diff --git a/LICENSE b/LICENSE
index 8cdb845..30ace6a 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,281 +1,622 @@
GNU GENERAL PUBLIC LICENSE
- Version 2, June 1991
+ Version 3, 29 June 2007
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.) You can apply it to
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
- GNU GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+ TERMS AND CONDITIONS
- 0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term "modification".) Each licensee is addressed as "you".
+ 0. Definitions.
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
+ "This License" refers to version 3 of the GNU General Public License.
- 1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
- 2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
- c) If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such
- interactive use in the most ordinary way, to print or display an
- announcement including an appropriate copyright notice and a
- notice that there is no warranty (or else, saying that you provide
- a warranty) and that users may redistribute the program under
- these conditions, and telling the user how to view a copy of this
- License. (Exception: if the Program itself is interactive but
- does not normally print such an announcement, your work based on
- the Program is not required to print an announcement.)
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
+ 1. Source Code.
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
- 3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
- b) Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your
- cost of physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
- c) Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is
- allowed only for noncommercial distribution and only if you
- received the program in object code or executable form with such
- an offer, in accord with Subsection b above.)
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
+ The Corresponding Source for a work in source code form is that
+same work.
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
+ 2. Basic Permissions.
- 4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
- 5. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
- 6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
this License.
- 7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
+ 13. Use with the GNU Affero General Public License.
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
+ 14. Revised Versions of this License.
- 8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
- 9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
- 10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
- NO WARRANTY
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
+ 15. Disclaimer of Warranty.
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
@@ -287,15 +628,15 @@ free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
+state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
- {description}
- Copyright (C) {year} {fullname}
+ {one line to give the program's name and a brief idea of what it does.}
+ Copyright (C) {year} {name of author}
- This program is free software; you can redistribute it and/or modify
+ This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
@@ -303,38 +644,31 @@ the "copyright" line and a pointer to where the full notice is found.
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
- Gnomovision version 69, Copyright (C) year name of author
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ {project} Copyright (C) {year} {fullname}
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
- {signature of Ty Coon}, 1 April 1989
- Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
\ No newline at end of file
diff --git a/README.md b/README.md
index a2ab5ea..92b56c5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# ssh_controls
-SSH Controls is a light-weight SSH public key distribution & management framework
+# SSH Controls
+SSH Controls is a light-weight SSH **public key** distribution & management framework
+
+* uses a **desired state** model: SSH Controls pushes public keys from a key master server onto client host and applies them according to the central configuration.
+
+* uses **SSH** as **transport** mechanism: eat your own dogfood. SSH Controls connects to client hosts through the secure path of SSH and using a public key that is under its own control.
+
+* **shields** public keys from owners/users on client systems: SSH Controls requires the standard sshd_config to be reconfigured with an alternate path for the AuthorizedKeysFile setting so that public keys are stored in common location which cannot be manipulated by the owners of the public keys. This allows for more administrative control and better security.
+
+* performs operations with **least privileges**: copy/distribute operations are performed with a low-privileged account. Only the actual key updates requires super-user privileges which need to be configured via SUDO.
+
+* uses a **two-stage** approach to **activate** public keys: copy (or distribute) and apply. Keys are first copied into a temporary location on each client hosts - the holding directory - and not applied automatically. Applying or activating keys on a client host is a separate operation which can be triggered either locally or remotely (from the SSH master)
+
+* can assign a single public key to **multiple** OS accounts: SSH Controls allows an user to log on under multiple accounts using the same key. Auditing of the connecting user and the target account is possible using fingerprinting.
+
+* allows the use of (nested) **groups** in the master configuration: users, keys and hosts can be grouped in the SSH master configuration files to allow a simplified configuration. Nesting of groups is allowed up to one level deep.
+
+* allows compromised public keys to be **blacklisted**: SSH Controls will deny the use of public keys that have been administrative blacklisted. Blacklisting happens on the SSH master and is applied to all client hosts.
+
+* requires **no client agent** component and is **stateless**: SSH Controls performs operations by pushing keys or commands to client hosts. Update processes on the client hosts will only be started on-demand. If the SSH master is - for whatever reason - unavailable then active keys on a client host remain in place and logons are still possible.
+
+* is **easy** to **configure** and **maintain** (command-line based): the configuration is stored in a limited number of flat files and be easily updated. A very rudimentary syntax checking facility is also available to check the consistency of the most important (master) configuration files.
+
+
+SSH Controls does NOT:
+
+* manage or distribute SSH **private keys**: SSH private keys should be controlled and managed (and safeguarded!) by the actual owners. Though one could consider SSH key pairs of generic accounts (such as application accounts) as an exception, SSH Controls currently does not support the management of private keys.
+
+* discover SSH **host keys**: SSH Controls will silently ignore any questions related to host keys discoveries upon the first connection to client hosts. If you are managing a large number of client hosts, you may want to prepare a known_hosts file in advance or else let the host keys be added automatically upon first public key distribution.
diff --git a/convert_pubkey.pl b/convert_pubkey.pl
new file mode 100644
index 0000000..3f1285f
--- /dev/null
+++ b/convert_pubkey.pl
@@ -0,0 +1,201 @@
+#!/bin/env perl
+#******************************************************************************
+# @(#) convert_pubkey.pl
+#******************************************************************************
+# @(#) Copyright (C) 2014 by KUDOS BVBA . All rights reserved.
+#
+# This program is a free software; you can redistribute it and/or modify
+# it under the same terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details
+#******************************************************************************
+
+#******************************************************************************
+# PRAGMAs/LIBs
+#******************************************************************************
+
+use strict;
+use Getopt::Long;
+use Pod::Usage;
+
+
+#******************************************************************************
+# DATA structures
+#******************************************************************************
+
+# ------------------------- CONFIGURATION starts here -------------------------
+# define the V.R.F (version/release/fix)
+my $MY_VRF = "1.0.0";
+# always assume RSA keys!
+my $key_algo = 'ssh-rsa';
+# ------------------------- CONFIGURATION ends here ---------------------------
+# initialize variables
+my (%options, @key_file);
+my ($key_file, $key_label, $key_line, $key_type);
+$|++;
+
+
+#******************************************************************************
+# MAIN routine
+#******************************************************************************
+
+
+# -----------------------------------------------------------------------------
+# process script arguments & options
+# -----------------------------------------------------------------------------
+
+unless (@ARGV > 0) { pod2usage(-verbose => 0) };
+
+Getopt::Long::Configure ('prefix_pattern=(--|-|\/)', 'bundling', 'no_ignore_case');
+GetOptions (\%options,
+ qw(
+ file|f=s
+ help|h|?
+ label|l=s
+ version|V
+ ));
+pod2usage(-verbose => 0) unless (%options);
+
+# check version parameter
+if ($options{'version'}) {
+ print "INFO: $0: version $MY_VRF";
+ exit (0);
+}
+# check help parameter
+if ($options{'help'}) {
+ pod2usage(-verbose => 3);
+ exit (0);
+};
+# check file parameter
+if ($options{'file'}) {
+ $key_file = $options{'file'};
+ unless (-f $key_file) {
+ die "ERROR: input file $key_file not found [$!]";
+ }
+} else {
+ die "ERROR: missing value for --file parameter";
+}
+# check label parameter
+if ($options{'label'}) {
+ $key_label = $options{'label'};
+ if (not (defined ($key_label) or $key_label eq "")) {
+ die "ERROR: key label not defined";
+ }
+} else {
+ die "ERROR: missing value for --label parameter";
+}
+
+# -----------------------------------------------------------------------------
+# read key file contents & process key
+# -----------------------------------------------------------------------------
+
+open (KEY_FILE, $key_file) or die "ERROR: unable to read file";
+chomp (@key_file = );
+close (KEY_FILE);
+
+# determine type of key
+if (grep { /$key_algo/ } @key_file) {
+ $key_type = 1;
+} else {
+ $key_type = 2;
+}
+
+# process key
+SWITCH: {
+ $key_type == 1 && do {
+ # 1 line only!!
+ foreach (@key_file) {
+ chomp;
+ ($key_algo, $key_line) = split (/ /);
+ };
+ last SWITCH;
+ };
+ $key_type == 2 && do {
+ foreach (@key_file) {
+ chomp;
+ # skip BEGIN/END lines
+ next if (/^----/);
+ # skip Comment field
+ next if (/^Comment/);
+ $key_line .= $_;
+ }
+ last SWITCH;
+ };
+}
+
+# mangle space in label
+$key_label =~ tr/ /_/s;
+
+# print result
+print "$key_label,$key_algo,$key_line\n";
+
+exit (0);
+
+#******************************************************************************
+# End of SCRIPT
+#******************************************************************************
+
+#******************************************************************************
+# POD
+#******************************************************************************
+
+# -----------------------------------------------------------------------------
+
+=head1 NAME
+
+convert_pubkey.pl - converts public keys for SSH controls format (SSH-RSA)
+
+=head1 SYNOPSIS
+
+ update_ssh.pl -f|--file= -l|--label=
+ [-h|--help]
+ [-V|--version]
+
+
+=head1 DESCRIPTION
+
+B converts public keys generated by PuTTYgen or ssh-keygen into the
+correct format for the SSH controls key store.
+
+
+=head1 OPTIONS
+
+=over 2
+
+=item -h | --help
+
+S< >Show the help page.
+
+=item -f | --file
+
+S< >File containing the public key to be converted.
+
+=item -l | --label
+
+S< >Name for the public key in SSH control. This name will be used as identifier of the key in the different SSH controls configuration files.
+
+=item -V | --version
+
+S< >Show version of the script.
+
+=back
+
+=head1 NOTES
+
+=over 2
+
+=item * Options may be preceded by a - (dash), -- (double dash) or a / (slash).
+
+=back
+
+=head1 AUTHOR
+
+(c) KUDOS BVBA, Patrick Van der Veken
+
+=head1 HISTORY
+
+@(#) 2014-12-20: VRF 1.0.0: first version [Patrick Van der Veken]
\ No newline at end of file
diff --git a/manage_ssh.sh b/manage_ssh.sh
new file mode 100644
index 0000000..caa4f79
--- /dev/null
+++ b/manage_ssh.sh
@@ -0,0 +1,1254 @@
+#!/bin/env ksh
+#******************************************************************************
+# @(#) manage_ssh.sh
+#******************************************************************************
+# @(#) Copyright (C) 2014 by KUDOS BVBA . All rights reserved.
+#
+# This program is a free software; you can redistribute it and/or modify
+# it under the same terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details
+#******************************************************************************
+#
+# DOCUMENTATION (MAIN)
+# -----------------------------------------------------------------------------
+# @(#) MAIN: manage_ssh.sh
+# DOES: performs basic functions for SSH controls: update SSH keys locally or
+# remote, create SSH key fingerprints or distribute the SSH controls files
+# EXPECTS: (see --help for more options)
+# REQUIRES: check_config(), check_logging(), check_params(), check_setup(),
+# check_syntax(), count_fields(), die(), display_usage(),
+# distribute2host(), do_cleanup(), fix2host(), get_linux_version(),
+# log(), resolve_host(), sftp_file(), update2host(),
+# update_fingerprints(), warn()
+# For other pre-requisites see the documentation in display_usage()
+#
+# @(#) HISTORY:
+# @(#) 2014-12-16: initial version (VRF 1.0.0) [Patrick Van der Veken]
+# @(#) 2014-12-20: updated SELinux contexts (VRF 1.0.1) [Patrick Van der Veken]
+# @(#) 2015-01-05: added backup feature, see --backup (VRF 1.1.0) [Patrick Van der Veken]
+# @(#) 2015-01-19: updated display_usage() (VRF 1.1.1) [Patrick Van der Veken]
+# @(#) 2015-02-03: use 'sudo -n' (VRF 1.1.2) [Patrick Van der Veken]
+# @(#) 2015-04-10: fix in --fix-local routine (VRF 1.1.3) [Patrick Van der Veken]
+# @(#) 2015-05-16: added SSH_OWNER_GROUP (VRF 1.1.4) [Patrick Van der Veken]
+# -----------------------------------------------------------------------------
+# DO NOT CHANGE THIS FILE UNLESS YOU KNOW WHAT YOU ARE DOING!
+#******************************************************************************
+
+#******************************************************************************
+# DATA structures
+#******************************************************************************
+
+# ------------------------- CONFIGURATION starts here -------------------------
+# define the V.R.F (version/release/fix)
+MY_VRF="1.1.4"
+# name of the user account performing the SSH controls copies
+# (leave blank for current user)
+SSH_TRANSFER_USER=""
+# name of the OS group that should own the SSH controls files
+SSH_OWNER_GROUP="sshadmin"
+# extra arguments/options for the SFTP command
+SFTP_ARGS="-o StrictHostKeyChecking=no -o ConnectTimeout=10 -b - "
+# extra arguments/options for the SSH command
+SSH_ARGS="-o StrictHostKeyChecking=no -o ConnectTimeout=10 -n"
+# location of the local SSH controls directory
+LOCAL_DIR="/etc/ssh_master"
+# location of the remote SSH controls directory
+REMOTE_DIR="/etc/ssh_controls/holding"
+# name of the user account performing the SSH controls update
+# (leave blank for current user but user should have remote sudo root privs)
+SSH_UPDATE_USER=""
+# options to pass to manage_ssh.sh when executing a key update
+SSH_UPDATE_OPTS="--verbose --remove"
+# maximum number of background process to spawn (~maxuprc, ~nstrpty etc)
+MAX_BACKGROUND_PROCS=30
+# location of the backup directory (for configuration & key files)
+BACKUP_DIR="${LOCAL_DIR}/backup"
+# location of log directory (default), see --log-dir)
+LOG_DIR="/var/log"
+# location of temporary working storage
+TMP_DIR="/var/tmp"
+# ------------------------- CONFIGURATION ends here ---------------------------
+# miscelleaneous
+PATH=${PATH}:/usr/bin:/usr/local/bin
+SCRIPT_NAME=$(basename $0)
+SCRIPT_DIR=$(dirname $0)
+OS_NAME="$(uname)"
+KEYS_FILE=""
+KEYS_DIR=""
+TARGETS_FILE=""
+FIX_CREATE=0
+KEY_COUNT=0
+KEY_1024_COUNT=0
+KEY_2048_COUNT=0
+KEY_4096_COUNT=0
+KEY_OTHER_COUNT=0
+TMP_FILE="${TMP_DIR}/.${SCRIPT_NAME}.$$"
+# command-line parameters
+ARG_ACTION=0 # default is nothing
+ARG_FIX_DIR="" # location of SSH controls directory
+ARG_LOG_DIR="" # location of the log directory (~root etc)
+ARG_LOCAL_DIR="" # location of the local SSH control files
+ARG_REMOTE_DIR="" # location of the remote SSH control files
+ARG_TARGETS="" # list of remote targets
+ARG_LOG=1 # logging is on by default
+ARG_VERBOSE=1 # STDOUT is on by default
+ARG_DEBUG=0 # debug is off by default
+
+
+#******************************************************************************
+# FUNCTION routines
+#******************************************************************************
+
+# -----------------------------------------------------------------------------
+function check_config
+{
+# SSH_TRANSFER_USER
+if [[ -z "${SSH_TRANSFER_USER}" ]]
+then
+ SSH_TRANSFER_USER="${LOGNAME}"
+ if [[ -z "${SSH_TRANSFER_USER}" ]]
+ then
+ print -u2 "ERROR: unable to set a value for SSH_TRANSFER_USER in $0"
+ exit 1
+ fi
+fi
+# LOCAL_DIR
+if [[ -z "${LOCAL_DIR}" ]]
+then
+ print -u2 "ERROR: you must define a value for the LOCAL_DIR setting in $0"
+ exit 1
+fi
+# REMOTE_DIR
+if [[ -z "${REMOTE_DIR}" ]]
+then
+ print -u2 "ERROR: you must define a value for the REMOTE_DIR setting in $0"
+ exit 1
+fi
+# SSH_UPDATE_USER
+if [[ -z "${SSH_UPDATE_USER}" ]]
+then
+ SSH_UPDATE_USER="${LOGNAME}"
+ if [[ -z "${SSH_UPDATE_USER}" ]]
+ then
+ print -u2 "ERROR: unable to set a value for SSH_UPDATE_USER in $0"
+ exit 1
+ fi
+fi
+# MAX_BACKGROUND_PROCS
+if [[ -z "${MAX_BACKGROUND_PROCS}" ]]
+then
+ print -u2 "ERROR: you must define a value for the MAX_BACKGROUND_PROCS setting in $0"
+ exit 1
+fi
+# BACKUP_DIR
+if [[ -z "${BACKUP_DIR}" ]]
+then
+ print -u2 "ERROR: you must define a value for the BACKUP_DIR setting in $0"
+ exit 1
+fi
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function check_logging
+{
+if (( ARG_LOG ))
+then
+ if [[ ! -d "${LOG_DIR}" ]]
+ then
+ if [[ ! -w "${LOG_DIR}" ]]
+ then
+ # switch off logging intelligently when needed for permission problems
+ # since this script may run with root/non-root actions
+ print -u2 "ERROR: unable to write to the log directory at ${LOG_DIR}, disabling logging"
+ ARG_LOG=0
+ fi
+ else
+ if [[ ! -w "${LOG_FILE}" ]]
+ then
+ # switch off logging intelligently when needed for permission problems
+ # since this script may run with root/non-root actions
+ print -u2 "ERROR: unable to write to the log file at ${LOG_FILE}, disabling logging"
+ ARG_LOG=0
+ fi
+ fi
+fi
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function check_params
+{
+# -- ALL
+if (( ARG_ACTION < 1 || ARG_ACTION > 9 ))
+then
+ display_usage
+ exit 0
+fi
+# --fix-local + --fix-dir
+if (( ARG_ACTION == 5 ))
+then
+ if [[ -z "${ARG_FIX_DIR}" ]]
+ then
+ print -u2 "ERROR: you must specify a value for parameter '--fix-dir"
+ exit 1
+ else
+ FIX_DIR="${ARG_FIX_DIR}"
+ fi
+fi
+# --local-dir
+if [[ -n "${ARG_LOCAL_DIR}" ]]
+then
+ if [ \( ! -d "${ARG_LOCAL_DIR}" \) -o \( ! -r "${ARG_LOCAL_DIR}" \) ]
+ then
+ print -u2 "ERROR: unable to read directory ${ARG_LOCAL_DIR}"
+ exit 1
+ else
+ LOCAL_DIR="${ARG_LOCAL_DIR}"
+ fi
+fi
+# --log-dir
+[[ -z "${ARG_LOG_DIR}" ]] || LOG_DIR="${ARG_LOG_DIR}"
+LOG_FILE="${LOG_DIR}/${SCRIPT_NAME}.log"
+# --remote-dir
+if (( ARG_ACTION == 1 || ARG_ACTION == 2 ))
+then
+ if [[ -n "${ARG_REMOTE_DIR}" ]]
+ then
+ REMOTE_DIR="${ARG_REMOTE_DIR}"
+ fi
+fi
+# --targets
+if [[ -n "${ARG_TARGETS}" ]]
+then
+ > ${TMP_FILE}
+ # write comma-separated target list to the temporary file
+ print "${ARG_TARGETS}" | tr -s ',' '\n' | while read TARGET_HOST
+ do
+ print ${TARGET_HOST} >>${TMP_FILE}
+ done
+fi
+# --update + --fix-local
+if (( ARG_ACTION == 4 || ARG_ACTION == 5 ))
+then
+ if [[ -n "${TARGETS}" ]]
+ then
+ print -u2 "ERROR: you cannot specify '--targets' in this context!"
+ exit 1
+ fi
+fi
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function check_root_user
+{
+(IFS='()'; set -- $(id); print $2) | read UID
+if [[ "${UID}" = "root" ]]
+then
+ return 0
+else
+ return 1
+fi
+}
+
+# -----------------------------------------------------------------------------
+function check_setup
+{
+# use added fall back for LOCAL_DIR (the default script directory)
+[[ -d "${LOCAL_DIR}" ]] || LOCAL_DIR="${SCRIPT_DIR}"
+
+# check for basic SSH control files: access/alias
+for FILE in "${LOCAL_DIR}/access" "${LOCAL_DIR}/alias"
+do
+ if [[ ! -r "${FILE}" ]]
+ then
+ print -u2 "ERROR: cannot read file ${FILE}"
+ exit 1
+ fi
+done
+# check for basic SSH control file(s): targets, /var/tmp/targets.$USER (or $TMP_FILE)
+if (( ARG_ACTION == 1 || ARG_ACTION == 2 || ARG_ACTION == 6 ))
+then
+ if [[ -z "${ARG_TARGETS}" ]]
+ then
+ TARGETS_FILE="${LOCAL_DIR}/targets"
+ if [ \( ! -r "${TARGETS_FILE}" \) -a \( ! -r "/var/tmp/targets.${USER}" \) ]
+ then
+ print -u2 "ERROR: cannot read file ${TARGETS_FILE} nor /var/tmp/targets.${USER}"
+ exit 1
+ fi
+ # override default targets file
+ [[ -r "/var/tmp/targets.${USER}" ]] && TARGETS_FILE="/var/tmp/targets.${USER}"
+ else
+ TARGETS_FILE=${TMP_FILE}
+ fi
+fi
+# check for basic SSH control file(s): keys, keys.d/*
+if [[ -d "${LOCAL_DIR}/keys.d" && -f "${LOCAL_DIR}/keys" ]]
+then
+ print -u2 "WARN: found both a 'keys' file (${LOCAL_DIR}/keys) and a 'keys.d' directory (${LOCAL_DIR}/keys.d). Ignoring the 'keys' file"
+fi
+if [[ -d "${LOCAL_DIR}/keys.d" ]]
+then
+ KEYS_DIR="${LOCAL_DIR}/keys.d"
+ if [[ ! -r "${KEYS_DIR}" ]]
+ then
+ print -u2 "ERROR: unable to read directory ${KEYS_DIR}"
+ exit 1
+ fi
+elif [[ -f "${LOCAL_DIR}/keys" ]]
+then
+ KEYS_FILE="${LOCAL_DIR}/keys"
+ if [[ ! -r "${KEYS_FILE}" ]]
+ then
+ print -u2 "ERROR: cannot read file ${KEYS_FILE}"
+ exit 1
+ fi
+else
+ print -u2 "ERROR: could not found any public keys in ${LOCAL_DIR}!"
+ exit 1
+fi
+# check for SSH control scripts & configurations (not .local)
+if (( ARG_ACTION == 1 || ARG_ACTION == 2 || ARG_ACTION == 4 ))
+then
+ for FILE in "${LOCAL_DIR}/update_ssh.pl" \
+ "${LOCAL_DIR}/update_ssh.conf" \
+ "${SCRIPT_DIR}/${SCRIPT_NAME}"
+ do
+ if [[ ! -r "${FILE}" ]]
+ then
+ print -u2 "ERROR: cannot read file ${FILE}"
+ exit 1
+ fi
+ done
+fi
+
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function check_syntax
+{
+# access should have 3 fields
+cat "${LOCAL_DIR}/access" | grep -v -E -e '^#|^$' | while read ACCESS_LINE
+do
+ ACCESS_FIELDS=$(count_fields "${ACCESS_LINE}" ":")
+ (( ACCESS_FIELDS != 3 )) && \die "line '${ACCESS_LINE}' in access file has missing or too many field(s) (should be 3)"
+done
+
+# alias should have 2 fields
+cat "${LOCAL_DIR}/alias" | grep -v -E -e '^#|^$' | while read ALIAS_LINE
+do
+ ALIAS_FIELDS=$(count_fields "${ALIAS_LINE}" ":")
+ (( ALIAS_FIELDS != 2 )) && die "line '${ALIAS_LINE}' in alias file has missing or too many field(s) (should be 2)"
+done
+
+# key files should have 3 fields
+ls -1 ${LOCAL_DIR}/keys.d/* ${LOCAL_DIR}/keys 2>/dev/null | while read KEY_FILE
+do
+ cat ${KEY_FILE} 2>/dev/null | grep -v -E -e '^#|^$' |\
+ while read KEY_LINE
+ do
+ KEY_FIELDS=$(count_fields "${KEY_LINE}" ",")
+ (( KEY_FIELDS != 3 )) && die "line '${KEY_LINE}' in a keys file has missing or too many field(s) (should be 3)"
+ done
+done
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function count_fields
+{
+CHECK_LINE="$1"
+CHECK_DELIM="$2"
+
+NUM_FIELDS=$(print "${CHECK_LINE}" | awk -F "${CHECK_DELIM}" '{ print NF }')
+
+print $NUM_FIELDS
+
+return ${NUM_FIELDS}
+}
+
+# -----------------------------------------------------------------------------
+function die
+{
+NOW="$(date '+%d-%h-%Y %H:%M:%S')"
+
+if [[ -n "$1" ]]
+then
+ if (( ARG_LOG ))
+ then
+ print - "$*" | while read LOG_LINE
+ do
+ # filter leading 'ERROR:'
+ LOG_LINE="${LOG_LINE#ERROR: *}"
+ print "${NOW}: ERROR: [$$]:" "${LOG_LINE}" >>${LOG_FILE}
+ done
+ fi
+ print - "$*" | while read LOG_LINE
+ do
+ # filter leading 'ERROR:'
+ LOG_LINE="${LOG_LINE#ERROR: *}"
+ print -u2 "ERROR:" "${LOG_LINE}"
+ done
+fi
+
+# finish up work
+do_cleanup
+
+exit 1
+}
+
+# -----------------------------------------------------------------------------
+function display_usage
+{
+cat << EOT
+
+**** ${SCRIPT_NAME} ****
+**** (c) KUDOS BVBA - Patrick Van der Veken ****
+
+Performs basic functions for SSH controls: update SSH keys locally or
+remote, create SSH key fingerprints or copy/distribute the SSH controls files
+
+Syntax: ${SCRIPT_DIR}/${SCRIPT_NAME} [--help] | (--backup | --check-syntax | --preview-global | --make-finger | --update ) |
+ (--apply [--remote-dir=] [--targets=,,...]) |
+ ((--copy|--distribute) [--remote-dir= [--targets=,,...]]) |
+ ([--fix-local --fix-dir= [--create-dir]] | [--fix-remote [--create-dir] [--targets=,,...]])
+ [--local-dir=] [--no-log] [--log-dir=] [--debug]
+
+Parameters:
+
+--apply|-a : apply SSH controls remotely (~targets)
+--backup|-b : create a backup of the SSH controls repository (SSH master)
+--create-dir : also create missing directories when fixing the SSH controls
+ repository (see also --fix-local/--fix-remote)
+--check-syntax|-s : do basic syntax checking on SSH controls configuration
+ (access, alias & keys files)
+--copy|-c : copy SSH control files to remote host (~targets)
+--debug : print extra status messages on STDERR
+--distribute|-d : same as --copy
+--fix-dir : location of the local SSH controls client repository
+--fix-local : fix permissions on the local SSH controls repository
+ (local SSH controls repository given by --fix-dir)
+--fix-remote : fix permissions on the remote SSH controls repository
+--help|-h : this help text
+--local-dir : location of the SSH control files on the local filesystem.
+ [default: ${LOCAL_DIR}]
+--log-dir : specify a log directory location.
+--no-log : do not log any messages to the script log file.
+--make-finger|-m : create (local) key fingerprints file
+--preview-global|-p : dump the global access namespace (after alias resolution)
+--remote-dir : directory where SSH control files are/should be
+ located/copied on/to the target host
+ [default: ${REMOTE_DIR}]
+--targets : comma-separated list of target hosts to operate on. Override the
+ hosts contained in the 'targets' configuration file.
+--update|-u : apply SSH controls locally
+
+--version|-V : show the script version/release/fix
+
+Note 1: distribute and update actions are run in parallel across a maximum of
+ ${MAX_BACKGROUND_PROCS} clients at the same time.
+
+Note 2: for fix and update actions: make sure correct 'sudo' rules are setup
+ on the target systems to allow the SSH controls script to run with
+ elevated privileges.
+
+EOT
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+# distribute SSH controls to a single host/client
+function distribute2host
+{
+SERVER="$1"
+
+# convert line to hostname
+SERVER=${SERVER%%;*}
+resolve_host ${SERVER}
+if (( $? ))
+then
+ warn "could not lookup host ${SERVER}, skipping"
+ return 1
+fi
+
+# specify copy objects as 'filename!permissions'
+# 1) config files & scripts
+for FILE in "${LOCAL_DIR}/access!660" \
+ "${LOCAL_DIR}/alias!660" \
+ "${LOCAL_DIR}/update_ssh.pl!770" \
+ "${LOCAL_DIR}/update_ssh.conf!660" \
+ "${SCRIPT_DIR}/${SCRIPT_NAME}!770"
+do
+ # sftp transfer
+ sftp_file ${FILE} ${SERVER}
+ COPY_RC=$?
+ if (( ! COPY_RC ))
+ then
+ log "transferred ${FILE%!*} to ${SERVER}:${REMOTE_DIR}"
+ else
+ warn "failed to transfer ${FILE%!*} to ${SERVER}:${REMOTE_DIR} [RC=${COPY_RC}]"
+ fi
+done
+# 2) keys files
+# are keys stored a file or a directory?
+if [[ -n "${KEYS_DIR}" ]]
+then
+ # merge keys file(s) before copy (in a temporary location)
+ TMP_WORK_DIR="${TMP_DIR}/$0.${RANDOM}"
+ mkdir -p ${TMP_WORK_DIR}
+ if (( $? ))
+ then
+ die "unable to create temporary directory ${TMP_WORK_DIR} for mangling of 'keys' file"
+ fi
+ TMP_MERGE_FILE="${TMP_WORK_DIR}/keys"
+ log "keys are stored in a DIRECTORY, first merging all keys into ${TMP_MERGE_FILE}"
+ cat ${KEYS_DIR}/* >${TMP_MERGE_FILE}
+ # sftp transfer
+ sftp_file "${TMP_MERGE_FILE}!440" ${SERVER}
+ COPY_RC=$?
+ if (( ! COPY_RC ))
+ then
+ log "transferred ${TMP_MERGE_FILE} to ${SERVER}:${REMOTE_DIR}"
+ else
+ warn "failed to transfer ${TMP_MERGE_FILE%!*} to ${SERVER}:${REMOTE_DIR} [RC=${COPY_RC}]"
+ fi
+ [[ -d ${TMP_WORK_DIR} ]] && rm -rf ${TMP_WORK_DIR} 2>/dev/null
+else
+ sftp_file "${KEYS_FILE}!440" ${SERVER}
+ COPY_RC=$?
+ if (( ! COPY_RC ))
+ then
+ log "transferred ${KEYS_FILE} to ${SERVER}:${REMOTE_DIR}"
+ else
+ warn "failed to transfer ${KEYS_FILE} to ${SERVER}:${REMOTE_DIR} [RC=${COPY_RC}]"
+ fi
+fi
+# discover a keys blacklist file, also copy it across if we find one
+# never use a keys blacklist file from the local config though
+[[ -r ${LOCAL_DIR}/keyupdate.conf ]] && \
+ BLACKLIST_FILE="$(grep -E -e '^blacklist_file' ${LOCAL_DIR}/update_ssh.conf 2>/dev/null | cut -f2 -d'=')"
+if [[ -n "${BLACKLIST_FILE}" ]]
+then
+ if [[ -r "${BLACKLIST_FILE}" ]]
+ then
+ log "keys blacklist file found at ${BLACKLIST_FILE}"
+ # sftp transfer
+ sftp_file "${BLACKLIST_FILE}!660" ${SERVER}
+ COPY_RC=$?
+ if (( ! COPY_RC ))
+ then
+ log "transferred ${BLACKLIST_FILE} to ${SERVER}:${REMOTE_DIR}"
+ else
+ warn "failed to transfer ${BLACKLIST_FILE%!*} to ${SERVER}:${REMOTE_DIR} [RC=${COPY_RC}]"
+ fi
+ fi
+fi
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function do_cleanup
+{
+log "performing cleanup ..."
+
+# remove temporary file
+[[ -f ${TMP_FILE} ]] && rm -f ${TMP_FILE} >/dev/null 2>&1
+[[ -f ${TMP_MERGE_FILE} ]] && rm -f ${TMP_MERGE_FILE} >/dev/null 2>&1
+
+log "*** finish of ${SCRIPT_NAME} [${CMD_LINE}] ***"
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+# fix SSH controls on a single host/client (permissions/ownerships)
+# !! requires appropriate 'sudo' rules on remote client for privilege elevation
+function fix2host
+{
+SERVER="$1"
+SERVER_DIR="$2"
+
+# convert line to hostname
+SERVER=${SERVER%%;*}
+resolve_host ${SERVER}
+if (( $? ))
+then
+ warn "could not lookup host ${SERVER}, skipping"
+ return 1
+fi
+
+log "fixing ssh controls on ${SERVER} ..."
+if [[ -z "${SSH_UPDATE_USER}" ]]
+then
+ # own user w/ sudo
+ log "$(ssh ${SSH_ARGS} ${SERVER} sudo -n ${REMOTE_DIR}/${SCRIPT_NAME} --fix-local --fix-dir=${SERVER_DIR})"
+elif [[ "${SSH_UPDATE_USER}" != "root" ]]
+then
+ # other user w/ sudo
+ log "$(ssh ${SSH_ARGS} ${SSH_UPDATE_USER}@${SERVER} sudo -n ${REMOTE_DIR}/${SCRIPT_NAME} --fix-local --fix-dir=${SERVER_DIR})"
+else
+ # root user w/o sudo
+ log "$(ssh ${SSH_ARGS} ${SSH_UPDATE_USER}@${SERVER} ${REMOTE_DIR}/${SCRIPT_NAME} --fix-local --fix-dir=${SERVER_DIR})"
+fi
+# no error checking possible here due to log(), done in called script
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+function get_linux_version
+{
+LSB_VERSION=$(lsb_release -rs 2>/dev/null | cut -f1 -d'.')
+
+if [[ -z "${LSB_VERSION}" ]]
+then
+ RELEASE_STRING=$(/bin/grep -i 'release' /etc/redhat-release 2>/dev/null)
+
+ case "${RELEASE_STRING}" in
+ *release\ 5*)
+ RHEL_VERSION=5
+ ;;
+ *release\ 6*)
+ RHEL_VERSION=6
+ ;;
+ *release\ 7*)
+ RHEL_VERSION=7
+ ;;
+ *)
+ RHEL_VERSION=""
+ ;;
+ esac
+ print "${RHEL_VERSION}"
+else
+ print "${LSB_VERSION}"
+fi
+}
+
+# -----------------------------------------------------------------------------
+function log
+{
+NOW="$(date '+%d-%h-%Y %H:%M:%S')"
+
+if [[ -n "$1" ]]
+then
+ if (( ARG_LOG ))
+ then
+ print - "$*" | while read LOG_LINE
+ do
+ # filter leading 'INFO:'
+ LOG_LINE="${LOG_LINE#INFO: *}"
+ print "${NOW}: INFO: [$$]:" "${LOG_LINE}" >>${LOG_FILE}
+ done
+ fi
+ if (( ARG_VERBOSE ))
+ then
+ print - "$*" | while read LOG_LINE
+ do
+ # filter leading 'INFO:'
+ LOG_LINE="${LOG_LINE#INFO: *}"
+ print "INFO:" "${LOG_LINE}"
+ done
+ fi
+fi
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+# resolve a host (check)
+function resolve_host
+{
+LOOKUP_HOST="$1"
+
+nslookup $1 2>/dev/null | grep -q -E -e 'Address:.*([0-9]{1,3}[\.]){3}[0-9]{1,3}'
+
+return $?
+}
+
+# -----------------------------------------------------------------------------
+# transfer a file using sftp
+function sftp_file
+{
+TRANSFER_FILE="$1"
+TRANSFER_HOST="$2"
+
+# find the local directory & permission bits
+TRANSFER_DIR="${TRANSFER_FILE%/*}"
+TRANSFER_PERMS="${TRANSFER_FILE##*!}"
+# cut out the permission bits and the directory path
+TRANSFER_FILE="${TRANSFER_FILE%!*}"
+SOURCE_FILE="${TRANSFER_FILE##*/}"
+OLD_PWD=$(pwd) && cd ${TRANSFER_DIR}
+
+# transfer, chmod the file to/on the target server (keep STDERR)
+# chmod is not possible in the used security model as files should be
+# owned by root, so must be disabled. This requires a fix operation right
+# after the very first initial SSH controls distribution:
+# ./manage_ssh.sh --fix-local --fix-dir=/etc/ssh_controls
+sftp ${SFTP_ARGS} ${SSH_TRANSFER_USER}@${TRANSFER_HOST} >/dev/null < ${TMP_FILE}
+# check if fingerprint is valid
+FINGERPRINT="$(ssh-keygen -l -f ${TMP_FILE} 2>&1)"
+FINGER_RC=$?
+if (( ! FINGER_RC ))
+then
+ FINGER_ENTRY="$(print ${FINGERPRINT} | awk '{print $1,$2,$4}')"
+ log "${FINGER_USER}->${FINGER_ENTRY}"
+ print "${FINGER_USER} ${FINGER_ENTRY}" >> "${LOCAL_DIR}/fingerprints"
+else
+ die "failed to obtain fingerprint for key ${FINGER_LINE} [RC=${FINGER_RC}]"
+fi
+# check bit count
+case "${FINGERPRINT}" in
+ 1024*)
+ KEY_1024_COUNT=$(( KEY_1024_COUNT + 1 ))
+ ;;
+ 2048*)
+ KEY_2048_COUNT=$(( KEY_2048_COUNT + 1 ))
+ ;;
+ 4096*)
+ KEY_4096_COUNT=$(( KEY_4096_COUNT + 1 ))
+ ;;
+ *)
+ KEY_OTHER_COUNT=$(( KEY_OTHER_COUNT + 1 ))
+ ;;
+esac
+
+return 0
+}
+
+# -----------------------------------------------------------------------------
+# wait for child processes to exit
+function wait_for_children
+{
+WAIT_ERRORS=0
+
+# 'endless' loop :-)
+while :
+do
+ (( ARG_DEBUG )) && print -u2 "child processes remaining: $*"
+ for PID in "$@"
+ do
+ shift
+ # child is still alive?
+ if $(kill -0 ${PID} 2>/dev/null)
+ then
+ (( ARG_DEBUG )) && print -u2 "DEBUG: ${PID} is still alive"
+ set -- "$@" "${PID}"
+ # wait for sigchild, catching child exit codes is unreliable because
+ # the child might have already ended before we get here (caveat emptor)
+ elif $(wait ${PID})
+ then
+ log "child process ${PID} exited"
+ else
+ log "child process ${PID} exited"
+ WAIT_ERRORS=$(( WAIT_ERRORS + 1 ))
+ fi
+ done
+ # break loop if we no child PIDs left
+ (($# > 0)) || break
+ sleep 1 # required to avoid race conditions
+done
+
+return ${WAIT_ERRORS}
+}
+
+# -----------------------------------------------------------------------------
+function warn
+{
+NOW="$(date '+%d-%h-%Y %H:%M:%S')"
+
+if [[ -n "$1" ]]
+then
+ if (( ARG_LOG ))
+ then
+ print - "$*" | while read LOG_LINE
+ do
+ # filter leading 'WARN:'
+ LOG_LINE="${LOG_LINE#WARN: *}"
+ print "${NOW}: WARN: [$$]:" "${LOG_LINE}" >>${LOG_FILE}
+ done
+ fi
+ if (( ARG_VERBOSE ))
+ then
+ print - "$*" | while read LOG_LINE
+ do
+ # filter leading 'WARN:'
+ LOG_LINE="${LOG_LINE#WARN: *}"
+ print "WARN:" "${LOG_LINE}"
+ done
+ fi
+fi
+
+return 0
+}
+
+
+#******************************************************************************
+# MAIN routine
+#******************************************************************************
+
+# parse arguments/parameters
+CMD_LINE="$@"
+for PARAMETER in ${CMD_LINE}
+do
+ case ${PARAMETER} in
+ -a|-apply|--apply)
+ ARG_ACTION=1
+ ;;
+ -b|-backup|--backup)
+ ARG_ACTION=9
+ ;;
+ -c|-copy|--copy)
+ ARG_ACTION=2
+ ;;
+ -debug|--debug)
+ ARG_DEBUG=1
+ ;;
+ -d|-distribute|--distribute)
+ ARG_ACTION=2
+ ;;
+ -p|--preview-global|-preview-global)
+ ARG_ACTION=7
+ ;;
+ -s|--check-syntax|-check-syntax)
+ ARG_ACTION=8
+ ;;
+ -fix-local|--fix-local)
+ ARG_ACTION=5
+ ;;
+ -fix-remote|--fix-remote)
+ ARG_ACTION=6
+ ;;
+ -m|-make-finger|--make-finger)
+ ARG_ACTION=3
+ ;;
+ -u|-update|--update)
+ ARG_ACTION=4
+ ;;
+ -create-dir|--create-dir)
+ FIX_CREATE=1
+ ;;
+ -fix-dir=*)
+ ARG_FIX_DIR="${PARAMETER#-fix-dir=}"
+ ;;
+ --fix-dir=*)
+ ARG_FIX_DIR="${PARAMETER#--fix-dir=}"
+ ;;
+ -local-dir=*)
+ ARG_LOCAL_DIR="${PARAMETER#-local-dir=}"
+ ;;
+ --local-dir=*)
+ ARG_LOCAL_DIR="${PARAMETER#--local-dir=}"
+ ;;
+ -log-dir=*)
+ ARG_LOG_DIR="${PARAMETER#-log-dir=}"
+ ;;
+ --log-dir=*)
+ ARG_LOG_DIR="${PARAMETER#--log-dir=}"
+ ;;
+ -no-log|--no-log)
+ ARG_LOG=0
+ ;;
+ -remote-dir=*)
+ ARG_REMOTE_DIR="${PARAMETER#-remote-dir=}"
+ ;;
+ --remote-dir=*)
+ ARG_REMOTE_DIR="${PARAMETER#--remote-dir=}"
+ ;;
+ -targets=*)
+ ARG_TARGETS="${PARAMETER#-targets=}"
+ ;;
+ --targets=*)
+ ARG_TARGETS="${PARAMETER#--targets=}"
+ ;;
+ -V|-version|--version)
+ print "INFO: $0: ${MY_VRF}"
+ exit 0
+ ;;
+ \? | -h | -help | --help)
+ display_usage
+ exit 0
+ ;;
+ esac
+done
+
+# startup checks
+check_params && check_config && check_setup && check_logging
+
+# catch shell signals
+trap 'do_cleanup; exit' 1 2 3 15
+
+log "*** start of ${SCRIPT_NAME} [${CMD_LINE}] ***"
+(( ARG_LOG )) && log "logging takes places in ${LOG_FILE}"
+
+log "runtime info: LOCAL_DIR is set to: ${LOCAL_DIR}"
+
+case ${ARG_ACTION} in
+ 1) # apply SSH controls remotely
+ log "ACTION: apply SSH controls remotely"
+ check_root_user && die "must NOT be run as user 'root'"
+ # build clients list (in array)
+ cat "${TARGETS_FILE}" | grep -v -E -e '^#' -e '^$' |\
+ {
+ I=0
+ set -A CLIENTS
+ while read LINE
+ do
+ CLIENTS[${I}]="${LINE}"
+ I=$(( I + 1 ))
+ done
+ }
+ # set max updates in background
+ COUNT=${MAX_BACKGROUND_PROCS}
+ for CLIENT in ${CLIENTS[@]}
+ do
+ update2host ${CLIENT} &
+ PID=$!
+ log "updating ${CLIENT} in background [PID=${PID}] ..."
+ # add PID to list of all child PIDs
+ PIDS="${PIDS} ${PID}"
+ COUNT=$(( COUNT - 1 ))
+ if (( COUNT <= 0 ))
+ then
+ # wait until all background processes are completed
+ wait_for_children ${PIDS} || \
+ warn "$? background jobs failed to complete correctly"
+ PIDS=''
+ # reset max updates in background
+ COUNT=${MAX_BACKGROUND_PROCS}
+ fi
+ done
+ # final wait for background processes to be finished completely
+ wait_for_children ${PIDS} || \
+ warn "$? background jobs failed to complete correctly"
+
+ log "finished applying SSH controls remotely"
+ ;;
+ 2) # copy/distribute SSH controls
+ log "ACTION: copy/distribute SSH controls"
+ check_root_user && die "must NOT be run as user 'root'"
+ # build clients list (in array)
+ cat "${TARGETS_FILE}" | grep -v -E -e '^#' -e '^$' |\
+ {
+ I=0
+ set -A CLIENTS
+ while read LINE
+ do
+ CLIENTS[${I}]="${LINE}"
+ I=$(( I + 1 ))
+ done
+ }
+ # set max updates in background
+ COUNT=${MAX_BACKGROUND_PROCS}
+ for CLIENT in ${CLIENTS[@]}
+ do
+ distribute2host ${CLIENT} &
+ PID=$!
+ log "copying/distributing to ${CLIENT} in background [PID=${PID}] ..."
+ # add PID to list of all child PIDs
+ PIDS="${PIDS} ${PID}"
+ COUNT=$(( COUNT - 1 ))
+ if (( COUNT <= 0 ))
+ then
+ # wait until all background processes are completed
+ wait_for_children ${PIDS} || \
+ warn "$? background jobs failed to complete correctly"
+ PIDS=''
+ # reset max updates in background
+ COUNT=${MAX_BACKGROUND_PROCS}
+ fi
+ done
+ # final wait for background processes to be finished completely
+ wait_for_children ${PIDS} || \
+ warn "$? background jobs failed to complete correctly"
+ log "finished copying/distributing SSH controls"
+ ;;
+ 3) # create key fingerprints
+ check_root_user && die "must NOT be run as user 'root'"
+ log "ACTION: create key fingerprints into ${LOCAL_DIR}/fingerprints"
+ > "${LOCAL_DIR}/fingerprints"
+
+ # are keys stored in a file or a directory?
+ if [[ -n "${KEYS_DIR}" ]]
+ then
+ cat ${KEYS_DIR}/* | sort | while read LINE
+ do
+ update_fingerprints "${LINE}"
+ KEY_COUNT=$(( KEY_COUNT + 1 ))
+ done
+ else
+ while read LINE
+ do
+ update_fingerprints "${LINE}"
+ done < ${KEYS_FILE}
+ fi
+ log "${KEY_COUNT} public keys discovered with following bits distribution:"
+ log " 1024 bits: ${KEY_1024_COUNT}"
+ log " 2048 bits: ${KEY_2048_COUNT}"
+ log " 4096 bits: ${KEY_4096_COUNT}"
+ log " others : ${KEY_OTHER_COUNT}"
+ log "finished updating public key fingerprints"
+ ;;
+ 4) # apply SSH controls locally (root user)
+ log "ACTION: apply SSH controls locally"
+ log "$(sudo -n ${LOCAL_DIR}/update_ssh.pl ${SSH_UPDATE_OPTS})"
+ # no error checking possible here due to log(), done in called script
+ log "finished applying SSH controls locally"
+ ;;
+ 5) # fix local directory structure/perms/ownerships
+ log "ACTION: fix local SSH controls repository"
+ check_root_user || die "must be run as user 'root'"
+ if (( FIX_CREATE ))
+ then
+ log "you requested to create directories (if needed)"
+ else
+ log "you requested NOT to create directories (if needed)"
+ fi
+
+ # check if the SSH control repo is already there
+ if [[ ${FIX_CREATE} = 1 && ! -d "${FIX_DIR}" ]]
+ then
+ # create stub directories
+ mkdir -p "${FIX_DIR}/holding" 2>/dev/null || \
+ warn "failed to create directory ${FIX_DIR}/holding"
+ mkdir -p "${FIX_DIR}/keys.d" 2>/dev/null || \
+ warn "failed to create directory ${FIX_DIR}/keys.d"
+ fi
+ # fix permissions & ownerships
+ if [[ -d "${FIX_DIR}" ]]
+ then
+ # updating default directories
+ chmod 755 "${FIX_DIR}" 2>/dev/null && \
+ chown root:sys "${FIX_DIR}" 2>/dev/null
+ if [[ -d "${FIX_DIR}/holding" ]]
+ then
+ chmod 2775 "${FIX_DIR}/holding" 2>/dev/null && \
+ chown root:${SSH_OWNER_GROUP} "${FIX_DIR}/holding" 2>/dev/null
+ fi
+ if [[ -d "${FIX_DIR}/keys.d" ]]
+ then
+ chmod 755 "${FIX_DIR}/keys.d" 2>/dev/null && \
+ chown root:sys "${FIX_DIR}/keys.d" 2>/dev/null
+ fi
+ # checking files in holding (keys.d/* are fixed by update_ssh.pl)
+ for FILE in access alias keys update_ssh.conf
+ do
+ if [[ -f "${FIX_DIR}/holding/${FILE}" ]]
+ then
+ chmod 660 "${FIX_DIR}/holding/${FILE}" 2>/dev/null && \
+ chown root:${SSH_OWNER_GROUP} "${FIX_DIR}/holding/${FILE}" 2>/dev/null
+ fi
+ done
+ for FILE in manage_ssh.sh update_ssh.pl
+ do
+ if [[ -f "${FIX_DIR}/holding/${FILE}" ]]
+ then
+ chmod 770 "${FIX_DIR}/holding/${FILE}" 2>/dev/null && \
+ chown root:${SSH_OWNER_GROUP} "${FIX_DIR}/holding/${FILE}" 2>/dev/null
+ fi
+ done
+ # log file
+ if [[ -f "${LOG_FILE}" ]]
+ then
+ chmod 664 "${LOG_FILE}" 2>/dev/null && \
+ chown root:${SSH_OWNER_GROUP} "${LOG_FILE}" 2>/dev/null
+ fi
+ # check for SELinux labels
+ case ${OS_NAME} in
+ *Linux*)
+ case "$(getenforce)" in
+ *Permissive*|*Enforcing*)
+ LINUX_VERSION=$(get_linux_version)
+ case "${LINUX_VERSION}" in
+ 5)
+ chcon -R -t sshd_key_t "${FIX_DIR}/keys.d"
+ ;;
+ 6|7)
+ chcon -R -t ssh_home_t "${FIX_DIR}/keys.d"
+ ;;
+ *)
+ chcon -R -t etc_t "${FIX_DIR}/keys.d"
+ ;;
+ esac
+ ;;
+ *Disabled*)
+ :
+ ;;
+ esac
+ ;;
+ *)
+ :
+ ;;
+ esac
+ else
+ die "SSH controls repository at "${FIX_DIR}" does not exist?"
+ fi
+ log "finished applying fixes to the local SSH control repository"
+ ;;
+ 6) # fix remote directory structure/perms/ownerships
+ log "ACTION: fix remote SSH controls repository"
+ check_root_user && die "must NOT be run as user 'root'"
+ # derive SSH controls repo from $REMOTE_DIR:
+ # /etc/ssh_controls/holding -> /etc/ssh_controls
+ FIX_DIR="$(print ${REMOTE_DIR%/*})"
+ [[ -z "${FIX_DIR}" ]] && \
+ die "could not determine SSH controls repo path from \$REMOTE_DIR?"
+ # build clients list (in array)
+ cat "${TARGETS_FILE}" | grep -v -E -e '^#' -e '^$' |\
+ {
+ I=0
+ set -A CLIENTS
+ while read LINE
+ do
+ CLIENTS[${I}]="${LINE}"
+ I=$(( I + 1 ))
+ done
+ }
+ # set max updates in background
+ COUNT=${MAX_BACKGROUND_PROCS}
+ for CLIENT in ${CLIENTS[@]}
+ do
+ fix2host ${CLIENT} "${FIX_DIR}" &
+ PID=$!
+ log "copying/distributing to ${CLIENT} in background [PID=${PID}] ..."
+ # add PID to list of all child PIDs
+ PIDS="${PIDS} ${PID}"
+ COUNT=$(( COUNT - 1 ))
+ if (( COUNT <= 0 ))
+ then
+ # wait until all background processes are completed
+ wait_for_children ${PIDS} || \
+ warn "$? background jobs failed to complete correctly"
+ PIDS=''
+ # reset max updates in background
+ COUNT=${MAX_BACKGROUND_PROCS}
+ fi
+ done
+ # final wait for background processes to be finished completely
+ wait_for_children ${PIDS} || \
+ warn "$? background jobs failed to complete correctly"
+ log "finished applying fixes to the remote SSH control repository"
+ ;;
+ 7) # dump the configuration namespace
+ log "ACTION: dumping the global access namespace with resolved aliases ..."
+ ${LOCAL_DIR}/update_ssh.pl --preview --global
+ log "finished dumping the global namespace"
+ ;;
+ 8) # check syntax of the access/alias/keys files
+ log "ACTION: syntax-checking the configuration files ..."
+ check_syntax
+ log "finished syntax-checking the configuration files"
+ ;;
+ 9) # make backup copy of configuration & keys files
+ log "ACTION: backing up the current configuration & keys files ..."
+ if [[ -d ${BACKUP_DIR} ]]
+ then
+ TIMESTAMP="$(date '+%Y%m%d-%H%M')"
+ BACKUP_TAR_FILE="${BACKUP_DIR}/backup_repo_${TIMESTAMP}.tar"
+ if [ \( -f ${BACKUP_TAR_FILE} \) -o \( -f "${BACKUP_TAR_FILE}.gz" \) ]
+ then
+ die "backup file ${BACKUP_TAR_FILE}(.gz) already exists"
+ fi
+ # keys files
+ if [[ -n "${KEYS_DIR}" ]]
+ then
+ log "$(tar -cvf ${BACKUP_TAR_FILE} ${KEYS_DIR} 2>/dev/null)"
+ else
+ log "$(tar -cvf ${BACKUP_TAR_FILE} ${KEYS_FILE} 2>/dev/null)"
+ fi
+ # configuration files
+ for FILE in "${LOCAL_DIR}/access" "${LOCAL_DIR}/alias ${LOCAL_DIR}/targets"
+ do
+ log "$(tar -rvf ${BACKUP_TAR_FILE} ${FILE} 2>/dev/null)"
+ done
+ log "$(gzip ${BACKUP_TAR_FILE} 2>/dev/null)"
+ log "resulting backup file is: $(ls -1 ${BACKUP_TAR_FILE}* 2>/dev/null)"
+ else
+ die "could not find backup directory ${BACKUP_DIR}. Host is not an SSH master?"
+ fi
+ log "finished backing up the current configuration & keys files"
+ ;;
+esac
+
+# finish up work
+do_cleanup
+
+#******************************************************************************
+# END of script
+#******************************************************************************
diff --git a/update_ssh.conf b/update_ssh.conf
new file mode 100644
index 0000000..85e2c9b
--- /dev/null
+++ b/update_ssh.conf
@@ -0,0 +1,20 @@
+#******************************************************************************
+# update_ssh.pl configuration file
+#******************************************************************************
+#
+# Lines starting with '#' (hash) are comment lines
+#
+# Format: option=
+#
+# Do not use double or single quotes around the option values
+#
+
+# target directory for allowed SSH key files
+access_dir=/etc/ssh_controls/keys.d
+
+# location of the keys blacklist file
+blacklist_file=/etc/ssh_controls/keys.blacklisted
+
+#******************************************************************************
+# End of FILE
+#******************************************************************************
\ No newline at end of file
diff --git a/update_ssh.pl b/update_ssh.pl
new file mode 100644
index 0000000..1ec64e2
--- /dev/null
+++ b/update_ssh.pl
@@ -0,0 +1,763 @@
+#!/bin/env perl
+#******************************************************************************
+# @(#) update_ssh.pl
+#******************************************************************************
+# @(#) Copyright (C) 2014 by KUDOS BVBA . All rights reserved.
+#
+# This program is a free software; you can redistribute it and/or modify
+# it under the same terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details
+#******************************************************************************
+# This script distributes SSH keys to the appropriate files into the designated
+# repository based on the 'access', 'alias' and 'keys' configuration files.
+# Superfluous usage of 'hostname' reporting in log messages is encouraged to
+# make reading of multiplexed output from update_ssh.pl through backgrounded
+# jobs via manage_ssh.sh much easier.
+#
+# @(#) HISTORY: see perldoc 'update_ssh.pl'
+# -----------------------------------------------------------------------------
+# DO NOT CHANGE THIS FILE UNLESS YOU KNOW WHAT YOU ARE DOING!
+#******************************************************************************
+
+#******************************************************************************
+# PRAGMAs/LIBs
+#******************************************************************************
+
+use strict;
+use Data::Dumper;
+use Getopt::Long;
+use Pod::Usage;
+
+
+#******************************************************************************
+# DATA structures
+#******************************************************************************
+
+# ------------------------- CONFIGURATION starts here -------------------------
+# define the V.R.F (version/release/fix)
+my $MY_VRF = "1.0.1";
+# name of global configuration file (no path, must be located in the script directory)
+my $global_config_file = "update_ssh.conf";
+# name of localized configuration file (no path, must be located in the script directory)
+my $local_config_file = "update_ssh.conf.local";
+# selinux context labels of key files for different RHEL version
+my %selinux_contexts = ( '5' => 'sshd_key_t',
+ '6' => 'ssh_home_t',
+ '7' => 'ssh_home_t');
+# ------------------------- CONFIGURATION ends here ---------------------------
+# initialize variables
+my ($debug, $verbose, $preview, $remove, $global) = (0,0,0,0,0);
+my (@config_files, @zombie_files, $access_dir, $blacklist_file);
+my (%options, @accounts, %aliases, %keys, %access, @blacklist);
+my ($os, $host, $hostname, $run_dir);
+my ($selinux_status, $selinux_context, $linux_version, $has_selinux) = ("","","",0);
+$|++;
+
+
+#******************************************************************************
+# SUBroutines
+#******************************************************************************
+
+# -----------------------------------------------------------------------------
+sub do_log {
+
+ my $message = shift;
+
+ if ($message =~ /^ERROR:/ || $message =~ /^WARN:/) {
+ print STDERR "$message\n";
+ } elsif ($message =~ /^DEBUG:/) {
+ print STDOUT "$message\n" if ($debug);
+ } else {
+ print STDOUT "$message\n" if ($verbose);
+ }
+
+ return (1);
+}
+
+# -----------------------------------------------------------------------------
+sub parse_config_file {
+
+ my $config_file = shift;
+
+ unless (open (CONF_FD, "<", $config_file)) {
+ do_log ("ERROR: failed to open the configuration file ${config_file} [$! $hostname]")
+ and exit (1);
+ }
+ while () {
+ chomp ();
+ # parse settings
+ if (/^\s*$/ || /^#/) {
+ next;
+ } else {
+ if (/^\s*access_dir\s*=\s*([0-9A-Za-z_\-\.\/~]+)\s*$/) {
+ $access_dir = $1;
+ do_log ("DEBUG: picking up setting: access_dir=${access_dir}");
+ }
+ if (/^\s*blacklist_file\s*=\s*([0-9A-Za-z_\-\.\/~]+)\s*$/) {
+ $blacklist_file = $1;
+ # support tilde (~) expansion for ~root
+ $blacklist_file =~ s{ ^ ~ ( [^/]* ) }
+ { $1
+ ? (getpwnam($1))[7]
+ : ( $ENV{HOME} || $ENV{LOGDIR}
+ || (getpwuid($>))[7]
+ )
+ }ex;
+ do_log ("DEBUG: picking up setting: blacklist_file=${blacklist_file}");
+ }
+ }
+ }
+
+ return (1);
+}
+
+# -----------------------------------------------------------------------------
+sub resolve_aliases
+{
+ my $input = shift;
+ my (@tmp_array, @new_array, $entry);
+
+ @tmp_array = split (/,/, $input);
+ foreach $entry (@tmp_array) {
+ if ($entry =~ /^\@/) {
+ ($aliases{$entry})
+ ? push (@new_array, @{$aliases{$entry}})
+ : do_log ("WARN: unable to resolve alias $entry [$hostname]");
+ } else {
+ ($entry)
+ ? push (@new_array, $entry)
+ : do_log ("WARN: unable to resolve alias $entry [$hostname]");
+ }
+ }
+ return (@new_array);
+}
+
+# -----------------------------------------------------------------------------
+sub set_file {
+
+ my ($file, $perm, $uid, $gid) = @_;
+
+ chmod ($perm, "$file")
+ or do_log ("ERROR: cannot set permissions on $file [$! $hostname]")
+ and exit (1);
+ chown ($uid, $gid, "$file")
+ or do_log ("ERROR: cannot set ownerships on $file [$! $hostname]")
+ and exit (1);
+
+ return (1);
+}
+
+
+#******************************************************************************
+# MAIN routine
+#******************************************************************************
+
+# -----------------------------------------------------------------------------
+# process script arguments & options
+# -----------------------------------------------------------------------------
+
+if ( @ARGV > 0 ) {
+ Getopt::Long::Configure ('prefix_pattern=(--|-|\/)', 'bundling', 'no_ignore_case');
+ GetOptions (\%options,
+ qw(
+ debug|d
+ help|h|?
+ global|g
+ preview|p
+ remove|r
+ verbose|v
+ version|V
+ )) || pod2usage(-verbose => 0);
+}
+pod2usage(-verbose => 0) unless (%options);
+
+# check version parameter
+if ($options{'version'}) {
+ $verbose = 1;
+ do_log ("INFO: $0: version $MY_VRF");
+ exit (0);
+}
+# check help parameter
+if ($options{'help'}) {
+ pod2usage(-verbose => 3);
+ exit (0);
+};
+# check global parameter
+if ($options{'global'}) {
+ $global = 1;
+}
+# check preview parameter
+if ($options{'preview'}) {
+ $preview = 1;
+ $verbose = 1;
+ if ($global) {
+ do_log ("INFO: running in GLOBAL PREVIEW mode");
+ } else {
+ do_log ("INFO: running in PREVIEW mode");
+ }
+} else {
+ do_log ("INFO: running in UPDATE mode");
+}
+# check remove parameter
+if ($options{'remove'}) {
+ $remove = 1 unless ($preview);
+}
+# debug & verbose
+if ($options{'debug'}) {
+ $debug = 1;
+ $verbose = 1;
+}
+$verbose = 1 if ($options{'verbose'});
+
+# what am I?
+$os = `uname`;
+chomp ($os);
+# who am I?
+unless ($preview and $global) {
+ if ($< != 0) {
+ do_log ("ERROR: script must be invoked as user 'root' [$hostname]")
+ and exit (1);
+ }
+}
+# where am I?
+$host = `hostname`;
+chomp ($host);
+if ($host =~ /\./) {
+ ($hostname) = $host =~ /(.*?)\./;
+} else {
+ $hostname = $host;
+}
+$0 =~ /^(.+[\\\/])[^\\\/]+[\\\/]*$/;
+my $run_dir = $1 || ".";
+$run_dir =~ s#/$##; # remove trailing slash
+
+do_log ("INFO: runtime info: ".getpwuid ($<)."; $hostname\@${run_dir}; Perl v$]");
+
+# -----------------------------------------------------------------------------
+# check/process configuration files, environment checks
+# -----------------------------------------------------------------------------
+
+# don't do anything without configuration file(s)
+do_log ("INFO: parsing configuration file(s) ...");
+push (@config_files, "$run_dir/$global_config_file") if (-f "$run_dir/$global_config_file");
+push (@config_files, "$run_dir/$local_config_file") if (-f "$run_dir/$local_config_file");
+unless (@config_files) {
+ do_log ("ERROR: unable to find any configuration file, bailing out [$hostname]")
+ and exit (1);
+}
+
+# process configuration file: global first, local may override
+foreach my $config_file (@config_files) {
+ parse_config_file ($config_file);
+}
+
+# is the target directory for keys present? (not for global preview)
+unless ($preview and $global) {
+ do_log ("INFO: checking for SSH control mode ...");
+ if (-d $access_dir) {
+ do_log ("INFO: host is under SSH control via $access_dir");
+ } else {
+ do_log ("ERROR: host is not under SSH keys only control [$hostname]")
+ and exit (1);
+ }
+}
+
+# do we have a blacklist file? (optional) (not for global preview)
+unless ($preview and $global) {
+ do_log ("INFO: checking for keys blacklist file ...");
+ if (-f $blacklist_file) {
+ open (BLACKLIST, "<", $blacklist_file) or \
+ do_log ("ERROR: cannot read keys blacklist file [$! $hostname]")
+ and exit (1);
+ @blacklist = ;
+ close (BLACKLIST);
+ do_log ("INFO: keys blacklist file found with ".scalar (@blacklist)." entr(y|ies) on $hostname");
+ print Dumper (\@blacklist) if $debug;
+ } else {
+ do_log ("WARN: no keys blacklist file found [$hostname]");
+ }
+}
+
+# -----------------------------------------------------------------------------
+# collect local user accounts from /etc/passwd
+# result: %accounts
+# -----------------------------------------------------------------------------
+
+do_log ("INFO: reading user accounts from /etc/passwd ...");
+
+open (PASSWD, "/etc/passwd")
+ or do_log ("ERROR: cannot read PASSWD file [$! $hostname]") and exit (1);
+while () {
+
+ my @pw_entry;
+
+ chomp ();
+ @pw_entry = split (/:/);
+ push (@accounts, $pw_entry[0]);
+}
+close (PASSWD);
+
+do_log ("INFO: ".scalar (@accounts)." user accounts found on $hostname");
+print Dumper (\@accounts) if $debug;
+
+# -----------------------------------------------------------------------------
+# read aliases for teams, servers and users
+# result: %aliases
+# -----------------------------------------------------------------------------
+
+do_log ("INFO: reading 'alias' file ...");
+
+open (ALIASES, "<", "${run_dir}/alias")
+ or do_log ("ERROR: cannot read 'alias' file [$! $hostname]") and exit (1);
+while () {
+
+ my ($key, $value, @values);
+
+ chomp ();
+ next if (/^$/ || /\#/);
+ s/\s+//g;
+ ($key, $value) = split (/:/);
+ next unless ($value);
+ @values = sort (split (/\,/, $value));
+ $aliases{$key} = [@values];
+};
+close (ALIASES);
+do_log ("DEBUG: dumping unexpanded aliases:");
+print Dumper (\%aliases) if $debug;
+
+# we can nest aliases one level deep, so do a one-level recursive sort of lookup
+# of the remaining '@' aliases. Input should be passed as comma-separated
+# string to resolve_aliases so don't forget to smash everything back together
+# first.
+foreach my $key (keys (%aliases)) {
+
+ $aliases{$key} = [resolve_aliases (join (",", @{$aliases{$key}}))];
+}
+
+do_log ("INFO: ".scalar (keys (%aliases))." aliases found on $hostname");
+do_log ("DEBUG: dumping expanded aliases:");
+print Dumper (\%aliases) if $debug;
+
+# -----------------------------------------------------------------------------
+# read SSH keys (incl. the blacklisted keys), supports keys stored in a single
+# 'keys.d' file or in individual key files in a 'keys' directory
+# result: %keys
+# -----------------------------------------------------------------------------
+
+do_log ("INFO: reading 'keys' file(s) ...");
+
+my @key_files;
+
+# check if the SSH keys are stored in a directory or file
+if (-d "${run_dir}/keys.d" && -f "${run_dir}/keys") {
+ do_log ("WARN: found both a 'keys' file and 'keys.d' directory. Ignoring the 'keys' file [$hostname]");
+}
+if (-d "${run_dir}/keys.d") {
+ do_log ("INFO: local 'keys' are stored in a DIRECTORY on $hostname");
+ opendir (KEYS_DIR, "${run_dir}/keys.d")
+ or do_log ("ERROR: cannot open 'keys.d' directory [$! $hostname]")
+ and exit (1);
+ while (my $key_file = readdir (KEYS_DIR)) {
+ next if ($key_file =~ /^\./);
+ push (@key_files, "${run_dir}/keys.d/$key_file");
+ }
+ closedir (KEYS_DIR);
+} elsif (-f "${run_dir}/keys") {
+ do_log ("INFO: local 'keys' are stored in a FILE on $hostname");
+ push (@key_files, "${run_dir}/keys");
+} else {
+ do_log ("ERROR: cannot find any public keys in the repository! [$hostname]")
+ and exit (1);
+}
+
+# process 'keys' files
+foreach my $key_file (@key_files) {
+ open (KEYS, "<", $key_file)
+ or do_log ("ERROR: cannot read 'keys' file [$! $hostname]") and exit (1);
+ do_log ("INFO: reading public keys from file: $key_file");
+ while () {
+
+ my ($user, $keytype, $key);
+
+ chomp ();
+ next if (/^$/ || /\#/);
+
+ # check for blacklisting
+ my $key_line = $_;
+ if (grep (/\Q${key_line}\E/, @blacklist)) {
+ do_log ("WARN: *BLACKLIST*: key match found for '$key_line', ignoring key! [$hostname]");
+ next;
+ }
+ # process key
+ s/\s+//g;
+ ($user, $keytype, $key) = split (/,/);
+ next unless ($key);
+ $keys{$user}{"keytype"} = $keytype;
+ $keys{$user}{"key"} = $key;
+ };
+ close (KEYS);
+}
+
+do_log ("INFO: ".scalar (keys (%keys))." public key(s) found on $hostname");
+print Dumper(\%keys) if $debug;
+
+# -----------------------------------------------------------------------------
+# read access definitions
+# result: %access (hash of arrays). The keys are the accounts for which
+# access control has been defined for this server. The values are an array
+# with all the people who can access the account.
+# -----------------------------------------------------------------------------
+
+do_log ("INFO: reading 'access' file ...");
+
+open (ACCESS, "<", "${run_dir}/access")
+ or do_log ("ERROR: cannot read 'access' file [$! $hostname]") and exit (1);
+while () {
+
+ my ($who, $where, $what, @who, @where, @what);
+
+ chomp ();
+ next if (/^$/ || /\#/);
+ s/\s+//g;
+ ($who, $where, $what) = split (/:/);
+ next unless ($what);
+ @who = resolve_aliases ($who);
+ @where = resolve_aliases ($where);
+ @what = resolve_aliases ($what);
+ unless (@who and @where and @what) {
+ do_log ("WARN: ignoring line $. in 'access' due to missing/non-resolving values [$hostname]");
+ next;
+ }
+
+ foreach my $account (sort (@what)) {
+
+ my @new_array;
+
+ foreach my $server (sort (@where)) {
+ foreach my $person (sort (@who)) {
+ do_log ("DEBUG: adding access for $account to $person on $server in \%access")
+ if ($server eq $hostname);
+ # add person to access list if the entry is for this host
+ push (@new_array, $person) if ($server eq $hostname);
+ }
+ }
+ # add to full access list of persons for this host
+ push (@{$access{$account}}, @new_array) if (@new_array);
+ }
+};
+close (ACCESS);
+
+# remove duplicates in 'persons' in %access{$account}
+foreach my $account (keys (%access)) {
+ @{$access{$account}} = keys (%{{ map { $_ => 1 } @{$access{$account}}}});
+}
+
+do_log ("INFO: ".scalar (keys (%access))." accounts with applicable access rules found on $hostname");
+print Dumper(\%access) if $debug;
+
+# -----------------------------------------------------------------------------
+# global preview, show full configuration data only
+# -----------------------------------------------------------------------------
+
+if ($preview && $global) {
+
+ do_log ("INFO: display GLOBAL configuration ....");
+
+ open (ACCESS, "<", "${run_dir}/access")
+ or do_log ("ERROR: cannot read 'access' file [$! $hostname]") and exit (1);
+ while () {
+
+ my ($who, $where, $what, @who, @where, @what);
+
+ chomp ();
+ next if (/^$/ || /\#/);
+ s/\s+//g;
+ ($who, $where, $what) = split (/:/);
+ next unless ($what);
+ @who = resolve_aliases ($who);
+ @where = resolve_aliases ($where);
+ @what = resolve_aliases ($what);
+ unless (@who and @where and @what) {
+ do_log ("WARN: ignoring line $. in 'access' due to missing/non-resolving values [$hostname]");
+ next;
+ }
+
+ foreach my $account (sort (@what)) {
+
+ my @new_array;
+
+ foreach my $server (sort (@where)) {
+ foreach my $person (sort (@who)) {
+ do_log ("$person|$server|$account")
+ }
+ }
+ }
+ };
+ close (ACCESS);
+
+ exit (0);
+}
+
+# -----------------------------------------------------------------------------
+# distribute keys into authorized_keys files in $access_dir
+# -----------------------------------------------------------------------------
+
+do_log ("INFO: applying SSH access rules ....");
+
+# check for SELinux & contexts
+unless ($preview) {
+ SWITCH_OS: {
+ $os eq "Linux" && do {
+ # figure out selinux mode
+ $selinux_status = qx#/usr/sbin/getenforce 2>/dev/null#;
+ chomp ($selinux_status);
+ if ($selinux_status eq "Permissive" or $selinux_status eq "Enforcing") {
+ do_log ("INFO: runtime info: detected active SELinux system on $hostname");
+ $has_selinux = 1;
+ }
+ # figure out RHEL version (via lsb_release or /etc/redhat-release)
+ $linux_version = qx#/usr/bin/lsb_release -rs 2>/dev/null | /bin/cut -f1 -d'.'#;
+ chomp ($linux_version);
+ if (not (defined ($linux_version)) or $linux_version eq "") {
+ my $release_string;
+ $release_string = qx#/bin/grep -i "release" /etc/redhat-release 2>/dev/null#;
+ chomp ($release_string);
+ SWITCH_RELEASE: {
+ $release_string =~ m/release 5/i && do {
+ $linux_version = 5;
+ last SWITCH_RELEASE;
+ };
+ $release_string =~ m/release 6/i && do {
+ $linux_version = 6;
+ last SWITCH_RELEASE;
+ };
+ $release_string =~ m/release 7/i && do {
+ $linux_version = 7;
+ last SWITCH_RELEASE;
+ };
+ }
+ }
+ # use fall back in case we cannot determine the version
+ if (not (defined ($linux_version)) or $linux_version eq "") {
+ $selinux_context = 'etc_t';
+ $linux_version = 'unknown';
+ } else {
+ $selinux_context = $selinux_contexts{$linux_version};
+ }
+ do_log ("INFO: runtime info: OS major version $linux_version, SELinux context $selinux_context on $hostname");
+ last SWITCH_OS;
+ };
+ }
+}
+
+# only add authorized_keys for existing local accounts,
+# otherwise revoke access if needed
+foreach my $account (sort (@accounts)) {
+
+ my $access_file = "$access_dir/$account";
+
+ # only add authorised_keys if there are access definitions
+ if ($access{$account}) {
+
+ unless ($preview) {
+ open (KEYFILE, "+>", $access_file)
+ or do_log ("ERROR: cannot open file for writing in $access_dir [$! $hostname]")
+ and exit (1);
+ }
+ foreach my $person (sort (@{$access{$account}})) {
+ my $real_name = $person;
+ $real_name =~ s/([a-z])([A-Z])/$1 $2/g;
+ # only add authorized_keys if $person actually has a key
+ if (exists ($keys{$person})) {
+ # only add authorized_keys if $person actually has an account
+ print KEYFILE "$keys{$person}{keytype} $keys{$person}{key} $real_name\n"
+ unless $preview;
+ do_log ("INFO: granting access to $account for $real_name on $hostname");
+ } else {
+ do_log ("INFO: denying access (no key) to $account for $real_name on $hostname");
+ }
+ }
+ close (KEYFILE) unless $preview;
+
+ # set permissions to world readable and check for SELinux context
+ unless ($preview) {
+ set_file ($access_file, 0644, 0, 0);
+ # selinux labels
+ SWITCH: {
+ $os eq "Linux" && do {
+ if ($has_selinux) {
+ system ("/usr/bin/chcon -t $selinux_context $access_file") and
+ do_log ("WARN: failed to set SELinux context $selinux_context on $access_file [$hostname]");
+ };
+ last SWITCH;
+ }
+ }
+ }
+ } else {
+ # remove obsolete access file if needed (revoking access)
+ if (-f $access_file) {
+ unless ($preview) {
+ unlink ($access_file)
+ or do_log ("ERROR: cannot remove obsolete access file(s) [$! $hostname]")
+ and exit (1);
+ } else {
+ do_log ("INFO: removing obsolete access $access_file on $hostname");
+ }
+ }
+ }
+}
+
+# -----------------------------------------------------------------------------
+# alert on/remove extraneous authorized_keys files
+# (access files for which no longer a valid UNIX account exists)
+# -----------------------------------------------------------------------------
+
+do_log ("INFO: checking for extraneous access files ....");
+
+opendir (ACCESS_DIR, $access_dir)
+ or do_log ("ERROR: cannot open directory $access_dir [$! $hostname]")
+ and exit (1);
+while (my $access_file = readdir (ACCESS_DIR)) {
+ next if ($access_file =~ /^\./);
+ unless (grep (/$access_file/, @accounts)) {
+ do_log ("WARN: found extraneous access file in $access_dir/$access_file [$hostname]");
+ push (@zombie_files, "$access_dir/$access_file");
+ }
+}
+closedir (ACCESS_DIR);
+do_log ("INFO: ".scalar (@zombie_files)." extraneous access file(s) found on $hostname");
+print Dumper (\@zombie_files) if $debug;
+
+# remove if requested and needed
+if ($remove && @zombie_files) {
+ my $count = unlink (@zombie_files)
+ or do_log ("ERROR: cannot remove extraneous access file(s) [$! $hostname]")
+ and exit (1);
+ do_log ("INFO: $count extraneous access files removed $hostname");
+}
+
+exit (0);
+
+#******************************************************************************
+# End of SCRIPT
+#******************************************************************************
+__END__
+#******************************************************************************
+# POD
+#******************************************************************************
+
+# -----------------------------------------------------------------------------
+
+=head1 NAME
+
+update_ssh.pl - distributes SSH public keys in a desired state model.
+
+=head1 SYNOPSIS
+
+ update_ssh.pl[-d|--debug]
+ [-h|--help]
+ ([-p|--preview] [-g|--global]) | [-r|--remove]
+ [-v|--verbose]
+ [-V|--version]
+
+
+=head1 DESCRIPTION
+
+B distributes SSH keys to the appropriate files (.e. 'authorized_keys') into the C<$access_dir> repository based on the F, F and F files.
+This script should be run on each host where SSH key authentication is the exclusive method of (remote) authentication.
+
+For update SSH public keys must be stored in a generic F file within the same directory as B script.
+Alternatively key files may be stored as set of individual key files within a called sub-directory called F.
+Both methods are mutually exclusive and the latter always take precedence.
+
+=head1 CONFIGURATION
+
+B requires the presence of at least one of the following configuration files:
+
+=over 2
+
+=item * F
+
+=item * F
+
+=back
+
+Use F for localized settings per host. Settings in the localized configuration file will always override other values.
+
+Following settings must be configured:
+
+=over 2
+
+=item * B : target directory for allowed SSH public key files
+
+=item * B : location of the file with blacklisted SSH public keys
+
+=back
+
+=head1 BLACKLISTING
+
+Key blacklisting can be performed by adding a public key definition in its entirety to the blacklist keys file. When a blacklisted key is
+found in the available F file(s) during SSH control updates, an alert will be shown on STDOUT and the key will be ignored for the rest.
+
+Examples:
+
+WARN: *BLACKLIST*: key match found for 'John Doe,ssh-rsa,AAAAB3N', ignoring key!
+
+
+=head1 OPTIONS
+
+=over 2
+
+=item -d | --debug
+
+S< >Be I verbose during execution; show array/hash dumps.
+
+=item -h | --help
+
+S< >Show the help page.
+
+=item -p | --preview
+
+S< >Do not actually distribute any SSH public keys, nor update/remove any 'authorized_keys' files.
+
+=item -p | --global
+
+S< >Must be used in conjunction with the --preview option. This will dump the global namespace/configuration to STDOUT.
+
+=item -r | --remove
+
+S< >Remove any extraneous 'authorized_keys' files (i.e. belonging to non-existing accounts in /etc/passwd)
+
+=item -v | --verbose
+
+S< >Be verbose during exection.
+
+=item -V | --version
+
+S< >Show version of the script.
+
+=back
+
+=head1 NOTES
+
+=over 2
+
+=item * Options may be preceded by a - (dash), -- (double dash) or a / (slash).
+
+=item * Options may be bundled (e.g. -vp)
+
+=back
+
+=head1 AUTHOR
+
+(c) KUDOS BVBA, Patrick Van der Veken
+
+=head1 history
+
+@(#) 2014-12-04: VRF 1.0.0: first version [Patrick Van der Veken]
+@(#) 2014-12-16: VRF 1.0.1: added SELinux context, new config option 'selinux_context' [Patrick Van der Veken]