diff --git a/.gitignore b/.gitignore index 4caa611..b79beae 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /bin /data -/vendor \ No newline at end of file +/vendor +/release \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bae94e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + 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 GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/Makefile b/Makefile index fb3158c..03bfbc3 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ deps: vendor build: vendor bin/server -release: vendor static doc +release: vendor script/release test: @@ -36,4 +36,17 @@ godoc: @echo "open your browser to http://localhost:6060/pkg/forge.cadoles.com/Cadoles/ldap-profile to see the documentation" godoc -http=:6060 + +fake-ldap: + docker kill cadoles-profile-ldap || exit 0 + mkdir -p data/ldap/o=test + [ -e data/ldap/o=test/uid=jdoe ] || cp misc/ldap/jdoe.json data/ldap/o=test/uid=jdoe + docker run \ + --rm -it \ + -p 389:3389 \ + -p 8081:8081 \ + -v $(PWD)/data/ldap:/fake-ldap/data/ldap \ + --name cadoles-profile-ldap \ + bornholm/fake-ldap + .PHONY: test run clean generate vendor deps lint tidy release \ No newline at end of file diff --git a/README.md b/README.md index a0cd3c5..625e780 100644 --- a/README.md +++ b/README.md @@ -19,4 +19,14 @@ make watch # Observer les sources et recompiler/exécuter à la volée le serve Le fichier de configuration sera généré automatiquement dans `data/server.conf`. Vous pouvez le modifier pour correspondre à votre environnement de développement. -Par défaut, l'application devrait être disponible à l'adresse http://localhost:3000/. \ No newline at end of file +Par défaut, l'application devrait être disponible à l'adresse http://localhost:3000/. + +### Annuaire LDAP de test + +Si Docker est installé sur votre machine, vous pouvez démarrer un annuaire LDAP de test via la commande + +```bash +make fake-ldap +``` + +Les données de cet annuaire seront stockées dans le répertoire `data/ldap`. \ No newline at end of file diff --git a/cmd/server/config/config.go b/cmd/server/config/config.go index 756966d..0046e7f 100644 --- a/cmd/server/config/config.go +++ b/cmd/server/config/config.go @@ -21,7 +21,6 @@ type LDAPConfig struct { URL string BaseDN string UserSearchFilterPattern string - EditableAttributes []string `ini:",allowshadow"` } // NewFromFile retrieves the configuration from the given file @@ -48,10 +47,6 @@ func NewDefault() *Config { URL: "ldap://127.0.0.1:389", BaseDN: "o=org,c=fr", UserSearchFilterPattern: "(&(objectClass=person)(uid=%s))", - EditableAttributes: []string{ - "displayname", - "mail", - }, }, } } diff --git a/cmd/server/container.go b/cmd/server/container.go index 195ec52..51f110c 100644 --- a/cmd/server/container.go +++ b/cmd/server/container.go @@ -18,7 +18,7 @@ func getServiceContainer(conf *config.Config) (*service.Container, error) { ctn := service.NewContainer() // Create and initialize HTTP session service provider - cookieStore, err := gorilla.CreateCookieSessionStore(32, 64, &sessions.Options{ + cookieStore, err := gorilla.CreateCookieSessionStore(64, 32, &sessions.Options{ Path: "/", HttpOnly: true, }) diff --git a/cmd/server/route.go b/cmd/server/route.go index 8a76b65..49c99fc 100644 --- a/cmd/server/route.go +++ b/cmd/server/route.go @@ -1,6 +1,7 @@ package main import ( + "crypto/rand" "log" "net/http" @@ -12,19 +13,35 @@ import ( "forge.cadoles.com/wpetit/goweb/static" "forge.cadoles.com/wpetit/goweb/template/html" "github.com/go-chi/chi" + "github.com/gorilla/csrf" "github.com/pkg/errors" ldapv3 "gopkg.in/ldap.v3" ) func mountRoutes(r *chi.Mux, config *config.Config) { + + csrfSecret, err := generateRandomBytes(32) + if err != nil { + panic(errors.Wrap(err, "error while generating CSRF secret")) + } + csrfMiddleware := csrf.Protect( + csrfSecret, + csrf.Secure(false), + ) + + r.Use(csrfMiddleware) + r.Get("/login", serveLoginPage) r.Post("/login", handleLoginForm) + r.Get("/logout", handleLogout) r.Group(func(r chi.Router) { r.Use(authMiddleware) r.Get("/", serveHomePage) r.Get("/profile", serveProfilePage) + r.Post("/profile/password", handlePasswordChange) }) + r.Get("/*", static.Dir(config.HTTP.PublicDir, "", r.NotFoundHandler())) } @@ -35,7 +52,10 @@ func serveHomePage(w http.ResponseWriter, r *http.Request) { func serveLoginPage(w http.ResponseWriter, r *http.Request) { ctn := container.Must(r.Context()) tmpl := template.Must(ctn) - if err := tmpl.RenderPage(w, "login.html.tmpl", nil); err != nil { + data := template.Data{ + csrf.TemplateTag: csrf.TemplateField(r), + } + if err := tmpl.RenderPage(w, "login.html.tmpl", data); err != nil { panic(errors.Wrap(err, "error while rendering page")) } } @@ -74,13 +94,19 @@ func handleLoginForm(w http.ResponseWriter, r *http.Request) { renderInvalidCredentials := func() { sess.AddFlash(session.FlashError, "Identifiants invalides.") data := extendTemplateData(w, r, template.Data{ - "Username": username, + "Username": username, + csrf.TemplateTag: csrf.TemplateField(r), }) if err := tmplSrv.RenderPage(w, "login.html.tmpl", data); err != nil { panic(errors.Wrap(err, "error while rendering page")) } } + if username == "" || password == "" { + renderInvalidCredentials() + return + } + results, err := ldapSrv.Search( ldap.EscapeFilter(conf.LDAP.UserSearchFilterPattern, username), ldap.WithBaseDN(conf.LDAP.BaseDN), @@ -155,14 +181,11 @@ func serveProfilePage(w http.ResponseWriter, r *http.Request) { panic(errors.Wrap(err, "error while binding ldap connection")) } - conf := config.Must(ctn) - results, err := ldapSrv.Search( "(&)", ldap.WithBaseDN(userDN), ldap.WithScope(ldapv3.ScopeBaseObject), ldap.WithSizeLimit(1), - ldap.WithAttributes(conf.LDAP.EditableAttributes...), ) if err != nil { panic(errors.Wrap(err, "error while searching ldap entry")) @@ -176,6 +199,7 @@ func serveProfilePage(w http.ResponseWriter, r *http.Request) { data := extendTemplateData(w, r, template.Data{ "EntryAttributes": results.Entries[0].Attributes, + csrf.TemplateTag: csrf.TemplateField(r), }) if err := tmpl.RenderPage(w, "profile.html.tmpl", data); err != nil { @@ -183,6 +207,90 @@ func serveProfilePage(w http.ResponseWriter, r *http.Request) { } } +func handlePasswordChange(w http.ResponseWriter, r *http.Request) { + + ctn := container.Must(r.Context()) + tmpl := template.Must(ctn) + + sess, err := session.Must(ctn).Get(w, r) + if err != nil { + panic(errors.Wrap(err, "error while retrieving session")) + } + + renderError := func(message string) { + sess.AddFlash(session.FlashError, message) + data := extendTemplateData(w, r, template.Data{ + csrf.TemplateTag: csrf.TemplateField(r), + }) + if err := tmpl.RenderPage(w, "profile.html.tmpl", data); err != nil { + panic(errors.Wrap(err, "error while rendering page")) + } + } + + if err := r.ParseForm(); err != nil { + panic(errors.Wrap(err, "error while parsing form")) + } + + currentPassword := r.Form.Get("currentPassword") + + if currentPassword == "" { + renderError("Vous devez renseigner votre mot de passe actuel.") + return + } + + if currentPassword == "" { + renderError("Vous devez renseigner votre mot de passe actuel.") + return + } + + password := sess.Get("password").(string) + if currentPassword != password { + renderError("Votre mot de passe est invalide.") + return + } + + newPassword := r.Form.Get("newPassword") + newPasswordConfirm := r.Form.Get("newPasswordConfirm") + + if newPassword == "" { + renderError("Vous devez renseigner un nouveau mot de passe.") + return + } + + if newPassword != newPasswordConfirm { + renderError("La confirmation de votre mot de passe n'est pas identique à votre nouveau mot de passe.") + return + } + + ldapSrv := ldap.Must(ctn) + + conn, err := ldapSrv.Connect() + if err != nil { + panic(errors.Wrap(err, "error while connecting to ldap server")) + } + defer conn.Close() + + userDN := sess.Get("dn").(string) + + if err := ldapSrv.BindConn(conn, userDN, password); err != nil { + panic(errors.Wrap(err, "error while binding ldap connection")) + } + + if err := ldapSrv.ModifyPasswordConn(conn, userDN, password, newPassword); err != nil { + panic(errors.Wrap(err, "error while modifying password")) + } + + sess.Set("password", newPassword) + sess.AddFlash(session.FlashSuccess, "Votre mot de passe a été modifié.") + + if err := sess.Save(w, r); err != nil { + panic(errors.Wrap(err, "error while saving session")) + } + + http.Redirect(w, r, "/profile", http.StatusSeeOther) + +} + func authMiddleware(next http.Handler) http.Handler { fn := func(w http.ResponseWriter, r *http.Request) { ctn := container.Must(r.Context()) @@ -210,3 +318,12 @@ func extendTemplateData(w http.ResponseWriter, r *http.Request, data template.Da } return data } + +func generateRandomBytes(n int) ([]byte, error) { + b := make([]byte, n) + _, err := rand.Read(b) + if err != nil { + return nil, err + } + return b, nil +} diff --git a/cmd/server/templates/layouts/login.html.tmpl b/cmd/server/templates/layouts/login.html.tmpl index c8d2f03..2d51101 100644 --- a/cmd/server/templates/layouts/login.html.tmpl +++ b/cmd/server/templates/layouts/login.html.tmpl @@ -1,4 +1,4 @@ -{{define "title"}}LDAP Profile - Authentification{{end}} +{{define "title"}}Gestionnaire de profil - Cadoles{{end}} {{define "head_style"}} {{end}} @@ -13,22 +13,26 @@
+

Gestionnaire de profil

+ {{ .csrfField }}
diff --git a/cmd/server/templates/layouts/profile.html.tmpl b/cmd/server/templates/layouts/profile.html.tmpl index 1adb830..fe7fa0f 100644 --- a/cmd/server/templates/layouts/profile.html.tmpl +++ b/cmd/server/templates/layouts/profile.html.tmpl @@ -5,38 +5,50 @@ {{define "body"}}
-
+
{{template "flash" .}}
-

Votre profil

-
- {{range .EntryAttributes}} - - {{ $name := .Name }} - {{range .Values}} -
-
- -
+
+
+

Informations personnelles

+
+
+ Fonctionnalité prochainement disponible :-) +
+
+
+
+

Mot de passe

+ +
+
- {{end}} -
- -
- {{end}} -
- +
+ +
+ +
+
+
+ +
+ +
+
+ {{ .csrfField }} +
+ +
+
- +
diff --git a/go.mod b/go.mod index 0a8bea8..947a3af 100644 --- a/go.mod +++ b/go.mod @@ -5,6 +5,7 @@ go 1.12 require ( forge.cadoles.com/wpetit/goweb v0.0.0-20190513070928-35c763a6c65f github.com/go-chi/chi v4.0.2+incompatible + github.com/gorilla/csrf v1.5.1 github.com/gorilla/sessions v1.1.3 github.com/oxtoacart/bpool v0.0.0-20190227141107-8c4636f812cc // indirect github.com/pkg/errors v0.8.1 diff --git a/go.sum b/go.sum index 047f849..a443486 100644 --- a/go.sum +++ b/go.sum @@ -6,6 +6,8 @@ github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGa github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= github.com/gorilla/context v1.1.1 h1:AWwleXJkX/nhcU9bZSnZoi3h/qGYqQAGhq6zZe/aQW8= github.com/gorilla/context v1.1.1/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= +github.com/gorilla/csrf v1.5.1 h1:UASc2+EB0T51tvl6/2ls2ciA8/qC7KdTO7DsOEKbttQ= +github.com/gorilla/csrf v1.5.1/go.mod h1:HTDW7xFOO1aHddQUmghe9/2zTvg7AYCnRCs7MxTGu/0= github.com/gorilla/securecookie v1.1.1 h1:miw7JPhV+b/lAHSXz4qd/nN9jRiAFV5FwjeKyCS8BvQ= github.com/gorilla/securecookie v1.1.1/go.mod h1:ra0sb63/xPlUeL+yeDciTfxMRAA+MP+HVt/4epWDjd4= github.com/gorilla/sessions v1.1.3 h1:uXoZdcdA5XdXF3QzuSlheVRUvjl+1rKY7zBXL68L9RU= @@ -14,6 +16,7 @@ github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7 github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= github.com/oxtoacart/bpool v0.0.0-20190227141107-8c4636f812cc h1:uhnyuvDwdKbjemAXHKsiEZOPagHim2nRjMcazH1g26A= github.com/oxtoacart/bpool v0.0.0-20190227141107-8c4636f812cc/go.mod h1:L3UMQOThbttwfYRNFOWLLVXMhk5Lkio4GGOtw5UrxS0= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= diff --git a/ldap/service.go b/ldap/service.go index 2338369..5f8ab85 100644 --- a/ldap/service.go +++ b/ldap/service.go @@ -68,6 +68,23 @@ func (s *Service) Connect() (*ldap.Conn, error) { return conn, err } +func (s *Service) ModifyPassword(identity, oldPassword, newPassword string) error { + conn, err := s.Connect() + if err != nil { + return errors.Wrap(err, "error while connecting to ldap server") + } + defer conn.Close() + return s.ModifyPasswordConn(conn, identity, oldPassword, newPassword) +} + +func (s *Service) ModifyPasswordConn(conn *ldap.Conn, identity, oldPassword, newPassword string) error { + req := ldap.NewPasswordModifyRequest("", oldPassword, newPassword) + if _, err := conn.PasswordModify(req); err != nil { + return errors.Wrap(err, "error while modifying password") + } + return nil +} + // From retrieves the ldap service in the given container func From(container *service.Container) (*Service, error) { service, err := container.Service(ServiceName) diff --git a/misc/ldap/jdoe.json b/misc/ldap/jdoe.json new file mode 100644 index 0000000..2ae4033 --- /dev/null +++ b/misc/ldap/jdoe.json @@ -0,0 +1,20 @@ +{ + "dn": "uid=jdoe,o=test", + "attributes": { + "cn": [ + "John Doe" + ], + "mail": [ + "john.doe@example.com" + ], + "objectclass": [ + "person" + ], + "uid": [ + "jdoe" + ], + "userpassword": [ + "jdoe" + ] + } +} \ No newline at end of file diff --git a/modd.conf b/modd.conf index ba23ea7..d5ea49c 100644 --- a/modd.conf +++ b/modd.conf @@ -6,4 +6,4 @@ Makefile { prep: make bin/server prep: [ -e data/server.conf ] || ( mkdir -p data && bin/server -dump-config > data/server.conf ) daemon: bin/server -workdir "./cmd/server" -config ../../data/server.conf -} +} \ No newline at end of file diff --git a/script/release b/script/release new file mode 100755 index 0000000..732c16a --- /dev/null +++ b/script/release @@ -0,0 +1,109 @@ +#!/bin/bash + +set -eo pipefail + +OS_TARGETS=(linux) +ARCH_TARGETS=${ARCH_TARGETS:-amd64 arm 386} + +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )" + +function build { + + local name=$1 + local srcdir=$2 + local os=$3 + local arch=$4 + + local dirname="$name-$os-$arch" + local destdir="$DIR/../release/$dirname" + + rm -rf "$destdir" + mkdir -p "$destdir" + + echo "building $dirname..." + + CGO_ENABLED=0 GOOS="$os" GOARCH="$arch" go build \ + -mod=vendor \ + -ldflags="-s -w" \ + -gcflags=-trimpath="${PWD}" \ + -asmflags=-trimpath="${PWD}" \ + -o "$destdir/$name" \ + "$srcdir" + + if [ ! -z "$(which upx)" ]; then + upx --best "$destdir/$name" + fi + +} + +function copy { + + local name=$1 + local os=$2 + local arch=$3 + local src=$4 + local dest=$5 + + local dirname="$name-$os-$arch" + local destdir="$DIR/../release/$dirname" + + echo "copying '$src' to '$destdir/$dest'..." + + mkdir -p "$(dirname $destdir/$dest)" + + cp -rfL $src "$destdir/$dest" + +} + +function dump_default_conf { + # Generate and copy configuration file + local command=$1 + local os=$2 + local arch=$3 + local tmp_conf=$(mktemp) + + go run "$DIR/../cmd/$command" -dump-config > "$tmp_conf" + copy "$command" $os $arch "$tmp_conf" "$command.conf" + rm -f "$tmp_conf" +} + +function compress { + + local name=$1 + local os=$2 + local arch=$3 + + local dirname="$name-$os-$arch" + local destdir="$DIR/../release/$dirname" + + echo "compressing $dirname..." + tar -czf "$destdir.tar.gz" -C "$destdir/../" "$dirname" +} + +function release_server { + + local os=$1 + local arch=$2 + + build 'server' "$DIR/../cmd/server" $os $arch + + dump_default_conf 'server' $os $arch + + copy 'server' $os $arch "$DIR/../README.md" "README.md" + copy 'server' $os $arch "$DIR/../LICENSE" "LICENSE" + copy 'server' $os $arch "$DIR/../cmd/server/templates" "templates" + copy 'server' $os $arch "$DIR/../cmd/server/public" "public" + + compress 'server' $os $arch + +} + +function main { + for os in ${OS_TARGETS[@]}; do + for arch in ${ARCH_TARGETS[@]}; do + release_server $os $arch + done + done +} + +main \ No newline at end of file