diff --git a/LICENSE b/LICENSE index 94a9ed0..5f1051c 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,13 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 +Copyright (c) 2015 Dropbox, Inc. - 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. +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at - Preamble + http://www.apache.org/licenses/LICENSE-2.0 - 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 -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 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 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. - - 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. - - 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. - - 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. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "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. - - 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 "covered work" means either the unmodified Program or a work based -on the Program. - - 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. - - 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. - - 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. - - 1. Source Code. - - 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. - - 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. - - 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. - - 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. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - 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. - - 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. - - 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. - - 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 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. - - 13. Use with the GNU Affero General Public License. - - 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. - - 14. Revised Versions of this License. - - 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 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. - - 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. - - 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. - - 15. Disclaimer of Warranty. - - 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 - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -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 -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. - - - Copyright (C) - - 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 3 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. - - 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 does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - 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, 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 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 -. +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.rst b/README.rst index ff594ea..ef5acfc 100644 --- a/README.rst +++ b/README.rst @@ -2,58 +2,22 @@ do_auth.py ========== -Versions -======== - -1.93.2 ------- - -+ Default log destination to /dev/null unless -l is passed. - -1.93.1 ------- - -+ Replace all instances of log_file.write with a log object -+ Remove all references to log_file within the code -+ Read DEBUG environment variable to toggle debug logging -+ A few minor syntax cleanup changes to improve readability -+ A few minor line-spacing/formatting changes to improve readability -+ Extra commenting added here and there to improve readability - -1.92 ----- - -+ Catch exception on failed config.read() for backwards-compatibility w/ Python 2.4. - -1.91 ----- - -+ Error out on no "default service = permit" -+ Option to hard code return value (for Procurve) - -1.9 ---- - -+ Better Nexus Support -+ Only send roles to Nexus -+ Better av pair replacement - -1.8 ---- - -+ Nexus support (tac_pair format different) +do_auth is a Python program to work as a post-authorization script for the +``tac_plus`` TACACS+ daemon to allow greater flexibility in TACACS+ +authentication and authorization. For more information on tac_plus please see +http://shrubbery.net/tac_plus. +It allows a user to be part of many predefined groups that can allow different +access to different devices based on device IP address, usernmae, and source IP +address. -1.7 ---- +Do not play with do_auth until you have a firm grasp on ``tac_plus`` and the +syntax for ``do_auth.ini``! -http://www.pastie.org/2499657 - -1.2 ---- - -http://pastie.org/506002 +Versions +======== +Please see ``CHANGELOG.rst`` for the version history. Usage ===== @@ -166,7 +130,6 @@ change to this:: default = fewcommands - Multiple Groups --------------- @@ -221,3 +184,226 @@ just type "en" if they have an enable password. Now, this should open all sorts of opportunities for wlc and roles. For reasons unknown, this does not work. If you have a wlc that you can lab up & wireshark, please contact me on the tac_plus listserv. + +Users +===== + +To define users you must specify a ``[users]`` section. A user must be assigned +to one or more groups, one per line:: + + [users] + homer = + simpson_group + television_group + stimpy = + television_group + +Groups +====== + +Groups are assigned to users in the ``[users]`` section. Groups are defined in +brackets, and can have any name. Each group can have up to eight options as +defined below: + +host_deny + (Optional) Deny any user coming from this host. + +host_allow + (Mandatory if -i is specified) Allow users from this range. + +device_deny + (Optional) Deny any device with this IP. + +device_permit + (Mandatory if -d is specified) Allow this range. + +command_deny + (Optional) Deny these commands. + +command_permit + (Mandatory) Allow these commands. + +av_pairs + (Advanced - Use with care) List of av pairs to replace if found. + +exit_val + (Advanced - Use with care) hard code return value. + +These options are parsed in order until a match is found. For login authentication, +the commands section is not parsed. If a match is not found, or a deny is +found, we move on to the next group. At the end, we have an implicit deny if no +groups match. + +An simple example is as follows:: + + [users] + homer = + simpson_group + television_group + stimpy = + television_group + + [simpson_group] + host_deny = + 1.1.1.1 + 1.1.1.2 + host_allow = + 1.1.1.* + device_permit = + 10.1.1.* + command_permit = + .* + + [television_group] + host_allow = + .* + device_permit = + .* + command_permit = + show.* + +Example tac_plus config line:: + + after authorization "/usr/bin/python /root/do_auth.pyc -i $address -fix_crs_bug -u $user -d $name -l /root/log.txt -f /root/do_auth.ini" + +The following ``av_pair`` example will replace any ``priv-lvl`` with +``priv-lvl=1`` **only** if passed. Think of it as a find/replace function:: + + av_pairs = + priv-lvl=1 + +Brocade devices +--------------- + +Brocade has a vendor-specific attribute called ``brocade-privlvl``. It maps +``priv-lvl`` to ``brocade-privlvl``, but the result is an account that has some +privileges. Here is an example of how to map ``brocade-privlvl=5`` which has no +modification rights. Unfortunately, it also requires you to specify the IP +addresses of your +Brocade devices. + +You could also put ``priv-lvl=15,brocade-privlvl=5`` or whatever your tac_plus +deamon is passing. As long as the A/V pairs match the results are the same. In +this example, we essentially replace the whole ``av_pair`` resulting in the user +having read-only access. + +To work the Brocade-specific group must be above the other groups:: + + [brocade_readonly] + host_allow = + .* + device_permit = + 192.168.1.* + command_permit = + .* + av_pairs = + priv-lvl,brocade-privlvl=5 + +Cisco Nexus devices +------------------- + +Due to a slight change in the Nexus, ``do_auth`` is able to identify a device as +a Cisco Nexus. In ``tac_plus.conf``, do the following:: + + service = exec { + priv-lvl = 1 + shell:roles=\"\\"network-operator\\"" + idletime = 3 + timeout = 15 + } + after authorization "" + +This configuration **WILL NOT** work without ``do_auth``, however, with +``do_auth`` the ``shell:roles`` A/V pair will only be sent to Nexus switches, +allowing your other devices to work correctly. These roles can also be modified +in a ``do_auth`` group, as below:: + + av_pairs = + priv-lvl=15 + shell:roles="network-admin" + +NOTE: You **must** use double quotes to get ``tac_plus`` to correctly pass +"network-operator" in the ``service`` definition example above. Unless you are +explicitly modifying the attribute with ``do_auth`` in ``av_pairs``, it will be +adjusted for you! + +HP Procurve devices +------------------- + +This is the worst TACACS+ implementation I've ever seen and is the whole reason +for the ``exit_val`` group option. This is to work around the incorrect +implementation by HP. NOT MY FAULT! + +Setting ``exit_val`` to ``0`` makes it work (the Procurve doesn't like +``AUTHOR_STATUS_PASS_REPL``). Unfortunately, this means you need to define your +Procurves in a distinct group and it must be the **very first** +group defined:: + + [fix_procurve] + host_allow = + .* + device_permit = + 192.168.1.* + command_permit = + .* + exit_val = + 0 + +Known Issues +============ + +You must know your regular expressions. If you enter a bad expression, such as +"*." instead of ".*", Python's "re" module will freak out and not evaluate the +expression. + +Caveats +======= + +Ordering of groups is crucial. One group can not take away what another group +grants. If a match is not found, it will go on to the next group. If a deny is +matched, it will go on to the next group. The groups should go from +most-specific to least-specific. + +For example:: + + [users] + homer = + simpson_group + television_group + stimpy = + television_group + + [simpson_group] + host_deny = + 1.1.1.1 + 1.1.1.2 + host_allow = + 1.1.1.* + device_permit = + 10.1.1.* + command_permit = + .* + + [television_group] + host_allow = + .* + device_permit = + .* + command_permit = + show.* + +In this example, if ``television_group`` was put before ``simpson_group``, +``simpson_group`` would never be called because ``televsion_group`` catches +everything in ``device_permit``. + +License +======= + +This program is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License version 3 or any later version as +published by the Free Software Foundation, http://www.gnu.org/ + +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 LICENSE in the ``do_auth`` source distribution for more +details. diff --git a/do_auth.py b/do_auth.py index 71400b9..180c202 100755 --- a/do_auth.py +++ b/do_auth.py @@ -1,249 +1,24 @@ #!/usr/bin/env python +# -*- coding: utf-8 -*- # vim: ts=4:sw=4:expandtab """ -do_auth is a Python program to work as an authorization script for the +do_auth is a Python program to work as an post-authorization script for the ``tac_plus`` TACACS+ daemon to allow greater flexibility in TACACS+ authentication and authorization. For more information on tac_plus please see http://shrubbery.net/tac_plus. -It allows a user to be part of many predefined groups that can allow different -access to different devices based on device IP address, usernmae, and source IP -address. - -Do not play with do_auth until you have a firm grasp on ``tac_plus`` and the -syntax for ``do_auth.ini``! - -Users -===== - -To define users you must specify a ``[users]`` section. A user must be assigned -to one or more groups, one per line:: - - [users] - homer = - simpson_group - television_group - stimpy = - television_group - -Groups -====== - -Groups are assigned to users in the ``[users]`` section. Groups are defined in -brackets, and can have any name. Each group can have up to eight options as -defined below: - -host_deny - (Optional) Deny any user coming from this host. - -host_allow - (Mandatory if -i is specified) Allow users from this range. - -device_deny - (Optional) Deny any device with this IP. - -device_permit - (Mandatory if -d is specified) Allow this range. - -command_deny - (Optional) Deny these commands. - -command_permit - (Mandatory) Allow these commands. - -av_pairs - (Advanced - Use with care) List of av pairs to replace if found. - -exit_val - (Advanced - Use with care) hard code return value. - -These options are parsed in order until a match is found. For login authentication, -the commands section is not parsed. If a match is not found, or a deny is -found, we move on to the next group. At the end, we have an implicit deny if no -groups match. - -An simple example is as follows:: - - [users] - homer = - simpson_group - television_group - stimpy = - television_group - - [simpson_group] - host_deny = - 1.1.1.1 - 1.1.1.2 - host_allow = - 1.1.1.* - device_permit = - 10.1.1.* - command_permit = - .* - - [television_group] - host_allow = - .* - device_permit = - .* - command_permit = - show.* - -Example tac_plus config line:: - - after authorization "/usr/bin/python /root/do_auth.pyc -i $address -fix_crs_bug -u $user -d $name -l /root/log.txt -f /root/do_auth.ini" - -The following ``av_pair`` example will replace any ``priv-lvl`` with -``priv-lvl=1`` **only** if passed. Think of it as a find/replace function:: - - av_pairs = - priv-lvl=1 - -Brocade devices ---------------- - -Brocade has a vendor-specific attribute called ``brocade-privlvl``. It maps -``priv-lvl`` to ``brocade-privlvl``, but the result is an account that has some -privileges. Here is an example of how to map ``brocade-privlvl=5`` which has no -modification rights. Unfortunately, it also requires you to specify the IP -addresses of your -Brocade devices. - -You could also put ``priv-lvl=15,brocade-privlvl=5`` or whatever your tac_plus -deamon is passing. As long as the A/V pairs match the results are the same. In -this example, we essentially replace the whole ``av_pair`` resulting in the user -having read-only access. - -To work the Brocade-specific group must be above the other groups:: - - [brocade_readonly] - host_allow = - .* - device_permit = - 192.168.1.* - command_permit = - .* - av_pairs = - priv-lvl,brocade-privlvl=5 - -Cisco Nexus devices -------------------- - -Due to a slight change in the Nexus, ``do_auth`` is able to identify a device as -a Cisco Nexus. In ``tac_plus.conf``, do the following:: - - service = exec { - priv-lvl = 1 - shell:roles=\"\\"network-operator\\"" - idletime = 3 - timeout = 15 - } - after authorization "" - -This configuration **WILL NOT** work without ``do_auth``, however, with -``do_auth`` the ``shell:roles`` A/V pair will only be sent to Nexus switches, -allowing your other devices to work correctly. These roles can also be modified -in a ``do_auth`` group, as below:: - - av_pairs = - priv-lvl=15 - shell:roles="network-admin" - -NOTE: You **must** use double quotes to get ``tac_plus`` to correctly pass -"network-operator" in the ``service`` definition example above. Unless you are -explicitly modifying the attribute with ``do_auth`` in ``av_pairs``, it will be -adjusted for you! - -HP Procurve devices -------------------- - -This is the worst TACACS+ implementation I've ever seen and is the whole reason -for the ``exit_val`` group option. This is to work around the incorrect -implementation by HP. NOT MY FAULT! - -Setting ``exit_val`` to ``0`` makes it work (the Procurve doesn't like -``AUTHOR_STATUS_PASS_REPL``). Unfortunately, this means you need to define your -Procurves in a distinct group and it must be the **very first** -group defined:: - - [fix_procurve] - host_allow = - .* - device_permit = - 192.168.1.* - command_permit = - .* - exit_val = - 0 - -Known Issues -============ - -You must know your regular expressions. If you enter a bad expression, such as -"*." instead of ".*", Python's "re" module will freak out and not evaluate the -expression. - -Caveats -======= - -Ordering of groups is crucial. One group can not take away what another group -grants. If a match is not found, it will go on to the next group. If a deny is -matched, it will go on to the next group. The groups should go from -most-specific to least-specific. - -For example:: - - [users] - homer = - simpson_group - television_group - stimpy = - television_group - - [simpson_group] - host_deny = - 1.1.1.1 - 1.1.1.2 - host_allow = - 1.1.1.* - device_permit = - 10.1.1.* - command_permit = - .* - - [television_group] - host_allow = - .* - device_permit = - .* - command_permit = - show.* - -In this example, if ``television_group`` was put before ``simpson_group``, -``simpson_group`` would never be called because ``televsion_group`` catches -everything in ``device_permit``. - -License -======= - -This program is free software; you can redistribute it and/or modify it under -the terms of the GNU General Public License version 3 or any later version as -published by the Free Software Foundation, http://www.gnu.org/ - -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 LICENSE in the ``do_auth`` source distribution for more -details. +Please see the README.rst file bundled with this program for information on how +to use it. """ __author__ = 'Dan Schmidt, Jathan McCollum' -__maintainer__ = 'Dan Schmidt, Jathan McCollum' -__email__ = 'daniel.schmidt@wyo.gov' +__maintainer__ = 'Jathan McCollum' +__email__ = 'jathan@gmail.com' __copyright__ = 'Dan Schmidt' -__license__ = 'GPL-3.0' -__version__ = '1.11' +__license__ = 'APL-2.0' +__version__ = '2.0' + try: import configparser @@ -263,6 +38,7 @@ except ImportError: got_getgrouplist = False + # Defaults CONFIG = 'do_auth.ini' LOG_FILE = '/dev/null' @@ -280,8 +56,19 @@ # Functions def _setup_logging(filename=LOG_FILE, format=LOG_FORMAT, level=LOG_LEVEL): - """Returns a logging object. Intended to be called by main before any - logging occurs.""" + """ + Returns a logging object. Intended to be called by main before any + logging occurs. + + :param filename: + Log filename + + :param format: + Log format + + :param level: + Log level + """ logging.basicConfig( level=level, format=format, @@ -289,15 +76,6 @@ def _setup_logging(filename=LOG_FILE, format=LOG_FORMAT, level=LOG_LEVEL): ) return logging.getLogger(__name__) -def dprint(*args, **kwargs): - """Pretty-print the passed in values if global ``DEBUG`` is set.""" - if DEBUG: - for a in args: - print(a) - for k,v in kwargs.items(): - print('%s = %s' % (k.upper(), v)) - if args and kwargs: - print('') def _product(*args, **kwds): """ @@ -310,7 +88,7 @@ def _product(*args, **kwds): pools = list(map(tuple, args)) * kwds.get('repeat', 1) result = [[]] for pool in pools: - result = [x+[y] for x in result for y in pool] + result = [x + [y] for x in result for y in pool] for prod in result: yield tuple(prod) # itertools.product() wasn't added until Python 2.6, so this is so we can @@ -320,53 +98,59 @@ def _product(*args, **kwds): except ImportError: product = _product + def get_attribute(config, the_section, the_option, filename): """ Fetches a section by name from the config and returns a list of attributes. - I really don't want to deal with these exceptions more than once filename + I really don't want to deal with these exceptions more than once. filename is only used in log statements. """ log.debug('get_attributes(%s)' % locals()) if not config.has_section(the_section): - log.critical("Section '%s' does not exist in %s" % (the_section, filename)) + msg = 'Section %r does not exist in %s' % (the_section, filename) + log.critical(msg) sys.exit(1) if not config.has_option(the_section, the_option): - log.critical("Option '%s' does not exist in section %s in file %s" % (the_option, the_section, filename)) + msg = 'Option %r does not exist in section %s in %s' % \ + (the_option, the_section, filename) + log.critical(msg) sys.exit(1) # Should not have any exceptions - BUT, just in case try: attributes = config.get(the_section, the_option) except configparser.NoSectionError: - log.critical("Section '%s' Doesn't Exist!" % (the_section)) + log.critical('Section %r is missing!' % (the_section,)) sys.exit(1) except configparser.DuplicateSectionError: - log.critical("Duplicate section '%s'" % (the_section)) + log.critical('Duplicate section %r' % (the_section,)) sys.exit(1) except configparser.NoOptionError: - log.critical("'%s' not found in section '%s'" % (the_option, the_section)) + msg = '%r not found in section %r' % (the_option, the_section) + log.critical(msg) sys.exit(1) # TODO (dan): Finish exceptions. except configparser.ParsingError: - log.critical("Can't parse file '%s'! (You got me)" % (filename)) + log.critical("Can't parse file '%s'! (You got me)" % (filename,)) sys.exit(1) # This is only executed if no exceptions were thrown else: - log.debug('attributes BEFORE = %r' % attributes) + log.debug('attributes BEFORE = %r' % (attributes,)) attributes = attributes.splitlines() - log.debug('attributes AFTER = %r' % attributes) + log.debug('attributes AFTER = %r' % (attributes,)) # Strip empty lines new_attributes = [line for line in attributes if line != ''] log.debug('new_attributes = %s' % new_attributes) return new_attributes + # Can't make it part of get_attribute... oh well... # We need someway to check to see if a username exists with out exit(1) -def check_username(config, user_name): +def check_username(config, username): """ Check if a username exists in the config. Pukes if the config doesn't even have a "users" section. @@ -376,7 +160,8 @@ def check_username(config, user_name): log.critical("users section doesn't exist!") sys.exit(1) - return config.has_option('users', user_name) + return config.has_option('users', username) + def match_it(the_section, the_option, match_item, config, filename): """ @@ -387,13 +172,14 @@ def match_it(the_section, the_option, match_item, config, filename): If deny section has a match for 10.1.1.1, return True, else False. If the section doesn't exist, we assume an implicit deny/false """ - if config.has_option(the_section,the_option): + if config.has_option(the_section, the_option): our_list = get_attribute(config, the_section, the_option, filename) for item in our_list: if re.match(item, match_item): return True return False + class DoAuthOptionParser(optparse.OptionParser): """ A custom OptionParser to work with tac_plus post-authorization: @@ -405,7 +191,6 @@ def error(self, msg): """Print a usage message using 'msg' to stderr and exit 1.""" # Use the global log if it exists, else instantiate it. global log - print(log) if log is None: log = _setup_logging(filename=self.values.log_file) log.critical(msg) @@ -413,6 +198,7 @@ def error(self, msg): self.print_usage(sys.stderr) self.exit(1, "%s: error: %s\n" % (self.get_prog_name(), msg)) + def is_i_before_f(argv, parser): """ Make sure -i always comes before -f. This is for the CRS workaround. @@ -432,12 +218,12 @@ def is_i_before_f(argv, parser): # Iterate over the flag names and check their position in argv and make # sure that -i always comes before -f. for f, i in product(flags, ilags): - dprint('Checking %s against %s' % (f, i)) if (f in argv and i in argv) and (argv.index(f) < argv.index(i)): - parser.error("%s must be specified after %s in the argument list." % (f, i)) - + msg = 'Argument %s must be specified after %s.' % (f, i) + parser.error(msg) return True + def parse_args(argv=None): """ Self-explanatory. @@ -448,32 +234,73 @@ def parse_args(argv=None): if argv is None: argv = sys.argv - dprint(argv=argv) - - usage = 'usage: %prog -u [-i ] [-d ] [-f ] [-l ] [-D|--debug]' - desc = 'do_auth is a Python program to work as an authorization script for the ``tac_plus`` TACACS+ daemon to allow greater flexibility in TACACS+ authentication and authorization. For more information on tac_plus please see http://shrubbery.net/tac_plus.' - ver ='%prog ' + __version__ - - parser = DoAuthOptionParser(usage=usage, description=desc, version=ver) - parser.add_option('-u', '--username', metavar='', - help='(Mandatory) Username. [$user]') - parser.add_option('-i', '--ip-addr', metavar='', - help="""(Optional) IP address of user. If not specified, all host_ entries are ignored and can be omitted. [$address] (Note: If you use IOS-XR, you MUST add '-fix_crs_bug' after $address due to a bug in IOS-XR)""") - parser.add_option('-d', '--device', metavar='', - help="""(Optional) Device address. If not specified, all device_ entries are ignored and can be omitted. [$name]""") - parser.add_option('-f', '--config-file', metavar='', - default=CONFIG, help='Config filename. (default: %s)' % - CONFIG) - parser.add_option('-l', '--log-file', metavar='', default=LOG_FILE, - help='Log filename. (default: %s)' % LOG_FILE) - parser.add_option('--docs', action='store_true', default=False, - help='Display usage docs and exit.') - parser.add_option('-D', '--debug', action='store_true', default=False, - help="""Debug mode. Allows you to call the program without reading from stdin. Useful to test your configuration before going live. Sets a default command of "show users wides".""") + usage = ( + 'usage: %prog -u [-i ] [-d ] ' + '[-f ] [-l ] [-D|--debug]' + ) - opts, args = parser.parse_args() + ver = '%prog ' + __version__ + + parser = DoAuthOptionParser(usage=usage, description=__doc__, version=ver) + parser.add_option( + '-D', + '--debug', + action='store_true', + default=False, + help=( + 'Debug mode. Allows you to call the program without reading from ' + 'stdin. Useful to test your configuration before going live. Sets ' + 'a default command of "show users wide".' + ) + ) + parser.add_option( + '-d', + '--device', + metavar='', + help=( + '(Optional) Device address. If not specified, all device_* ' + 'entries are ignored and can be omitted. [$name]' + ) + ) + parser.add_option( + '--docs', + action='store_true', + default=False, + help='Display usage docs and exit.' + ) + parser.add_option( + '-f', + '--config-file', + metavar='', + default=CONFIG, + help='Config filename. (default: %s)' % CONFIG + ) + parser.add_option( + '-i', + '--ip-addr', + metavar='', + help=( + 'Optional) IP address of user. If not specified, all host_ ' + 'entries are ignored and can be omitted. [$address] (Note: If ' + 'you use IOS-XR, you MUST add "-fix_crs_bug" after $address due ' + 'to a bug in IOS-XR).' + ) + ) + parser.add_option( + '-l', + '--log-file', + metavar='', + default=LOG_FILE, + help='Log filename. (default: %s)' % LOG_FILE + ) + parser.add_option( + '-u', + '--username', + metavar='', + help='(Mandatory) Username. [$user]' + ) - dprint('\nBefore:', opts=opts, args=args) + opts, args = parser.parse_args() if opts.docs: parser.exit(1, __doc__) @@ -484,30 +311,82 @@ def parse_args(argv=None): parser.error(msg) # Make sure -u, -i, -f are all provided, despite being labeled as optional? - #if len(argv) < 7: - # print __doc__ - # sys.exit(1) + # if len(argv) < 7: + # print __doc__ + # sys.exit(1) # Make sure that -i always comes before -f is_i_before_f(argv, parser) - # Support legacy '-fix_crs_bug' option so it does not conflict with '-f' option + # Support legacy '-fix_crs_bug' option so it does not conflict with '-f' + # option if opts.config_file == 'ix_crs_bug' and opts.ip_addr: opts.ip_addr = '-fix_crs_bug' opts.config_file = CONFIG - dprint('\nAfter:', opts=opts, args=args) - return opts, args + +# Default debug command is "show users wide". Later versions will allow this to +# be set. +DEBUG_AV_PAIRS = [ + 'service=shell', + 'cmd=show', + 'cmd-arg=users', + 'cmd-arg=wide', + 'cmd-arg=', +] + + +def get_av_pairs(is_debug=False): + """Read AV pairs from stdin.""" + if is_debug: + return DEBUG_AV_PAIRS + + log.debug('get_av_pairs()') + log.debug('=' * 40) + av_pairs = [] + for line in sys.stdin: + line = line.strip() + log.debug('Incoming AV pair: %s' % line) + av_pairs.append(line) + + # log.debug('AV pairs: %r' % (av_pairs,)) + log.debug('=' * 40) + log.debug(' ') + return av_pairs + + +def validate_av_pairs(av_pairs): + # Make sure that we have AV pairs or exit(1) + if not av_pairs: + log.info('No AV pairs!') + msg = 'Did you forget "default service = permit" in tac_plus.conf?' + log.critical(msg) + log.critical('Confused: Exiting(1)') + sys.exit(1) + + +def read_config(filename): + config = configparser.SafeConfigParser() + try: + config.readfp(open(filename)) + except (IOError, configparser.ParsingError): + log.critical('Could not open/parse config file: %r' % (filename,)) + sys.exit(1) + + log.debug('Got config: %s' % config) + return config + + def main(): # Defaults - global log # So we can use and modify the global logging object + global log # So we can use and modify the global logging object opts, _args = parse_args() filename = opts.config_file log_name = opts.log_file - user_name = opts.username + username = opts.username ip_addr = opts.ip_addr device = opts.device is_debug = opts.debug @@ -521,28 +400,18 @@ def main(): log = _setup_logging(filename=log_name) # DEBUG! We at least got CALLED (and the logger works!) - log.debug('Hello World!') + log.debug('do_auth started with args %s' % sys.argv[1:]) - # Read AV pairs - av_pairs = [] - if not is_debug: - for line in sys.stdin: - av_pairs.append(line) + # First and foremost, can we even read the config? + config = read_config(filename) - log.debug('AV pairs: %r' % av_pairs) + # Read incoming AV Pairs from stdin + if device: + log.info('Device: %s' % device) + av_pairs = get_av_pairs(is_debug) - else: - # Default Debug command is "show users wide" - # Later versions will allow this to be set - av_pairs.append("service=shell\n") - av_pairs.append("cmd=show\n") - av_pairs.append("cmd-arg=users\n") - av_pairs.append("cmd-arg=wide\n") - av_pairs.append("cmd-arg=\n") - - # DEBUG - print av_pairs - for item in av_pairs: - log.debug('AV item: %r' % item) + # Make sure that we have AV pairs + validate_av_pairs(av_pairs) # Function to make cmd's readable # Not very good, but will do for now @@ -550,22 +419,19 @@ def main(): the_command = "" return_pairs = "" - if not len(av_pairs) > 0: - log.info('No av pairs!!') - if device: - log.info('Device:%s' % device) - - log.critical('Did you forget "default service = permit" in tac_plus.conf?') - log.critical('Confused - exiting(1)!') - sys.exit(1) - - if (av_pairs[0] == "service=shell\n"): + # + # Commands + # + # Process commands + log.debug('validate_commands()') + log.debug('=' * 40) + if (av_pairs[0] == "service=shell"): # $**@ Nexus! - if av_pairs[1] == ("cmd=\n"): # #&*@ Nexus! + if av_pairs[1] == ("cmd=\n"): # #&*@ Nexus! if len(av_pairs) > 2: # DEBUG log.debug('Nexus pairs found') - return_pairs = av_pairs[2:] # strip the "cmd=" for consistency + return_pairs = av_pairs[2:] # Strip the "cmd=" for consistency # # Commands - Concatenate to a readable command @@ -578,10 +444,11 @@ def main(): i = 2 our_command = av_pairs[i].split("=") - while not (our_command[1] == "\n"): - the_command = the_command + " " + our_command[1].strip('\n') - i = i + 1 - if i == len(av_pairs): # Firewalls don't give a !! + while our_command[1] != "\n": + the_command = '%s %s' % (the_command, + our_command[1].strip('\n')) + i += 1 + if i == len(av_pairs): # Firewalls don't give a !! break our_command = av_pairs[i].split("=") @@ -594,83 +461,95 @@ def main(): # # (Note: during debugging, you may see AV pairs whose separator - # character is a * instead of a = sign, meaning that the value in a pair - # is optional. An = sign indicates a mandatory value. A * denotes an - # optional value). + # character is a * instead of a = sign, meaning that the value in a + # pair is optional. An = sign indicates a mandatory value. A * denotes + # an optional value). elif av_pairs[1].startswith("cmd*"): # Anybody know why it's "cmd*"? if len(av_pairs) > 2: - return_pairs = av_pairs[2:] # You MUST strip the "cmd*" av-pair + return_pairs = av_pairs[2:] # You MUST strip "cmd*" av-pair # Definitely not a Nexus, so strip any Nexus pair for item in return_pairs: if item.startswith("shell:roles"): return_pairs.remove(item) else: - return_pairs = av_pairs - - config = configparser.SafeConfigParser() - try: - config.readfp(open(filename)) - except (IOError, configparser.ParsingError): - log.critical("Can't open/parse config file: '%s'" % (filename)) - sys.exit(1) + return_pairs = av_pairs + log.debug('=' * 40) + log.debug(' ') - log.debug('Got config: %s' % config) - - the_section = "users" + # + # Users + # + # def validate_user(username): # If the user doesn't exist, just use the default settings - # Kind of a hack, but it works because we only get_attribute on user_name once. - # We have the : in there which we can use to split if required - log.debug('Checking username: %s' % user_name) - if not check_username(config, user_name): + # Kind of a hack, but it works because we only get_attribute on username + # once. We have the ':' in there which we can use to split if required + log.debug('validate_user()') + log.debug('=' * 40) + log.debug('Checking username: %s' % username) + if not check_username(config, username): log.debug('username not found; searching for default') - user_name = (user_name + ":(default)") + username = (username + ":(default)") groups = get_attribute(config, "users", "default", filename) else: log.debug('username found in config') - groups = get_attribute(config, "users", user_name, filename) + groups = get_attribute(config, "users", username, filename) if '_nss' in groups and got_getgrouplist: - log.debug('Got special group _nss and have getgrouplist, importing nss groups') + msg = 'Got group _nss and have getgrouplist; importing nss groups' + log.debug(msg) try: - pwd_user = pwd_getpwnam(user_name) - os_group = os_getgrouplist(user_name, pwd_user[3]) - for gid in os_group: - try: - group = grp_getgrgid(gid) - groups.append(group[0]) - except KeyError: - # group not found in nss - pass + pwd_user = pwd_getpwnam(username) + os_group = os_getgrouplist(username, pwd_user[3]) + for gid in os_group: + try: + group = grp_getgrgid(gid) + groups.append(group[0]) + except KeyError: + # group not found in nss + pass except KeyError: - log.debug('User not found in NSS') - log.debug('NSS Groups: %s' % (groups)) - + log.debug('User not found in NSS') + log.debug('NSS Groups: %s' % (groups,)) + log.debug('=' * 40) + log.debug(' ') + + # + # Groups + # + log.debug('validate_groups()') + log.debug('=' * 40) log.debug('About to check groups') for this_group in groups: + # Check $address if ip_addr: # 'host_deny' attribute - if match_it(this_group, "host_deny", ip_addr, config, filename): + host_deny = match_it( + this_group, 'host_deny', ip_addr, config, filename) + if host_deny: if this_group == groups[-1]: - log.info("User '%s' denied from source '%s' in '%s'->'%s'" - % (user_name, ip_addr, this_group, "host_deny")) + log.error('%r denied from source %r in %r:%r' % ( + username, ip_addr, this_group, 'host_deny')) sys.exit(1) else: - # HUM... afterthought. We need it to continue if more groups exist + # We need it to continue if more groups exist continue # 'host_allow' attribute - if not match_it(this_group, "host_allow", ip_addr, config, filename): + host_allow = match_it( + this_group, 'host_allow', ip_addr, config, filename) + if not host_allow: # Stupid IOS-XR bug in which $address is not passed by the # device. This workaround just gives us a value to check and is # ignored otherwise. if ip_addr == "-fix_crs_bug": pass elif this_group == groups[-1]: - log.info("User '%s' not allowed from source '%s' in '%s'->'%s'" - % (user_name, ip_addr, this_group, "host_allow")) + msg = '%r not allowed from source %r in %r:%r' % ( + username, ip_addr, this_group, 'host_allow') + log.error(msg) sys.exit(1) else: continue @@ -678,84 +557,119 @@ def main(): # Check $name if device: # 'device_deny' attribute - if match_it(this_group, "device_deny", device, config, filename): + device_deny = match_it( + this_group, 'device_deny', device, config, filename) + if device_deny: if this_group == groups[-1]: - log.info("User '%s' denied access to device '%s' in '%s'->'%s'" - % (user_name, device, this_group, "device_deny")) + msg = '%r denied access to device %r in %r:%r' % ( + username, device, this_group, 'device_deny') + log.error(msg) sys.exit(1) else: continue # 'device_permit' attribute - if not match_it(this_group, "device_permit", device, config, filename): + device_permit = match_it( + this_group, 'device_permit', device, config, filename) + if not device_permit: if this_group == groups[-1]: - log.info("User '%s' not allowed access to device '%s' in '%s'->'%s'" - % (user_name, device, this_group, "device_permit")) + msg = '%r denied access to device %r in %r:%r' % ( + username, device, this_group, "device_permit") + log.error(msg) sys.exit(1) else: continue # Attempt to modify return pairs want_tac_pairs = False - if config.has_option(this_group, "av_pairs"): - temp_av_pairs = get_attribute(config, this_group, "av_pairs", filename) + if config.has_option(this_group, 'av_pairs'): + temp_av_pairs = get_attribute( + config, this_group, 'av_pairs', filename) for idx, item in enumerate(return_pairs): # TODO (jathan): Turn av_pairs into a dict, not a list of # strings... Write a function to convert back and forth. We # also need to be able to account for optional pairs that may # be sent by the device ('*' delimited) - splt = item.split('=') + splt = item.split('=') + log.debug('SPLT = %s' % (splt,)) if len(splt) > 1: # DEBUG for thing in splt: log.debug('Thing: %s' % thing) - # TODO (jathan): item, splt, item2? Need better var names... + # TODO (jathan): item, splt, item2? Need better var + # names... + log.debug('TEMP AV_PAIRS = %s' % temp_av_pairs) + log.debug('RETURN_PAIRS = %s' % return_pairs) for item2 in temp_av_pairs: item2 = item2.strip() - + # Pair replacing logic. - if item2.find(',') > -1: + """ + if item2.find(',') > -1: + log.debug('HAS COMMA = %s' % item2) splt2 = item2.split(',') + log.debug('HAS SPLT2 = %s' % splt2) if len(splt2) > 1: #splt3 = splt2[0].split('=') if splt[0].find(splt2[0]) > -1: want_tac_pairs = True return_pairs[idx] = ('%s' % splt2[1]) + log.debug('HAS COMMA VALUE = %s' % ( + return_pairs[idx],)) else: splt2 = item2.split('=') if len(splt2) > 1: if splt[0] == splt2[0].strip(): # Strip needed? want_tac_pairs = True # DEBUG - pair = '%s=%s' % (splt2[0].strip(), splt2[1].strip()) + pair = '%s=%s' % (splt2[0].strip(), + splt2[1].strip()) log.debug("Replacing pairs %s" % pair) return_pairs[idx] = pair - - # Some devices implement TACACS+ so poorly that you shouldn't even TRY to - # mess with them. Like Procurves. - exit_val = '2' - if config.has_option(this_group, "exit_val"): - return_val = get_attribute(config, this_group, "exit_val", filename) + """ + splt2 = item2.split('=') + if len(splt2) > 1: + if splt[0] == splt2[0].strip(): + want_tac_pairs = True + # DEBUG + pair = '%s=%s' % (splt2[0].strip(), + splt2[1].strip()) + log.debug('Replacing pairs %r' % pair) + return_pairs[idx] = pair + + # Some devices implement TACACS+ so poorly that you shouldn't even TRY + # to mess with them. Like Procurves. + exit_val = '2' + if config.has_option(this_group, 'exit_val'): + return_val = get_attribute( + config, this_group, 'exit_val', filename) return_val = return_val[0] # more than 1 = they're stupid exit_val = return_val.strip() # The previous 4 statements are to deny, it we passed them, proceed - # If we are logging in, return pairs, if not, go no to check the command - # Yes, simply printing them is how you return them + # If we are logging in, return pairs, if not, go no to check the + # command. Yes, simply printing them is how you return them. # First, let's make sure we're doing 'service = shell'. If not, just # allow it. I currently have little knowledge of cmd's sent by other - # services which is why this code is a little kludgy. + # services which is why this code is a little kludgy. if return_pairs: - splt = av_pairs[0].split('=') # Removed service in return_pairs + splt = av_pairs[0].split('=') # Removed service in return_pairs + services = ('shell', 'junos-exec') + shell_info = splt[1].strip() + log.info('Got shell? %s' % shell_info) if len(splt) > 1: - if not splt[1].strip() == 'shell': - log.info("User '%s' granted non-shell access to device '%s' in group '%s' from '%s'" - % (user_name, device, this_group, ip_addr)) - return_pairs = av_pairs[2:] # Cut the first two? + if shell_info not in services: + msg = ( + '%r granted non-shell access to device %r in ' + 'group %r from %r' + ) % (username, device, this_group, ip_addr) + log.info(msg) + # return_pairs = av_pairs[2:] # Cut the first two? + return_pairs = av_pairs[1:] # Cut the first two? # DEBUG for item in return_pairs: @@ -767,58 +681,64 @@ def main(): sys.exit(int(exit_val)) else: log.debug("Exiting status 0") - sys.exit(0) # Don't even TRY to mess with the tac pairs + sys.exit(0) # Don't even TRY to mess with the AV pairs # Proceed with shell stuff + log.info('command = %s' % the_command) if not len(the_command) > 0: log.debug("not len(the_command) > 0") for item in return_pairs: - # DEBUG log.debug("Returning: %s" % item.strip()) print(item.strip('\n')) - log.info("User '%s' granted access to device '%s' in group '%s' from '%s'" - % (user_name, device, this_group, ip_addr)) - # DEBUG - log.debug("Exiting status %s" % exit_val) + msg = '%r granted access to device %r in group %r from %r' % ( + username, device, this_group, ip_addr) + log.info(msg) + log.debug('Exiting status %s' % exit_val) sys.exit(int(exit_val)) # Check command else: - if match_it(this_group, "command_deny", the_command, config, filename): - + command_deny = match_it( + this_group, 'command_deny', the_command, config, filename) + command_permit = match_it( + this_group, 'command_permit', the_command, config, filename) + if command_deny: if this_group == groups[-1]: - log.info("User '%s' denied command '%s' to device '%s' in '%s'->'%s'" - % (user_name, the_command, device, this_group, "command_deny")) + msg = '%r denied command %r to device %r in %r:%r' % ( + username, the_command, device, this_group, + 'command_deny') + log.info(msg) sys.exit(1) - else: continue - - elif match_it(this_group, "command_permit", the_command, config, filename): - log.info("User '%s' allowed command '%s' to device '%s' in '%s'->'%s'" - % (user_name, the_command, device, this_group, "command_permit")) + elif command_permit: + msg = '%r allowed command %r to device %r in %r:%r' % ( + username, the_command, device, this_group, + 'command_permit') + log.info(msg) sys.exit(0) # Exit & log if last group else: - if this_group == groups[-1]: - log.info("User '%s' not allowed command '%s' to device '%s' in any group" - % (user_name, the_command, device)) + msg = '%r denied command %r to device %r in any group' % ( + username, the_command, device) + log.info(msg) - #Hum... This only works if it's the last group/only group. + # Hum... This only works if it's the last group/only group. sys.exit(1) - else: continue + log.debug('=' * 40) # Implicit deny at the end. This should never happen, but in case it ever # does, it's not failing silently and you will know! :) - log.info("User '%s' not allowed access to device '%s' from '%s' in any group" - % (user_name, device, ip_addr)) + log.info('%r not allowed access to device %r from %r in any group' + % (username, device, ip_addr)) sys.exit(1) - + + if __name__ == "__main__": main() diff --git a/tests/av_pairs.arista b/tests/av_pairs.arista new file mode 100644 index 0000000..7a0d904 --- /dev/null +++ b/tests/av_pairs.arista @@ -0,0 +1,3 @@ +service=shell +cmd* +priv-lvl=1 diff --git a/tests/av_pairs.debug b/tests/av_pairs.debug new file mode 100644 index 0000000..ac8fdab --- /dev/null +++ b/tests/av_pairs.debug @@ -0,0 +1,5 @@ +service=shell +cmd=show +cmd-arg=users +cmd-arg=wide +cmd-arg= diff --git a/tests/av_pairs.juni b/tests/av_pairs.juni new file mode 100644 index 0000000..9297829 --- /dev/null +++ b/tests/av_pairs.juni @@ -0,0 +1,7 @@ +service=junos-exec +local-user-name=remote +allow-commands=^.* +allow-configuration=^.* +deny-commands= +deny-configuration= +user-permissions=