utm-plc 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. data/LICENSE +681 -0
  2. data/README.mkd +101 -0
  3. data/bin/plc +10 -0
  4. data/bin/plc.rb +227 -0
  5. data/lib/utm-plc.rb +237 -0
  6. metadata +53 -0
data/LICENSE ADDED
@@ -0,0 +1,681 @@
1
+ This license applies ONLY to code authored by Jeff Welling. All
2
+ other code contributions until now have been under the MIT license.
3
+ To see the MIT license, see the LICENSE_MIT file.
4
+ For information on how to find out which code was authored by whom,
5
+ see http://www.kernel.org/pub/software/scm/git/docs/git-blame.html
6
+
7
+
8
+ GNU GENERAL PUBLIC LICENSE
9
+ Version 3, 29 June 2007
10
+
11
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
12
+ Everyone is permitted to copy and distribute verbatim copies
13
+ of this license document, but changing it is not allowed.
14
+
15
+ Preamble
16
+
17
+ The GNU General Public License is a free, copyleft license for
18
+ software and other kinds of works.
19
+
20
+ The licenses for most software and other practical works are designed
21
+ to take away your freedom to share and change the works. By contrast,
22
+ the GNU General Public License is intended to guarantee your freedom to
23
+ share and change all versions of a program--to make sure it remains free
24
+ software for all its users. We, the Free Software Foundation, use the
25
+ GNU General Public License for most of our software; it applies also to
26
+ any other work released this way by its authors. You can apply it to
27
+ your programs, too.
28
+
29
+ When we speak of free software, we are referring to freedom, not
30
+ price. Our General Public Licenses are designed to make sure that you
31
+ have the freedom to distribute copies of free software (and charge for
32
+ them if you wish), that you receive source code or can get it if you
33
+ want it, that you can change the software or use pieces of it in new
34
+ free programs, and that you know you can do these things.
35
+
36
+ To protect your rights, we need to prevent others from denying you
37
+ these rights or asking you to surrender the rights. Therefore, you have
38
+ certain responsibilities if you distribute copies of the software, or if
39
+ you modify it: responsibilities to respect the freedom of others.
40
+
41
+ For example, if you distribute copies of such a program, whether
42
+ gratis or for a fee, you must pass on to the recipients the same
43
+ freedoms that you received. You must make sure that they, too, receive
44
+ or can get the source code. And you must show them these terms so they
45
+ know their rights.
46
+
47
+ Developers that use the GNU GPL protect your rights with two steps:
48
+ (1) assert copyright on the software, and (2) offer you this License
49
+ giving you legal permission to copy, distribute and/or modify it.
50
+
51
+ For the developers' and authors' protection, the GPL clearly explains
52
+ that there is no warranty for this free software. For both users' and
53
+ authors' sake, the GPL requires that modified versions be marked as
54
+ changed, so that their problems will not be attributed erroneously to
55
+ authors of previous versions.
56
+
57
+ Some devices are designed to deny users access to install or run
58
+ modified versions of the software inside them, although the manufacturer
59
+ can do so. This is fundamentally incompatible with the aim of
60
+ protecting users' freedom to change the software. The systematic
61
+ pattern of such abuse occurs in the area of products for individuals to
62
+ use, which is precisely where it is most unacceptable. Therefore, we
63
+ have designed this version of the GPL to prohibit the practice for those
64
+ products. If such problems arise substantially in other domains, we
65
+ stand ready to extend this provision to those domains in future versions
66
+ of the GPL, as needed to protect the freedom of users.
67
+
68
+ Finally, every program is threatened constantly by software patents.
69
+ States should not allow patents to restrict development and use of
70
+ software on general-purpose computers, but in those that do, we wish to
71
+ avoid the special danger that patents applied to a free program could
72
+ make it effectively proprietary. To prevent this, the GPL assures that
73
+ patents cannot be used to render the program non-free.
74
+
75
+ The precise terms and conditions for copying, distribution and
76
+ modification follow.
77
+
78
+ TERMS AND CONDITIONS
79
+
80
+ 0. Definitions.
81
+
82
+ "This License" refers to version 3 of the GNU General Public License.
83
+
84
+ "Copyright" also means copyright-like laws that apply to other kinds of
85
+ works, such as semiconductor masks.
86
+
87
+ "The Program" refers to any copyrightable work licensed under this
88
+ License. Each licensee is addressed as "you". "Licensees" and
89
+ "recipients" may be individuals or organizations.
90
+
91
+ To "modify" a work means to copy from or adapt all or part of the work
92
+ in a fashion requiring copyright permission, other than the making of an
93
+ exact copy. The resulting work is called a "modified version" of the
94
+ earlier work or a work "based on" the earlier work.
95
+
96
+ A "covered work" means either the unmodified Program or a work based
97
+ on the Program.
98
+
99
+ To "propagate" a work means to do anything with it that, without
100
+ permission, would make you directly or secondarily liable for
101
+ infringement under applicable copyright law, except executing it on a
102
+ computer or modifying a private copy. Propagation includes copying,
103
+ distribution (with or without modification), making available to the
104
+ public, and in some countries other activities as well.
105
+
106
+ To "convey" a work means any kind of propagation that enables other
107
+ parties to make or receive copies. Mere interaction with a user through
108
+ a computer network, with no transfer of a copy, is not conveying.
109
+
110
+ An interactive user interface displays "Appropriate Legal Notices"
111
+ to the extent that it includes a convenient and prominently visible
112
+ feature that (1) displays an appropriate copyright notice, and (2)
113
+ tells the user that there is no warranty for the work (except to the
114
+ extent that warranties are provided), that licensees may convey the
115
+ work under this License, and how to view a copy of this License. If
116
+ the interface presents a list of user commands or options, such as a
117
+ menu, a prominent item in the list meets this criterion.
118
+
119
+ 1. Source Code.
120
+
121
+ The "source code" for a work means the preferred form of the work
122
+ for making modifications to it. "Object code" means any non-source
123
+ form of a work.
124
+
125
+ A "Standard Interface" means an interface that either is an official
126
+ standard defined by a recognized standards body, or, in the case of
127
+ interfaces specified for a particular programming language, one that
128
+ is widely used among developers working in that language.
129
+
130
+ The "System Libraries" of an executable work include anything, other
131
+ than the work as a whole, that (a) is included in the normal form of
132
+ packaging a Major Component, but which is not part of that Major
133
+ Component, and (b) serves only to enable use of the work with that
134
+ Major Component, or to implement a Standard Interface for which an
135
+ implementation is available to the public in source code form. A
136
+ "Major Component", in this context, means a major essential component
137
+ (kernel, window system, and so on) of the specific operating system
138
+ (if any) on which the executable work runs, or a compiler used to
139
+ produce the work, or an object code interpreter used to run it.
140
+
141
+ The "Corresponding Source" for a work in object code form means all
142
+ the source code needed to generate, install, and (for an executable
143
+ work) run the object code and to modify the work, including scripts to
144
+ control those activities. However, it does not include the work's
145
+ System Libraries, or general-purpose tools or generally available free
146
+ programs which are used unmodified in performing those activities but
147
+ which are not part of the work. For example, Corresponding Source
148
+ includes interface definition files associated with source files for
149
+ the work, and the source code for shared libraries and dynamically
150
+ linked subprograms that the work is specifically designed to require,
151
+ such as by intimate data communication or control flow between those
152
+ subprograms and other parts of the work.
153
+
154
+ The Corresponding Source need not include anything that users
155
+ can regenerate automatically from other parts of the Corresponding
156
+ Source.
157
+
158
+ The Corresponding Source for a work in source code form is that
159
+ same work.
160
+
161
+ 2. Basic Permissions.
162
+
163
+ All rights granted under this License are granted for the term of
164
+ copyright on the Program, and are irrevocable provided the stated
165
+ conditions are met. This License explicitly affirms your unlimited
166
+ permission to run the unmodified Program. The output from running a
167
+ covered work is covered by this License only if the output, given its
168
+ content, constitutes a covered work. This License acknowledges your
169
+ rights of fair use or other equivalent, as provided by copyright law.
170
+
171
+ You may make, run and propagate covered works that you do not
172
+ convey, without conditions so long as your license otherwise remains
173
+ in force. You may convey covered works to others for the sole purpose
174
+ of having them make modifications exclusively for you, or provide you
175
+ with facilities for running those works, provided that you comply with
176
+ the terms of this License in conveying all material for which you do
177
+ not control copyright. Those thus making or running the covered works
178
+ for you must do so exclusively on your behalf, under your direction
179
+ and control, on terms that prohibit them from making any copies of
180
+ your copyrighted material outside their relationship with you.
181
+
182
+ Conveying under any other circumstances is permitted solely under
183
+ the conditions stated below. Sublicensing is not allowed; section 10
184
+ makes it unnecessary.
185
+
186
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
187
+
188
+ No covered work shall be deemed part of an effective technological
189
+ measure under any applicable law fulfilling obligations under article
190
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
191
+ similar laws prohibiting or restricting circumvention of such
192
+ measures.
193
+
194
+ When you convey a covered work, you waive any legal power to forbid
195
+ circumvention of technological measures to the extent such circumvention
196
+ is effected by exercising rights under this License with respect to
197
+ the covered work, and you disclaim any intention to limit operation or
198
+ modification of the work as a means of enforcing, against the work's
199
+ users, your or third parties' legal rights to forbid circumvention of
200
+ technological measures.
201
+
202
+ 4. Conveying Verbatim Copies.
203
+
204
+ You may convey verbatim copies of the Program's source code as you
205
+ receive it, in any medium, provided that you conspicuously and
206
+ appropriately publish on each copy an appropriate copyright notice;
207
+ keep intact all notices stating that this License and any
208
+ non-permissive terms added in accord with section 7 apply to the code;
209
+ keep intact all notices of the absence of any warranty; and give all
210
+ recipients a copy of this License along with the Program.
211
+
212
+ You may charge any price or no price for each copy that you convey,
213
+ and you may offer support or warranty protection for a fee.
214
+
215
+ 5. Conveying Modified Source Versions.
216
+
217
+ You may convey a work based on the Program, or the modifications to
218
+ produce it from the Program, in the form of source code under the
219
+ terms of section 4, provided that you also meet all of these conditions:
220
+
221
+ a) The work must carry prominent notices stating that you modified
222
+ it, and giving a relevant date.
223
+
224
+ b) The work must carry prominent notices stating that it is
225
+ released under this License and any conditions added under section
226
+ 7. This requirement modifies the requirement in section 4 to
227
+ "keep intact all notices".
228
+
229
+ c) You must license the entire work, as a whole, under this
230
+ License to anyone who comes into possession of a copy. This
231
+ License will therefore apply, along with any applicable section 7
232
+ additional terms, to the whole of the work, and all its parts,
233
+ regardless of how they are packaged. This License gives no
234
+ permission to license the work in any other way, but it does not
235
+ invalidate such permission if you have separately received it.
236
+
237
+ d) If the work has interactive user interfaces, each must display
238
+ Appropriate Legal Notices; however, if the Program has interactive
239
+ interfaces that do not display Appropriate Legal Notices, your
240
+ work need not make them do so.
241
+
242
+ A compilation of a covered work with other separate and independent
243
+ works, which are not by their nature extensions of the covered work,
244
+ and which are not combined with it such as to form a larger program,
245
+ in or on a volume of a storage or distribution medium, is called an
246
+ "aggregate" if the compilation and its resulting copyright are not
247
+ used to limit the access or legal rights of the compilation's users
248
+ beyond what the individual works permit. Inclusion of a covered work
249
+ in an aggregate does not cause this License to apply to the other
250
+ parts of the aggregate.
251
+
252
+ 6. Conveying Non-Source Forms.
253
+
254
+ You may convey a covered work in object code form under the terms
255
+ of sections 4 and 5, provided that you also convey the
256
+ machine-readable Corresponding Source under the terms of this License,
257
+ in one of these ways:
258
+
259
+ a) Convey the object code in, or embodied in, a physical product
260
+ (including a physical distribution medium), accompanied by the
261
+ Corresponding Source fixed on a durable physical medium
262
+ customarily used for software interchange.
263
+
264
+ b) Convey the object code in, or embodied in, a physical product
265
+ (including a physical distribution medium), accompanied by a
266
+ written offer, valid for at least three years and valid for as
267
+ long as you offer spare parts or customer support for that product
268
+ model, to give anyone who possesses the object code either (1) a
269
+ copy of the Corresponding Source for all the software in the
270
+ product that is covered by this License, on a durable physical
271
+ medium customarily used for software interchange, for a price no
272
+ more than your reasonable cost of physically performing this
273
+ conveying of source, or (2) access to copy the
274
+ Corresponding Source from a network server at no charge.
275
+
276
+ c) Convey individual copies of the object code with a copy of the
277
+ written offer to provide the Corresponding Source. This
278
+ alternative is allowed only occasionally and noncommercially, and
279
+ only if you received the object code with such an offer, in accord
280
+ with subsection 6b.
281
+
282
+ d) Convey the object code by offering access from a designated
283
+ place (gratis or for a charge), and offer equivalent access to the
284
+ Corresponding Source in the same way through the same place at no
285
+ further charge. You need not require recipients to copy the
286
+ Corresponding Source along with the object code. If the place to
287
+ copy the object code is a network server, the Corresponding Source
288
+ may be on a different server (operated by you or a third party)
289
+ that supports equivalent copying facilities, provided you maintain
290
+ clear directions next to the object code saying where to find the
291
+ Corresponding Source. Regardless of what server hosts the
292
+ Corresponding Source, you remain obligated to ensure that it is
293
+ available for as long as needed to satisfy these requirements.
294
+
295
+ e) Convey the object code using peer-to-peer transmission, provided
296
+ you inform other peers where the object code and Corresponding
297
+ Source of the work are being offered to the general public at no
298
+ charge under subsection 6d.
299
+
300
+ A separable portion of the object code, whose source code is excluded
301
+ from the Corresponding Source as a System Library, need not be
302
+ included in conveying the object code work.
303
+
304
+ A "User Product" is either (1) a "consumer product", which means any
305
+ tangible personal property which is normally used for personal, family,
306
+ or household purposes, or (2) anything designed or sold for incorporation
307
+ into a dwelling. In determining whether a product is a consumer product,
308
+ doubtful cases shall be resolved in favor of coverage. For a particular
309
+ product received by a particular user, "normally used" refers to a
310
+ typical or common use of that class of product, regardless of the status
311
+ of the particular user or of the way in which the particular user
312
+ actually uses, or expects or is expected to use, the product. A product
313
+ is a consumer product regardless of whether the product has substantial
314
+ commercial, industrial or non-consumer uses, unless such uses represent
315
+ the only significant mode of use of the product.
316
+
317
+ "Installation Information" for a User Product means any methods,
318
+ procedures, authorization keys, or other information required to install
319
+ and execute modified versions of a covered work in that User Product from
320
+ a modified version of its Corresponding Source. The information must
321
+ suffice to ensure that the continued functioning of the modified object
322
+ code is in no case prevented or interfered with solely because
323
+ modification has been made.
324
+
325
+ If you convey an object code work under this section in, or with, or
326
+ specifically for use in, a User Product, and the conveying occurs as
327
+ part of a transaction in which the right of possession and use of the
328
+ User Product is transferred to the recipient in perpetuity or for a
329
+ fixed term (regardless of how the transaction is characterized), the
330
+ Corresponding Source conveyed under this section must be accompanied
331
+ by the Installation Information. But this requirement does not apply
332
+ if neither you nor any third party retains the ability to install
333
+ modified object code on the User Product (for example, the work has
334
+ been installed in ROM).
335
+
336
+ The requirement to provide Installation Information does not include a
337
+ requirement to continue to provide support service, warranty, or updates
338
+ for a work that has been modified or installed by the recipient, or for
339
+ the User Product in which it has been modified or installed. Access to a
340
+ network may be denied when the modification itself materially and
341
+ adversely affects the operation of the network or violates the rules and
342
+ protocols for communication across the network.
343
+
344
+ Corresponding Source conveyed, and Installation Information provided,
345
+ in accord with this section must be in a format that is publicly
346
+ documented (and with an implementation available to the public in
347
+ source code form), and must require no special password or key for
348
+ unpacking, reading or copying.
349
+
350
+ 7. Additional Terms.
351
+
352
+ "Additional permissions" are terms that supplement the terms of this
353
+ License by making exceptions from one or more of its conditions.
354
+ Additional permissions that are applicable to the entire Program shall
355
+ be treated as though they were included in this License, to the extent
356
+ that they are valid under applicable law. If additional permissions
357
+ apply only to part of the Program, that part may be used separately
358
+ under those permissions, but the entire Program remains governed by
359
+ this License without regard to the additional permissions.
360
+
361
+ When you convey a copy of a covered work, you may at your option
362
+ remove any additional permissions from that copy, or from any part of
363
+ it. (Additional permissions may be written to require their own
364
+ removal in certain cases when you modify the work.) You may place
365
+ additional permissions on material, added by you to a covered work,
366
+ for which you have or can give appropriate copyright permission.
367
+
368
+ Notwithstanding any other provision of this License, for material you
369
+ add to a covered work, you may (if authorized by the copyright holders of
370
+ that material) supplement the terms of this License with terms:
371
+
372
+ a) Disclaiming warranty or limiting liability differently from the
373
+ terms of sections 15 and 16 of this License; or
374
+
375
+ b) Requiring preservation of specified reasonable legal notices or
376
+ author attributions in that material or in the Appropriate Legal
377
+ Notices displayed by works containing it; or
378
+
379
+ c) Prohibiting misrepresentation of the origin of that material, or
380
+ requiring that modified versions of such material be marked in
381
+ reasonable ways as different from the original version; or
382
+
383
+ d) Limiting the use for publicity purposes of names of licensors or
384
+ authors of the material; or
385
+
386
+ e) Declining to grant rights under trademark law for use of some
387
+ trade names, trademarks, or service marks; or
388
+
389
+ f) Requiring indemnification of licensors and authors of that
390
+ material by anyone who conveys the material (or modified versions of
391
+ it) with contractual assumptions of liability to the recipient, for
392
+ any liability that these contractual assumptions directly impose on
393
+ those licensors and authors.
394
+
395
+ All other non-permissive additional terms are considered "further
396
+ restrictions" within the meaning of section 10. If the Program as you
397
+ received it, or any part of it, contains a notice stating that it is
398
+ governed by this License along with a term that is a further
399
+ restriction, you may remove that term. If a license document contains
400
+ a further restriction but permits relicensing or conveying under this
401
+ License, you may add to a covered work material governed by the terms
402
+ of that license document, provided that the further restriction does
403
+ not survive such relicensing or conveying.
404
+
405
+ If you add terms to a covered work in accord with this section, you
406
+ must place, in the relevant source files, a statement of the
407
+ additional terms that apply to those files, or a notice indicating
408
+ where to find the applicable terms.
409
+
410
+ Additional terms, permissive or non-permissive, may be stated in the
411
+ form of a separately written license, or stated as exceptions;
412
+ the above requirements apply either way.
413
+
414
+ 8. Termination.
415
+
416
+ You may not propagate or modify a covered work except as expressly
417
+ provided under this License. Any attempt otherwise to propagate or
418
+ modify it is void, and will automatically terminate your rights under
419
+ this License (including any patent licenses granted under the third
420
+ paragraph of section 11).
421
+
422
+ However, if you cease all violation of this License, then your
423
+ license from a particular copyright holder is reinstated (a)
424
+ provisionally, unless and until the copyright holder explicitly and
425
+ finally terminates your license, and (b) permanently, if the copyright
426
+ holder fails to notify you of the violation by some reasonable means
427
+ prior to 60 days after the cessation.
428
+
429
+ Moreover, your license from a particular copyright holder is
430
+ reinstated permanently if the copyright holder notifies you of the
431
+ violation by some reasonable means, this is the first time you have
432
+ received notice of violation of this License (for any work) from that
433
+ copyright holder, and you cure the violation prior to 30 days after
434
+ your receipt of the notice.
435
+
436
+ Termination of your rights under this section does not terminate the
437
+ licenses of parties who have received copies or rights from you under
438
+ this License. If your rights have been terminated and not permanently
439
+ reinstated, you do not qualify to receive new licenses for the same
440
+ material under section 10.
441
+
442
+ 9. Acceptance Not Required for Having Copies.
443
+
444
+ You are not required to accept this License in order to receive or
445
+ run a copy of the Program. Ancillary propagation of a covered work
446
+ occurring solely as a consequence of using peer-to-peer transmission
447
+ to receive a copy likewise does not require acceptance. However,
448
+ nothing other than this License grants you permission to propagate or
449
+ modify any covered work. These actions infringe copyright if you do
450
+ not accept this License. Therefore, by modifying or propagating a
451
+ covered work, you indicate your acceptance of this License to do so.
452
+
453
+ 10. Automatic Licensing of Downstream Recipients.
454
+
455
+ Each time you convey a covered work, the recipient automatically
456
+ receives a license from the original licensors, to run, modify and
457
+ propagate that work, subject to this License. You are not responsible
458
+ for enforcing compliance by third parties with this License.
459
+
460
+ An "entity transaction" is a transaction transferring control of an
461
+ organization, or substantially all assets of one, or subdividing an
462
+ organization, or merging organizations. If propagation of a covered
463
+ work results from an entity transaction, each party to that
464
+ transaction who receives a copy of the work also receives whatever
465
+ licenses to the work the party's predecessor in interest had or could
466
+ give under the previous paragraph, plus a right to possession of the
467
+ Corresponding Source of the work from the predecessor in interest, if
468
+ the predecessor has it or can get it with reasonable efforts.
469
+
470
+ You may not impose any further restrictions on the exercise of the
471
+ rights granted or affirmed under this License. For example, you may
472
+ not impose a license fee, royalty, or other charge for exercise of
473
+ rights granted under this License, and you may not initiate litigation
474
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
475
+ any patent claim is infringed by making, using, selling, offering for
476
+ sale, or importing the Program or any portion of it.
477
+
478
+ 11. Patents.
479
+
480
+ A "contributor" is a copyright holder who authorizes use under this
481
+ License of the Program or a work on which the Program is based. The
482
+ work thus licensed is called the contributor's "contributor version".
483
+
484
+ A contributor's "essential patent claims" are all patent claims
485
+ owned or controlled by the contributor, whether already acquired or
486
+ hereafter acquired, that would be infringed by some manner, permitted
487
+ by this License, of making, using, or selling its contributor version,
488
+ but do not include claims that would be infringed only as a
489
+ consequence of further modification of the contributor version. For
490
+ purposes of this definition, "control" includes the right to grant
491
+ patent sublicenses in a manner consistent with the requirements of
492
+ this License.
493
+
494
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
495
+ patent license under the contributor's essential patent claims, to
496
+ make, use, sell, offer for sale, import and otherwise run, modify and
497
+ propagate the contents of its contributor version.
498
+
499
+ In the following three paragraphs, a "patent license" is any express
500
+ agreement or commitment, however denominated, not to enforce a patent
501
+ (such as an express permission to practice a patent or covenant not to
502
+ sue for patent infringement). To "grant" such a patent license to a
503
+ party means to make such an agreement or commitment not to enforce a
504
+ patent against the party.
505
+
506
+ If you convey a covered work, knowingly relying on a patent license,
507
+ and the Corresponding Source of the work is not available for anyone
508
+ to copy, free of charge and under the terms of this License, through a
509
+ publicly available network server or other readily accessible means,
510
+ then you must either (1) cause the Corresponding Source to be so
511
+ available, or (2) arrange to deprive yourself of the benefit of the
512
+ patent license for this particular work, or (3) arrange, in a manner
513
+ consistent with the requirements of this License, to extend the patent
514
+ license to downstream recipients. "Knowingly relying" means you have
515
+ actual knowledge that, but for the patent license, your conveying the
516
+ covered work in a country, or your recipient's use of the covered work
517
+ in a country, would infringe one or more identifiable patents in that
518
+ country that you have reason to believe are valid.
519
+
520
+ If, pursuant to or in connection with a single transaction or
521
+ arrangement, you convey, or propagate by procuring conveyance of, a
522
+ covered work, and grant a patent license to some of the parties
523
+ receiving the covered work authorizing them to use, propagate, modify
524
+ or convey a specific copy of the covered work, then the patent license
525
+ you grant is automatically extended to all recipients of the covered
526
+ work and works based on it.
527
+
528
+ A patent license is "discriminatory" if it does not include within
529
+ the scope of its coverage, prohibits the exercise of, or is
530
+ conditioned on the non-exercise of one or more of the rights that are
531
+ specifically granted under this License. You may not convey a covered
532
+ work if you are a party to an arrangement with a third party that is
533
+ in the business of distributing software, under which you make payment
534
+ to the third party based on the extent of your activity of conveying
535
+ the work, and under which the third party grants, to any of the
536
+ parties who would receive the covered work from you, a discriminatory
537
+ patent license (a) in connection with copies of the covered work
538
+ conveyed by you (or copies made from those copies), or (b) primarily
539
+ for and in connection with specific products or compilations that
540
+ contain the covered work, unless you entered into that arrangement,
541
+ or that patent license was granted, prior to 28 March 2007.
542
+
543
+ Nothing in this License shall be construed as excluding or limiting
544
+ any implied license or other defenses to infringement that may
545
+ otherwise be available to you under applicable patent law.
546
+
547
+ 12. No Surrender of Others' Freedom.
548
+
549
+ If conditions are imposed on you (whether by court order, agreement or
550
+ otherwise) that contradict the conditions of this License, they do not
551
+ excuse you from the conditions of this License. If you cannot convey a
552
+ covered work so as to satisfy simultaneously your obligations under this
553
+ License and any other pertinent obligations, then as a consequence you may
554
+ not convey it at all. For example, if you agree to terms that obligate you
555
+ to collect a royalty for further conveying from those to whom you convey
556
+ the Program, the only way you could satisfy both those terms and this
557
+ License would be to refrain entirely from conveying the Program.
558
+
559
+ 13. Use with the GNU Affero General Public License.
560
+
561
+ Notwithstanding any other provision of this License, you have
562
+ permission to link or combine any covered work with a work licensed
563
+ under version 3 of the GNU Affero General Public License into a single
564
+ combined work, and to convey the resulting work. The terms of this
565
+ License will continue to apply to the part which is the covered work,
566
+ but the special requirements of the GNU Affero General Public License,
567
+ section 13, concerning interaction through a network will apply to the
568
+ combination as such.
569
+
570
+ 14. Revised Versions of this License.
571
+
572
+ The Free Software Foundation may publish revised and/or new versions of
573
+ the GNU General Public License from time to time. Such new versions will
574
+ be similar in spirit to the present version, but may differ in detail to
575
+ address new problems or concerns.
576
+
577
+ Each version is given a distinguishing version number. If the
578
+ Program specifies that a certain numbered version of the GNU General
579
+ Public License "or any later version" applies to it, you have the
580
+ option of following the terms and conditions either of that numbered
581
+ version or of any later version published by the Free Software
582
+ Foundation. If the Program does not specify a version number of the
583
+ GNU General Public License, you may choose any version ever published
584
+ by the Free Software Foundation.
585
+
586
+ If the Program specifies that a proxy can decide which future
587
+ versions of the GNU General Public License can be used, that proxy's
588
+ public statement of acceptance of a version permanently authorizes you
589
+ to choose that version for the Program.
590
+
591
+ Later license versions may give you additional or different
592
+ permissions. However, no additional obligations are imposed on any
593
+ author or copyright holder as a result of your choosing to follow a
594
+ later version.
595
+
596
+ 15. Disclaimer of Warranty.
597
+
598
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
599
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
600
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
601
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
602
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
603
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
604
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
605
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
606
+
607
+ 16. Limitation of Liability.
608
+
609
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
610
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
611
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
612
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
613
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
614
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
615
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
616
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
617
+ SUCH DAMAGES.
618
+
619
+ 17. Interpretation of Sections 15 and 16.
620
+
621
+ If the disclaimer of warranty and limitation of liability provided
622
+ above cannot be given local legal effect according to their terms,
623
+ reviewing courts shall apply local law that most closely approximates
624
+ an absolute waiver of all civil liability in connection with the
625
+ Program, unless a warranty or assumption of liability accompanies a
626
+ copy of the Program in return for a fee.
627
+
628
+ END OF TERMS AND CONDITIONS
629
+
630
+ How to Apply These Terms to Your New Programs
631
+
632
+ If you develop a new program, and you want it to be of the greatest
633
+ possible use to the public, the best way to achieve this is to make it
634
+ free software which everyone can redistribute and change under these terms.
635
+
636
+ To do so, attach the following notices to the program. It is safest
637
+ to attach them to the start of each source file to most effectively
638
+ state the exclusion of warranty; and each file should have at least
639
+ the "copyright" line and a pointer to where the full notice is found.
640
+
641
+ <one line to give the program's name and a brief idea of what it does.>
642
+ Copyright (C) <year> <name of author>
643
+
644
+ This program is free software: you can redistribute it and/or modify
645
+ it under the terms of the GNU General Public License as published by
646
+ the Free Software Foundation, either version 3 of the License, or
647
+ (at your option) any later version.
648
+
649
+ This program is distributed in the hope that it will be useful,
650
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
651
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
652
+ GNU General Public License for more details.
653
+
654
+ You should have received a copy of the GNU General Public License
655
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
656
+
657
+ Also add information on how to contact you by electronic and paper mail.
658
+
659
+ If the program does terminal interaction, make it output a short
660
+ notice like this when it starts in an interactive mode:
661
+
662
+ <program> Copyright (C) <year> <name of author>
663
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
664
+ This is free software, and you are welcome to redistribute it
665
+ under certain conditions; type `show c' for details.
666
+
667
+ The hypothetical commands `show w' and `show c' should show the appropriate
668
+ parts of the General Public License. Of course, your program's commands
669
+ might be different; for a GUI interface, you would use an "about box".
670
+
671
+ You should also get your employer (if you work as a programmer) or school,
672
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
673
+ For more information on this, and how to apply and follow the GNU GPL, see
674
+ <http://www.gnu.org/licenses/>.
675
+
676
+ The GNU General Public License does not permit incorporating your program
677
+ into proprietary programs. If your program is a subroutine library, you
678
+ may consider it more useful to permit linking proprietary applications with
679
+ the library. If this is what you want to do, use the GNU Lesser General
680
+ Public License instead of this License. But first, please read
681
+ <http://www.gnu.org/philosophy/why-not-lgpl.html>.
data/README.mkd ADDED
@@ -0,0 +1,101 @@
1
+
2
+ ## UTM plc -- Proxy Logging Checker ##
3
+
4
+ This is a brief little script that logs in to your UTM via SSH using passwords that it prompts you for, and
5
+ then proceeds to loop over every Web Filter and proxy profile looking for any action that does not have both
6
+ logging options enabled. At the end of the run, it prints a list of suggested corrections to turn logging
7
+ back on on all actions. It is intended for users of advanced configurations where there are many filter
8
+ assignments and filter actions in a complex configuration. This tool will loop over all of the filter actions
9
+ that are in use and will list the ones that do not have logging enabled.
10
+
11
+ ### Prerequisites ###
12
+
13
+ You will need Ruby to run this script as it is a RubyGem. You will also need to have Shell Access enabled
14
+ your UTM, you must be in the list of Allowed Networks, and you must know what the passwords are for the
15
+ root and loginuser accounts, which you can set under the Shell Access tab under Management -> System Settings.
16
+
17
+ ### How It Works ###
18
+
19
+ Here is a general overview of how it works.
20
+
21
+ 1) SSH into the appliance as loginuser
22
+ 2) Become root
23
+ 3) Run 'cc get http' to get a dump of the Web Filter configuration
24
+ 4) For each profile listed,
25
+ -) Look up the profile with `cc get_oject REF_...`
26
+ -) For every 'cff_profiles' (aka Filter Assignment),
27
+ -) Look up that cff_profile `cc get_object REF_...`
28
+ -) Look up the 'action' with `cc get_object REF_...`
29
+ -) If the action doesn't log both accessed and logged pages, add to the list of results
30
+ 5) Print results.
31
+
32
+ ### What does it look like? ###
33
+
34
+ Here, let me show you. In this configuration, the main web filter (under Web Protection -> Web Filter)
35
+ is configured to log accessed pages and to not log blocked pages. FilterAction One is configured to log
36
+ blocked pages, but not accessed pages. FilterAction Two is configured to log accessed pages but not blocked
37
+ pages. The Default content filter block action is configured to log accessed but not blocked pages.
38
+ FilterAction Three is configured to not log either accessed or blocked pages. Here we go:
39
+
40
+ $ ./plc.rb
41
+ What port?: 22
42
+ Which host?: 192.168.0.1
43
+ Logging in as loginuser...
44
+ What is the password for loginuser?:
45
+ Using su to become root...
46
+ What is the password for root?:
47
+ Am now root.
48
+ Found 3 profiles:
49
+ -- REF_DefaultHTTPProfile
50
+ -- REF_HttProConta19216
51
+ -- REF_HttProConta192162
52
+
53
+ Checking profile: Default Proxy
54
+ Found cff_profiles:
55
+ -- REF_DefaultHTTPCFFProfile
56
+ Got the assignment for that profile...
57
+ Got the action for that assignment...
58
+ Found an action that isn't logging everything: Default content filter action
59
+
60
+ Checking profile: Profile One
61
+ Found cff_profiles:
62
+ -- REF_HttCffAllowFromAdmin
63
+ Got the assignment for that profile...
64
+ Got the action for that assignment...
65
+ Found an action that isn't logging everything: FilterAction Two
66
+
67
+ Checking profile: Profile Two
68
+ Found cff_profiles:
69
+ -- REF_HttCffAllowFromJeff
70
+ Got the assignment for that profile...
71
+ Got the action for that assignment...
72
+ Found an action that isn't logging everything: FilterAction One
73
+
74
+
75
+ Printing results:
76
+ Please activate the 'Log Blocked Pages' option for the Web Filter Action named: Default content filter action
77
+ Please activate the 'Log Blocked Pages' option for the Web Filter Action named: FilterAction Two
78
+ Please activate the 'Log Accessed Pages' option for the Web Filter Action named: FilterAction One
79
+ Done
80
+
81
+ ### It doesn't work ###
82
+
83
+ Check the output of `echo $PATH`, and compare it against `which bin/plc`. Is the directory that plc is in,
84
+ in your path? If not, this will be your problem. To resolve this, append that directory to your path.
85
+ How exactly to do this is left as an exercise for the reader.
86
+
87
+ If you're absolutley positely pinkey-swearsey sure that your $PATH contains the right directory, and it
88
+ still isn't doing what you think it should be doing, [file a bug](https://github.com/jeffWelling/utm-plc/issues).
89
+
90
+ ### Author ###
91
+
92
+ Jeff Welling
93
+ jeff.welling@gmail.com
94
+
95
+ ### License ###
96
+
97
+ This software is published under GPLv3. For an alternative license arrangement feel free to email me, but I make no guarantees.
98
+
99
+ ### Contributing ###
100
+
101
+ Contributions are welcome by submitting a pull request, or by emailing your patch to the above email address.
data/bin/plc ADDED
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env ruby
2
+ require 'fileutils'
3
+ #Add the library from the source tree if exists, this allows
4
+ #testing without installing the gem first
5
+ if File.exist? File.join('lib', 'utm-plc.rb')
6
+ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
7
+ end
8
+ require 'utm-plc'
9
+
10
+ run
data/bin/plc.rb ADDED
@@ -0,0 +1,227 @@
1
+ #!/usr/bin/env ruby
2
+ # This file is part of UTM_plc.
3
+ # Copyright 2013 Jeff Welling (jeff.welling@gmail.com)
4
+ #
5
+ # UTM_plc is free software: you can redistribute it and/or modify
6
+ # it under the terms of the GNU General Public License as published by
7
+ # the Free Software Foundation, either version 3 of the License, or
8
+ # (at your option) any later version.
9
+ #
10
+ # UTM_plc is distributed in the hope that it will be useful,
11
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ # GNU General Public License for more details.
14
+ #
15
+ # You should have received a copy of the GNU General Public License
16
+ # along with tget. If not, see <http://www.gnu.org/licenses/>.
17
+ #
18
+ # Add the library from the source tree to the front of the load path.
19
+ # This allows tget to run without first installing the tget gem, which is
20
+ # important when testing multiple branches of development.
21
+ require 'pty'
22
+ require 'timeout'
23
+ require 'pp'
24
+
25
+ def _host; prompt('Which host?: ') end
26
+ def _port; prompt('What port?: ') end
27
+ def _lu_password; disable_echo {prompt('What is the password for loginuser?: ')} end
28
+ def _ru_password; disable_echo {prompt('What is the password for root?: ')} end
29
+
30
+ $logging=false
31
+ $debugging=false
32
+
33
+ def disable_echo &block
34
+ system('stty -echo')
35
+ x=yield
36
+ system('stty echo')
37
+ #so that the next line doesn't start on the same line as the password prompt
38
+ log
39
+ x
40
+ end
41
+
42
+ def add_nl s
43
+ #append a "\n" (newline) to a string if it doesn't already end with one.
44
+ (s[/\\n$/].nil? ? s+"\n" : s)
45
+ end
46
+
47
+ def log string=String.new
48
+ if $logging==true
49
+ printf add_nl(string)
50
+ end
51
+ string
52
+ end
53
+
54
+ def debug string
55
+ if $logging and $debugging
56
+ printf add_nl(string)
57
+ end
58
+ string
59
+ end
60
+
61
+ def login
62
+ log "Logging in as loginuser..."
63
+ $in.printf( _lu_password + "\n" )
64
+ debug until_prompt( '/home/login >' )
65
+ end
66
+
67
+ def become_root
68
+ log "Using su to become root..."
69
+ $in.printf( "su\n" )
70
+ debug until_prompt( 'Password:' )
71
+ $in.printf( "#{_ru_password}\n" )
72
+ debug until_prompt( '/home/login #' )
73
+ log "Am now root."
74
+ end
75
+
76
+ def extract_profiles http
77
+ debug "Extracting profiles from 'http'="
78
+ profiles=http[/'profiles' => \[[^\]]*/].gsub( "'profiles' => \[",'' ).split(',').collect {|p|
79
+ p.strip.gsub(/^'/,'').gsub(/'$/,'')
80
+ }
81
+ log "Found #{profiles.size} profiles:"
82
+ profiles.each {|p|
83
+ log " -- "+p
84
+ }
85
+ end
86
+
87
+ def extract_cff_profiles raw_proxy_profile
88
+ log "Found cff_profiles: "
89
+ cff_p=raw_proxy_profile[/'cff_profiles' => \[[^\]]*/].gsub( "'cff_profiles' => \[",'' ).
90
+ strip.gsub(',','').strip.gsub(/^'/,'').gsub(/'$/,'').strip.gsub(/^'/,'').gsub(/'$/,'')
91
+ log " -- "+cff_p
92
+ cff_p
93
+ end
94
+
95
+ def extract_action raw_assignment
96
+ raw_assignment[/'action' => '[^']*/].gsub(/'action' => '/,'').strip
97
+ end
98
+
99
+ def search_profiles profiles
100
+ if profiles.class!=Array
101
+ raise ArgumentError "search_profiles(profiles): 'profiles' must be an array but it's something else, possibly a cheeseburger..."
102
+ elsif profiles.empty?
103
+ raise ArgumentError "search_profiles(profiles): 'profiles' must be a non-empty array! What have you done?!?"
104
+ end
105
+ results=[]
106
+ profiles.each {|profile|
107
+ debug raw_proxy_profile=get_object(profile)
108
+ log "\nChecking profile: #{get_name(raw_proxy_profile)}"
109
+ debug raw_assignment=get_object( extract_cff_profiles(raw_proxy_profile) )
110
+ log "Got the assignment for that profile..."
111
+ action= get_action(raw_assignment)
112
+ raw_action= get_object( extract_action(raw_assignment) )
113
+ log "Got the action for that assignment..."
114
+
115
+ if !log_accessed?(raw_action) || !log_blocked?(raw_action)
116
+ log "Found an action that isn't logging everything: #{get_name(raw_action)}"
117
+ results << raw_action
118
+ end
119
+ }
120
+ results
121
+ end
122
+
123
+ def log_accessed? action
124
+ if action[/'log_access' => \d/].nil?
125
+ raise ArgumentError "log_accessed?(action): action doesn't contain a 'log_access' attribute?"
126
+ end
127
+ action[/'log_access' => \d/].gsub(/'log_access' => /,'')=='1'
128
+ end
129
+
130
+ def log_blocked? action
131
+ if action[/'log_blocked' => \d/].nil?
132
+ raise ArgumentError "log_blocked?(action): action doesn't contain a 'log_blocked' attribute?"
133
+ end
134
+ action[/'log_blocked' => \d/].gsub(/'log_blocked' => /,'')=='1'
135
+ end
136
+
137
+ def print_results results
138
+ log "\n\nPrinting results:"
139
+ results.each {|action|
140
+ if !log_accessed?(action)
141
+ log "Please activate the 'Log Accessed Pages' option for the Web Filter Action named: #{get_name(action)}"
142
+ elsif !log_blocked?(action)
143
+ log "Please activate the 'Log Blocked Pages' option for the Web Filter Action named: #{get_name(action)}"
144
+ end
145
+ }
146
+ end
147
+
148
+ def get x, command='get'
149
+ debug "Running: 'cc #{command} #{x}'..."
150
+ $in.printf("cc #{command} #{x}\n")
151
+ debug until_prompt(':/home/login #')
152
+ end
153
+
154
+ def print_raction raw_action
155
+ log "Name: #{get_name(raw_action)}"
156
+ log "Comment: #{get_comment(raw_action)}"
157
+ end
158
+
159
+ def get_name raw
160
+ raw[/'name' => '[^']*/].gsub(/'name' => '/,'')
161
+ end
162
+
163
+ def get_comment raw
164
+ raw[/'comment' => '[^']*/].gsub(/'comment' => '/,'')
165
+ end
166
+
167
+ def get_action raw_assignment
168
+ raw_assignment[/'action' => '[^']*/].gsub(/'action' => '/,'').strip
169
+ end
170
+
171
+ def get_object x
172
+ get x, 'get_object'
173
+ end
174
+
175
+ def until_prompt( prompt )
176
+ buffer= ""
177
+ begin
178
+ Timeout.timeout( 30 ) {
179
+ loop do
180
+ buffer << $out.getc.chr
181
+ break if buffer =~ Regexp.new(prompt)
182
+ end
183
+ }
184
+ buffer
185
+ rescue Timeout::Error => error
186
+ printf "Error - Timed out waiting for \"#{prompt.gsub('"','\"') }\", printing stacktrace...\n "
187
+ printf error.backtrace.join("\n") + "\n"
188
+ printf "Dumping buffer...\n"
189
+ pp buffer
190
+ printf "-------\n\n"
191
+ end
192
+ end
193
+
194
+ def prompt *question
195
+ printf *question
196
+ (s=gets.strip).empty? ? prompt(*question) : s
197
+ end
198
+
199
+ def run
200
+ PTY.spawn("ssh -p #{_port} loginuser@#{_host}") {|stdout,stdin,pid|
201
+ old_out=$out; $out=stdout
202
+ old_in=$in; $in =stdin
203
+ $logging=true
204
+
205
+ debug( until_prompt('password:') )
206
+ login
207
+ become_root
208
+
209
+ #Because the main Web Filter is treated as a profile, this
210
+ #will operate on all Web Filters and proxy profiles.
211
+ results= search_profiles( extract_profiles( get('http') ) )
212
+
213
+ print_results( results )
214
+
215
+ stdin.printf( "exit\n" )
216
+ until_prompt( ":/home/login >" )
217
+ stdin.printf( "exit\n" )
218
+
219
+ $out=old_out
220
+ $in=old_in
221
+ }
222
+ log 'Done'
223
+ end
224
+
225
+ if __FILE__ == './plc.rb'
226
+ run
227
+ end
data/lib/utm-plc.rb ADDED
@@ -0,0 +1,237 @@
1
+ #!/usr/bin/env ruby
2
+ # This file is part of UTM_plc.
3
+ # Copyright 2013 Jeff Welling (jeff.welling@gmail.com)
4
+ #
5
+ # UTM_plc is free software: you can redistribute it and/or modify
6
+ # it under the terms of the GNU General Public License as published by
7
+ # the Free Software Foundation, either version 3 of the License, or
8
+ # (at your option) any later version.
9
+ #
10
+ # UTM_plc is distributed in the hope that it will be useful,
11
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ # GNU General Public License for more details.
14
+ #
15
+ # You should have received a copy of the GNU General Public License
16
+ # along with tget. If not, see <http://www.gnu.org/licenses/>.
17
+ #
18
+ # Add the library from the source tree to the front of the load path.
19
+ # This allows tget to run without first installing the tget gem, which is
20
+ # important when testing multiple branches of development.
21
+ require 'pty'
22
+ require 'timeout'
23
+ require 'pp'
24
+
25
+ def _host; prompt('Which host?: ') end
26
+ def _port; prompt('What port?: ') end
27
+ def _lu_password; prompt('What is the password for loginuser?: ', true) end
28
+ def _ru_password; prompt('What is the password for root?: ', true) end
29
+
30
+ $logging=false
31
+ $debugging=false
32
+
33
+ def disable_echo &block
34
+ system('stty -echo')
35
+ x=yield
36
+ system('stty echo')
37
+ #so that the next line doesn't start on the same line as the password prompt
38
+ log
39
+ x
40
+ end
41
+
42
+ def add_nl s
43
+ #append a "\n" (newline) to a string if it doesn't already end with one.
44
+ (s[/\\n$/].nil? ? s+"\n" : s)
45
+ end
46
+
47
+ def log string=String.new
48
+ if $logging==true
49
+ printf add_nl(string)
50
+ end
51
+ string
52
+ end
53
+
54
+ def debug string
55
+ if $logging and $debugging
56
+ printf add_nl(string)
57
+ end
58
+ string
59
+ end
60
+
61
+ def login
62
+ log "Logging in as loginuser..."
63
+ $in.printf( _lu_password + "\n" )
64
+ debug until_prompt( '/home/login >' )
65
+ end
66
+
67
+ def become_root
68
+ log "Using su to become root..."
69
+ $in.printf( "su\n" )
70
+ debug until_prompt( 'Password:' )
71
+ $in.printf( "#{_ru_password}\n" )
72
+ debug until_prompt( '/home/login #' )
73
+ log "Am now root."
74
+ end
75
+
76
+ def extract_profiles http
77
+ debug "Extracting profiles from 'http'="
78
+ profiles=http[/'profiles' => \[[^\]]*/].gsub( "'profiles' => \[",'' ).split(',').collect {|p|
79
+ p.strip.gsub(/^'/,'').gsub(/'$/,'')
80
+ }
81
+ log "Found #{profiles.size} profiles:"
82
+ profiles.each {|p|
83
+ log " -- "+p
84
+ }
85
+ end
86
+
87
+ def extract_cff_profiles raw_proxy_profile
88
+ log "Found cff_profiles: "
89
+ cff_p=raw_proxy_profile[/'cff_profiles' => \[[^\]]*/].gsub( "'cff_profiles' => \[",'' ).
90
+ strip.gsub(',','').strip.gsub(/^'/,'').gsub(/'$/,'').strip.gsub(/^'/,'').gsub(/'$/,'')
91
+ log " -- "+cff_p
92
+ cff_p
93
+ end
94
+
95
+ def extract_action raw_assignment
96
+ raw_assignment[/'action' => '[^']*/].gsub(/'action' => '/,'').strip
97
+ end
98
+
99
+ def search_profiles profiles
100
+ if profiles.class!=Array
101
+ raise ArgumentError "search_profiles(profiles): 'profiles' must be an array but it's something else, possibly a cheeseburger..."
102
+ elsif profiles.empty?
103
+ raise ArgumentError "search_profiles(profiles): 'profiles' must be a non-empty array! What have you done?!?"
104
+ end
105
+ results=[]
106
+ profiles.each {|profile|
107
+ debug raw_proxy_profile=get_object(profile)
108
+ log "\nChecking profile: #{get_name(raw_proxy_profile)}"
109
+ debug raw_assignment=get_object( extract_cff_profiles(raw_proxy_profile) )
110
+ log "Got the assignment for that profile..."
111
+ action= get_action(raw_assignment)
112
+ raw_action= get_object( extract_action(raw_assignment) )
113
+ log "Got the action for that assignment..."
114
+
115
+ if !log_accessed?(raw_action) || !log_blocked?(raw_action)
116
+ log "Found an action that isn't logging everything: #{get_name(raw_action)}"
117
+ results << raw_action
118
+ end
119
+ }
120
+ results
121
+ end
122
+
123
+ def log_accessed? action
124
+ if action[/'log_access' => \d/].nil?
125
+ raise ArgumentError "log_accessed?(action): action doesn't contain a 'log_access' attribute?"
126
+ end
127
+ action[/'log_access' => \d/].gsub(/'log_access' => /,'')=='1'
128
+ end
129
+
130
+ def log_blocked? action
131
+ if action[/'log_blocked' => \d/].nil?
132
+ raise ArgumentError "log_blocked?(action): action doesn't contain a 'log_blocked' attribute?"
133
+ end
134
+ action[/'log_blocked' => \d/].gsub(/'log_blocked' => /,'')=='1'
135
+ end
136
+
137
+ def print_results results
138
+ log "\n\nPrinting results:"
139
+ results.each {|action|
140
+ if !log_accessed?(action)
141
+ log "Please activate the 'Log Accessed Pages' option for the Web Filter Action named: #{get_name(action)}"
142
+ elsif !log_blocked?(action)
143
+ log "Please activate the 'Log Blocked Pages' option for the Web Filter Action named: #{get_name(action)}"
144
+ end
145
+ }
146
+ end
147
+
148
+ def get x, command='get'
149
+ debug "Running: 'cc #{command} #{x}'..."
150
+ $in.printf("cc #{command} #{x}\n")
151
+ debug until_prompt(':/home/login #')
152
+ end
153
+
154
+ def print_raction raw_action
155
+ log "Name: #{get_name(raw_action)}"
156
+ log "Comment: #{get_comment(raw_action)}"
157
+ end
158
+
159
+ def get_name raw
160
+ raw[/'name' => '[^']*/].gsub(/'name' => '/,'')
161
+ end
162
+
163
+ def get_comment raw
164
+ raw[/'comment' => '[^']*/].gsub(/'comment' => '/,'')
165
+ end
166
+
167
+ def get_action raw_assignment
168
+ raw_assignment[/'action' => '[^']*/].gsub(/'action' => '/,'').strip
169
+ end
170
+
171
+ def get_object x
172
+ get x, 'get_object'
173
+ end
174
+
175
+ def fingerprint_prompt? string
176
+ !string[/\(yes\/no\)\?/].nil?
177
+ end
178
+
179
+ def until_prompt( prompt )
180
+ buffer= ""
181
+ begin
182
+ Timeout.timeout( 5 ) {
183
+ loop do
184
+ buffer << $out.getc.chr
185
+ if fingerprint_prompt?(buffer)
186
+ printf "SSH Fingerprint prompt detected.\nPlease SSH to this system at least once before using this program to verify the SSH fingerprint manually, then run this program again.\n\n"
187
+ exit
188
+ end
189
+ break if buffer =~ Regexp.new(prompt)
190
+ end
191
+ }
192
+ buffer
193
+ rescue Timeout::Error => error
194
+ printf "Error - Timed out waiting for \"#{prompt.gsub('"','\"') }\", printing stacktrace...\n "
195
+ printf error.backtrace.join("\n") + "\n"
196
+ printf "Dumping buffer...\n"
197
+ pp buffer
198
+ printf "-------\n\n"
199
+ end
200
+ end
201
+
202
+ def prompt question, password=false
203
+ printf question
204
+ if password==true
205
+ disable_echo {
206
+ (s=gets.strip).empty? ? prompt(question) : s
207
+ }
208
+ else
209
+ (s=gets.strip).empty? ? prompt(question) : s
210
+ end
211
+ end
212
+
213
+ def run
214
+ PTY.spawn("ssh -p #{_port} loginuser@#{_host}") {|stdout,stdin,pid|
215
+ old_out=$out; $out=stdout
216
+ old_in=$in; $in =stdin
217
+ $logging=true
218
+
219
+ debug( until_prompt('password:') )
220
+ login
221
+ become_root
222
+
223
+ #Because the main Web Filter is treated as a profile, this
224
+ #will operate on all Web Filters and proxy profiles.
225
+ results= search_profiles( extract_profiles( get('http') ) )
226
+
227
+ print_results( results )
228
+
229
+ stdin.printf( "exit\n" )
230
+ until_prompt( ":/home/login >" )
231
+ stdin.printf( "exit\n" )
232
+
233
+ $out=old_out
234
+ $in=old_in
235
+ }
236
+ log 'Done'
237
+ end
metadata ADDED
@@ -0,0 +1,53 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: utm-plc
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Jeff Welling
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-05-21 00:00:00.000000000 Z
13
+ dependencies: []
14
+ description: This tool logs in to your UTM and interacts with 'cc' to check the configuration
15
+ of every web filter configuration in use and list the ones that are not configured
16
+ to log accessed and blocked pages.
17
+ email:
18
+ - jeff.welling@gmail.com
19
+ executables:
20
+ - plc
21
+ extensions: []
22
+ extra_rdoc_files: []
23
+ files:
24
+ - bin/plc
25
+ - bin/plc.rb
26
+ - lib/utm-plc.rb
27
+ - LICENSE
28
+ - README.mkd
29
+ homepage: https://github.com/jeffWelling/UTM_plc
30
+ licenses: []
31
+ post_install_message:
32
+ rdoc_options: []
33
+ require_paths:
34
+ - lib
35
+ required_ruby_version: !ruby/object:Gem::Requirement
36
+ none: false
37
+ requirements:
38
+ - - ! '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ required_rubygems_version: !ruby/object:Gem::Requirement
42
+ none: false
43
+ requirements:
44
+ - - ! '>='
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
47
+ requirements: []
48
+ rubyforge_project:
49
+ rubygems_version: 1.8.23
50
+ signing_key:
51
+ specification_version: 3
52
+ summary: Tool to check if your UTM's Web Filter is logging
53
+ test_files: []