commit 1fabfb5204f7b621a832a7ad48b8e9dd5cc49df5 Author: trimstray Date: Sat Jun 23 12:45:27 2018 +0200 init commit - signed-off-by: trimstray diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..10ee1b0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# This is where the result of the script output. +log/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..a20dfa2 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,33 @@ +notifications: + email: + recipients: + - git@nslab.at + on_success: always + on_failure: always + +branches: + only: + - master + - testing + +language: bash + +sudo: required + +addons: + apt: + packages: + - bash + +before_install: + - curl -sSL "https://ftp-master.debian.org/keys/archive-key-7.0.asc" | sudo -E apt-key add - + - echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | sudo tee -a /etc/apt/sources.list > /dev/null + - sudo apt-get update + - sudo apt-get install shellcheck + +# after_success: +# - test $TRAVIS_PULL_REQUEST = false && git push + +script: + - shellcheck --version + - shellcheck -s bash -e 1072,1094 -x src/* -x lib/* bin/git-template-full diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7a7ad4e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing + +If you would like to support this project, you have an interesting idea how to improve the operation of this tool or if you found some errors - do fork this add your fixes and add pull-request of your branch to the **testing branch**. + +## Bash style + +I would like you to stick to certain standards of writing in bash. I realize that it is not easy and time-consuming if you have certain habits. I do not expect 100% compliance and adherence to good practices, however, I would like you to try to use certain principles. + +The following should help: + +- [http://wiki.bash-hackers.org/](http://wiki.bash-hackers.org/) +- [https://google.github.io/styleguide/shell.xml](https://google.github.io/styleguide/shell.xml) +- [https://github.com/progrium/bashstyle](https://github.com/progrium/bashstyle) + + +- [http://kvz.io/blog/2013/11/21/bash-best-practices/](http://kvz.io/blog/2013/11/21/bash-best-practices/) + +## Shellcheck + +One of the requirements before approving your changes is to check them with the **shellcheck** utility. If the returned errors are not critical (eg. [SC2154](https://github.com/koalaman/shellcheck/wiki/SC2154)) you can use the `shellcheck disable=SC2154` design. + +## Signature of commit + +Moving forward all commits to this project must include a "signed-off-by" line indicating the name and email address of the contributor signing off on the change. To enable signatures add the following lines to `.git/hooks/prepare-commit-msg` : + +`````` +SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/- signed-off-by: \1/p') +grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" +`````` + +## Pull requests + +When creating pull request, please heed the following: + +- Base your code on the latest master branch to avoid manual merges +- Code review may ensue in order to help shape your proposal +- Explain the problem and your proposed solution + + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..aa88ca6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,676 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . + diff --git a/README.md b/README.md new file mode 100644 index 0000000..72f84de --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +

+ Master +

+ +

A collection of awesome lists, manuals, hacks and tools for Awesome Ninja Admins.

+ +
+ diff --git a/ana.conf b/ana.conf new file mode 100644 index 0000000..082ad39 --- /dev/null +++ b/ana.conf @@ -0,0 +1,3 @@ +_functions=(_git _scg _scl) + +_aliases=(git main ssh system) diff --git a/awesome-ninja-admins b/awesome-ninja-admins new file mode 100755 index 0000000..44dc634 --- /dev/null +++ b/awesome-ninja-admins @@ -0,0 +1,84 @@ +#!/usr/bin/env bash + +### BEG SCRIPT INFO +# +# Header: +# +# fname : "ana-init" +# cdate : "24.05.2018" +# author : "Michał Żurawski " +# tab_size : "2" +# soft_tabs : "yes" +# +# Description: +# +# See README.md file for more information. +# +# License: +# +# awesome-ninja-admins, Copyright (C) 2018 Michał Żurawski +# +# 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 . +# +### END SCRIPT INFO + +# The array that store call parameters. +# shellcheck disable=SC2034 +__init_params=() +__script_params=("$@") + +# Store the name of the script and directory call. +readonly _ana_dir="${HOME}/.awesome-ninja-admins" + +# Directory structure. +# shellcheck disable=SC2154 +readonly _ana_src="${_ana_dir}/src" +readonly _ana_lib="${_ana_dir}/lib" + +# shellcheck disable=SC1090,SC1091 +source "${_ana_src}/settings" +# shellcheck disable=SC1090 +source "${_ana_src}/helpers" + +# Include main configuration file. +# shellcheck disable=SC1090 +source "${_ana_dir}/ana.conf" || (printf "%s\\n" "file not found" ; exit) + +# shellcheck disable=SC2154 +for _i in "${_functions[@]}" ; do + + _fd="${_ana_lib}/functions/${_i}" + if [[ ! -z "$_fd" ]] && [[ -e "$_fd" ]] ; then + + # If the file exists is loaded. + # shellcheck disable=SC1090 + source "${_fd}" + + fi + +done + +# shellcheck disable=SC2154 +for _i in "${_aliases[@]}" ; do + + _fd="${_ana_lib}/aliases/${_i}" + if [[ ! -z "$_fd" ]] && [[ -e "$_fd" ]] ; then + + # If the file exists is loaded. + # shellcheck disable=SC1090 + source "${_fd}" + + fi + +done diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/img/awesome_ninja_admins.png b/doc/img/awesome_ninja_admins.png new file mode 100644 index 0000000..db5c448 Binary files /dev/null and b/doc/img/awesome_ninja_admins.png differ diff --git a/install b/install new file mode 100755 index 0000000..bbee368 --- /dev/null +++ b/install @@ -0,0 +1,205 @@ +#!/usr/bin/env bash + +### BEG SCRIPT INFO +# +# Header: +# +# fname : "awesome-ninja-admins" +# cdate : "24.05.2018" +# author : "Michał Żurawski " +# tab_size : "2" +# soft_tabs : "yes" +# +# Description: +# +# See README.md file for more information. +# +# License: +# +# awesome-ninja-admins, Copyright (C) 2018 Michał Żurawski +# +# 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 . +# +### END SCRIPT INFO + + +# The array that store call parameters. +# shellcheck disable=SC2034 +__init_params=() +__script_params=("$@") + +# Store the name of the script and directory call. +readonly _init_name="$(basename "$0")" +readonly _init_directory="$(dirname "$(readlink -f "$0")")" + +# Set root directory. +readonly _rel="${_init_directory}" + +# Directory structure. +# shellcheck disable=SC2154 +readonly _src="${_rel}/src" +readonly _lib="${_rel}/lib" +readonly _cfg="${_rel}/etc" + +# shellcheck disable=SC1090,SC1091 +source "${_src}/settings" +# shellcheck disable=SC1090 +source "${_src}/helpers" + + +################################################################################ +######################### Main function (script init) ########################## +################################################################################ + +function __main__() { + + local _FUNCTION_ID="__main__" + local _STATE="0" + + # Stores the current date. + readonly _cdate=$(date +%Y%m%d) + + # External configuration file (-c|--config script param). + config="" + load_state="0" + + # Declaration of output variables (--debug and --verbose params). + stdout_mode="" + printf_mode="" + # Enable/disable output colors. + # shellcheck disable=SC2034 + s_color="true" + + # We place here used commands at script runtime, as strings to anything + # unnecessarily run. + readonly commands=("basename" "dirname" "stat" "date" "grep" "egrep" "cut" \ + "sed" "gzip" "tar") + + # If you intend to specify the full path to the command we do it like: + # readonly exec_gzip="/bin/gzip" + + # Stores the names of the missing commands. + missing_hash=() + missing_counter="0" + + for i in "${commands[@]}" ; do + + if [[ ! -z "$i" ]] ; then + + hash "$i" >/dev/null 2>&1 ; state="$?" + + # If the command was not found put it in the array + if [[ "$state" -ne 0 ]] ; then + + missing_hash+=("$i") + ((missing_counter++)) + + fi + + fi + + done + + # It is a good idea to terminate the script at this stage + # with information for the user to fix the errors if at least one + # of the required commands in the commands array is not found. + if [[ "$missing_counter" -gt 0 ]] ; then + + printf "not found in PATH: %s\\n" "${missing_hash[*]}" >&2 + exit 1 + + fi + + # Specifies the call parameters of the script, the exact description + # can be found in _help_ and file README.md. + local _short_opt="" + local _long_opt="help" + + _GETOPT_PARAMS=$(getopt -o "${_short_opt}" --long "${_long_opt}" \ + -n "${_init_name}" -- "${__script_params[@]}") + + # With this structure, in the case of problems with the parameters placed + # in the _GETOPT_PARAMS variable we finish the script. Keep this in mind + # because it has some consequences - the __main __() function will not be + # executed. + + # Ends an error if the parameter or its argument is not valid. + _getopt_state="$?" + if [ "$_getopt_state" != 0 ] ; then + exit 1 + fi + + eval set -- "$_GETOPT_PARAMS" + while true ; do + + case $1 in + + --help) + + _help_ + + shift ; exit 0 ;; + + *) + + if [[ "$2" == "-" ]] || [[ ! -z "$2" ]] ; then + + printf "%s: invalid option -- '%s'\\n" "$_init_name" "$2" + exit 1 + + # elif [[ -z "$2" ]] ; then break ; fi + else break ; fi + + ;; + + esac + + done + + ################################# USER SPACE ################################# + # ```````````````````````````````````````````````````````````````````````````` + # Put here all your variable declarations, function calls + # and all the other code blocks. + + # In this section we add external file (for -c|--config script param). + if [[ "$load_state" -eq 1 ]] ; then _load "head" "$config" ; fi + + # shellcheck disable=SC2034 + # Generate random value. + _random=$(date +"%s") + + local _user + + _user=$(whoami) + + _sprintf "head" "Awesome-Ninja-Admins" + + _sprintf "info" "tasks:" + + _init_skel + + echo + + # ```````````````````````````````````````````````````````````````````````````` + + return "$_STATE" + +} + + +# We pass arguments to the __main__ function. +# It is required if you want to run on arguments type $1, $2, ... +__main__ "${__script_params[@]}" + +exit 0 diff --git a/lib/aliases/git b/lib/aliases/git new file mode 100644 index 0000000..f340290 --- /dev/null +++ b/lib/aliases/git @@ -0,0 +1,4 @@ +alias git.a='git add' +alias git.show='git log --oneline --decorate --graph --all' + +alias git.pm='_ana_git_pull master' diff --git a/lib/aliases/main b/lib/aliases/main new file mode 100644 index 0000000..e8aaf74 --- /dev/null +++ b/lib/aliases/main @@ -0,0 +1,24 @@ +alias ssh_nonpass='ssh -o PreferredAuthentications=password -o PubkeyAuthentication=no' +alias xfce.restart.panel='xfce4-panel -r' + +alias cpu.low='cpupower frequency-set -d' +alias cpu.high='cpupower frequency-set -u' +alias cpu.show='cpupower frequency-info' + +alias git.commit='git add . && git commit -m "uncommited changes"' + +alias claminit='/usr/bin/clamscan --suppress-ok-results --block-encrypted --database=/home/admin/.clamtk/db --scan-mail=yes --scan-archive=yes --max-scansize=500M --exclude-dir=^/home/admin/.clamtk/viruses --exclude-dir=^/sys/ --exclude-dir=^/dev/ --exclude-dir=^/proc/ --follow-dir-symlinks=1 --follow-file-symlinks=1 --detect-broken --recursive=yes' +alias ssh.pentest-kali='ssh 139.59.154.194 -p 9000' +alias ssh.ext-web1='ssh 46.101.164.125 -p 8200' + +alias l='ls -lFh --group-directories-first' #size,show type,human readable +alias la='ls -lAFh --group-directories-first' #long list,show almost all,show type,human readable +alias lr='ls -tRFh --group-directories-first' #sorted by date,recursive,show type,human readable +alias lt='ls -ltFh --group-directories-first' #long list,sorted by date,show type,human readable +alias ll='ls -l --group-directories-first' #long list + +alias git.reft="git pull origin testing && git fetch --all && git fetch --prune --tags" +alias git.refm="git pull origin master && git fetch --all && git fetch --prune --tags" + +alias show.dns="ll /etc/dnsmasq.d/templates" +alias show.vpn="ll /etc/netrog/vpn" diff --git a/lib/aliases/ssh b/lib/aliases/ssh new file mode 100644 index 0000000..c376527 --- /dev/null +++ b/lib/aliases/ssh @@ -0,0 +1 @@ +alias ssh.nonpass='ssh -o PreferredAuthentications=password -o PubkeyAuthentication=no' diff --git a/lib/aliases/system b/lib/aliases/system new file mode 100644 index 0000000..e69de29 diff --git a/lib/functions/_git b/lib/functions/_git new file mode 100644 index 0000000..ecbc34b --- /dev/null +++ b/lib/functions/_git @@ -0,0 +1,15 @@ +#!/usr/bin/env bash + +function _ana_git_pull() { + + local _arg=("$@") + + for _i in "${_arg[@]}" ; do + + printf "%s" "$_i" + + git pull origin "$_i" && git fetch --all && git fetch --prune --tags + + done + +} diff --git a/lib/functions/_scg b/lib/functions/_scg new file mode 100644 index 0000000..d41a1e0 --- /dev/null +++ b/lib/functions/_scg @@ -0,0 +1,6 @@ +function scg() { + + /usr/bin/keychain $HOME/.ssh/id_rsa.blueservices.pl + source $HOME/.keychain/$HOSTNAME-sh + +} diff --git a/lib/functions/_scl b/lib/functions/_scl new file mode 100644 index 0000000..5866291 --- /dev/null +++ b/lib/functions/_scl @@ -0,0 +1,5 @@ +function scl() { + + /usr/bin/keychain --clear + +} diff --git a/skel/.vimrc b/skel/.vimrc new file mode 100644 index 0000000..161d062 --- /dev/null +++ b/skel/.vimrc @@ -0,0 +1,75 @@ +" au BufWritePost * :set nobinary | set eol +autocmd FileType * setlocal eol nobinary fileformats="unix,mac,dos" + +set pastetoggle= + +set history=256 + +filetype plugin on + +set autoread + +set so=7 + +set wildmenu +set wildignore=*.o,*~,*.pyc + +set cmdheight=2 + +set hid + +set backspace=eol,start,indent +set whichwrap+=<,>,h,l + +set ignorecase +set smartcase +set hlsearch +set incsearch + +set lazyredraw + +set magic + +set number + +set showmatch +set mat=2 + +set noerrorbells +set novisualbell +set t_vb= +set tm=500 + +syntax enable + +colorscheme desert +set background=dark + +if has("gui_running") + set guioptions-=T + set guioptions+=e + set t_Co=256 + set guitablabel=%M\ %t +endif + +set encoding=utf8 +set ffs=unix,dos,mac + +set expandtab +set smarttab +set shiftwidth=2 +set tabstop=2 + +set lbr +set tw=500 + +set ai "Auto indent +set si "Smart indent +set wrap "Wrap lines + +set linebreak +set showbreak=>\ \ \ + +set laststatus=2 + +map :wq! diff --git a/src/helpers b/src/helpers new file mode 100644 index 0000000..ea7263c --- /dev/null +++ b/src/helpers @@ -0,0 +1,234 @@ +#!/usr/bin/env bash + +# shellcheck shell=bash + +################################################################################ +####################### Definitions of global functions ######################## +################################################################################ + +# `````````````````````````````````````````````````````````````````````````````` +# Function name: _sprintf() +# +# Description: +# Function designed to output to the screen in a clear format. +# +# Usage: +# _sprintf "type" "message" +# +# Examples: +# _sprintf "head" "correct certificate: $_ssl_cert_file" +# + +function _sprintf() { + + local _FUNCTION_ID="_sprintf" + local _STATE="0" + + local _s_type="$1" + local _s_info="$2" + + # Determine the type of character and color for each type + # of output information. + if [[ "$_s_type" == "head" ]] ; then + + s_char="::" + s_trgb="1;32" + + elif [[ "$_s_type" == "info" ]] ; then + + s_char="»" + s_trgb="0;33" + + elif [[ "$_s_type" == "warn" ]] ; then + + s_char="!" + s_trgb="1;37" + + elif [[ "$_s_type" == "stop" ]] ; then + + s_char="!" + s_trgb="1;31" + + else + + s_char="-" + s_trgb="0;37" + + fi + + # If verbose mode is enabled, display info message. + # shellcheck disable=SC2154 + if [[ "$_s_type" == "info" ]] ; then + + printf ' \e['${s_trgb}'m%s\e[m %s\n\n' "$s_char" "$_s_info" + + elif [[ "$_s_type" == "light-red" ]] ; then + + s_char="»" + printf ' \e[1;49;31m%s\e[m %s\n' "$s_char" "$_s_info" + + elif [[ "$_s_type" == "light-green" ]] ; then + + s_char="»" + printf ' \e[1;49;32m%s\e[m %s\n' "$s_char" "$_s_info" + + elif [[ "$_s_type" == "light-cyan" ]] ; then + + s_char="»" + printf ' \e[1;49;36m%s\e[m %s\n' "$s_char" "$_s_info" + + else + + # If not, just display only the head, warn or stop string. + # shellcheck disable=SC2154 + if [[ "$_s_type" == "head" ]] ; then + + if [[ "$s_color" == "true" ]] ; then + + c_trgb="1;38" + + printf '\e['${s_trgb}'m%s\e[m \e['${c_trgb}'m%s\e[m\n\n' "$s_char" "$_s_info" + + else + + printf '\e['${s_trgb}'m%s\e[m %s\n\n' "$s_char" "$_s_info" + + fi + + elif [[ "$_s_type" == "warn" ]] ; then + + if [[ "$s_color" == "true" ]] ; then + + c_trgb="1;43" + + printf ' \e['${s_trgb}'m%s\e[m \e['${c_trgb}'m%s\e[m\n' "$s_char" "$_s_info" + + else + + printf ' \e['${s_trgb}'m%s\e[m %s\n' "$s_char" "$_s_info" + + fi + + elif [[ "$_s_type" == "stop" ]] ; then + + if [[ "$s_color" == "true" ]] ; then + + c_trgb="1;41" + + printf ' \e['${s_trgb}'m%s\e[m \e['${c_trgb}'m%s\e[m\n' "$s_char" "$_s_info" + + else + + printf ' \e['${s_trgb}'m%s\e[m %s\n' "$s_char" "$_s_info" + + fi + + fi + + fi + + return "$_STATE" + +} + +# `````````````````````````````````````````````````````````````````````````````` +# Function name: _load() +# +# Description: +# Responsible for loading the configuration file, $config variable +# parameter is defined in the script call. +# +# Usage: +# _load "type" "path_to_config_file" +# +# Examples: +# _load "info" "$config" +# _load "head" "/tmp/file.cfg" +# + +function _load() { + + local _FUNCTION_ID="_load" + local _STATE="0" + + local _type="$1" + local _filename="$2" + + if [[ ! -z "$_filename" ]] && [[ -e "$_filename" ]] ; then + + # If we do not want to inform that the file is loaded, + # the value is 'null', otherwise: + if [[ "$_type" == "head" ]] ; then + + _sprintf "info" "load configuration: '$_filename'" + + elif [[ "$_type" == "info" ]] ; then + + _sprintf "info" "load configuration: '$_filename'" + + fi + + # shellcheck disable=SC1090 + # If the file exists is loaded. + . "$_filename" && \ + _logger "info" \ + "${_FUNCTION_ID}()" \ + "configuration file: '$_filename'" + + elif [ -z "$_filename" ] ; then + + _sprintf "stop" "incorrectly loaded '$_filename' file (incorrect filename)" + + else + + _sprintf "stop" "incorrectly loaded '$_filename' file (does not exist?)" + + fi + + return "$_STATE" + +} + +# `````````````````````````````````````````````````````````````````````````````` +# Function name: _init_skel() +# +# Description: +# Init user skel: +# - create directory structure +# +# Usage: +# _init_skel +# +# Examples: +# _init_skel +# + +function _init_skel() { + + local _FUNCTION_ID="_init_skel" + local _STATE="0" + + local _shell_config="${HOME}/.bashrc" + local _ana_string="source \"${HOME}/.awesome-ninja-admins/awesome-ninja-admins\"" + + # shellcheck disable=SC2154 + _sprintf "light-cyan" "init user skel" + + # shellcheck disable=SC2154 + rsync -a "${HOME}/.awesome-ninja-admins/skel/" "${HOME}" > /dev/null 2>&1 + + # shellcheck disable=SC2154 + _sprintf "light-cyan" "enable awesome-ninja-admins" + + _if_exist=$(grep -q "${_ana_string}" "${_shell_config}" ; echo "$?") + + if [[ "$_if_exist" -ne 0 ]] ; then + + echo "source \"${HOME}/.awesome-ninja-admins/awesome-ninja-admins\"" \ + >> "${_shell_config}" + + fi + + return "$_STATE" + +} diff --git a/src/settings b/src/settings new file mode 100644 index 0000000..5175fb0 --- /dev/null +++ b/src/settings @@ -0,0 +1,26 @@ +# shellcheck shell=bash + +################################################################################ +################## The configuration parameters of the script ################## +################################################################################ + +# Bash 'Strict Mode': +# errexit - exit the script if any statement returns a non-true return value +# pipefail - exit the script if any command in a pipeline errors +# nounset - exit the script if you try to use an uninitialised variable +# xtrace - display debugging information +set -o pipefail + +# Internal field separator (more flexible): +# IFS_ORIG="$IFS" +# IFS_HACK=$'\n\t' +# IFS="$IFS_HACK" + +# PATH env variable setup: +PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin + +# Setting permissions in the script environment: +# 0022 - less restrictive settings (default value) +# 0027 - for better security than above +# 0077 - only for user access (more restrictive) +umask 0027