commit b70ca7fb9e6412124ae9f44a06b6340a24349b49 Author: Akis Kesoglou Date: Tue Feb 20 11:20:12 2018 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0bc9c18 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.DS_Store +.project +.vagrant/ +config/ +src/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..26110c9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# Change Log + +All notable changes to this project will be documented in this file +automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY! +This project adheres to [Semantic Versioning](http://semver.org/). + +## v0.0.1 - 2018-02-20 + +* Initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dbbe355 --- /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 +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..725f06f --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +.PHONY: lint + +lint: + shellcheck scripts/* diff --git a/README.md b/README.md new file mode 100644 index 0000000..79af3b9 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ + +## Host requirements + +- Docker >= 18.05.0 +- Docker Compose >= 1.11 +- OpenSSL >= 1.0.0 +- Python >= 2.7 or >=3.4 + +## Installation + +Make sure you have the software listed above installed. + +In a terminal, clone the project with: + + $ git clone https://github.com/balena-io/open-balena.git + +Change into the `open-balena` directory and run the configuration script. +This will create a new directory, `config`, and generate appropriate SSL +certificates and configuration for the instance. + + $ ./scripts/quickstart + +You may optionally configure the instance to run under a custom domain name. +The default is `openbalena.local`. For example: + + $ ./scripts/quickstart -d mydomain.com + +For more available options, see the script's help: + + $ ./scripts/quickstart -h + +Start the instance with: + + $ ./scripts/compose up -d + +Stop the instance with: + + $ ./scripts/compose stop + +To remove all traces of the instance, run the following commands and finally +delete the configuration folder. + +**WARNING**: This will remove *all* data. + + $ ./scripts/compose kill + $ ./scripts/compose down + $ docker volume rm openbalena_s3 openbalena_redis openbalena_db openbalena_registry + +### macOS & Windows + +On macOS and Windows you need Vagrant. `open-balena` is not being tested with +docker-machine. `open-balena` comes with an appropriate `Vagrantfile` for +setting up the VM, installing dependencies and starting the platform. + +- Install Vagrant >= 2.0 +- `$ vagrant plugin install vagrant-docker-compose` +- `$ vagrant up` + +When provisioning completes and the VM has started, `open-balena` services +should be running inside the VM. You will need to expose these services to +the outside in order for them to be reachable by devices. To do so, you must +setup DNS for the domain name you've deployed the instance as to point to the +VM's IP address. diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 0000000..d1ff12b --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,28 @@ +Vagrant.require_version '>= 2.0.0' + +[ 'vagrant-vbguest', 'vagrant-docker-compose' ].each do |p| + unless Vagrant.has_plugin?(p) + raise "Please install missing plugin: vagrant plugin install #{p}" + end +end + +Vagrant.configure('2') do |config| + config.vm.define 'openbalenavm' + config.vm.box = 'bento/ubuntu-16.04' + config.vm.box_url = 'https://vagrantcloud.com/bento/boxes/ubuntu-16.04/versions/201808.24.0/providers/virtualbox.box' + + config.vm.synced_folder '.', '/vagrant', disabled: true + config.vm.synced_folder '.', '/home/vagrant/open-balena' + config.vm.network 'public_network', bridge: ENV.fetch('OPENBALENA_BRIDGE', '') + + config.ssh.forward_agent = true + + config.vm.provision :docker + config.vm.provision :docker_compose + + # FIXME: remove node + config.vm.provision :shell, inline: 'apt-get update && apt-get install -y nodejs && rm -rf /var/lib/apt/lists/*' + + config.vm.provision :shell, privileged: false, + inline: "cd /home/vagrant/open-balena && ./scripts/quickstart -p -d #{ENV.fetch('OPENBALENA_DOMAIN', 'openbalena.local')}" +end diff --git a/compose/common.yml b/compose/common.yml new file mode 100644 index 0000000..ac95267 --- /dev/null +++ b/compose/common.yml @@ -0,0 +1,17 @@ +version: '2.1' + +services: + component: + cap_add: + - SYS_ADMIN + - SYS_RESOURCE + environment: + - CONFD_BACKEND=ENV + tmpfs: + - /run + - /sys/fs/cgroup + privileged: true + + system: + security_opt: + - seccomp:unconfined diff --git a/compose/services.yml b/compose/services.yml new file mode 100644 index 0000000..45470a3 --- /dev/null +++ b/compose/services.yml @@ -0,0 +1,157 @@ +version: '2.1' + +volumes: + db: + registry: + s3: + redis: + +services: + api: + extends: + file: ./common.yml + service: component + image: balena/open-balena-api:${OPENBALENA_API_VERSION_TAG:-master} + depends_on: + - db + - s3 + - redis + environment: + API_VPN_SERVICE_API_KEY: ${OPENBALENA_API_VPN_SERVICE_API_KEY} + BALENA_ROOT_CA: ${OPENBALENA_ROOT_CA} + COOKIE_SESSION_SECRET: ${OPENBALENA_COOKIE_SESSION_SECRET} + DB_HOST: db.${OPENBALENA_HOST_NAME} + DB_PASSWORD: docker + DB_PORT: 5432 + DB_USER: docker + DELTA_HOST: delta.${OPENBALENA_HOST_NAME} + HOST: api.${OPENBALENA_HOST_NAME} + IMAGE_MAKER_URL: img.${OPENBALENA_HOST_NAME} + IMAGE_STORAGE_BUCKET: resin-production-img-cloudformation + IMAGE_STORAGE_PREFIX: resinos + IMAGE_STORAGE_ENDPOINT: s3.amazonaws.com + JSON_WEB_TOKEN_EXPIRY_MINUTES: 10080 + JSON_WEB_TOKEN_SECRET: ${OPENBALENA_JWT_SECRET} + MIXPANEL_TOKEN: __unused__ + PRODUCTION_MODE: '${OPENBALENA_PRODUCTION_MODE}' + PUBNUB_PUBLISH_KEY: __unused__ + PUBNUB_SUBSCRIBE_KEY: __unused__ + REDIS_HOST: redis.${OPENBALENA_HOST_NAME} + REDIS_PORT: 6379 + REGISTRY2_HOST: registry.${OPENBALENA_HOST_NAME} + REGISTRY_HOST: registry.${OPENBALENA_HOST_NAME} + SENTRY_DSN: + TOKEN_AUTH_BUILDER_TOKEN: ${OPENBALENA_TOKEN_AUTH_BUILDER_TOKEN} + TOKEN_AUTH_CERT_ISSUER: api.${OPENBALENA_HOST_NAME} + TOKEN_AUTH_CERT_KEY: ${OPENBALENA_TOKEN_AUTH_KEY} + TOKEN_AUTH_CERT_KID: ${OPENBALENA_TOKEN_AUTH_KID} + TOKEN_AUTH_CERT_PUB: ${OPENBALENA_TOKEN_AUTH_PUB} + TOKEN_AUTH_JWT_ALGO: 'ES256' + VPN_HOST: vpn.${OPENBALENA_HOST_NAME} + VPN_PORT: 443 + VPN_SERVICE_API_KEY: ${OPENBALENA_VPN_SERVICE_API_KEY} + + registry: + extends: + file: ./common.yml + service: component + image: balena/open-balena-registry:${OPENBALENA_REGISTRY_VERSION_TAG:-master} + depends_on: + - api + - s3 + - redis + volumes: + - registry:/data + environment: + API_TOKENAUTH_CRT: ${OPENBALENA_TOKEN_AUTH_PUB} + BALENA_REGISTRY2_HOST: registry.${OPENBALENA_HOST_NAME} + BALENA_ROOT_CA: ${OPENBALENA_ROOT_CA} + BALENA_TOKEN_AUTH_ISSUER: api.${OPENBALENA_HOST_NAME} + BALENA_TOKEN_AUTH_REALM: https://api.${OPENBALENA_HOST_NAME}/auth/v1/token + COMMON_REGION: + REGISTRY2_S3_BUCKET: + REGISTRY2_S3_KEY: + REGISTRY2_S3_SECRET: + REGISTRY2_SECRETKEY: ${OPENBALENA_REGISTRY_SECRET_KEY} + REGISTRY2_STORAGEPATH: /data + + vpn: + extends: + file: ./common.yml + service: component + image: balena/open-balena-vpn:${OPENBALENA_VPN_VERSION_TAG:-master} + depends_on: + - api + cap_add: + - NET_ADMIN + environment: + API_SERVICE_API_KEY: ${OPENBALENA_API_VPN_SERVICE_API_KEY} + BALENA_API_HOST: api.${OPENBALENA_HOST_NAME} + BALENA_ROOT_CA: ${OPENBALENA_ROOT_CA} + BALENA_VPN_PORT: 443 + PRODUCTION_MODE: '${OPENBALENA_PRODUCTION_MODE}' + RESIN_VPN_GATEWAY: 10.2.0.1 + SENTRY_DSN: + VPN_HAPROXY_USEPROXYPROTOCOL: 'true' + VPN_OPENVPN_CA_CRT: ${OPENBALENA_VPN_CA} + VPN_OPENVPN_SERVER_CRT: ${OPENBALENA_VPN_SERVER_CRT} + VPN_OPENVPN_SERVER_DH: ${OPENBALENA_VPN_SERVER_DH} + VPN_OPENVPN_SERVER_KEY: ${OPENBALENA_VPN_SERVER_KEY} + VPN_SERVICE_API_KEY: ${OPENBALENA_VPN_SERVICE_API_KEY} + + db: + extends: + file: ./common.yml + service: system + image: balena/open-balena-db:${OPENBALENA_DB_VERSION_TAG:-master} + volumes: + - db:/var/lib/postgresql/data + + s3: + extends: + file: ./common.yml + service: system + image: balena/open-balena-s3:${OPENBALENA_S3_VERSION_TAG:-master} + volumes: + - s3:/export + + redis: + extends: + file: ./common.yml + service: system + image: redis:alpine + volumes: + - redis:/data + + haproxy: + extends: + file: ./common.yml + service: system + build: ../haproxy + depends_on: + - api + - registry + - vpn + - db + - s3 + - redis + ports: + - "80:80" + - "222:222" + - "443:443" + - "5432:5432" + - "6379:6379" + networks: + default: + aliases: + - api.${OPENBALENA_HOST_NAME} + - registry.${OPENBALENA_HOST_NAME} + - vpn.${OPENBALENA_HOST_NAME} + - db.${OPENBALENA_HOST_NAME} + - s3.${OPENBALENA_HOST_NAME} + - redis.${OPENBALENA_HOST_NAME} + environment: + BALENA_HAPROXY_CRT: ${OPENBALENA_ROOT_CRT} + BALENA_HAPROXY_KEY: ${OPENBALENA_ROOT_KEY} + BALENA_ROOT_CA: ${OPENBALENA_ROOT_CA} + HAPROXY_HOSTNAME: ${OPENBALENA_HOST_NAME} diff --git a/compose/template.yml b/compose/template.yml new file mode 100644 index 0000000..9092271 --- /dev/null +++ b/compose/template.yml @@ -0,0 +1,10 @@ +# Project-specific config. +# +# All paths must be defined relative to `compose/services.yml` regardless of +# the location of this file, i.e. refer to `my-open-balena-checkout/somedir` +# as `../somedir`. This is because of the way docker-compose handles paths +# when specifying multiple configs and open-balena always specifying +# `compose/services.yml` as the "base" config. +# +# You may view the effective config with `scripts/compose config`. +version: '2.1' diff --git a/haproxy/Dockerfile b/haproxy/Dockerfile new file mode 100644 index 0000000..3416c32 --- /dev/null +++ b/haproxy/Dockerfile @@ -0,0 +1,6 @@ +FROM haproxy:1.8-alpine + +COPY haproxy.cfg /usr/local/etc/haproxy/haproxy.cfg +COPY entry.sh /open-balena-entry + +CMD /open-balena-entry diff --git a/haproxy/entry.sh b/haproxy/entry.sh new file mode 100755 index 0000000..b89e333 --- /dev/null +++ b/haproxy/entry.sh @@ -0,0 +1,11 @@ +#!/bin/sh +set -e + +HAPROXY_CHAIN=/etc/ssl/private/open-balena.pem +mkdir -p "$(dirname "${HAPROXY_CHAIN}")" +( + echo "${BALENA_HAPROXY_CRT}" | base64 -d + echo "${BALENA_HAPROXY_KEY}" | base64 -d + echo "${BALENA_ROOT_CA}" | base64 -d +) > "${HAPROXY_CHAIN}" +exec haproxy -f /usr/local/etc/haproxy/haproxy.cfg \ No newline at end of file diff --git a/haproxy/haproxy.cfg b/haproxy/haproxy.cfg new file mode 100644 index 0000000..ff2af6a --- /dev/null +++ b/haproxy/haproxy.cfg @@ -0,0 +1,105 @@ +global + tune.ssl.default-dh-param 1024 + +defaults + timeout connect 5000 + timeout client 50000 + timeout server 50000 + +frontend http-in + mode http + option forwardfor + bind *:80 + reqadd X-Forwarded-Proto:\ http + + acl host_api hdr_dom(host) -i "api.${HAPROXY_HOSTNAME}" + use_backend backend_api if host_api + + acl host_registry hdr_dom(host) -i "registry.${HAPROXY_HOSTNAME}" + use_backend backend_registry if host_registry + + acl host_vpn hdr_dom(host) -i "vpn.${HAPROXY_HOSTNAME}" + use_backend backend_vpn if host_vpn + + acl host_s3 hdr_dom(host) -i "s3.${HAPROXY_HOSTNAME}" + use_backend backend_s3 if host_s3 + +frontend ssl-in + mode tcp + bind *:443 + tcp-request inspect-delay 2s + tcp-request content accept if { req.ssl_hello_type 1 } + + acl is_ssl req.ssl_ver 2:3.4 + use_backend redirect-to-https-in if is_ssl + use_backend vpn-devices if !is_ssl + +backend redirect-to-https-in + mode tcp + balance roundrobin + server localhost 127.0.0.1:444 send-proxy-v2 + +frontend https-in + mode http + option forwardfor + bind 127.0.0.1:444 ssl crt /etc/ssl/private/open-balena.pem accept-proxy + reqadd X-Forwarded-Proto:\ https + + acl host_api hdr_dom(host) -i "api.${HAPROXY_HOSTNAME}" + use_backend backend_api if host_api + + acl host_registry hdr_dom(host) -i "registry.${HAPROXY_HOSTNAME}" + use_backend backend_registry if host_registry + + acl host_vpn hdr_dom(host) -i "vpn.${HAPROXY_HOSTNAME}" + use_backend backend_vpn if host_vpn + + acl host_s3 hdr_dom(host) -i "s3.${HAPROXY_HOSTNAME}" + use_backend backend_s3 if host_s3 + +backend backend_api + mode http + option forwardfor + balance roundrobin + server resin_api_1 api:80 check port 80 + +backend backend_registry + mode http + option forwardfor + balance roundrobin + server resin_registry_1 registry:80 check port 80 + +backend backend_vpn + mode http + option forwardfor + balance roundrobin + server resin_vpn_1 vpn:80 check port 80 + +backend backend_s3 + mode http + option forwardfor + balance roundrobin + +backend vpn-devices + mode tcp + server resin_vpn_1 vpn:443 send-proxy-v2 check-send-proxy port 443 + +frontend db + mode tcp + bind *:5432 + default_backend backend_db + timeout client 1h + +backend backend_db + mode tcp + server resin_db_1 db:5432 check port 5432 + +frontend redis + mode tcp + bind *:6379 + default_backend backend_redis + timeout client 1h + +backend backend_redis + mode tcp + server resin_redis_1 redis:6379 check port 6379 diff --git a/scripts/_keyid.js b/scripts/_keyid.js new file mode 100644 index 0000000..201d334 --- /dev/null +++ b/scripts/_keyid.js @@ -0,0 +1,79 @@ +'use strict'; + +var crypto = require('crypto'); +var fs = require('fs'); + +var base32 = (function() { + // Extracted from https://github.com/chrisumbel/thirty-two + // to avoid having to install packages for this script. + var charTable = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"; + var byteTable = [ + 0xff, 0xff, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, + 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, + 0xff, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, + 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, + 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, + 0x17, 0x18, 0x19, 0xff, 0xff, 0xff, 0xff, 0xff, + 0xff, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, + 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, + 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, + 0x17, 0x18, 0x19, 0xff, 0xff, 0xff, 0xff, 0xff + ]; + + function quintetCount(buff) { + var quintets = Math.floor(buff.length / 5); + return buff.length % 5 == 0 ? quintets: quintets + 1; + } + + return function(plain) { + if (!Buffer.isBuffer(plain)) { + plain = new Buffer(plain); + } + var i = 0; + var j = 0; + var shiftIndex = 0; + var digit = 0; + var encoded = new Buffer(quintetCount(plain) * 8); + + /* byte by byte isn't as pretty as quintet by quintet but tests a bit + faster. will have to revisit. */ + while(i < plain.length) { + var current = plain[i]; + + if(shiftIndex > 3) { + digit = current & (0xff >> shiftIndex); + shiftIndex = (shiftIndex + 5) % 8; + digit = (digit << shiftIndex) | ((i + 1 < plain.length) ? + plain[i + 1] : 0) >> (8 - shiftIndex); + i++; + } else { + digit = (current >> (8 - (shiftIndex + 5))) & 0x1f; + shiftIndex = (shiftIndex + 5) % 8; + if(shiftIndex == 0) i++; + } + + encoded[j] = charTable.charCodeAt(digit); + j++; + } + + for (i = j; i < encoded.length; i++) { + encoded[i] = 0x3d; //'='.charCodeAt(0) + } + return encoded; + } +})(); + +function joseKeyId(der) { + var hasher = crypto.createHash('sha256'); + hasher.update(der); + var b32 = base32(hasher.digest().slice(0, 30)).toString('ascii'); + var chunks = []; + for (var i = 0; i < b32.length; i += 4) { + chunks.push(b32.substr(i, 4)); + } + return chunks.join(':'); +} + +var derFilePath = process.argv[2]; +var der = fs.readFileSync(derFilePath); +process.stdout.write(joseKeyId(der)); diff --git a/scripts/compose b/scripts/compose new file mode 100755 index 0000000..9286ace --- /dev/null +++ b/scripts/compose @@ -0,0 +1,24 @@ +#!/bin/bash -e + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" +BASE_DIR="$(dirname "${DIR}")" +CONFIG_DIR="${BASE_DIR}/config" + +echo_bold() { + printf "\\033[1m%s\\033[0m\\n" "$@" +} + +ENV_FILE="${CONFIG_DIR}/activate" +if [ ! -f "$ENV_FILE" ]; then + echo_bold 'No configuration found; please create one first with: ./scripts/quickstart' + echo_bold 'See README.md for help.' + exit 1 +fi + +# shellcheck source=/dev/null +source "${ENV_FILE}"; docker-compose \ + --project-name 'openbalena' \ + -f "${BASE_DIR}/compose/services.yml" \ + -f "${CONFIG_DIR}/docker-compose.yml" \ + "$@" diff --git a/scripts/create-superuser b/scripts/create-superuser new file mode 100755 index 0000000..34d379a --- /dev/null +++ b/scripts/create-superuser @@ -0,0 +1,34 @@ +#!/bin/bash -e + +usage() { + echo "usage: $0 EMAIL PASSWORD" + echo + echo 'Create the superuser account with the given email and password.' + echo + echo 'The instance must already be running in the background. You can ' + echo 'start it with: ./scripts/compose up -d' +} + +if [[ -z "$1" || -z "$2" ]]; then + usage + exit 1 +fi + +echo_bold() { + printf "\\033[1m%s\\033[0m\\n" "${@}" +} + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" +FIG="${DIR}/compose" + +EMAIL="$1" +PASSWORD="$2" + +"${FIG}" exec api /bin/bash -c \ + 'export $(grep -v "^#" config/env | xargs -d "\n"); node index.js create-superuser root '${EMAIL}' '${PASSWORD}'' \ + >/dev/null \ + || (echo 'Failed to create superuser; please ensure the instance is running and that no superuser has been created before.' && exit 1) + +echo_bold "==> Success! Superuser created with email: ${EMAIL}" +echo " - You may now login with: balena login --credentials --email ${EMAIL}" diff --git a/scripts/gen-root-ca b/scripts/gen-root-ca new file mode 100755 index 0000000..e6e2aa5 --- /dev/null +++ b/scripts/gen-root-ca @@ -0,0 +1,33 @@ +#!/bin/bash -e + +usage() { + echo "usage: $0 COMMON_NAME [OUT]" + echo + echo " COMMON_NAME the domain name the certificate is valid for, eg. example.com" + echo " OUT path to output directory generated files will be placed in" + echo +} + +if [ -z "$1" ]; then + usage + exit 1 +fi + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" + +CN="$1" +OUT="$(realpath "${2:-.}")" + +# shellcheck source=scripts/ssl-common.sh +source "${DIR}/ssl-common.sh" + +# Create a secret key and CA file for the self-signed CA +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" init-pki 2>/dev/null +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" --days="${CA_EXPIRY_DAYS}" --req-cn="ca.${CN}" build-ca nopass 2>/dev/null +ROOT_CA="${ROOT_PKI}/ca.crt" +echo "ROOT_CA=${ROOT_CA//$OUT/\$OUT}" + +# update indexes and generate CRLs +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" update-db 2>/dev/null +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" gen-crl 2>/dev/null diff --git a/scripts/gen-root-cert b/scripts/gen-root-cert new file mode 100755 index 0000000..0673a9e --- /dev/null +++ b/scripts/gen-root-cert @@ -0,0 +1,34 @@ +#!/bin/bash -e + +usage() { + echo "usage: $0 COMMON_NAME [OUT]" + echo + echo " COMMON_NAME the domain name the certificate is valid for, eg. example.com" + echo " OUT path to output directory generated files will be placed in" + echo +} + +if [ -z "$1" ]; then + usage + exit 1 +fi + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" + +CN="$1" +OUT="$(realpath "${2:-.}")" + +# shellcheck source=scripts/ssl-common.sh +source "${DIR}/ssl-common.sh" + +# generate default CSR and sign (root + wildcard) +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" --days="${CRT_EXPIRY_DAYS}" --subject-alt-name="DNS:*.${CN}" build-server-full "*.${CN}" nopass 2>/dev/null +ROOT_CRT="${ROOT_PKI}"'/issued/*.'"${CN}"'.crt' +ROOT_KEY="${ROOT_PKI}"'/private/*.'"${CN}"'.key' +echo "ROOT_CRT=${ROOT_CRT//$OUT/\$OUT}" +echo "ROOT_KEY=${ROOT_KEY//$OUT/\$OUT}" + +# update indexes and generate CRLs +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" update-db 2>/dev/null +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" gen-crl 2>/dev/null diff --git a/scripts/gen-token-auth-cert b/scripts/gen-token-auth-cert new file mode 100755 index 0000000..324ab17 --- /dev/null +++ b/scripts/gen-token-auth-cert @@ -0,0 +1,45 @@ +#!/bin/bash -e + +usage() { + echo "usage: $0 COMMON_NAME [OUT]" + echo + echo " COMMON_NAME the domain name the certificate is valid for, eg. example.com" + echo " OUT path to output directory generated files will be placed in" + echo +} + +if [ -z "$1" ]; then + usage + exit 1 +fi + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" + +CN="$1" +OUT="$(realpath "${2:-.}")" + +# shellcheck source=scripts/ssl-common.sh +source "${DIR}/ssl-common.sh" + +CERT_DIR="${OUT}/api" +CERT_FILE="${CERT_DIR}/api.${CN}" + +keyid() { + nodejs "${DIR}/_keyid.js" "$1" +} + +JWT_CRT="${CERT_FILE}.crt" +JWT_KEY="${CERT_FILE}.pem" +JWT_KID="${CERT_FILE}.kid" + +mkdir -p "${CERT_DIR}" +openssl ecparam -name prime256v1 -genkey -noout -out "${JWT_KEY}" 2>/dev/null +openssl req -x509 -new -nodes -days "${CRT_EXPIRY_DAYS}" -key "${JWT_KEY}" -subj "/CN=api.${CN}" -out "${JWT_CRT}" 2>/dev/null +openssl ec -in "${JWT_KEY}" -pubout -outform DER -out "${CERT_FILE}.der" 2>/dev/null +keyid "${CERT_FILE}.der" >"${JWT_KID}" 2>/dev/null +rm "${CERT_FILE}.der" + +echo "JWT_CRT=${JWT_CRT//$OUT/\$OUT}" +echo "JWT_KEY=${JWT_KEY//$OUT/\$OUT}" +echo "JWT_KID=${JWT_KID//$OUT/\$OUT}" diff --git a/scripts/gen-vpn-certs b/scripts/gen-vpn-certs new file mode 100755 index 0000000..4cd4ab6 --- /dev/null +++ b/scripts/gen-vpn-certs @@ -0,0 +1,53 @@ +#!/bin/bash -e + +usage() { + echo "usage: $0 COMMON_NAME [OUT]" + echo + echo " COMMON_NAME the domain name the certificate is valid for, eg. example.com" + echo " OUT path to output directory generated files will be placed in" + echo +} + +if [ -z "$1" ]; then + usage + exit 1 +fi + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" + +CN="$1" +OUT="$(realpath "${2:-.}")" + +# shellcheck source=scripts/ssl-common.sh +source "${DIR}/ssl-common.sh" +VPN_PKI="$(realpath "${OUT}/vpn")" + +# generate VPN sub-CA +"$easyrsa_bin" --pki-dir="${VPN_PKI}" init-pki 2>/dev/null +"$easyrsa_bin" --pki-dir="${VPN_PKI}" --days="${CA_EXPIRY_DAYS}" --req-cn="vpn-ca.${CN}" build-ca nopass subca 2>/dev/null + +# import sub-CA CSR into root PKI, sign, and copy back to vpn PKI +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" import-req "${VPN_PKI}/reqs/ca.req" "vpn-ca" 2>/dev/null +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" sign-req ca "vpn-ca" 2>/dev/null +cp "${ROOT_PKI}/issued/vpn-ca.crt" "${VPN_PKI}/ca.crt" +VPN_CA="${VPN_PKI}/ca.crt" +echo "VPN_CA=${VPN_CA//$OUT/\$OUT}" + +# generate and sign vpn server certificate +"$easyrsa_bin" --pki-dir="${VPN_PKI}" --days="${CRT_EXPIRY_DAYS}" build-server-full "vpn.${CN}" nopass 2>/dev/null +VPN_CRT="${VPN_PKI}/issued/vpn.${CN}.crt" +VPN_KEY="${VPN_PKI}/private/vpn.${CN}.key" +echo "VPN_CRT=${VPN_CRT//$OUT/\$OUT}" +echo "VPN_KEY=${VPN_KEY//$OUT/\$OUT}" + +# generate vpn dhparams (keysize of 2048 will do, 4096 can wind up taking hours to generate) +"$easyrsa_bin" --pki-dir="${VPN_PKI}" --keysize=2048 gen-dh 2>/dev/null +VPN_DH="${VPN_PKI}/dh.pem" +echo "VPN_DH=${VPN_DH//$OUT/\$OUT}" + +# update indexes and generate CRLs +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" update-db 2>/dev/null +"$easyrsa_bin" --pki-dir="${VPN_PKI}" update-db 2>/dev/null +"$easyrsa_bin" --pki-dir="${ROOT_PKI}" gen-crl 2>/dev/null +"$easyrsa_bin" --pki-dir="${VPN_PKI}" gen-crl 2>/dev/null diff --git a/scripts/make-env b/scripts/make-env new file mode 100755 index 0000000..ba0a257 --- /dev/null +++ b/scripts/make-env @@ -0,0 +1,58 @@ +#!/bin/bash -e + +usage() { + echo "usage: $0" + echo + echo "Required Variables:" + echo + echo " DOMAIN" + echo " ROOT_CA Path to root CA certificate" + echo " ROOT_CRT Path to root/wildcard certificate" + echo " ROOT_KEY Path to root/wildcard private key" + echo " JWT_CRT Path to Token Auth certificate" + echo " JWT_KEY Path to Token Auth private key" + echo " JWT_KID Path to KeyID for the Token Auth certificate" + echo " VPN_CA Path to the VPN sub-CA certificate" + echo " VPN_CRT Path to the VPN server certificate" + echo " VPN_KEY Path to the VPN server private key" + echo " VPN_DH Path to the VPN server Diffie Hellman parameters" + echo +} + +for var in DOMAIN ROOT_CA ROOT_CRT ROOT_KEY JWT_CRT JWT_KEY JWT_KID VPN_CA VPN_CRT VPN_KEY VPN_DH; do + if [ -z "${!var-}" ]; then + usage + exit 1 + fi +done + +randstr() { + LC_CTYPE=C tr -dc A-Za-z0-9 < /dev/urandom | fold -w "${1:-32}" | head -n 1 +} + +b64encode() { + cat "$@" | base64 --wrap=0 2>/dev/null || cat "$@" | base64 --break=0 +} + +cat </dev/null 2>&1 ; then + echo "adding $name" + echo "127.0.0.1 $name" >>"${tmp}" + fi +done +# shellcheck disable=SC2024 +sudo tee -a /etc/hosts >/dev/null <"${tmp}" +rm -f "${tmp}" diff --git a/scripts/quickstart b/scripts/quickstart new file mode 100755 index 0000000..26006bc --- /dev/null +++ b/scripts/quickstart @@ -0,0 +1,85 @@ +#!/bin/bash -e + +CMD="$(realpath "$0")" +DIR="$(dirname "${CMD}")" +BASE_DIR="$(dirname "${DIR}")" +CONFIG_DIR="${BASE_DIR}/config" +CERTS_DIR="${CONFIG_DIR}/certs" + +DOMAIN=openbalena.local + +usage() { + echo "usage: $0 [-h] [-p] [-d DOMAIN]" + echo + echo " -p patch hosts - patch the host /etc/hosts file" + echo " -d DOMAIN the domain name this deployment will run as, eg. example.com. Default is 'openbalena.local'" + echo +} + +show_help=false +patch_hosts=false +while getopts ":hpd:" opt; do + case "${opt}" in + h) show_help=true;; + p) patch_hosts=true;; + d) DOMAIN="${OPTARG}";; + *) + echo "Invalid argument: -${OPTARG}" + usage + exit 1 + ;; + esac +done +shift $((OPTIND-1)) + +if [ "$show_help" = "true" ]; then + usage + exit 1 +fi + +echo_bold() { + printf "\\033[1m%s\\033[0m\\n" "${@}" +} + +if [ -d "$CONFIG_DIR" ]; then + echo 'Configuration directory already exists; please remove it first.' + exit 1 +fi + +echo_bold "==> Creating new configuration at: $CONFIG_DIR" +mkdir -p "$CONFIG_DIR" "$CERTS_DIR" + +echo_bold "==> Generating root CA cert..." +# shellcheck source=scripts/gen-root-ca +source "${DIR}/gen-root-ca" "${DOMAIN}" "${CERTS_DIR}" + +echo_bold "==> Generating root cert chain for haproxy..." +# shellcheck source=scripts/gen-root-cert +source "${DIR}/gen-root-cert" "${DOMAIN}" "${CERTS_DIR}" + +echo_bold "==> Generating token auth cert..." +# shellcheck source=scripts/gen-token-auth-cert +source "${DIR}/gen-token-auth-cert" "${DOMAIN}" "${CERTS_DIR}" + +echo_bold "==> Generating VPN CA, cert and dhparam (this may take a while)..." +# shellcheck source=scripts/gen-vpn-certs +source "${DIR}/gen-vpn-certs" "${DOMAIN}" "${CERTS_DIR}" + +echo_bold "==> Setting up environment..." +# shellcheck source=scripts/make-env +cat >"${CONFIG_DIR}/activate" <(source "${DIR}/make-env") + +echo_bold "==> Adding default compose file..." +cp "${BASE_DIR}/compose/template.yml" "${CONFIG_DIR}/docker-compose.yml" + +if [ "${patch_hosts}" = "true" ]; then + echo_bold "==> Patching /etc/hosts..." + # shellcheck source=scripts/patch-hosts + source "${DIR}/patch-hosts" "${DOMAIN}" +fi + +echo_bold "==> Success!" +echo ' - Start the instance with: ./scripts/compose up -d' +echo ' - Stop the instance with: ./scripts/compose stop' +echo ' - To create the superuser, see: ./scripts/create-superuser -h' +echo " - Use the following certificate with Balena CLI: ${CONFIG_DIR}/root/ca.crt" diff --git a/scripts/ssl-common.sh b/scripts/ssl-common.sh new file mode 100644 index 0000000..48f3ef6 --- /dev/null +++ b/scripts/ssl-common.sh @@ -0,0 +1,24 @@ +#!/bin/bash -e +# shellcheck disable=SC2034 + +# ensure we have `easyrsa` available +if [ -z "${easyrsa_bin-}" ] || [ ! -x "${easyrsa_bin}" ]; then + easyrsa_bin="$(command easyrsa 2>/dev/null || true)" + if [ -z "${easyrsa_bin}" ]; then + easyrsa_dir="$(mktemp -dt easyrsa.XXXXXXXX)" + easyrsa_url="https://github.com/OpenVPN/easy-rsa/releases/download/v3.0.5/EasyRSA-nix-3.0.5.tgz" + (cd "${easyrsa_dir}"; curl -sL "${easyrsa_url}" | tar xz --strip-components=1) + easyrsa_bin="${easyrsa_dir}/easyrsa" + # shellcheck disable=SC2064 + trap "rm -rf \"${easyrsa_dir}\"" EXIT + fi + export EASYRSA_BATCH=1 + export EASYRSA_KEY_SIZE=4096 +fi + +# setup ROOT_PKI path +ROOT_PKI="$(realpath "${OUT}/root")" + +# global expiry settings +CA_EXPIRY_DAYS=3650 +CRT_EXPIRY_DAYS=730 diff --git a/src/README b/src/README new file mode 100644 index 0000000..6952fa9 --- /dev/null +++ b/src/README @@ -0,0 +1 @@ +This is the working folder for any specific container you might want to work on.