From d5a80bae6ce00e10ba9ec5eda61844188009bcf9 Mon Sep 17 00:00:00 2001 From: Kilian Pinheiro Date: Sun, 3 Apr 2022 17:44:24 +0200 Subject: [PATCH] publish ISS --- LICENSE | 674 +++++++++++++++++++++++++++++ README.md | 106 +++++ core/addAndCheckGitRepository.sh | 101 +++++ core/addNormalUser.sh | 39 ++ core/addToCrontabEveryHour.sh | 50 +++ core/defineAuthorizedKeysOfUser.sh | 86 ++++ core/ensureUsageOfDefinitions.sh | 177 ++++++++ definitions/README.md | 1 + preparationBeforeCloning.sh | 53 +++ renew.this.sh | 4 + setupCoreOntoThisHost.sh | 220 ++++++++++ states/README.md | 1 + updateRepositories.sh | 73 ++++ 13 files changed, 1585 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100755 core/addAndCheckGitRepository.sh create mode 100755 core/addNormalUser.sh create mode 100755 core/addToCrontabEveryHour.sh create mode 100755 core/defineAuthorizedKeysOfUser.sh create mode 100755 core/ensureUsageOfDefinitions.sh create mode 100644 definitions/README.md create mode 100755 preparationBeforeCloning.sh create mode 100755 renew.this.sh create mode 100755 setupCoreOntoThisHost.sh create mode 100644 states/README.md create mode 100755 updateRepositories.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2722b12 --- /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. + + Infrastructure System (ISS) + Copyright (C) 2022 Pinheirii + + 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: + + Infrastructure System (ISS) Copyright (C) 2022 Pinheirii + 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 index 0000000..5eb5fea --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ +Infrastructure System (ISS) +=========================== + +Setup a new host +---------------- + +### Preconditions +To deploy the system you have to clone this repository to the host as root user. +Therefore you have to register the SSH public key of that root user as deploy key to allow readonly access to this repository. +We use the modern ed25519 keys, so the public key of root is stored at this location: + +1. First become root: + ```sh + sudo -i + ``` + +2. Set the long hostname: + ```sh + hostnamectl set-hostname "the-new-unique-long-hostname (fqdn, eg.: host1.example.net)" + ``` + +3. Update Ubuntu: + ```sh + # DO NOT SKIP THIS STEP + apt update; apt upgrade -y + ``` + +4. Install git if needed: + ```sh + git --version > /dev/null || apt install git + ``` + +5. If not exist generate the ssh key pair and print the public key of the user root: + ```sh + # -t type of the key pair + # -f defines the filenames (we use the standard for the selected type here) + # -q quiet, no output or interaction + # -N "" means the private key will not be secured by a passphrase + # -C defines a comment + cat "/root/.ssh/id_ed25519.pub" \ + || (ssh-keygen \ + -t ed25519 \ + -f "/root/.ssh/id_ed25519" -q -N "" \ + -C "$(date +%Y%m%d):root@$(hostname -b)" \ + && cat "/root/.ssh/id_ed25519.pub") + ``` + + This key has to be registerd via gitea web ui as deploy key into the repositories as documented in chapter "Register public host key". + + + +### Register public host key +This is an example for `example.net` as domain of the host owner. + +1. Repository `iss`, allow __readonly__ access only. +2. Repository `iss-definition-example.net`, allow __readonly__ access only. +3. Repository `iss-state-example.net`, allow __writable__ access. + + + +### Clone the Infrastructure System (iss) repository +After you registered the printed root's public key of this host you can clone the repository and execute the setup script: +```sh +# Note the tailing '/iss', because we want to clone the repository to that folder +git clone ssh://git@git.example.dev:22448/iss.git /iss + +# Execute the setup script +/iss/setupCoreOntoThisHost.sh +``` + +
+
+
+ +How it works +------------ +We add a webhook to each gitea repository that belongs to ISS: + - __Taget URL:__ https://YOUR.JENKINS.DOMAIN/generic-webhook-trigger/invoke?token=YOUR_TOKEN + - __HTTP-Method:__ POST + - __Trigger On:__ Push Events + - __Branch filter:__ main + +Then we configure a jenkins job with no SCM, but 'Generic Webhook Trigger' as build-trigger. +Here the same token must be used as for the 'Target URL' in gitea. + +Finally we add 'shell execution' as build step there with this content: +```sh +cat < /dev/null \ + && return 0 + + [ "${_RIGHTS}" == "writable" ] \ + && [ -d "${_FOLDER}/.git" ] \ + && git -C "${_FOLDER}" push --dry-run &> /dev/null \ + && return 0 + + echo "FAIL: The rights of the repository are incorrect: ("$(readlink -f ${0})")" + echo " - '${_FOLDER}' is not '${_RIGHTS}'" + echo " - check the settings of gitea." + return 1 +} + +function checkRemoteRepository() { + local _FOLDER _REPOSITORY + _FOLDER="${1:?"Missing first parameter FOLDER"}" + _REPOSITORY="${2:?"Missing second parameter REPOSITORY"}" + readonly _FOLDER _REPOSITORY + + #Should exist after successful clone only, therefore the remote repository exists and was accessible. + [ -d "${_FOLDER}/.git" ] \ + && return 0 + + #Checks if repository exists and is accessible. + ! [ -d "${_FOLDER}/.git" ] \ + && git ls-remote "${_REPOSITORY}" \ + && return 0 + + echo "FAIL: The remote repository is not accessible: ("$(readlink -f ${0})")" + echo " - '${_REPOSITORY}'" + echo " - check the settings of gitea." + return 1 +} + +function cloneOrPull { + local _FOLDER _REPOSITORY + _FOLDER="${1:?"Missing first parameter FOLDER"}" + _REPOSITORY="${2:?"Missing second parameter REPOSITORY"}" + readonly _FOLDER _REPOSITORY + + ! [ -d "${_FOLDER}/.git" ] \ + && git clone "${_REPOSITORY}" "${_FOLDER}" &> /dev/null \ + && return 0 + + [ -d "${_FOLDER}/.git" ] \ + && git -C "${_FOLDER}" pull &> /dev/null \ + && return 0 + + echo "FAIL: The local repository is not updatable: ("$(readlink -f ${0})")" + echo " - '${_FOLDER}'" + echo " - check your network and the permissions in gitea." + return 1 +} + +# Note that an unprivileged user can use this script successfully, +# if no user has to be added to the host because it already exists. +function addAndCheckGitRepository() { + local _FOLDER _REPOSITORY + _FOLDER="${1:?"Missing first parameter FOLDER"}" + _REPOSITORY="${2:?"Missing second parameter REPOSITORY: e.g. ssh://git@your.domain.com/iss.git "}" + _RIGHTS="${3:?"Missing third parameter RIGHTS: (readonly, writable) "}" + readonly _FOLDER _REPOSITORY + + checkRemoteRepository "${_FOLDER}" "${_REPOSITORY}" \ + && cloneOrPull "${_FOLDER}" "${_REPOSITORY}" \ + && checkPermissions "${_FOLDER}" "${_RIGHTS}" \ + && echo "SUCCESS: The git repository is usable. ("$(readlink -f ${0})")" \ + && echo " - remote repository: '${_REPOSITORY}'" \ + && echo " - local repository: '${_FOLDER}' (${_RIGHTS})" \ + && return 0 + + echo "FAIL: The repository is not functional: ("$(readlink -f ${0})")" + echo " - remote repository: '${_REPOSITORY}'" + echo " - local repository: '${_FOLDER}'" + echo " - due to an error or insufficient rights or" + echo " - one check failed." + return 1 +} + +# sanitizes all parameters +addAndCheckGitRepository \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + "$(echo ${2} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + "$(echo ${3} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1 diff --git a/core/addNormalUser.sh b/core/addNormalUser.sh new file mode 100755 index 0000000..04716c1 --- /dev/null +++ b/core/addNormalUser.sh @@ -0,0 +1,39 @@ +#!/bin/bash + +#WARNING: Used for core functionality in setup.sh +# DO NOT rename the script and test changes well! + + + +# Note that an unprivileged user can use this script successfully, +# if no user has to be added to the host because it already exists. +function addNormalUser() { + local _USER + _USER="${1:?"Missing first parameter USER"}" + readonly _USER + + #The user already exists + id -u "${_USER}" &> /dev/null \ + && echo "SUCCESS: The user already exists: ("$(readlink -f ${0})")" \ + && echo " - '${_USER}'" \ + && return 0 + + [ "$(id -u)" == "0" ] \ + && adduser --gecos 'Normal user' --disabled-password "${_USER}" \ + && chown -R "${_USER}:${_USER}" "/home/${_USER}" \ + && echo "SUCCESS: The user was created: ("$(readlink -f ${0})")" \ + && echo " - '${_USER}'" \ + && echo " - no password was set, use passwd if needed" \ + && echo " - existing home directories were taken over" \ + && return 0 + + echo "FAIL: The user could not be created: ("$(readlink -f ${0})")" + echo " - '${_USER}'" + echo " - due to an error or insufficient rights." + return 1 +} + +# sanitizes all parameters +addNormalUser \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1 diff --git a/core/addToCrontabEveryHour.sh b/core/addToCrontabEveryHour.sh new file mode 100755 index 0000000..492ad14 --- /dev/null +++ b/core/addToCrontabEveryHour.sh @@ -0,0 +1,50 @@ +#!/bin/bash + +#WARNING: Used for core functionality in setup.sh +# DO NOT rename the script and test changes well! + + + +# Note that an unprivileged user can use this script successfully, +# if no user has to be added to the host because it already exists. +function addToCrontabEveryHour() { + local _ROOT _MINUTE_VALUE _STRING + _ROOT="${0%%/core/*}/" #Removes longest matching pattern '/core/*' from the end + ! [ -z "${2##*[!0-9]*}" ] && _MINUTE_VALUE=$((${2}%60)) # if second parameter is integer then (minute-value % 60) as safe guard + _STRING="${_MINUTE_VALUE:?"Missing MINUTE_VALUE"} * * * * ${1:?"Missing first parameter COMMAND"} > /dev/null 2>&1" + readonly _ROOT _MINUTE_VALUE _STRING + + [ "$(id -u)" == "0" ] \ + && crontab -l | grep -qF "${_STRING:?"Missing CRON_STRING"}" \ + && echo "SUCCESS: Entry already is registered to crontab: ("$(readlink -f ${0})")" \ + && echo " - '${_STRING}'" \ + && return 0 + + [ "$(id -u)" == "0" ] \ + && echo "${_ROOT:?"Missing ROOT"}" | grep "home" &> /dev/null \ + && echo "SUCCESS: Although the entry will be skipped: ("$(readlink -f ${0})")" \ + && echo " - '${_STRING}'" \ + && echo " that is because the current environment is:" \ + && echo " - ${_ROOT}" \ + && return 0 + + [ "$(id -u)" == "0" ] \ + && (crontab -l; \ + echo "# Every hour at ?:${_MINUTE_VALUE:?"Missing MINUTE_VALUE"}:"; \ + echo "${_STRING:?"Missing CRON_STRING"}") | crontab - \ + && crontab -l | grep -qF "${_STRING:?"Missing CRON_STRING"}" \ + && echo "SUCCESS: Entry is registered to crontab now: ("$(readlink -f ${0})")" \ + && echo " - '${_STRING}'" \ + && return 0 + + echo "FAIL: Entry could not be registered to crontab: ("$(readlink -f ${0})")" + echo " - '${_STRING:?"Missing CRON_STRING"}'" + echo " - due to an error or insufficient rights." + return 1 +} + +# sanitizes all parameters +addToCrontabEveryHour \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + "$(echo ${2} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1 diff --git a/core/defineAuthorizedKeysOfUser.sh b/core/defineAuthorizedKeysOfUser.sh new file mode 100755 index 0000000..68b318e --- /dev/null +++ b/core/defineAuthorizedKeysOfUser.sh @@ -0,0 +1,86 @@ +#!/bin/bash + +#WARNING: Used for core functionality in setup.sh +# DO NOT rename the script and test changes well! + +function prepareFolder() { + local _HOME_FOLDER _SSH_FOLDER _USER + _SSH_FOLDER="${1:?"prepareFolder(): Missing parameter SSH_PATH"}" + _HOME_FOLDER="${_SSH_FOLDER%%/.ssh*}" #Removes longest matching pattern '/.ssh*' from the end + _USER="${_HOME_FOLDER##*/}" #Removes longest matching pattern '*/' from the begin + readonly _HOME_FOLDER _SSH_FOLDER _USER + + ! [ -d "${_HOME_FOLDER}" ] \ + && echo "FAIL: The home folder is unavailable: ("$(readlink -f ${0})")" \ + && echo " - '${_HOME_FOLDER}'" \ + && return 1 + + #The ssh folder already exists + [ -d "${_SSH_FOLDER}" ] \ + && [ "$(stat -c '%U:%G' "${_SSH_FOLDER}")" == "${_USER}:${_USER}" ] \ + && [ "$(stat -c '%a' "${_SSH_FOLDER}")" == "700" ] \ + && echo "SUCCESS: The ssh folder already exists: ("$(readlink -f ${0})")" \ + && echo " - '${_SSH_FOLDER}'" \ + && return 0 + + #The calling user can create its own folder + ! [ -d "${_SSH_FOLDER}" ] \ + && [ "${_USER:?"Missing USER"}" == "$(whoami)" ] \ + && mkdir -p "${_SSH_FOLDER}" \ + && chown "${_USER}:${_USER}" "${_SSH_FOLDER}" \ + && chmod go-rwx "${_SSH_FOLDER}" \ + && echo "SUCCESS: The ssh folder was created: ("$(readlink -f ${0})")" \ + && echo " - '${_SSH_FOLDER}'" \ + && return 0 + + #The root user can create every folder + ! [ -d "${_SSH_FOLDER}" ] \ + && [ "${_USER:?"Missing USER"}" != "$(whoami)" ] \ + && [ "$(id -u)" == "0" ] \ + && mkdir -p "${_SSH_FOLDER}" \ + && chown "${_USER}:${_USER}" "${_SSH_FOLDER}" \ + && chmod go-rwx "${_SSH_FOLDER}" \ + && echo "SUCCESS: The ssh folder was created: ("$(readlink -f ${0})")" \ + && echo " - '${_SSH_FOLDER}'" \ + && return 0 + + echo "FAIL: The ssh folder could not be prepared: ("$(readlink -f ${0})")" + echo " - '${_SSH_FOLDER}'" + echo " - due to an error or insufficient rights." + return 1 +} + +function defineAuthorizedKeysOfUser() { + local _ROOT _CORE_SCRIPTS _DOMAIN _DEFINITIONS _USER + _DEFINITIONS="$(realpath -s "${1:?"Missing first parameter DEFINITIONS: 'ROOT/definitions/DOMAIN'"}")" + _ROOT="${_DEFINITIONS%%/definitions/*}/" #Removes longest matching pattern '/definitions/*' from the end + _DOMAIN="${_DEFINITIONS##*/definitions/}" #Removes longest matching pattern '*/definitions/' from the begin + _DOMAIN="${_DOMAIN%/}" #Removes shortest matching pattern '/' from the end + #Build from components for safety + _DEFINITIONS="${_ROOT:?"Missing ROOT"}definitions/${_DOMAIN:?"Missing DOMAIN"}" + + _USER="${2:?"Missing second parameter USER"}" + _CORE_SCRIPTS="${_ROOT:?"Missing ROOT"}core/" + readonly _ROOT _CORE_SCRIPTS _DOMAIN _DEFINITIONS _USER + + case "${_USER:?"Missing USER"}" in + root) + prepareFolder "/root/.ssh" \ + && echo \ + && source "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}ensureUsageOfDefinitions.sh" "${_DEFINITIONS}" "/root/.ssh/authorized_keys" \ + && return 0 || return 1 + ;; + *) + prepareFolder "/home/${_USER}/.ssh" \ + && echo \ + && source "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}ensureUsageOfDefinitions.sh" "${_DEFINITIONS}" "/home/${_USER}/.ssh/authorized_keys" \ + && return 0 || return 1 + ;; + esac +} + +# sanitizes all parameters +defineAuthorizedKeysOfUser \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + "$(echo ${2} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1 diff --git a/core/ensureUsageOfDefinitions.sh b/core/ensureUsageOfDefinitions.sh new file mode 100755 index 0000000..f9b53b1 --- /dev/null +++ b/core/ensureUsageOfDefinitions.sh @@ -0,0 +1,177 @@ +#!/bin/bash + +#WARNING: Used for core functionality in setup.sh +# DO NOT rename the script and test changes well! + +function printIfEqual() { + [ "${1:?"Missing first parameter"}" == "${2}" ] \ + && echo "${1}" \ + && return 0 + + return 1 +} + +function isCoreDefinition() { + echo "${1:?"Missing first parameter FILE"}" | grep "/root/.ssh/authorized_keys" &> /dev/null \ + && return 0 + + echo "${1:?"Missing first parameter FILE"}" | grep "/home/jenkins/.ssh/authorized_keys" &> /dev/null \ + && return 0 + + echo "${1:?"Missing first parameter FILE"}" | grep "/etc/sudoers.d/allow-jenkins-updateRepositories" &> /dev/null \ + && return 0 + + return 1 +} + +function printSelectedDefinition() { + local _CORE_FILE_DEFINED_ALL_HOSTS _CORE_FILE_DEFINED_THIS_HOST _FILE_DEFINED_ALL_HOSTS _FILE_DEFINED_THIS_HOST + _CORE_FILE_DEFINED_ALL_HOSTS="${1:?"Missing DEFINITIONS"}/core/all${2:?"Missing CURRENT_FULLFILE"}" + _CORE_FILE_DEFINED_THIS_HOST="${1:?"Missing DEFINITIONS"}/core/$(hostname -s)${2:?"Missing CURRENT_FULLFILE"}" + _FILE_DEFINED_ALL_HOSTS="${1:?"Missing DEFINITIONS"}/hosts/all${2:?"Missing CURRENT_FULLFILE"}" + _FILE_DEFINED_THIS_HOST="${1:?"Missing DEFINITIONS"}/hosts/$(hostname -s)${2:?"Missing CURRENT_FULLFILE"}" + readonly _CORE_FILE_DEFINED_ALL_HOSTS _CORE_FILE_DEFINED_THIS_HOST _FILE_DEFINED_ALL_HOSTS _FILE_DEFINED_THIS_HOST + + #The following are special definitions that affect the core functionality. + #Try this host first because it should be priorized. + isCoreDefinition "${2:?"Missing CURRENT_FULLFILE"}" \ + && [ -s "${_CORE_FILE_DEFINED_THIS_HOST}" ] \ + && echo "${_CORE_FILE_DEFINED_THIS_HOST}" \ + && return 0 + + #The following are special definitions that affect the core functionality. + isCoreDefinition "${2:?"Missing CURRENT_FULLFILE"}" \ + && [ -s "${_CORE_FILE_DEFINED_ALL_HOSTS}" ] \ + && echo "${_CORE_FILE_DEFINED_ALL_HOSTS}" \ + && return 0 + + #Try this host first because it should be priorized. + ! isCoreDefinition "${2:?"Missing CURRENT_FULLFILE"}" \ + && [ -s "${_FILE_DEFINED_THIS_HOST}" ] \ + && echo "${_FILE_DEFINED_THIS_HOST}" \ + && return 0 + + ! isCoreDefinition "${2:?"Missing CURRENT_FULLFILE"}" \ + && [ -s "${_FILE_DEFINED_ALL_HOSTS}" ] \ + && echo "${_FILE_DEFINED_ALL_HOSTS}" \ + && return 0 + + return 1 +} + +function createSymlinkToDefinition() { + local _CURRENT_FOLDER _CURRENT_FULLFILE _DEFINED_FULLFILE _SAVED_FULLFILE + _CURRENT_FOLDER="${1:?"Missing CURRENT_FOLDER"}" + _CURRENT_FULLFILE="${2:?"Missing CURRENT_FULLFILE"}" + _DEFINED_FULLFILE="${3:?"Missing DEFINED_FULLFILE"}" + _SAVED_FULLFILE="${4:?"Missing SAVED_FULLFILE"}" + readonly _CURRENT_FOLDER _CURRENT_FULLFILE _DEFINED_FULLFILE _SAVED_FULLFILE + + [ -f "${_CURRENT_FULLFILE}" ] \ + && [ "$(sha256sum "${_DEFINED_FULLFILE}" | cut -d' ' -f1)" == "$(sha256sum "${_CURRENT_FULLFILE}" | cut -d' ' -f1)" ] \ + && echo "The content of the current file already matches the definition, but it will be replaced by a symlink..." + + [ -f "${_CURRENT_FULLFILE}" ] \ + && [ "$(sha256sum "${_DEFINED_FULLFILE}" | cut -d' ' -f1)" == "$(sha256sum "${_CURRENT_FULLFILE}" | cut -d' ' -f1)" ] \ + && echo "The content of the current file already matches the definition, but it will be replaced by a symlink..." + + + [ -f "${_CURRENT_FULLFILE}" ] \ + && mv "${_CURRENT_FULLFILE:?"Missing CURRENT_FULLFILE"}" "${_SAVED_FULLFILE:?"Missing SAVED_FULLFILE"}" \ + && echo "Current file has been backed up to: '${_SAVED_FULLFILE}'" + + [ -d "${_CURRENT_FOLDER}" ] \ + && ln -s -f "${_DEFINED_FULLFILE}" "${_CURRENT_FULLFILE}" \ + && return 0 + + [ -f "${_SAVED_FULLFILE}" ] \ + && cp --remove-destination "${_SAVED_FULLFILE}" "${_CURRENT_FULLFILE}" \ + && echo "File restored due to a failure." + + return 1 +} + +function ensureUsageOfDefinitions() { + local _ROOT _CURRENT_FILE _CURRENT_FOLDER _CURRENT_FULLFILE _DEFINITIONS _DOMAIN _DEFINED_FULLFILE _NOW _SAVED_FULLFILE + _DEFINITIONS="$(realpath -s "${1:?"Missing first parameter DEFINITIONS: 'ROOT/definitions/DOMAIN'"}")" + _ROOT="${_DEFINITIONS%%/definitions/*}/" #Removes longest matching pattern '/definitions/*' from the end + _DOMAIN="${_DEFINITIONS##*/definitions/}" #Removes longest matching pattern '*/definitions/' from the begin + _DOMAIN="${_DOMAIN%/}" #Removes shortest matching pattern '/' from the end + #Build from components for safety + _DEFINITIONS="$(printIfEqual "${_DEFINITIONS}" "${_ROOT:?"Missing ROOT"}definitions/${_DOMAIN:?"Missing DOMAIN"}")" + + + _CURRENT_FOLDER="$(dirname "${2:?"Missing second parameter CURRENT_FULLFILE"}")" + _CURRENT_FOLDER="${_CURRENT_FOLDER%/}/" #Removes shortest matching pattern '/' from the end + ! [ -d "${_CURRENT_FOLDER}" ] \ + && echo "FAIL: The folder cannot be read: ("$(readlink -f ${0})")" \ + && echo " - '${_CURRENT_FOLDER}'" \ + && echo " - user '"$(whoami)"' has insufficient rights on this host '$(hostname -s)'" \ + && echo " - or the folder does not exist." \ + && return 1 + + _CURRENT_FOLDER="$(realpath -s "${_CURRENT_FOLDER:?"Missing CURRENT_FOLDER"}")" + _CURRENT_FOLDER="${_CURRENT_FOLDER%/}/" #Removes shortest matching pattern '/' from the end + + _CURRENT_FILE="$(basename "${2:?"Missing second parameter CURRENT_FULLFILE"}")" + #Build from components for safety + _CURRENT_FULLFILE="${_CURRENT_FOLDER:?"Missing CURRENT_FOLDER"}${_CURRENT_FILE:?"Missing CURRENT_FILE"}" + + + _DEFINED_FULLFILE="$(printSelectedDefinition "${_DEFINITIONS}" "${_CURRENT_FULLFILE}")" + _NOW="$(date +%Y%m%d_%H%M)" + _SAVED_FULLFILE="${_CURRENT_FULLFILE}-backup@${_NOW:?"Missing NOW"}" + readonly _ROOT _CURRENT_FILE _CURRENT_FOLDER _CURRENT_FULLFILE _DEFINITIONS _DOMAIN _DEFINED_FULLFILE _NOW _SAVED_FULLFILE + + ! [ -f "${_DEFINED_FULLFILE}" ] \ + && echo "FAIL: No definition available for this file: ("$(readlink -f ${0})")" \ + && echo " - '${_CURRENT_FULLFILE}'" \ + && return 1 + + ! [ -s "${_DEFINED_FULLFILE}" ] \ + && echo "FAIL: No content available for this file: ("$(readlink -f ${0})")" \ + && echo " - '${_CURRENT_FULLFILE}'" \ + && return 1 + + [ "${_DEFINED_FULLFILE}" == "$(readlink -f "${_CURRENT_FULLFILE}")" ] \ + && echo "SUCCESS: The definition already is in place: ("$(readlink -f ${0})")" \ + && echo " - '${_DEFINED_FULLFILE}'" \ + && return 0 + + echo "${_ROOT:?"Missing ROOT"}" | grep "home" &> /dev/null \ + && echo "SUCCESS: Although this definition will be skipped: ("$(readlink -f ${0})")" \ + && echo " - '${_DEFINED_FULLFILE}'" \ + && echo " that is because the current environment is:" \ + && echo " - ${_ROOT}" \ + && echo " following file is in use:" \ + && echo " - $(readlink -f "${_CURRENT_FULLFILE}")" \ + && return 0 + + ! [ -w "${_CURRENT_FOLDER}" ] \ + && echo "FAIL: The current file cannot be added: ("$(readlink -f ${0})")" \ + && echo " - '${_CURRENT_FULLFILE}'" \ + && echo " - user '$(whoami)' has insufficient rights on this host '$(hostname -s)'" \ + && return 1 + + [ -f "${_CURRENT_FULLFILE}" ] \ + && ! [ -w "${_CURRENT_FULLFILE}" ] \ + && echo "FAIL: The current file cannot be modified: ("$(readlink -f ${0})")" \ + && echo " - '${_CURRENT_FULLFILE}'" \ + && echo " - user '$(whoami)' has insufficient rights on this host '$(hostname -s)'" \ + && return 1 + + createSymlinkToDefinition "${_CURRENT_FOLDER}" "${_CURRENT_FULLFILE}" "${_DEFINED_FULLFILE}" "${_SAVED_FULLFILE}" \ + && echo "SUCCESS: The definition was ensured: ("$(readlink -f ${0})")" \ + && echo "- '${_DEFINED_FULLFILE}'" \ + && return 0 + + echo "FAIL: The definition could not be ensured: ("$(readlink -f ${0})")" + echo " - due to an error or insufficient rights." + return 1 +} + +# sanitizes all parameters +ensureUsageOfDefinitions \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + "$(echo ${2} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1 diff --git a/definitions/README.md b/definitions/README.md new file mode 100644 index 0000000..2ace626 --- /dev/null +++ b/definitions/README.md @@ -0,0 +1 @@ +This folder `definitions` contains one repository per domain to define stuff across all hosts of that domain. diff --git a/preparationBeforeCloning.sh b/preparationBeforeCloning.sh new file mode 100755 index 0000000..74d60b4 --- /dev/null +++ b/preparationBeforeCloning.sh @@ -0,0 +1,53 @@ +#!/bin/bash + +[ "$(id -u)" != "0" ] \ + && echo "This script prepares the user 'root' of this host and the host itself," \ + && echo "so this script is allowed to be executed if you are root only." \ + && exit 1 + +function setNeededHostnameOrExit() { + _FQDN="${1:?"Missing unique long hostname (fqdn, eg.: host1.example.net) for this host as first parameter."}" + + echo "${_FQDN}" | grep '\.' &> /dev/null \ + && hostnamectl set-hostname "${_FQDN}" \ + && return 0 + + echo "FAILED: setting full qualified domain name, given value was:" + echo " - ${_FQDN}" + exit 1 +} + +function prepare() { + git --version > /dev/null || (apt update; apt upgrade -y; apt install git) + + echo + echo "Public SSH-Key for root@$(hostname -b):" + # -t type of the key pair + # -f defines the filenames (we use the standard for the selected type here) + # -q quiet, no output or interaction + # -N "" means the private key will not be secured by a passphrase + # -C defines a comment + cat "/root/.ssh/id_ed25519.pub" \ + || (ssh-keygen \ + -t ed25519 \ + -f "/root/.ssh/id_ed25519" -q -N "" \ + -C "$(date +%Y%m%d)-root@$(hostname -b)" \ + && cat "/root/.ssh/id_ed25519.pub") + + echo + echo "Now you have to register the public ssh-key from above into your git-server to grant these access rights:" + echo " - scripts repository (allow readonly access only)," + echo " - definitions repository (allow readonly access only)," + echo " - states repository (allow writable access)." + echo + echo "After all access rights are granted you can clone the Infrastructure System:" + echo " e.g.: git clone ssh://git@git.example.dev:22448/iss.git /iss" + echo + echo "Finally call 'setupCoreOntoThisHost.sh' from the root directory of the repository:" + echo " e.g.: /iss/setupCoreOntoThisHost.sh" + echo +} + +# sanitizes all parameters +setNeededHostnameOrExit "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && prepare diff --git a/renew.this.sh b/renew.this.sh new file mode 100755 index 0000000..3c6b4d1 --- /dev/null +++ b/renew.this.sh @@ -0,0 +1,4 @@ +#!/bin/bash +echo "$(head -n 3 ${0})" > ${0} +echo "#$(date --rfc-3339=ns)" >> ${0} +#2023-11-11 15:03:46.439551015+01:00 diff --git a/setupCoreOntoThisHost.sh b/setupCoreOntoThisHost.sh new file mode 100755 index 0000000..f745839 --- /dev/null +++ b/setupCoreOntoThisHost.sh @@ -0,0 +1,220 @@ +#!/bin/bash + +[ "$(id -u)" != "0" ] \ + && sudo "${0}" "${1}" \ + && exit 0 + + + + +function checkPathsAreAvaiable() { + grep --version &> /dev/null \ + && [ "$(echo ${PATH} | tr ':' '\n' | grep -c /usr/local/sbin)" -ge 1 ] \ + && [ "$(echo ${PATH} | tr ':' '\n' | grep -c /usr/local/bin)" -ge 1 ] \ + && [ "$(echo ${PATH} | tr ':' '\n' | grep -c /usr/sbin)" -ge 1 ] \ + && [ "$(echo ${PATH} | tr ':' '\n' | grep -c /usr/bin)" -ge 1 ] \ + && [ "$(echo ${PATH} | tr ':' '\n' | grep -c /sbin)" -ge 3 ] \ + && [ "$(echo ${PATH} | tr ':' '\n' | grep -c /bin)" -ge 3 ] \ + && return 0 + + echo "Content of variable PATH is not available." + return 1 +} + +function checkGitIsAvailable() { + git --version &> /dev/null \ + && return 0 + + apt update &> /dev/null + echo "Git seams to be unavailable. Please install it using 'apt install git'." + return 1 +} + +function checkPreconditions() { + local _ROOT _DOMAIN + _ROOT="${1:?"Missing parameter ROOT"}" + _DOMAIN="${2}" # Optional parameter DOMAIN + readonly _ROOT _DOMAIN + + ! [ -z "${_DOMAIN}" ] \ + && [ "$(hostname -d)" != "${_DOMAIN}" ] \ + && echo \ + && echo "WARNING: system-domain DOES NOT MATCH domainOfHostOwner: '$(hostname -d)' != '${_DOMAIN}'" \ + && echo + + # Given domain verfügbar (nicht leer) + ! [ -z "${_DOMAIN}" ] \ + && checkPathsAreAvaiable \ + && checkGitIsAvailable \ + && git -C "${_ROOT}" pull &> /dev/null \ + && return 0 + + echo + echo "The preconditions were not met." + + # Given domain verfügbar (nicht leer) => Text unten unnötig + ! [ -z "${_DOMAIN}" ] \ + && return 1 + + echo + echo "The needed domain provided by the owner of this host is not available." + echo "You have to configure the host correctly, e.g.:" + echo " hostnamectl set-hostname 'SHORT_HOSTNAME.DOMAIN.TLD'" + echo + echo "If you are root you can specify the domain information as a parameter, e.g.:" + echo " ${0} DOMAIN.TLD" + echo "Then the specified domain is appended to the current short hostname: '$(hostname -s)'" + + return 1 +} + +function getOrSetDomain() { + local _ROOT _DOMAIN_FILE _GIVEN_DOMAIN + _ROOT="${1:?"Missing parameter ROOT"}" + _DOMAIN_FILE="${_ROOT:?"Missing ROOT"}domainOfHostOwner" + _GIVEN_DOMAIN="${2}" # Optional parameter DOMAIN + readonly _ROOT _DOMAIN_FILE _GIVEN_DOMAIN + + # Wenn DOMAIN_FILE enhält lesbare Daten + grep '[^[:space:]]' "${_DOMAIN_FILE:?"Missing DOMAIN_FILE"}" &> /dev/null \ + && cat "${_DOMAIN_FILE}" \ + && return 0 + + # Der boot-hostname muss mindestens einen Punkt enthalten, dann wird die hintere Hälfte als Domain genommen + hostname -b | grep "\." | cut -d. -f2- > "${_DOMAIN_FILE}" + grep '[^[:space:]]' "${_DOMAIN_FILE}" &> /dev/null \ + && cat "${_DOMAIN_FILE}" \ + && return 0 + + # Given domain is set (nicht leer) + ! [ -z "${_GIVEN_DOMAIN}" ] \ + && [ "$(id -u)" == "0" ] \ + && hostnamectl set-hostname "$(hostname -s).${_GIVEN_DOMAIN}" \ + && hostname -b | grep "\." | cut -d. -f2- > "${_DOMAIN_FILE}" \ + && grep '[^[:space:]]' "${_DOMAIN_FILE}" &> /dev/null \ + && cat "${_DOMAIN_FILE}" \ + && return 0 + + return 1 +} + +function getRemoteRepositoryPath() { + local _ROOT + _ROOT="${1:?"Missing parameter ROOT"}" + readonly _ROOT + + _RESULT="$(git -C "${_ROOT:?"Missing ROOT"}" remote show origin | grep -i 'fetch' | xargs -n 1 | grep -i 'ssh://')" + _RESULT="${_RESULT%/*}" #Removes shortest matching pattern '/*' from the end + ! [ -z "${_RESULT}" ] \ + && echo "${_RESULT}" \ + && return 0 + + return 1 +} + +function addDefinition(){ + local _ROOT _CORE_SCRIPTS _DEFINITIONS _REPOSITORY + _DEFINITIONS="${1:?"Missing parameter DEFINITIONS"}" + _REPOSITORY="${2:?"Missing parameter REPOSITORY"}" + _ROOT="${_DEFINITIONS%%/definitions/*}/" #Removes longest matching pattern '/definitions/*' from the end + _CORE_SCRIPTS="${_ROOT:?"Missing ROOT"}core/" + readonly _ROOT _CORE_SCRIPTS _DEFINITIONS _REPOSITORY + [ "$(id -u)" == "0" ] \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}addAndCheckGitRepository.sh" "${_DEFINITIONS}" "${_REPOSITORY}" readonly \ + && echo " - definitions are usable for this host." \ + && return 0 + + [ "$(id -u)" != "0" ] \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}addAndCheckGitRepository.sh" "${_DEFINITIONS}" "${_REPOSITORY}" writable \ + && echo " - definitions are usable, as working copy." \ + && return 0 + + return 1 +} + +function addState() { + local _ROOT _CORE_SCRIPTS _STATES _REPOSITORY + _STATES="${1:?"Missing parameter STATES"}" + _REPOSITORY="${2:?"Missing parameter REPOSITORY"}" + _ROOT="${_STATES%%/states/*}/" #Removes longest matching pattern '/states/*' from the end + _CORE_SCRIPTS="${_ROOT:?"Missing ROOT"}core/" + readonly _ROOT _CORE_SCRIPTS _STATES _REPOSITORY + + [ "$(id -u)" == "0" ] \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}addAndCheckGitRepository.sh" "${_STATES}" "${_REPOSITORY}" writable \ + && echo " - states are usable for this host." \ + && return 0 + + [ "$(id -u)" != "0" ] \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}addAndCheckGitRepository.sh" "${_STATES}" "${_REPOSITORY}" writable \ + && echo " - states are usable, as working copy." \ + && return 0 + + return 1 +} + +function setupCoreFunctionality() { + local _ROOT _CORE_SCRIPTS _DEFINITIONS _MINUTE_FROM_OWN_IP _SETUP + _DEFINITIONS="${1:?"Missing DEFINITIONS: 'ROOT/definitions/DOMAIN'"}" + _ROOT="${_DEFINITIONS%%/definitions/*}/" #Removes longest matching pattern '/definitions/*' from the end + _CORE_SCRIPTS="${_ROOT:?"Missing ROOT"}core/" + _MINUTE_FROM_OWN_IP="$(hostname -I | xargs -n 1 | grep -F . | head -n 1 | cut -d. -f4 || echo 0)" #uses last value from first own ipv4 or 0 as minute value + _SETUP="${2:?"Missing SETUP"}" + readonly _ROOT _CORE_SCRIPTS _DEFINITIONS _MINUTE_FROM_OWN_IP _SETUP + + [ "$(id -u)" != "0" ] \ + && echo "Configuration of host skipped because of insufficient rights." \ + && return 1 + + [ "$(id -u)" == "0" ] \ + && echo \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}defineAuthorizedKeysOfUser.sh" "${_DEFINITIONS}" root \ + && echo \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}addNormalUser.sh" jenkins \ + && echo \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}defineAuthorizedKeysOfUser.sh" "${_DEFINITIONS}" jenkins \ + && echo \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}ensureUsageOfDefinitions.sh" "${_DEFINITIONS}" /etc/sudoers.d/allow-jenkins-updateRepositories \ + && echo \ + && "${_CORE_SCRIPTS:?"Missing CORE_SCRIPTS"}addToCrontabEveryHour.sh" "${_SETUP}" "${_MINUTE_FROM_OWN_IP}" \ + && return 0 + + return 1 +} + +function setup() { + local _ROOT _DEFINITIONS _DEFINITIONS_REPOSITORY _DOMAIN _REPOSITORY_PATH _SETUP _STATES _STATES_REPOSITORY + _SETUP="$(readlink -f "${0}" 2> /dev/null)" + _ROOT="$(dirname ${_SETUP:?"Missing SETUP"} 2> /dev/null || echo "/iss")/" + _DOMAIN="$(getOrSetDomain "${_ROOT:?"Missing ROOT"}" "${1}")" + _REPOSITORY_PATH="$(getRemoteRepositoryPath "${_ROOT:?"Missing ROOT"}")" + + ! checkPreconditions "${_ROOT:?"Missing ROOT"}" "${_DOMAIN}" \ + && return 1 + + _DEFINITIONS="${_ROOT:?"Missing ROOT"}definitions/${_DOMAIN:?"Missing DOMAIN"}" + _DEFINITIONS_REPOSITORY="${_REPOSITORY_PATH:?"Missing REPOSITORY_PATH"}/iss-definition-${_DOMAIN:?"Missing DOMAIN"}.git" + _STATES="${_ROOT:?"Missing ROOT"}states/${_DOMAIN:?"Missing DOMAIN"}" + _STATES_REPOSITORY="${_REPOSITORY_PATH:?"Missing REPOSITORY_PATH"}/iss-state-${_DOMAIN:?"Missing DOMAIN"}.git" + readonly _ROOT _DEFINITIONS _DEFINITIONS_REPOSITORY _DOMAIN _REPOSITORY_PATH _SETUP _STATES _STATES_REPOSITORY + + echo \ + && echo "Running setup using repositories of: '${_REPOSITORY_PATH:?"Missing REPOSITORY_PATH"}' ..." \ + && echo \ + && addDefinition "${_DEFINITIONS:?"Missing DEFINITIONS"}" "${_DEFINITIONS_REPOSITORY:?"Missing DEFINITIONS_REPOSITORY"}" \ + && echo \ + && addState "${_STATES:?"Missing STATES"}" "${_STATES_REPOSITORY:?"Missing STATES_REPOSITORY"}" \ + && echo \ + && echo "Using definitions: '${_DEFINITIONS:?"Missing DEFINITIONS"}' ..." \ + && setupCoreFunctionality "${_DEFINITIONS:?"Missing DEFINITIONS"}" "${_SETUP:?"Missing SETUP"}" \ + && return 0 + + echo "FAIL: setup is incomplete: ("$(readlink -f ${0})")" + echo " - due to an error or insufficient rights." + return 1 +} + +# sanitizes all parameters +setup \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1 diff --git a/states/README.md b/states/README.md new file mode 100644 index 0000000..544447c --- /dev/null +++ b/states/README.md @@ -0,0 +1 @@ +This folder `states` contains one repository per domain to document stuff about all hosts of that domain by the system only. diff --git a/updateRepositories.sh b/updateRepositories.sh new file mode 100755 index 0000000..1454c3d --- /dev/null +++ b/updateRepositories.sh @@ -0,0 +1,73 @@ +#!/bin/bash + +# No write permission, but terminal => restart as root using sudo, user jenkins can do this with> +! [ -w "${0}" ] \ + && [ -t 0 ] \ + && sudo "${0}" "${1}" \ + && exit 0 + +# No write permission and no terminal => restart as root using sudo non-interactive, user jenkin> +! [ -w "${0}" ] \ + && ! [ -t 0 ] \ + && sudo -n "${0}" "${1}" \ + && exit 0 + +# Still no write permission => was not called as root +! [ -w "${0}" ] \ + && echo "Host $HOSTNAME: insufficient rights." \ + && exit 1 + + + +function update_repositories() { + local _ROOT _DEFINITIONS _DOMAIN _MODE _STATES _UPDATE_REPOSITORIES + _UPDATE_REPOSITORIES="$(readlink -f "${0}" 2> /dev/null)" + _MODE="${1:-"all"}" + _ROOT="$(dirname ${_UPDATE_REPOSITORIES:?"Missing UPDATE_REPOSITORIES"} 2> /dev/null || echo> + _DOMAIN="$(cat ${_ROOT:?"Missing ROOT"}domainOfHostOwner)" + _DEFINITIONS="${_ROOT}definitions/${_DOMAIN:?"Missing DOMAIN from file: ${_ROOT}domainOfHost> + _STATES="${_ROOT}states/${_DOMAIN:?"Missing DOMAIN from file: ${_ROOT}domainOfHostOwner"}/" + readonly _ROOT _DEFINITIONS _DOMAIN _MODE _STATES _UPDATE_REPOSITORIES + + [ "${_MODE}" == "--repair" ] \ + && (git -C "${_ROOT}" reset --hard origin/master; \ + git -C "${_DEFINITIONS}" reset --hard origin/master; \ + git -C "${_STATES}" reset --hard origin/master; \ + echo "Run repairs") \ + && return 0 + + [ "${_MODE}" == "--test" ] \ + && git -C "${_ROOT}" pull \ + && git -C "${_DEFINITIONS}" pull \ + && git -C "${_STATES}" pull \ + && echo "Run in testMode successfully." \ + && return 0 + + [ "${_MODE}" == "--scripts" ] \ + && echo "Host $HOSTNAME updating scripts: ${_ROOT} ..." \ + && (git -C "${_ROOT}" pull &> /dev/null &) \ + && return 0 + + [ "${_MODE}" == "--definitions" ] \ + && echo "Host ${HOSTNAME} updating definitions: ${_DEFINITIONS} ..." \ + && (git -C "${_DEFINITIONS}" pull &> /dev/null &) \ + && return 0 + + [ "${_MODE}" == "--states" ] \ + && echo "Host ${HOSTNAME} updating states: ${_STATES} ..." \ + && (git -C "${_STATES}" pull &> /dev/null &) \ + && return 0 + + echo "Host ${HOSTNAME} updating ${_MODE}:" \ + && echo " - ${_ROOT}" \ + && echo " - ${_DEFINITIONS}" \ + && echo " - ${_STATES}" + git -C "${_ROOT}" pull &> /dev/null + git -C "${_DEFINITIONS}" pull &> /dev/null + git -C "${_STATES}" pull &> /dev/null +} + +# sanitizes all parameters +update_repositories \ + "$(echo ${1} | sed -E 's|[^a-zA-Z0-9/:@._-]*||g')" \ + && exit 0 || exit 1