diff --git a/ChangeLog.md b/ChangeLog.md new file mode 100644 --- /dev/null +++ b/ChangeLog.md @@ -0,0 +1,3 @@ +## 0.1.0.0 + +* Initial release diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 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 +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# passman-core + +Generates unique passwords deterministically from a single master password. +A hash of the master password is stored on disk to prevent accidentally +generating a password from a mistyped master password. + +This is the core of passman. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/internal/Passman/Core/Internal/Util.hs b/internal/Passman/Core/Internal/Util.hs new file mode 100644 --- /dev/null +++ b/internal/Passman/Core/Internal/Util.hs @@ -0,0 +1,58 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.Internal.Util +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +module Passman.Core.Internal.Util + ( bytesToInt + , fromBase + , toBase + ) where + +import Numeric.Natural (Natural) + +import Data.ByteString (ByteString, unpack) +import Data.List (foldl', unfoldr) +import Data.Tuple (swap) +import Data.IntCast (intCast) + + +bytesToInt :: ByteString -> Natural +bytesToInt = fromBase 256 . map intCast . unpack + +fromBase :: Natural -> [Natural] -> Natural +fromBase 0 = error "Base 0" +fromBase 1 = error "Base 1" +fromBase base = foldl' (\acc x -> acc * base + x) 0 + +toBase :: Natural -> Natural -> [Natural] +toBase base = reverse . toBaseRev base + +toBaseRev :: Natural -> Natural -> [Natural] +toBaseRev 0 = error "Base 0" +toBaseRev 1 = error "Base 1" +toBaseRev base = unfoldr helper + where + helper :: Natural -> Maybe (Natural, Natural) + helper 0 = Nothing + helper i = Just $ swap $ quotRem i base diff --git a/passman-core.cabal b/passman-core.cabal new file mode 100644 --- /dev/null +++ b/passman-core.cabal @@ -0,0 +1,106 @@ +name: passman-core +version: 0.1.0.0 +synopsis: Deterministic password generator core +description: + Generates unique passwords deterministically from a single master password. + A hash of the master password is stored on disk to prevent accidentally + generating a password from a mistyped master password. + . + This is the core of passman. +homepage: https://github.com/PasswordManager/passman-core#readme +bug-reports: https://github.com/PasswordManager/passman-core/issues +license: GPL-3 +license-file: LICENSE +author: Matthew Harm Bekkema +maintainer: mbekkema97@gmail.com +copyright: 2017 Matthew Harm Bekkema +category: Password +build-type: Simple +extra-source-files: README.md + , ChangeLog.md +cabal-version: >=2.0 +tested-with: GHC >= 8.0.1 && <= 8.2.2 + +library + hs-source-dirs: src + exposed-modules: Passman.Core.Hash + Passman.Core.Mode + Passman.Core.Config + Passman.Core.Config.Lens + Passman.Core.Info + Passman.Core.Entry + Passman.Core.Entry.Lens + ghc-options: -Wall + build-depends: passman-core-internal + , base >= 4.9 && < 4.11 + , aeson >= 0.7 && < 1.3 + , bcrypt ^>= 0.0.10 + , bytestring ^>= 0.10.8.1 + , conduit ^>= 1.2.11 + , conduit-extra >= 1.1.5 && < 1.3 + , containers ^>= 0.5.7.1 + , cryptohash-md5 ^>= 0.11.100.1 + , csv-conduit ^>= 0.6.7 + , data-ordlist ^>= 0.4.7.0 + , directory >= 1.2.3 && < 1.4 + , filepath ^>= 1.4.1.0 + , int-cast ^>= 0.1.2.0 + , memory ^>= 0.14.6 + , resourcet ^>= 1.1.9 + , text ^>= 1.2.2.2 + , unix-compat >= 0.4.3.1 && < 0.6 + , yaml ^>= 0.8.23.3 + default-language: Haskell2010 + other-extensions: GeneralizedNewtypeDeriving + OverloadedStrings + TemplateHaskell + PatternSynonyms + +library passman-core-internal + hs-source-dirs: internal + exposed-modules: Passman.Core.Internal.Util + ghc-options: -Wall + build-depends: base + , bytestring + , int-cast + default-language: Haskell2010 + +test-suite precomputed + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: precomputed.hs + ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N + build-depends: base + , passman-core + , conduit + , text + , yaml + default-language: Haskell2010 + other-extensions: OverloadedStrings + +test-suite properties + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: properties.hs + other-modules: PropertiesTH + ghc-options: -Wall -Wno-orphans -threaded -rtsopts -with-rtsopts=-N + build-depends: base + , passman-core + , passman-core-internal + , conduit + , filepath + , text + + , async ^>= 2.1.0 + , QuickCheck ^>= 2.9.2 + , quickcheck-unicode ^>= 1.0.1.0 + , template-haskell >= 2.11 && < 2.13 + , temporary ^>= 1.2.0.3 + default-language: Haskell2010 + other-extensions: TemplateHaskell + TemplateHaskellQuotes + TupleSections + +source-repository head + type: git + location: https://github.com/PasswordManager/passman-core diff --git a/src/Passman/Core/Config.hs b/src/Passman/Core/Config.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Config.hs @@ -0,0 +1,103 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.Config +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TemplateHaskell #-} + +module Passman.Core.Config + ( -- * Data Structures + Config(..) + -- * File IO + , loadConfig + , saveConfig + ) where + +import Control.Exception (throwIO) + +import Data.Text (Text) +import Data.Yaml (encodeFile, decodeFileEither) +import Data.Aeson.TH (deriveJSON, defaultOptions, omitNothingFields) + +import System.FilePath (()) +import System.Directory (XdgDirectory(XdgConfig), getXdgDirectory, createDirectoryIfMissing) +import System.PosixCompat.Files (fileMode, getFileStatus, setFileMode, intersectFileModes, ownerModes) + + +-- | The persistent configuration of the password manager. +-- +-- Intended to be saved to file in YAML format. This example config file: +-- +-- >masterPasswordHash: "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy" +-- +-- Would be parsed as: +-- +-- >Config { masterPasswordHash = "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy" +-- > , passlistPath = Nothing +-- > } +-- +-- Optionally, the `passlistPath` field can be present as well. This example +-- config file: +-- +-- >masterPasswordHash: "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy" +-- >passlistPath: "/path/to/passlist.txt" +-- +-- Would be parsed as: +-- +-- >Config { masterPasswordHash = "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy" +-- > , passlistPath = Just "/path/to/passlist.txt" +-- > } +data Config = Config { + -- | Hash of the master password generated by + -- `Passman.Core.Hash.hashMasterPassword` + masterPasswordHash :: Text + -- | The path to the last used passlist file + , passlistPath :: Maybe FilePath + } deriving (Show, Eq) + +$(deriveJSON defaultOptions {omitNothingFields = True} ''Config) + +-- | Load a `Config` from file. +loadConfig :: IO Config +loadConfig = configFile >>= decodeFileEither >>= either throwIO pure + +-- | Save the specified `Config` to file, overwriting an existing config file. +saveConfig :: Config -> IO () +saveConfig config = configFile >>= flip encodeFile config + +-- | Create the path leading up to the config file with the correct permissions +-- and return the config filepath. +configFile :: IO FilePath +configFile = do + fp <- getXdgDirectory XdgConfig "passman" + createDirectoryIfMissing False fp + correctPermissions fp + pure $ fp "config.yaml" + +-- | Remove all but the owner's permissions on the specified path. +correctPermissions :: FilePath -> IO () +correctPermissions fp = do + currentMode <- fileMode <$> getFileStatus fp + let newMode = intersectFileModes currentMode ownerModes + setFileMode fp newMode diff --git a/src/Passman/Core/Config/Lens.hs b/src/Passman/Core/Config/Lens.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Config/Lens.hs @@ -0,0 +1,49 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.Config.Lens +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +module Passman.Core.Config.Lens + ( -- * Data Structures + C.Config(Config) + , masterPasswordHash + , passlistPath + -- * File IO + , C.loadConfig + , C.saveConfig + ) where + +import Data.Text (Text) +import qualified Passman.Core.Config as C + + +-- | Hash of the master password generated by +-- `Passman.Core.Hash.hashMasterPassword` +masterPasswordHash :: Functor f => (Text -> f Text) + -> C.Config -> f C.Config +masterPasswordHash f (C.Config a b) = flip C.Config b <$> f a + +-- | The path to the last used passlist file +passlistPath :: Functor f => (Maybe FilePath -> f (Maybe FilePath)) + -> C.Config -> f C.Config +passlistPath f (C.Config a b) = C.Config a <$> f b diff --git a/src/Passman/Core/Entry.hs b/src/Passman/Core/Entry.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Entry.hs @@ -0,0 +1,149 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.PassList +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +{-# LANGUAGE OverloadedStrings #-} + +module Passman.Core.Entry + ( -- * Data structures + Entry (..) + -- * Parsing + , load + , textToEntry + , csvToEntry + -- * Saving + , save + , append + , entryToText + , entryToCsv + ) where + +import Control.Monad.Trans.Resource (MonadResource, MonadThrow, + throwM) +import Control.Monad (mfilter) + +import Data.Conduit (ConduitM, (.|)) +import qualified Data.Conduit.List as C +import Data.Conduit.Binary (sourceFile, sinkFile, sinkIOHandle) +import Data.Conduit.Text (decodeUtf8, encodeUtf8) +import Data.CSV.Conduit (intoCSV, fromCSV, defCSVSettings) + +import Numeric.Natural (Natural) +import Text.Read (readMaybe) + +import Data.Text (Text) +import qualified Data.Text as T + +import System.IO (IOMode (AppendMode), openBinaryFile) + +import Passman.Core.Mode (Mode, readMode, defaultMode, characterCode) +import Passman.Core.Info (Info (Info), fromInfo) + + +-- | Represents an entry in the password list. +-- +-- Password lists are intended to be saved to file in UTF8 CSV format. All +-- fields except for `info` are optional and can be left blank for a default +-- value. +-- +-- This example password list file: +-- +-- >google.com +-- >projecteuler.net,32 +-- >wiki.haskell.org,,nl +-- +-- Would be parsed as: +-- +-- >[ Entry {info = "google.com", maxLength = 0, mode = Mode (ModeN :| [ModeC,ModeL])} +-- >, Entry {info = "projecteuler.net", maxLength = 32, mode = Mode (ModeN :| [ModeC,ModeL])} +-- >, Entry {info = "wiki.haskell.org", maxLength = 0, mode = Mode (ModeN :| [ModeL])} +-- >] +data Entry = Entry + { -- | The info string to generate the password for. + info :: Info + + -- | Maximum length of the generated password or 0 if no maximum length. + , maxLength :: Natural + + -- | The mode to use when generating the password. + , mode :: Mode + } + deriving (Show, Eq) + +-- | Load `Entry`s from the specified file. +load :: MonadResource m => FilePath -> ConduitM i Entry m () +load f = sourceFile f .| decodeUtf8 .| textToEntry + +-- | Convert `Text` into `Entry`s. +textToEntry :: MonadThrow m => ConduitM Text Entry m () +textToEntry = intoCSV defCSVSettings .| C.mapM csvToEntry + +-- | Attempt to convert CSV fields into an `Entry`. +csvToEntry :: MonadThrow m => [Text] -> m Entry +csvToEntry [] = failM "no info column" +csvToEntry [a] = pure $ Entry (Info a) 0 defaultMode +csvToEntry [a,b] = flip (Entry (Info a)) defaultMode <$> parseLength b +csvToEntry [a,b,c] = Entry (Info a) <$> parseLength b <*> parseMode c +csvToEntry _ = failM "too many columns" + +-- | Save `Entry`s to the specified file. +save :: MonadResource m => FilePath -> ConduitM Entry o m () +save f = entryToText .| encodeUtf8 .| sinkFile f + +-- | Append `Entry`s to the specified file. +append :: MonadResource m => FilePath -> ConduitM Entry o m () +append fp = entryToText .| encodeUtf8 .| sinkIOHandle + (openBinaryFile fp AppendMode) + +-- | Convert an `Entry` into `Text` for saving to file. +entryToText :: Monad m => ConduitM Entry Text m () +entryToText = C.map entryToCsv .| fromCSV defCSVSettings + +-- | Convert an `Entry` into CSV fields. +entryToCsv :: Entry -> [Text] +entryToCsv (Entry i l m) = + [ fromInfo i + , if l == 0 then T.empty else T.pack $ show l + , T.pack $ characterCode m + ] + +parseLength :: MonadThrow m => Text -> m Natural +parseLength = parseOrError + (parseWithOrEmpty (mfilter (>0) . readMaybe . T.unpack) 0) + "invalid length" + +parseMode :: MonadThrow m => Text -> m Mode +parseMode = parseOrError (parseWithOrEmpty (readMode . T.unpack) defaultMode) + "invalid mode" + +parseWithOrEmpty :: (Text -> Maybe a) -> a -> Text -> Maybe a +parseWithOrEmpty p d x = if T.null x' then Just d else p x' + where + x' = T.strip x + +parseOrError :: MonadThrow m => (a -> Maybe b) -> String -> a -> m b +parseOrError f err = maybe (failM err) pure . f + +failM :: MonadThrow m => String -> m a +failM = throwM . userError diff --git a/src/Passman/Core/Entry/Lens.hs b/src/Passman/Core/Entry/Lens.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Entry/Lens.hs @@ -0,0 +1,59 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.PassList.Lens +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +module Passman.Core.Entry.Lens + ( -- * Data structures + E.Entry (Entry) + , info + , maxLength + , mode + -- * Parsing + , E.load + , E.textToEntry + , E.csvToEntry + -- * Saving + , E.save + , E.append + , E.entryToText + , E.entryToCsv + ) where + +import Numeric.Natural (Natural) +import Passman.Core.Info (Info) +import Passman.Core.Mode (Mode) +import qualified Passman.Core.Entry as E + + +-- | The info string to generate the password for. +info :: Functor f => (Info -> f Info) -> E.Entry -> f E.Entry +info f (E.Entry a b c) = flip (flip E.Entry b) c <$> f a + +-- | Maximum length of the generated password or 0 if no maximum length. +maxLength :: Functor f => (Natural -> f Natural) -> E.Entry -> f E.Entry +maxLength f (E.Entry a b c) = flip (E.Entry a) c <$> f b + +-- | The mode to use when generating the password. +mode :: Functor f => (Mode -> f Mode) -> E.Entry -> f E.Entry +mode f (E.Entry a b c) = E.Entry a b <$> f c diff --git a/src/Passman/Core/Hash.hs b/src/Passman/Core/Hash.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Hash.hs @@ -0,0 +1,129 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.Hash +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +{-# LANGUAGE OverloadedStrings #-} + +module Passman.Core.Hash + ( -- * Password Generation + generatePassword + -- * Master Password + , MasterPassword + , masterPassword + , fromMasterPassword + -- ** Hashing + , hashMasterPassword + , checkMasterPassword + ) where + +import Numeric.Natural (Natural) + +import Data.ByteString (ByteString) +import qualified Data.ByteString as BS + +import Data.Text (Text) +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8, decodeUtf8) + +import Data.IntCast (intCastMaybe) + +import qualified Crypto.BCrypt as BCrypt +import qualified Crypto.Hash.MD5 as MD5 +import qualified Data.ByteArray.Encoding as BAE + +import Passman.Core.Info (fromInfo) +import Passman.Core.Entry (Entry (Entry)) +import Passman.Core.Mode (toCharset) +import Passman.Core.Internal.Util (toBase, bytesToInt) + + +-- | Represents valid master passwords. +newtype MasterPassword = MP ByteString + deriving Eq + +-- | Turn a `MasterPassword` back into `Text`. +fromMasterPassword :: MasterPassword -> Text +fromMasterPassword (MP bs) = decodeUtf8 bs + +-- | Turn `Text` into a `MasterPassword`. `Nothing` if it contains invalid bytes +-- or is too long. +masterPassword :: Text -> Maybe MasterPassword +masterPassword s = let bs = encodeUtf8 s in + if (BS.length bs > 72) || BS.elem 0 bs + then Nothing + else Just $ MP bs + +shorten :: Natural -> Text -> Text +shorten 0 = id +shorten n = case intCastMaybe n of + Nothing -> shorten 0 + Just n' -> T.take n' + +-- | Deterministically generate a password. +generatePassword :: Entry + -> MasterPassword -- ^ The master password + -> Text -- ^ The generated password +generatePassword (Entry i l m) (MP p) = shorten l $ customDigest (toCharset m) $ + runBCrypt p $ MD5.hash $ encodeUtf8 $ fromInfo i + +runBCrypt :: ByteString -- ^ The password to hash + -> ByteString -- ^ A 16-byte salt + -> ByteString -- ^ The raw BCrypt output (not base64) +runBCrypt passwd salt = case BCrypt.genSalt "$2y$" 12 salt of + Nothing -> error "BCrypt: Invalid salt (needed 16-byte)" + Just salt' -> case BCrypt.hashPassword passwd salt' of + Nothing -> error "BCrypt: Unable to hash password" + Just hash -> either error id $ + BAE.convertFromBase BAE.Base64OpenBSD $ BS.drop 29 hash + +-- | Generate a hash of the `MasterPassword` to be stored in the config. +hashMasterPassword :: MasterPassword -- ^ Master password + -> IO Text -- ^ Hash +hashMasterPassword (MP p) = do + Just salt <- BCrypt.genSaltUsingPolicy BCrypt.slowerBcryptHashingPolicy + {BCrypt.preferredHashCost = 12} + let Just hash = BCrypt.hashPassword p salt + return $ decodeUtf8 hash + +-- | Test if the master password is correct against a hash produced by +-- `hashMasterPassword`. +-- +-- >>> hash <- hashMasterPassword pass +-- >>> checkMasterPassword hash pass +-- True +checkMasterPassword :: Text -- ^ Hash + -> MasterPassword -- ^ Master password + -> Bool +checkMasterPassword hash (MP p) = BCrypt.validatePassword (encodeUtf8 hash) p + +customDigest :: Text -> ByteString -> Text +customDigest charSet cs = T.pack (T.index charSet <$> is) + where + is :: [Int] + is = map fromIntegral $ toBase l (bytesToInt cs) + -- fromIntegral: @toBase l@ returns < @l@ and @l@ fits in `Int` + + l :: Natural + l = fromIntegral $ (T.length charSet :: Int) + -- fromIntegral: @T.length@ returns >= 0 diff --git a/src/Passman/Core/Info.hs b/src/Passman/Core/Info.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Info.hs @@ -0,0 +1,62 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.Info +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE GeneralizedNewtypeDeriving #-} + +module Passman.Core.Info + ( Info (Info) + , fromInfo + ) where + +import Control.Arrow (first) + +import Data.Semigroup (Semigroup) +import Data.Coerce (coerce) +import Data.String (IsString (fromString)) +import Data.Text (Text, strip) + + +-- | Represents an info string to be used in an "Passman.Core.Entry". +newtype Info = MkInfo { -- | Turn an `Info` back into `Text` + fromInfo :: Text + } + deriving (Eq, Ord, Semigroup, Monoid) + +instance Show Info where + showsPrec = coerce (showsPrec :: Int -> Text -> ShowS) + +instance Read Info where + readsPrec i = fmap (first Info) . readsPrec i + +instance IsString Info where + fromString = Info . fromString + +pattern Info :: Text -> Info +pattern Info x <- MkInfo x + where + Info = MkInfo . strip + +{-# COMPLETE Info #-} diff --git a/src/Passman/Core/Mode.hs b/src/Passman/Core/Mode.hs new file mode 100644 --- /dev/null +++ b/src/Passman/Core/Mode.hs @@ -0,0 +1,130 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core +-- +-- passman-core 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. +-- +-- passman-core 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 . + +----------------------------------------------------------------------------- +-- | +-- Module : Passman.Core.Mode +-- Copyright : Matthew Harm Bekkema 2017 +-- License : GPL-3 +-- Maintainer : mbekkema97@gmail.com +----------------------------------------------------------------------------- + +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE PatternSynonyms #-} + +module Passman.Core.Mode + ( -- * Mode + Mode (Mode) + , SingletonMode (..) + -- * Constants + , validModes + , defaultMode + -- * Parsing modes + , characterCode + , readMode + -- * Convert mode to character set + , toCharset + ) where + +import Control.Monad ((<=<)) + +import Data.Coerce (coerce) +import Data.Semigroup (Semigroup ((<>), stimes), stimesIdempotent) +import Data.String (IsString, fromString) +import Data.List (sort, subsequences) +import Data.Maybe (mapMaybe) + +import Data.List.NonEmpty (NonEmpty((:|)), nonEmpty, toList) +import qualified Data.List.NonEmpty as NE + +import qualified Data.List.Ordered as O + + +-- | Represents the sets of characters that generated passwords may contain. +-- Inspired by the mode parameter to [apg](https://linux.die.net/man/1/apg). +newtype Mode = MkMode { fromMode :: NonEmpty SingletonMode } + deriving Eq + +data SingletonMode = ModeS -- ^ Represents special characters, that is: + -- !\"#$%&\'()*+,-./:;\<\=\>?\@[\\]^_\`{|}~ + | ModeN -- ^ Represents numbers + | ModeC -- ^ Represents capital letters + | ModeL -- ^ Represents lowercase letters + deriving (Eq, Ord, Show, Enum, Bounded) + +instance Show Mode where + showsPrec = coerce (showsPrec :: Int -> NonEmpty SingletonMode -> ShowS) + +instance Semigroup Mode where + (Mode x) <> (Mode y) = MkMode $ NE.fromList $ O.union (toList x) (toList y) + stimes = stimesIdempotent + +pattern Mode :: NonEmpty SingletonMode -> Mode +pattern Mode x <- MkMode x + where + Mode = MkMode . NE.fromList . O.nubSort . toList + +{-# COMPLETE Mode #-} + +-- | List of every valid `Mode`. +validModes :: [Mode] +validModes = mapMaybe (fmap Mode . nonEmpty) $ + subsequences [ModeS, ModeN, ModeC, ModeL] + +-- | The combination of `ModeN`, `ModeC` and `ModeL` +defaultMode :: Mode +defaultMode = Mode $ ModeN :| [ModeC, ModeL] + +-- | Turn a mode back into a character code that can be read by `readMode`. +characterCode :: IsString a => Mode -> a +characterCode = fromString . map helper . toList . fromMode + where + helper ModeS = 's' + helper ModeN = 'n' + helper ModeC = 'c' + helper ModeL = 'l' + +-- | Reads a string for the characters: 's', 'n', 'c' or 'l'. Constructs a +-- `Mode` based on those characters where 's' represents `ModeS`, 'n' represents +-- `ModeN`, 'c' represents `ModeC` and 'l' represents `ModeL`. Returns `Nothing` +-- if the string contains invalid characters. Returns `defaultMode` for the +-- empty string. +readMode :: String -> Maybe Mode +readMode = fmap Mode . nonEmpty <=< traverse helper + where + helper :: Char -> Maybe SingletonMode + helper 's' = Just ModeS + helper 'n' = Just ModeN + helper 'c' = Just ModeC + helper 'l' = Just ModeL + helper _ = Nothing + +-- | Get the character set that the specified `Mode` represents +toCharset :: IsString a => Mode -> a +toCharset = fromString . sort . concatMap helper . toList . fromMode + where + helper :: SingletonMode -> String + helper ModeS = symbols + helper ModeN = numbers + helper ModeC = upper + helper ModeL = lower + +lower, upper, numbers, symbols :: String +lower = ['a'..'z'] +upper = ['A'..'Z'] +numbers = ['0'..'9'] +symbols = "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~" diff --git a/test/PropertiesTH.hs b/test/PropertiesTH.hs new file mode 100644 --- /dev/null +++ b/test/PropertiesTH.hs @@ -0,0 +1,39 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core. +-- +-- passman-core 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. +-- +-- passman-core 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 . + +{-# LANGUAGE TemplateHaskellQuotes #-} + +module PropertiesTH + ( ttt + ) where + +import Test.QuickCheck (Testable, Result, Args (maxSuccess, chatty), + quickCheckWithResult, stdArgs) +import Language.Haskell.TH (Q, Name, Exp (AppE, VarE, LitE), + Lit (StringL, IntegerL)) + + +ttt :: Name -> Int -> Q Exp +ttt name len = pure $ (VarE $ 'ttt') `AppE` + (LitE $ StringL $ show name) `AppE` + (LitE $ IntegerL $ fromIntegral len) `AppE` + (VarE name) + +ttt' :: Testable prop => String -> Int -> prop -> (String, IO Result) +ttt' name len prop = (name, quickCheckWithResult myArgs prop) + where + myArgs = stdArgs { maxSuccess = len, chatty = False } diff --git a/test/precomputed.hs b/test/precomputed.hs new file mode 100644 --- /dev/null +++ b/test/precomputed.hs @@ -0,0 +1,96 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core. +-- +-- passman-core 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. +-- +-- passman-core 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 . + +{-# LANGUAGE OverloadedStrings #-} + +import Data.Functor.Identity (Identity (Identity)) + +import Data.Conduit ((.|), yield, sourceToList) +import Data.Conduit.Lift (runCatchC) + +import Data.Maybe (fromJust) +import Data.Yaml (decode) +import qualified Data.Text as T +import Data.Text.Encoding (encodeUtf8) +import Data.List.NonEmpty (NonEmpty ((:|))) + +import Passman.Core.Mode (SingletonMode (..), Mode (Mode), + defaultMode) +import Passman.Core.Hash (generatePassword, masterPassword) +import Passman.Core.Entry (Entry (Entry), textToEntry) +import Passman.Core.Info (Info (Info)) +import Passman.Core.Config (Config (Config)) + + +main :: IO () +main = do + testPrecomputed configExamples + testPrecomputed entryExamples + testPrecomputed hashCompat + +testPrecomputed :: (Foldable f, Eq a, Show a) => f (a, a) -> IO () +testPrecomputed = mapM_ $ \(x, y) -> if x == y then pure () else + fail $ "Test failed, wanted: " ++ show x ++ ", got: " ++ show y + +-- | Ensure the examples in "Passman.Core.Config" are correct. +configExamples :: [(Config, Config)] +configExamples = zip' wanted got + where + got = map (fromJust . decode . encodeUtf8 . T.unlines) + [ ["masterPasswordHash: \"$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy\""] + , ["masterPasswordHash: \"$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy\"" + ,"passlistPath: \"/path/to/passlist.txt\""] + ] + wanted = [ Config "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy" Nothing + , Config "$2y$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy" (Just "/path/to/passlist.txt") + ] + +-- | Ensure the examples in "Passman.Core.Entry" are correct. +entryExamples :: [(Entry, Entry)] +entryExamples = zip' wanted got + where + Identity got = sourceToList $ + runCatchC (yield input .| textToEntry) >>= + either (fail . show) pure + wanted = [ Entry "google.com" 0 $ Mode $ ModeN :| [ModeC,ModeL] + , Entry "projecteuler.net" 32 $ Mode $ ModeN :| [ModeC,ModeL] + , Entry "wiki.haskell.org" 0 $ Mode $ ModeN :| [ModeL] + ] + input = T.unlines [ "google.com" + , "projecteuler.net,32" + , "wiki.haskell.org,,nl" + ] + +-- | Ensure the same passwords are generated in the future +hashCompat = zip' wanted got + where + got = do + site <- [ "google.com" + , "twitter.com" + , "github.com" + , "projecteuler.net" + ] + mode <- map (Mode . pure) [ModeN, ModeC, ModeL, ModeS] ++ [defaultMode] + pass <- ["password", "asdfghjkl;"] + return $ generatePassword (Entry (Info site) 0 mode) $ fromJust $ + masterPassword pass + wanted = ["17810818903316760060773059737533795991133745607244713632","14971578877009723178083623608509425124977824730063617147","BEIGUKMIRVADCGKPJFARIURSWINFVWGGFFZJDCOE","ZMPRZEOLYNLGSKVDMPORLIABGSZQCHNFHTMYCZJ","beigukmirvadcgkpjfariurswinfvwggffzjdcoe","zmprzeolynlgskvdmporliabgszqchnfhtmyczj",",>|\"!_-^,>{;\"@}~~/)(\".+@-)@-({)$\"'$@!","*]>{\"}{.})':;@'+/$&\".)^<={)>^~>)<<:$`","U7m8cqAIOqHoKZSy09DB33v0l1Ikjho","PK20RJ2Bps04UobqaqS20eRBF18IxER","16213550557837790768191330245979107764650558081656003841","4024181751675677039254525579814061978376990589883699557","BBPOVHUMTRJNVZUMQCPKPHCUPXKQNAOPZURCKDCR","GWCPOCUVQKSBVNEZPBCKFCIIBQRAAZUBSBQEYRL","bbpovhumtrjnvzumqcpkphcupxkqnaopzurckdcr","gwcpocuvqksbvnezpbckfciibqraazubsbqeyrl","+=<]\":%~'`&=}\\/^/||?_)}!@}@[`/'{=`()\"","#?!|;{/-=~:`;^}->*|^\"{`!=$[*%!?:|.?,&","RQH2ZyxOKG0AlgbrPzOxxwE5LUwosL3","6o0Mw8O0uwOgDPnW7N2eIFRJsDTUrUD","22987601634120402559542468265169167564948676216524901239","8353733280890735007293224669721856622313099986997974732","BNDJRMODRDBMSQVQVIDBKDVFPBPDFGCOQOXKONEL","OFSPDTEPACOLGNAELKQNKCMVNQILPNQNVNTGIGQ","bndjrmodrdbmsqvqvidbkdvfpbpdfgcoqoxkonel","ofspdtepacolgnaelkqnkcmvnqilpnqnvntgigq",":!!$>*_'/?&^^_[@>{]*#_;[/~~_!%/)))#`\\","&/.{;))}),$*^\\*&+^#,[#@*};##>@|+=>&[-","cseTPcHeM3fP3a4sXuDMqPx6uT1IKsp","E82BiPtvSYeIwF2kgxwEbt6iFDhMlrQ","15823457199654189728019009138314459330131805865815516925","23809039512397779922479254294240900352779187010885878014","BAYHYMMBPBPQXOACZSSLUXRJNGOYAFEASJYOIZFX","BONSXHELIEYAUPYXVYJWUVZCQOIGWORUQGRJJWWS","bayhymmbpbpqxoaczssluxrjngoyafeasjyoizfx","bonsxhelieyaupyxvyjwuvzcqoigworuqgrjjwws","++.$!]<#}@&\\,\"?\\}=[*^*&^:`+:~,|';/*\\|",":<%~@|%{,'_%-*%?|*#}\\\"#[\"*)/>$${\\(!(}","QlMjkg1KjUzNRpg1WkDKSndPnzyMrKX","eGnHr1DIalnw12J08mvJThB4afy1iyk"] + +zip' :: [a] -> [b] -> [(a, b)] +zip' [] [] = [] +zip' (x:xs) (y:ys) = (x, y) : zip' xs ys +zip' _ _ = error "zip': length mismatch" diff --git a/test/properties.hs b/test/properties.hs new file mode 100644 --- /dev/null +++ b/test/properties.hs @@ -0,0 +1,169 @@ +-- Copyright (C) 2017 Matthew Harm Bekkema +-- +-- This file is part of passman-core. +-- +-- passman-core 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. +-- +-- passman-core 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 . + +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE TupleSections #-} + +import Numeric.Natural (Natural) + +import Control.Concurrent.Async (Concurrently (Concurrently), + runConcurrently) + +import Data.Semigroup ((<>)) +import Data.Functor.Compose (Compose (Compose), getCompose) +import Data.Functor.Identity (Identity (Identity)) +import Data.Foldable (for_) +import Data.Traversable (for) +import Data.Maybe (fromJust, isJust) +import qualified Data.Text as T + +import Data.Conduit ((.|), sourceToList, runConduitRes) +import Data.Conduit.List (sourceList, consume) +import Data.Conduit.Lift (runCatchC) + +import System.IO.Temp (withSystemTempDirectory) +import System.FilePath (()) +import System.Exit (exitFailure) + +import Test.QuickCheck (Arbitrary (arbitrary, shrink), Gen, + Result, Property, suchThat, + arbitraryBoundedEnum) +import Test.QuickCheck.Monadic (PropertyM, assert, run, monadicIO, + pre) +import Test.QuickCheck.Test (isSuccess, output) +import qualified Test.QuickCheck.Unicode as U + +import Passman.Core.Mode (SingletonMode, Mode (Mode), validModes, + readMode, characterCode) +import Passman.Core.Info (Info (Info), fromInfo) +import Passman.Core.Entry (Entry (Entry), entryToText, textToEntry, + save, append, load) +import Passman.Core.Hash (MasterPassword, masterPassword, + fromMasterPassword, checkMasterPassword, + hashMasterPassword) + +import Passman.Core.Internal.Util (fromBase, toBase) + +import PropertiesTH (ttt) + + +instance Arbitrary SingletonMode where + arbitrary = arbitraryBoundedEnum + +instance Arbitrary Mode where + arbitrary = Mode <$> arbitrary + +instance Arbitrary Info where + arbitrary = Info . T.pack <$> U.string + shrink = map (Info . T.pack) . shrink . T.unpack . fromInfo + +instance Arbitrary Entry where + arbitrary = Entry <$> arbitrary <*> arbitrary <*> arbitrary + +instance Show MasterPassword where + showsPrec i = showsPrec i . fromMasterPassword + +instance Arbitrary MasterPassword where + arbitrary = suchThatMap masterPassword (T.pack <$> U.string) + +main :: IO () +main = runTests [ $(ttt 'prop_hashMasterPassword 10) + , $(ttt 'prop_modesValid 100) + , $(ttt 'prop_showReadMode 100) + , $(ttt 'prop_semigroupMode 100) + , $(ttt 'prop_idempotentMode 100) + , $(ttt 'prop_showReadEntry 100) + , $(ttt 'prop_saveAppendLoadEntry 100) + , $(ttt 'prop_toFromBase 100) + , $(ttt 'prop_toBase10 100) + ] + +prop_hashMasterPassword :: MasterPassword -> MasterPassword -> Property +prop_hashMasterPassword x y = monadicIO $ do + pre (x /= y) + hashX <- run $ hashMasterPassword x + hashY <- run $ hashMasterPassword y + let info = "x = " ++ show x ++ ", y = " ++ show y ++ ", hashX = " ++ show hashX ++ ", hashY = " ++ show hashY ++ "." + assertM ("(checkMasterPassword hashX x) failed, where: " ++ info) $ checkMasterPassword hashX x + assertM ("(checkMasterPassword hashY y) failed, where: " ++ info) $ checkMasterPassword hashY y + assertM ("(not $ checkMasterPassword hashX y) failed, where: " ++ info) $ not $ checkMasterPassword hashX y + assertM ("(not $ checkMasterPassword hashY x) failed, where: " ++ info) $ not $ checkMasterPassword hashY x + +prop_modesValid :: Mode -> Bool +prop_modesValid m = m `elem` validModes + +prop_showReadMode :: Bool +prop_showReadMode = and $ do + x <- validModes + return (readMode (characterCode x) == Just x) + +prop_semigroupMode :: Bool +prop_semigroupMode = and $ do + x <- validModes + y <- validModes + z <- validModes + return ((x <> y) <> z == x <> (y <> z)) + +prop_idempotentMode :: Bool +prop_idempotentMode = and $ do + x <- validModes + return (x == (x <> x)) + +prop_showReadEntry :: [Entry] -> Bool +prop_showReadEntry xs = xs == xs' + where + Identity xs' = sourceToList (sourceList xs .| entryToText .| textToEntry') + textToEntry' = runCatchC textToEntry >>= either (fail . show) pure + +prop_saveAppendLoadEntry :: [Entry] -> [Entry] -> Property +prop_saveAppendLoadEntry xs ys = monadicIO $ do + zs <- run $ withSystemTempDirectory "passman-testcase" $ \dir -> do + let fp = dir "list.txt" + runConduitRes $ sourceList xs .| save fp + runConduitRes $ sourceList ys .| append fp + runConduitRes $ load fp .| consume + assert $ (xs ++ ys) == zs + +prop_toFromBase :: Natural -> Natural -> Bool +prop_toFromBase b k = fromBase (b + 2) (toBase (b + 2) k) == k + +prop_toBase10 :: Natural -> Bool +prop_toBase10 0 = null $ toBase 10 0 +prop_toBase10 k = toBase 10 k == map (read . pure) (show k) + +assertM :: Monad m => String -> Bool -> PropertyM m () +assertM _ True = return () +assertM x False = fail x + +suchThatMap :: (a -> Maybe b) -> Gen a -> Gen b +suchThatMap f gen = fromJust <$> fmap f gen `suchThat` isJust + +runTests :: Traversable f => f (String, IO Result) -> IO () +runTests tests = do + results <- runConcurrently $ for tests $ \(name, prop) -> Concurrently $ + (name,) <$> prop + + allResult <- getCompose $ for_ results $ \(name, result) -> Compose $ do + putStr $ name + putStr $ ": " + putStr $ output result + pure $ if isSuccess result then Just () + else Nothing + + case allResult of + Nothing -> exitFailure + Just () -> pure ()