├── .github └── workflows │ └── bats.yml ├── .gitignore ├── .gitmodules ├── LICENSE ├── README.md ├── src ├── help.txt ├── installconfig.ini └── main.sh └── test ├── cleanup.bats ├── install.bats ├── install_prep.bats ├── main.bats ├── output.bats ├── preinstall.bats ├── prompts.bats ├── test.sh ├── test_helper.bash └── validators.bats /.github/workflows/bats.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: 5 | - bats 6 | workflow_dispatch: 7 | 8 | jobs: 9 | bats: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | bash: ["bash:3.2", "bash:4.4", "bash:5.0", "bash:5.1"] 14 | container: 15 | image: ${{ matrix.bash }} 16 | 17 | steps: 18 | - name: Setup BATS 19 | uses: mig4/setup-bats@v1 20 | with: 21 | bats-version: 1.7.0 22 | 23 | - name: Install git 24 | run: apk add git 25 | 26 | - name: Checkout code 27 | uses: actions/checkout@v3 28 | 29 | - name: Set ownership 30 | run: | 31 | # this is to fix GIT not liking owner of the checkout dir 32 | chown -R $(id -u):$(id -g) $PWD 33 | 34 | - name: Checkout submodules 35 | run: git submodule update --init --recursive 36 | 37 | - name: Run main tests 38 | run: bats test/main.bats 39 | 40 | - name: Run output tests 41 | run: bats test/output.bats 42 | 43 | - name: Run validator tests 44 | run: bats test/validators.bats 45 | 46 | - name: Run prompts tests 47 | run: bats test/prompts.bats 48 | 49 | - name: Run install_prep tests 50 | run: bats test/install_prep.bats 51 | 52 | - name: Run preinstall tests 53 | run: bats test/preinstall.bats 54 | 55 | - name: Run install tests 56 | run: bats test/install.bats 57 | 58 | - name: Run cleanup tests 59 | run: bats test/cleanup.bats 60 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Ignore lib directory under test 4 | test/bats/ 5 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "test/bats"] 2 | path = test/bats 3 | url = https://github.com/bats-core/bats-core 4 | [submodule "test/libs/bats-support"] 5 | path = test/libs/bats-support 6 | url = https://github.com/bats-core/bats-support 7 | [submodule "test/libs/bats-file"] 8 | path = test/libs/bats-file 9 | url = https://github.com/bats-core/bats-file 10 | [submodule "test/libs/bats-assert"] 11 | path = test/libs/bats-assert 12 | url = https://github.com/bats-core/bats-assert 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # autopsmp 2 | Automated CyberArk Privileged Session Manager SSH Proxy Installer. 3 | 4 | # Installation 5 | 1. Create a non-root Administrative user with the name "proxymng" prior to running this script. Part of the install process may prevent remote logins from the root user and will only allow logins as "proxymng". If you create an account with a different username the script will ask you if you would like to create the user "proxymng" upon execution. 6 | 2. Login as the non-root user, "proxymng" and change to the user home directory. 7 | 3. Clone this git (i.e. git clone https://github.com/strick-j/autopsmp). 8 | 4. Execute using the following syntax "sudo ./autopsmp/src/main.sh". 9 | 5. Answer the prompts as requested, required prompt information is covered below. 10 | 11 | # Requirements 12 | 1. Prior to running this script you must have access to the needed source files from CyberArk. These files will typically be in a zip file named something similar to "Privileged Session Manager SSH Proxy-Rls-v13.x". To obtain these files, work with your CyberArk Account Rep or Sales Engineer. Additionally, these files are obtainable through the CyberArk Support Vault. 13 | 2. You must unzip and copy the entire directory to the server which the installation script is being executed on. Recommended location is /home/proxymng or /home/admin 14 | 15 | # User Prompts 16 | Prior to installation have the following information on hand: 17 | 1. Accept Eula 18 | 2. Folder path that the above required files were copied to. (e.g., /root/PSMP/ or /home/PSMP) 19 | 3. Vault IP Address 20 | 4. Vault Username - Note user requires permissions to perform several activities in the vault, more details can be found in the PAS Installation Guide. 21 | 5. Vault User Password 22 | 6. Vault Installation Mode - Integrated, Yes, No 23 | 7. Vault AD Bridge Install - Yes, No 24 | 8. Maintenance User (proxymng) account creation prompt 25 | -------------------------------------------------------------------------------- /src/help.txt: -------------------------------------------------------------------------------- 1 | NAME 2 | autopsmp - A utility to install the CyberArk Privileged Session Manager SSH Proxy 3 | 4 | SYNOPSIS 5 | ./main.sh [options] 6 | ./main.sh --silent 7 | ./main.sh --dryrun 8 | ./main.sh --debug 9 | ./main.sh --help 10 | ./main.sh --version 11 | 12 | DESCRIPTION 13 | The script follows the approved CyberArk installation procedures documented in the 14 | CyberArk public documentation. 15 | 16 | When this is run without any options an interactive prompt process is presented to the 17 | end user. Key items that require input include: 18 | 1. Accept EULA (Yes, No) 19 | 2. Directory of Installation package 20 | 3. CyberArk Vault IP 21 | 4. CyberArk Username with rights to install PSMP 22 | 5. PSMP Installation Mode (Integrated, Yes, No) 23 | 6. Install AD Bridge (Yes, No) 24 | 25 | Prior to running the script download and unzip the PSMP installation media and place 26 | the folder on the target system (e.g., /home//psmp) 27 | 28 | If running in silent mode, update the installconfig.ini file prior to running the script 29 | with the silent flag. 30 | 31 | EXAMPLES 32 | Interactive Install: 33 | ./main.sh 34 | Silent Install: 35 | ./main.sh --silent (requires installconfig.ini to be updated) 36 | Show Help: 37 | ./main.sh --help 38 | Show Version: 39 | ./main.sh --version 40 | -------------------------------------------------------------------------------- /src/installconfig.ini: -------------------------------------------------------------------------------- 1 | CYBR_DIR="/root/psmp" 2 | CYBR_ADDRESS="192.168.1.1" 3 | CYBR_USERNAME="Administrator" 4 | CYBR_PASS="" 5 | CYBR_MODE="Integrated" 6 | CYBR_BRIDGE="1" -------------------------------------------------------------------------------- /src/main.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | set -e 4 | 5 | # Version 6 | AUTOPSMP_VERSION="0.0.2-alpha" 7 | 8 | # Logging 9 | VAR_TMP_D="/var/tmp" 10 | VAR_INSTALL_LOG_F=$VAR_TMP_D/autopsmp_install.log 11 | SHOULD_SHOW_LOGS=1 12 | CYBR_DEBUG=0 13 | DEBUG=0 14 | 15 | # Generic Variables 16 | ENABLEADBRIDGE=0 17 | CYBERARKSSHD="Integrated" 18 | DRYRUN=0 19 | 20 | # Generic output functions (logging, terminal, etc..) 21 | function write_log() { 22 | if [ ${SHOULD_SHOW_LOGS} -eq 1 ] ; then 23 | echo "$(date) | INFO | $1" >> $VAR_INSTALL_LOG_F 24 | [ ${CYBR_DEBUG} -eq 1 ] && printf 'DEBUG: %s\n' "$1" 25 | fi 26 | } 27 | 28 | function write_error() { 29 | echo "$(date) | ERROR | $1" >> $VAR_INSTALL_LOG_F 30 | printf 'ERROR: %s\n' "$1" 31 | } 32 | function write_to_terminal() { 33 | echo "$(date) | INFO | $1" >> $VAR_INSTALL_LOG_F 34 | printf 'INFO: %s\n' "$1" 35 | } 36 | 37 | function write_header() { 38 | echo "" 39 | echo "=======================================================================" 40 | echo "$1" 41 | echo "=======================================================================" 42 | echo "" 43 | } 44 | 45 | function check_uid() { 46 | if [[ $(id -u) != "0" ]] ; then 47 | write_to_terminal "This script must be run as root. Exiting..." 48 | exit 1 49 | fi 50 | } 51 | 52 | # Functional checks 53 | function check_se_linux() { 54 | # Check SELinux and recommend enabling if not enabled 55 | write_to_terminal "Checking SELinux status" 56 | local selinuxconfig=/etc/selinux/config 57 | if test -f "$selinuxconfig" ; then 58 | local selinuxEnforcing="" 59 | selinuxEnforcing=$(sestatus | grep enabled ) 60 | if [[ -n $selinuxEnforcing ]] ; then 61 | write_to_terminal "SELinux enabled, proceeding..." 62 | else 63 | write_to_terminal "SELinux is not enabled. CyberArk recommends enabling SELinux prior to installation. Exit and enable SELinux?" 64 | verify_se_linux 65 | fi 66 | else 67 | write_to_terminal "SELinux config file not found. CyberArk recommends enabling SELinux prior to installation. Exit and enable SELinx?" 68 | verify_se_linux 69 | fi 70 | printf "\n" 71 | } 72 | 73 | function verify_se_linux() { 74 | select yn in "Yes" "No"; do 75 | case $yn in 76 | Yes ) write_to_terminal "Exiting now..."; exit 1;; 77 | No ) write_to_terminal "Proceeding with SELinux disabled..."; break;; 78 | esac 79 | done 80 | } 81 | 82 | function disable_nscd() { 83 | # Check status of nscd service and socket 84 | nscd_array=("service" "socket") 85 | for nscd in ${nscd_array[@]} 86 | do 87 | nscd="$nscd" 88 | # Check if service is active, stop if so 89 | if [[ $(systemctl status nscd.$nscd | awk '/Active:/ {print $2}') = "active" ]] ; then 90 | write_to_terminal "nscd.${nscd} is active. Stopping nsdc.${nscd}" 91 | systemctl stop nscd.${nscd} 92 | if [[ $(systemctl status nscd.$nscd | awk '/Active:/ {print $2}') = "active" ]] ; then 93 | write_to_terminal "Failed to stop nscd.${nscd} service. Please stop and remove manually. Exiting..." 94 | exit 1 95 | else 96 | write_to_terminal "nscd.${nscd} successfully stopped. Proceeding..." 97 | fi 98 | else 99 | write_to_terminal "nscd.${nscd} is not active. Proceeding..." 100 | fi 101 | 102 | if [[ $(systemctl is-enabled nscd.$nscd) = "enabled" ]] ; then 103 | write_to_terminal "nscd.${nscd} is loaded. Attempting to disable" 104 | systemctl disable nscd.${nscd} 105 | if [[ $(systemctl is-enabled nscd.$nscd) = "enabled" ]] ; then 106 | write_to_terminal "Failed to disable nscd.${nscd} service. Please disable manually. Exiting..." 107 | exit 1 108 | else 109 | write_to_terminal "nscd.${nscd} successfully disabled Proceeding..." 110 | fi 111 | else 112 | write_to_terminal "nscd.${nscd} is not loaded. Proceeding..." 113 | fi 114 | done 115 | } 116 | 117 | function gather_facts() { 118 | write_to_terminal "Gathering installation system facts..." 119 | # Check if system is being installed in docker container and warn end user 120 | if [[ -f /.dockerenv ]] ; then 121 | write_to_terminal "Installing PSMP in a docker container is not officially supported. Proceeding..." 122 | export CYBR_DOCKER=1 123 | else 124 | export CYBR_DOCKER=0 125 | fi 126 | 127 | # Check Operating System 128 | if [[ -f /etc/os-release ]] ; then 129 | local os 130 | local osversion 131 | os=$(awk '{ FS = "="} /^ID=/ {print $2}' /etc/os-release | sed -e 's/^"//' -e 's/"$//' ) 132 | osversion=$(awk '{ FS = "="} /^VERSION_ID=/ {print $2}' /etc/os-release | sed -e 's/^"//' -e 's/"$//' ) 133 | export CYBR_OS="$os" 134 | export CYBR_OSVERSION="$osversion" 135 | write_to_terminal "Detected OS: ${CYBR_OS}" 136 | write_to_terminal "Detected OS Version: ${CYBR_OSVERSION}" 137 | write_to_terminal "Proceeding..." 138 | else 139 | write_to_terminal "Unable to determine system OS, exiting..." 140 | exit 1 141 | fi 142 | } 143 | 144 | function accept_eula() { 145 | # Prompt for EULA Acceptance 146 | write_to_terminal "Have you read and accepted the CyberArk EULA?" 147 | select yn in "Yes" "No"; do 148 | case $yn in 149 | Yes ) write_to_terminal "EULA Accepted, proceeding..."; break;; 150 | No ) write_to_terminal "EULA not accepted, exiting now..."; exit 1;; 151 | esac 152 | done 153 | printf "\n" 154 | } 155 | 156 | function enable_ad_bridge() { 157 | # Prompt to enable AD Bridge 158 | write_to_terminal "Enable PSMP AD Bridging?" 159 | select yn in "Yes" "No"; do 160 | case $yn in 161 | Yes ) write_to_terminal "Install will enable AD Bridging capability, proceeding..."; export CYBR_BRIDGE=0; break;; 162 | No ) write_to_terminal "Install will not enable AD Bridging capability, proceeding..."; export CYBR_BRIDGE=1; break;; 163 | esac 164 | done 165 | printf "\n" 166 | } 167 | 168 | function dir_prompt() { 169 | # Prompt for directory info of installation folder, verify directory exists 170 | local cybr_dir 171 | write_to_terminal "Requesting installation directory information:" 172 | read -rp 'Please enter the full path for the folder containing installation media [e.g. /tmp/psmp]: ' cybr_dir 173 | if [[ -d $cybr_dir ]]; then 174 | # Check for required installation files in directory 175 | if [[ ! -f $cybr_dir/vault.ini ]] || [[ ! -f $cybr_dir/psmpparms.sample ]] ; then 176 | write_to_terminal "Required files not found within directory, would you like to try again?" 177 | select yn in "Yes" "No"; do 178 | case $yn in 179 | Yes ) dir_prompt; break;; 180 | No ) write_to_terminal "Unable to find required installation files, exiting..."; exit 1;; 181 | esac 182 | done 183 | fi 184 | write_to_terminal "Directory information confirmed as: $cybr_dir, proceeding..." 185 | export CYBR_DIR=$cybr_dir 186 | printf "\n" 187 | else 188 | # Directory not present, allow user to re-enter path or exit 189 | write_to_terminal "Directory not found, would you like to try again?" 190 | select yn in "Yes" "No"; do 191 | case $yn in 192 | Yes ) dir_prompt; break;; 193 | No ) write_to_terminal "Unable to find installation folder, exiting..."; exit 1;; 194 | esac 195 | done 196 | fi 197 | } 198 | 199 | function address_prompt() { 200 | local cybr_address 201 | write_to_terminal "Requesting Vault IP for installation:" 202 | read -erp 'Please enter Vault IP Address: ' cybr_address 203 | local res=0 204 | # Check Address validity 205 | res=$(valid_ip "$cybr_address") 206 | if [[ $res -eq 0 ]] ; then 207 | write_to_terminal "Valid IP Address provided, proceeding..." 208 | confirm_input "$cybr_address" "Address" 209 | export CYBR_ADDRESS=$cybr_address 210 | else 211 | write_to_terminal "Invalid address provided, would you like to try again?" 212 | select yn in "Yes" "No"; do 213 | case $yn in 214 | Yes ) address_prompt; break;; 215 | No ) write_to_terminal "Invalid address provided, exiting..."; exit 1;; 216 | esac 217 | done 218 | fi 219 | printf "\n" 220 | } 221 | 222 | function username_prompt() { 223 | local cybr_username 224 | write_to_terminal "Requesting Vault Username for installation:" 225 | read -erp 'Please enter Vault Username: ' cybr_username 226 | local res=0 227 | # Check Username validity 228 | res=$(valid_username "$cybr_username") 229 | if [[ $res -eq 0 ]] ; then 230 | write_to_terminal "Valid username provided, proceeding..." 231 | confirm_input "$cybr_username" "Username" 232 | export CYBR_USERNAME=$cybr_username 233 | else 234 | case $res in 235 | 2) write_to_terminal "Invalid Username: Username is too long.";; 236 | 3) write_to_terminal "Invalid Username: Username has a leading or trailing dot or space.";; 237 | 4) write_to_terminal "Invalid Username: Username contains invalid characters.";; 238 | *) write_to_terminal "Invalid Username: Invalid Username provided." 239 | esac 240 | write_to_terminal "Would you like to try again?" 241 | select yn in "Yes" "No"; do 242 | case $yn in 243 | Yes ) username_prompt; break;; 244 | No ) write_to_terminal "Invalid username provided, exiting..."; exit 1;; 245 | esac 246 | done 247 | fi 248 | printf "\n" 249 | } 250 | 251 | function pass_prompt() { 252 | local passvar1 253 | local passvar2 254 | # Prompt for Vault Password info 255 | write_to_terminal "Requesting Vault Password. Password must be entered twice and will be hidden:" 256 | read -serp 'Please enter Vault Password: ' passvar1 257 | printf "\n" 258 | read -serp 'Please re-enter Vault Password: ' passvar2 259 | printf "\n" 260 | # Test if passwords match 261 | if [[ "$passvar1" == "$passvar2" ]]; then 262 | # Check password validity 263 | res=$(valid_pass "$passvar1") 264 | if [[ $res -eq 0 ]] ; then 265 | write_to_terminal "Valid password provided, proceeding..." 266 | export CYBR_PASS=$passvar1 267 | # Unset password variables 268 | unset passvar1 269 | unset passvar2 270 | else 271 | write_to_terminal "Password is not valid. Please try again." 272 | pass_prompt 273 | fi 274 | else 275 | write_to_terminal "Passwords do not match. Please try again." 276 | pass_prompt 277 | fi 278 | printf "\n" 279 | } 280 | 281 | function mode_prompt() { 282 | # Prompt for CyberArkInstallSSHD mode 283 | write_to_terminal "Desired InstallCyberArkSSHD setting (Integrated, Yes, No): " 284 | select method in "Integrated" "Yes" "No"; do 285 | case $method in 286 | Integrated ) 287 | write_to_terminal "InstallCyberArkSSHD=Integrated, proceeding..." 288 | export CYBR_MODE="Integrated" 289 | break;; 290 | Yes ) 291 | write_to_terminal "InstallCyberArkSSHD=Yes, proceeding..." 292 | export CYBR_MODE="Yes" 293 | break;; 294 | No ) 295 | write_to_terminal "InstallCyberArkSSHD=No, some limitations apply, proceeding..." 296 | export CYBR_MODE="No" 297 | break;; 298 | *) 299 | write_to_terminal "Invalid option selected..." 300 | mode_prompt 301 | esac 302 | done 303 | printf "\n" 304 | } 305 | 306 | # Check environment Variables for non-interactive install: 307 | function read_installation_var() { 308 | write_to_terminal "Silent installation detected, checking installation variables..." 309 | 310 | env_vars=("CYBR_DIR" "CYBR_ADDRESS" "CYBR_USERNAME" "CYBR_PASS" "CYBR_MODE" "CYBR_BRIDGE") 311 | for var in "${env_vars[@]}" ; do 312 | write_log "Reading Variable ${var}" 313 | installvar=$(awk -F "=" '/'${var}'=/{print $2} ' installconfig.ini | sed -e 's/^"//' -e 's/"$//') 314 | if [[ $installvar ]] ; then 315 | write_log "Variable ${var} found, proceeding..." 316 | write_to_terminal "${installvar}" 317 | export ${var}="${installvar}" 318 | else 319 | write_to_terminal "${var} is not set, exiting..." 320 | exit 1 321 | fi 322 | done 323 | 324 | write_to_terminal "All Environment Variables found, proceeding..." 325 | } 326 | 327 | function validate_installation_var() { 328 | # Use validators to check installation variables read from installconfig.ini 329 | write_to_terminal "Validating installation variables:" 330 | [[ $(valid_ip "${CYBR_ADDRESS}") -eq 0 ]] && (write_log "Valid IP found") || (write_error "Invalid IP provided exiting..."; exit 1) 331 | [[ $(valid_username "${CYBR_USERNAME}") -eq 0 ]] && (write_log "Valid Username found") || (write_error "Invalid Username provided, exiting..."; exit 1) 332 | [[ $(valid_pass "${CYBR_PASS}") -eq 0 ]] && (write_log "Valid password found") || (write_error "Invalid password provided, exiting..."; exit 1) 333 | [[ $CYBR_MODE =~ (^[Yy][Ee][Ss]$)|(^[Nn][Oo]$)|(^Integrated$) ]] && (write_log "Valide Installation mode found") || (write_error "Invalid Installation mode provided, exiting..."; exit 1) 334 | [[ $CYBR_BRIDGE =~ [0-1] ]] && (write_log "Valid AD Bridge mode found") || (write_error "Invalid AD Bridge mode provided, exiting..."; exit 1) 335 | write_to_terminal "Required installation variables validated, proceeding" 336 | } 337 | 338 | function create_vault_ini() { 339 | # Modifing vault.ini file with information provided above 340 | write_to_terminal "Updating vault.ini file with Vault IP: ${CYBR_ADDRESS}" 341 | # Verify vault.ini file is present, exit if not 342 | if [[ -f ${CYBR_DIR}/vault.ini ]]; then 343 | write_to_terminal "Found vault.ini, making backup and proceeding..." 344 | # Modify IP address in vault.ini file 345 | cp "${CYBR_DIR}"/vault.ini "${CYBR_DIR}"/vault.ini.bak 346 | sed -i "s+ADDRESS=.*+ADDRESS=${CYBR_ADDRESS}+g" "${CYBR_DIR}"/vault.ini 347 | write_to_terminal "Completed vault.ini file modifications, proceeding..." 348 | else 349 | # Error - File not found 350 | write_to_terminal "vault.ini file not found, verify needed files have been copied over. Exiting now..." 351 | exit 1 352 | fi 353 | printf "\n" 354 | } 355 | 356 | function create_credfile() { 357 | local verifycredfile 358 | # Create credential file with username and password provided above 359 | write_to_terminal "Creating Credential File for authorization to Vault" 360 | # Verify CreateCredFile is present, exit if not 361 | if [[ -f ${CYBR_DIR}/CreateCredFile ]];then 362 | # Modify permissions and create credential file 363 | chmod 755 "${CYBR_DIR}"/CreateCredFile 364 | "${CYBR_DIR}"/CreateCredFile "${CYBR_DIR}"/user.cred Password -username "${CYBR_USERNAME}" -password "${CYBR_PASS}" -EntropyFile >> autopsmp.log 2>&1 365 | # Unset password variable 366 | unset CYBR_PASS 367 | verifycredfile=$(tail -1 autopsmp.log) 368 | if [[ "$verifycredfile" == "Command ended successfully" ]]; then 369 | rm -f autopsmp.log 370 | write_to_terminal "Credential file created successfully, proceeding..." 371 | else 372 | write_to_terminal "Credential file not created sueccessfully. Exiting now..." 373 | exit 1 374 | fi 375 | else 376 | write_to_terminal "CreateCredFile file not found, verify needed files have been copied over. Exiting now..." 377 | exit 1 378 | fi 379 | printf "\n" 380 | } 381 | 382 | function create_psmpparms() { 383 | # Update psmpparms file with userprovided information 384 | write_to_terminal "Updating psmpparms file with user provided information" 385 | # Verify psmpparms.sample is present, exit if not 386 | if [[ -f ${CYBR_DIR}/psmpparms.sample ]]; then 387 | # Create psmpparms file and modify variables 388 | cp "${CYBR_DIR}"/psmpparms.sample "$VAR_TMP_D"/psmpparms 389 | sed -i "s+InstallationFolder.*+InstallationFolder=${CYBR_DIR}+g" "$VAR_TMP_D"/psmpparms 390 | sed -i "s+AcceptCyberArkEULA=No+AcceptCyberArkEULA=Yes+g" "$VAR_TMP_D"/psmpparms 391 | sed -i "s+InstallCyberArkSSHD=Integrated+InstallCyberArkSSHD=${CYBR_MODE}+g" "$VAR_TMP_D"/psmpparms 392 | if [[ ${CYBR_BRIDGE} -eq 0 ]] ; then 393 | sed -i "s+#EnableADBridge=no+EnableADBridge=Yes+g" "$VAR_TMP_D"/psmpparms 394 | fi 395 | if [[ ${CYBR_OS} =~ ^([sS][uUlL][sSeE][eEsS])$ ]] ; then 396 | sed -i "s+Hardening=Yes+Hardening=No+g" "$VAR_TMP_D"/psmpparms 397 | fi 398 | write_to_terminal "psmpparms file modified and copied to $VAR_TMP_D, proceeding..." 399 | else 400 | # Error - File not found 401 | write_to_terminal "psmpparms.sample file not found, verify needed files have been copied over. Exiting now..." 402 | exit 1 403 | fi 404 | printf "\n" 405 | } 406 | 407 | function preinstall_gpgkey() { 408 | write_to_terminal "Verifying rpm GPG Key is present" 409 | if [[ -f ${CYBR_DIR}/RPM-GPG-KEY-CyberArk ]] ; then 410 | # Import GPG Key 411 | write_to_terminal "GPG Key present - Importing..." 412 | #TODO: Catch import error 413 | rpm --import ${CYBR_DIR}/RPM-GPG-KEY-CyberArk 414 | write_to_terminal "GPG Key imported, proceeding..." 415 | else 416 | # Error - File not found 417 | write_to_terminal "RPM GPG Key not found, verify needed files have been copied over. Exiting now..." 418 | exit 1 419 | fi 420 | printf "\n" 421 | } 422 | 423 | function preinstall_libssh() { 424 | write_to_terminal "Verifying Pre-Requisites are present" 425 | if [[ $(rpm -qa | grep "libssh-") ]]; then 426 | write_to_terminal "libssh is already installed, skipping..." 427 | else 428 | local libsshrpm=$(find ${CYBR_DIR} -name '*libssh*') 429 | if [[ -f $libsshrpm ]]; then 430 | # Install libssh 431 | write_to_terminal "libssh present - Installing $libsshrpm" 432 | rpm -ih "$libsshrpm" 433 | write_to_terminal "$libsshrpm installed, proceeding..." 434 | else 435 | # Error - File not found 436 | write_to_terminal "libssh rpm not found, verify needed Pre-Requisites have been copied over. Exiting now..." 437 | exit 1 438 | fi 439 | fi 440 | printf "\n" 441 | } 442 | 443 | function preinstall_infra() { 444 | write_to_terminal "CyberArkSSHD set to integrated mode. CARKpsmp-infra will be installed." 445 | local infrarpm=$(find ${CYBR_DIR} -name '*CARKpsmp-infra*.rpm') 446 | if [[ -f $infrarpm ]] ; then 447 | # Install CARKpsmp-infra 448 | write_to_terminal "CARKpsmp-infra present - Installing $infrarpm" 449 | if [ $DRYRUN -eq 0 ] ; then 450 | write_to_terminal "Starting install - $infrarpm" 451 | rpm -ih "$infrarpm" 452 | write_to_terminal "$infrarpm installed, proceeding..." 453 | else 454 | write_to_terminal "CARKpsmp-infra rpm found: $infrarpm" 455 | write_to_terminal "Skipping installation for dryrun, proceeding..." 456 | fi 457 | else 458 | # Error - File not found 459 | write_to_terminal "CARKpsmp-infra rpm not found and is required for integrated mode, verify needed Pre-Requisites have been copied over. Exiting now..." 460 | exit 1 461 | fi 462 | printf "\n" 463 | } 464 | 465 | function install_psmp() { 466 | write_to_terminal "Verifying PSMP rpm installer is present" 467 | local psmprpm=$(find ${CYBR_DIR} -name '*CARKpsmp*.rpm' -not -path "*/IntegratedMode*") 468 | if [[ -f $psmprpm ]] ; then 469 | # Install CyberArk RPM 470 | write_to_terminal "PSMP rpm installer present..." 471 | # Skip installation if dryrun 472 | if [ $DRYRUN -eq 0 ] ; then 473 | write_to_terminal "Starting install - $psmprpm" 474 | rpm -ih "$psmprpm" 475 | write_to_terminal "PSMP install complete, proceeding..." 476 | else 477 | write_to_terminal "CARKpsmp rpm found: $psmprpm" 478 | write_to_terminal "Skipping installation for dryrun, proceeding..." 479 | fi 480 | else 481 | # Error - File not found 482 | write_to_terminal "PSMP rpm install file not found, verify needed files have been copied over. Exiting now..." 483 | exit 1 484 | fi 485 | printf "\n" 486 | } 487 | 488 | function postinstall_integratedsuse() { 489 | write_to_terminal "Running post installation steps for Integrated Mode on SUSE" 490 | # Disble nscd module 491 | local disable_rcnscd=$(rcnscd stop && chkconfig nscd off) 492 | $disable_rcnscd 493 | 494 | # Fix Symbolic Link issues 495 | write_to_terminal "Fixing symbolic link issues for public cert chain" 496 | if [[ -d /etc/pki/tls/certs ]] ; then 497 | write_log "/etc/pki/tls/certs directory exists already" 498 | # Check for symbolic link 499 | if [[ -f /etc/pki/tls/certs/ca-bundle.crt ]] ; then 500 | write_log "Symbolic link /etc/pki/tls/certs/ca-bundle.crt already exists" 501 | else 502 | ln -s /etc/ssl/ca-bundle.pem /etc/pki/tls/certs/ca-bundle.crt 503 | if [[ -f /etc/pki/tls/certs/ca-bundle.crt ]] ; then 504 | write_log "Symbolic link /etc/pki/tls/certs/ca-bundle.crt created successfully" 505 | else 506 | write_error "Failed to create /etc/pki/tls/certs/ca-bundle.crt symbolic link, manually create symbolic link" 507 | fi 508 | fi 509 | else 510 | # Directory doesnt exist 511 | write_log "Creating /etc/pki/tls/certs" 512 | mkdir -p /etc/pki/tls/certs 513 | if [[ -d /etc/pki/tls/certs ]] ; then 514 | write_log "/etc/pki/tls/certs directory created" 515 | # Create symbolic link 516 | if [[ -f /etc/ssl/ca-bundle.pem ]] ; then 517 | ln -s /etc/ssl/ca-bundle.pem /etc/pki/tls/certs/ca-bundle.crt 518 | if [[ -f /etc/pki/tls/certs/ca-bundle.crt ]] ; then 519 | write_log "Symbolic link /etc/pki/tls/certs/ca-bundle.crt created successfully" 520 | else 521 | write_error "Failed to create /etc/pki/tls/certs/ca-bundle.crt symbolic link, manually create symbolic link" 522 | fi 523 | else 524 | write_error "Failed to find appropriate ca-bundle.pem to create symbolic link" 525 | fi 526 | # Restart PSMP Servive 527 | if [[ $CYBR_OS = "rhel" ]] && [[ $CYBR_OSVERSION = 8* ]]; then 528 | systemctl restart psmpsrv 529 | else 530 | service psmpsrv restart 531 | fi 532 | else 533 | write_error "Failed to create /etc/pki/tls/certs, manually create directory and symbolic link" 534 | fi 535 | fi 536 | 537 | # Restart PSMP Servive 538 | if [[ $CYBR_OS = "rhel" ]] && [[ $CYBR_OSVERSION = 8* ]]; then 539 | systemctl restart psmpsrv 540 | else 541 | service psmpsrv restart 542 | fi 543 | printf "\n" 544 | } 545 | 546 | function verify_psmp_rpms() { 547 | # Add checks for rpm 548 | if [[ ${CYBR_BRIDGE} -eq 0 ]] ; then 549 | write_to_terminal "Verifying libssh rpm is installed" 550 | local installedlibsshrpm=$(rpm -qa | grep "libssh-") 551 | if [[ ${installedlibsshrpm} ]] ; then 552 | write_to_terminal "${installedlibsshrpm} found, proceeding..." 553 | else 554 | write_to_terminal "Required libssh rpm not installed, review logs for errors. Exiting..." 555 | exit 1 556 | fi 557 | fi 558 | 559 | if [[ ${CYBR_MODE} == "Integrated" ]]; then 560 | write_to_terminal "Verifying PSMP Infra rpm is installed" 561 | local installedinfrarpm=$(rpm -qa | grep "CARKpsmp-infra") 562 | if [[ ${installedinfrarpm} ]] ; then 563 | write_to_terminal "${installedinfrarpm} found, proceeding..." 564 | else 565 | write_to_terminal "PSMP Infra rpm not installed, review logs for errors. Exiting..." 566 | exit 1 567 | fi 568 | fi 569 | 570 | write_to_terminal "Verifying PSMP rpm is installed." 571 | local installedrpm=$(rpm -q CARKpsmp) 572 | if [[ ${installedrpm} ]] ; then 573 | write_to_terminal "${installedrpm} found, proceeding..." 574 | else 575 | write_to_terminal "PSMP rpm not installed, review logs for errors. Exiting..." 576 | exit 1 577 | fi 578 | printf "\n" 579 | } 580 | 581 | function verify_psmp_services() { 582 | # Add checks for service(s) status 583 | if [[ ${CYBR_BRIDGE} -eq 0 ]] ; then 584 | local services_array=("psmp" "psmpadb") 585 | else 586 | local services_array=("psmp") 587 | fi 588 | 589 | for service in ${services_array[@]} 590 | do 591 | service="$service" 592 | write_to_terminal "Checking status of ${service}" 593 | if [[ $CYBR_OS = "rhel" ]] && [[ $CYBR_OSVERSION = 8* ]]; then 594 | if [[ $(systemctl status psmpsrv-${service}server | awk '/Active:/ {print $2}') = "active" ]] ; then 595 | write_to_terminal "${service} service is active, proceeding..." 596 | else 597 | write_to_terminal "${service} service is not active, review logs for errors. Proceeding..." 598 | fi 599 | else 600 | if [[ $(service psmpsrv status ${service} | grep "running") ]] ; then 601 | write_to_terminal "${service} service is active, proceeding..." 602 | else 603 | write_to_terminal "${service} service is not active, review logs for errors. Proceeding..." 604 | fi 605 | fi 606 | done 607 | printf "\n" 608 | } 609 | 610 | function clean_install() { 611 | # Cleaning up system files used during install 612 | write_to_terminal "Removing user.cred, vault.ini, and CreateCredFile Utility" 613 | rm -f "${CYBR_DIR}"/user.cred 614 | rm -f "${CYBR_DIR}"/vault.ini 615 | rm -f "${CYBR_DIR}"/CreateCredFile 616 | if [[ -f ${CYBR_DIR}/user.cred ]]||[[ -f ${CYBR_DIR}/vault.ini ]]||[[ -f ${CYBR_DIR}/CreateCredFile ]]; then 617 | write_to_terminal "Files could not be deleted, please manually remove..." 618 | exit 1 619 | else 620 | write_to_terminal "PSMP installation and cleanup completed." 621 | exit 0 622 | fi 623 | 624 | # Move vault.ini.bak to vault.ini 625 | mv -f "${CYBR_DIR}"/vault.ini.bak "${CYBR_DIR}"/vault.ini 626 | printf "\n" 627 | } 628 | 629 | function check_maintenance_user() { 630 | # Verifying maintenance user exists 631 | local username="proxymng" 632 | write_to_terminal "Checking to see if maintenance user ${username} exists" 633 | if id $username >/dev/null 2>&1 ; then 634 | write_to_terminal "${username} exists. Ensure password is set prior to reboot. Proceeding..." 635 | else 636 | local done=0 637 | while : ; do 638 | write_to_terminal "Maintenance user ${username} does not exist, would you like to create ${username} user?" 639 | select yn in "Yes" "No"; do 640 | case $yn in 641 | Yes ) create_user "$username"; done=1; break;; 642 | No ) write_to_terminal "If you do not create a maintenance user you may not be able to log in after script completes via ssh. Create ${username} user?" 643 | select yn in "Yes" "No"; do 644 | case $yn in 645 | Yes ) create_user "$username"; done=1; break;; 646 | No ) write_to_terminal "Proceeding without creating maintenance user. Manually create before rebooting..."; done=1; break;; 647 | esac 648 | done 649 | if [[ "$done" -ne 0 ]]; then 650 | break 651 | fi 652 | esac 653 | if [[ "$done" -ne 0 ]]; then 654 | break 655 | fi 656 | done 657 | if [[ "$done" -ne 0 ]]; then 658 | break 659 | fi 660 | done 661 | fi 662 | printf "\n" 663 | } 664 | 665 | function create_user() { 666 | write_to_terminal "Creating ${1} user and setting permissions" 667 | useradd "$1" >/dev/null 2>&1 668 | 669 | local usergroup_array=("wheel" "admin" "PSMConnectUsers") 670 | 671 | for usergroup in ${usergroup_array[@]} 672 | do 673 | usergroup="$usergroup" 674 | write_to_terminal "Checking for group - ${usergroup}" 675 | if [ $(getent group ${usergroup}) ] ; then 676 | write_to_terminal "${usergroup} found. Adding ${1} to ${usergroup}" 677 | usermod -aG ${usergroup} "$1" >/dev/null 2>&1 678 | fi 679 | done 680 | 681 | write_to_terminal "Verifying user ${1} was created" 682 | if id "$1" >/dev/null 2>&1 ; then 683 | write_to_terminal "User ${1} created" 684 | write_to_terminal "Please set password for \"$1\"" 685 | passwd "$1" 686 | else 687 | write_to_terminal "User could not be created, manually add user prior to reboot" 688 | fi 689 | printf "\n" 690 | } 691 | 692 | function confirm_input() { 693 | local userinput=$1 694 | local inputfield=$2 695 | write_to_terminal "You entered ${userinput} for Vault ${inputfield}. Proceed or enter again?" 696 | select pc in "Proceed" "Change"; do 697 | case $pc in 698 | Proceed ) write_to_terminal "Input confirmed, proceeding..."; break;; 699 | Change ) 700 | case $inputfield in 701 | Address ) address_prompt; break;; 702 | Username ) username_prompt; break;; 703 | esac 704 | esac 705 | done 706 | } 707 | 708 | function valid_ip() { 709 | # Check for valid IP Address from user input 710 | local ip=$1 711 | local stat=1 712 | 713 | if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]] ; then 714 | OIFS=$IFS 715 | IFS='.' read -r -a ip <<< "$ip" 716 | IFS=$OIFS 717 | [[ ${ip[0]} -le 255 && ${ip[1]} -le 255 && ${ip[2]} -le 255 && ${ip[3]} -le 255 ]] 718 | stat=$? 719 | fi 720 | 721 | echo $stat 722 | } 723 | 724 | function valid_username() { 725 | # Vault usernames have the following requirements 726 | # - No larger than 128 Characters 727 | # - Cannot start or end with a period or space 728 | # - cannot contain the following characters 729 | # - \/:*?"<>|\t\r\n\x1F 730 | local username=$1 731 | local stat=1 732 | 733 | local leading="${username:0:1}" 734 | local trailing="${username: -1}" 735 | 736 | # Check length, leading and trailing characters, and invalid characters 737 | if [ "${#username}" -ge 129 ] ; then 738 | stat=2 739 | elif [[ $leading = *[\.[:space:]]* ]] || [[ $trailing = *[\.[:space:]]* ]] ; then 740 | stat=3 741 | elif [[ $username = *[\\/:*?'"''<''>''|'$'\t\r\n\x1f']* ]] ; then 742 | stat=4 743 | else 744 | stat=0 745 | fi 746 | 747 | echo $stat 748 | } 749 | 750 | function valid_pass() { 751 | declare desc="Validates password meets CyberArk requirements." 752 | local pass=$1 753 | local stat=1 754 | 755 | if [ "${#pass}" -le 39 ] ; then 756 | stat=0 757 | fi 758 | 759 | echo $stat 760 | } 761 | 762 | function _start_silent_install() { 763 | # TODO: Build out SILENT INSTALL 764 | 765 | # Check to verify script is being run as root 766 | check_uid 767 | 768 | # Check Operating System 769 | gather_facts 770 | 771 | # Disable NSCD - CyberArk recommends disabling to prevent unexpected behavior 772 | disable_nscd 773 | 774 | # Check for required environment variables 775 | read_installation_var 776 | 777 | # Validate installation variables 778 | validate_installation_var 779 | 780 | # Create vault.ini 781 | create_vault_ini 782 | 783 | # Create psmpparms 784 | create_psmpparms 785 | 786 | # Create credential file 787 | create_credfile 788 | 789 | # Import GPGKEY 790 | preinstall_gpgkey 791 | 792 | # Install AD Bridge based on user input 793 | if [ ${CYBR_BRIDGE} -eq 0 ] ; then 794 | preinstall_libssh 795 | fi 796 | 797 | # Check for Integrated Mode - Install infra package 798 | if [[ ${CYBR_MODE} == "Integrated" ]] ; then 799 | preinstall_infra 800 | fi 801 | 802 | # Install PSMP 803 | install_psmp 804 | 805 | # Check if OS is SUSE, if so check for integrated mode and run post install steps 806 | if [[ ${CYBR_OS} =~ ^([sS][uUlL][sSeE][eEsS])$ ]] ; then 807 | if [[ ${CYBR_MODE} == "Integrated" ]] ; then 808 | postinstall_integratedsuse 809 | fi 810 | fi 811 | 812 | # Verify RPM Status 813 | verify_psmp_rpms 814 | 815 | # Check Service Status 816 | verify_psmp_services 817 | 818 | # Check for maintenance user 819 | check_maintenance_user 820 | 821 | # Clean up files created during install (credfile, vault.ini, etc...) 822 | clean_install 823 | 824 | # Clean exit 825 | exit 0 826 | } 827 | 828 | function _start_interactive_install() { 829 | ### Begin System Validation 830 | 831 | write_header "Step 1: Validating installation requirements" 832 | 833 | # Check to verify script is being run as root 834 | check_uid 835 | 836 | # Check Operating System 837 | gather_facts 838 | 839 | # Check SELinux Status - CyberArk recommends enabling before install 840 | check_se_linux 841 | 842 | # Disable NSCD - CyberArk recommends disabling to prevent unexpected behavior 843 | disable_nscd 844 | 845 | ### System validation completed 846 | ### 847 | ### Begin Gathering information from user 848 | 849 | write_header "Step 2: Collecting installation information." 850 | # Prompt for EULA Acceptance 851 | accept_eula 852 | 853 | # Prompt for directory with installation media 854 | dir_prompt 855 | 856 | # Prompt for Vault IP Address 857 | address_prompt 858 | 859 | # Prompt for Vault Username 860 | username_prompt 861 | 862 | # Prompt for Vault Password 863 | pass_prompt 864 | 865 | # Prompt for Installation Mode 866 | mode_prompt 867 | 868 | # Prompt to Enable AD Bridging? 869 | enable_ad_bridge 870 | 871 | ### Information gathering completed 872 | ### 873 | ### Begin installation prep 874 | 875 | write_header "Step 3: Installation Prep" 876 | 877 | # Create vault.ini 878 | create_vault_ini 879 | 880 | # Create psmpparms 881 | create_psmpparms 882 | 883 | # Create credential file 884 | create_credfile 885 | 886 | ### Installation Prep completed 887 | ### 888 | ### Being Pre-Installation 889 | 890 | write_header "Step 4: Pre-Installation" 891 | 892 | # Import GPGKEY 893 | preinstall_gpgkey 894 | 895 | # Install AD Bridge based on user input 896 | if [ ${CYBR_BRIDGE} -eq 0 ] ; then 897 | preinstall_libssh 898 | fi 899 | 900 | # Check for Integrated Mode - Install infra package 901 | if [[ ${CYBR_MODE} == "Integrated" ]] ; then 902 | preinstall_infra 903 | fi 904 | 905 | ### Pre-Installation Completed 906 | ### 907 | ### Begin Installation 908 | 909 | write_header "Step 5: Installation" 910 | 911 | # Install PSMP 912 | install_psmp 913 | 914 | ### Installation Complete 915 | ### 916 | ### Begin Post Installation Steps 917 | 918 | write_header "Step 6: Post Installation" 919 | 920 | if [[ ${CYBR_OS} =~ ^([sS][uUlL][sSeE][eEsS])$ ]] ; then 921 | if [[ ${CYBR_MODE} == "Integrated" ]] ; then 922 | postinstall_integratedsuse 923 | fi 924 | fi 925 | 926 | write_header "Step 7: Installation Verification" 927 | 928 | # Verify RPM Status 929 | verify_psmp_rpms 930 | 931 | # Check Service Status 932 | verify_psmp_services 933 | 934 | ### Installation Verification Complete 935 | ### 936 | ### Check for maintenance existence and user access 937 | 938 | write_header "Step 8: Maintenance Access Verification" 939 | 940 | # Check for maintenance user 941 | check_maintenance_user 942 | 943 | ### Installation Complete 944 | ### 945 | ### Begin Installation Cleanup 946 | 947 | write_header "Step 9: Installation Cleanup" 948 | 949 | # Clean up files created during install (credfile, vault.ini, etc...) 950 | clean_install 951 | 952 | # Clean exit 953 | exit 0 954 | } 955 | 956 | function _show_help { 957 | printf "%s" "$(/dev/null 2>&1 && pwd )" 8 | PATH="$DIR/../src:$PATH" 9 | } 10 | 11 | teardown() { 12 | rm -rf "${TMP:?}"/* 13 | rm -rf '/var/tmp/autopsmp_install.log' 14 | } 15 | 16 | function helper_vaultini() { 17 | touch "${TMP}/tmp_dir/vault.ini" 18 | cat << EOF > "${TMP}/tmp_dir/vault.ini" 19 | VAULT="Demo Vault" 20 | ADDRESS=1.1.1.1 21 | PORT=1858 22 | TIMEOUT=10 23 | EOF 24 | } 25 | 26 | function helper_createcredfile() { 27 | touch "${TMP}/tmp_dir/CreateCredFile" 28 | } 29 | 30 | function helper_psmpparms() { 31 | touch "${TMP}/tmp_dir/psmpparms.sample" 32 | cat << EOF > "${TMP}/tmp_dir/psmpparms.sample" 33 | [Main] 34 | InstallationFolder= 35 | InstallCyberArkSSHD=Integrated 36 | Hardening=Yes 37 | AcceptCyberArkEULA=No 38 | #EnableADBridge=Yes 39 | EOF 40 | } -------------------------------------------------------------------------------- /test/validators.bats: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bats 2 | 3 | load test_helper 4 | load 'libs/bats-assert/load' 5 | load 'libs/bats-support/load' 6 | load 'libs/bats-file/load' 7 | 8 | MAINSCRIPT="$BATS_TEST_DIRNAME/../src/main.sh" 9 | source "$MAINSCRIPT" 10 | 11 | @test "valid_username() valid username" { 12 | testusername=$(head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 36) 13 | run valid_username $testusername 14 | echo $output 15 | assert_output '0' 16 | } 17 | 18 | @test "valid_username() invalid username, length > 128" { 19 | testusername=$(head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 129) 20 | run valid_username $testusername 21 | assert_output '2' 22 | } 23 | 24 | @test "valid_username() invalid username, starts with ." { 25 | run valid_username ".InvalidUsername" 26 | assert_output '3' 27 | } 28 | 29 | @test "valid_username() invalid username, ends with ." { 30 | run valid_username "InvalidUsername." 31 | assert_output '3' 32 | } 33 | 34 | @test "valid_username() invalid username, starts with space" { 35 | run valid_username " InvalidUsername" 36 | assert_output '3' 37 | } 38 | 39 | @test "valid_username() invalid username, ends with space" { 40 | run valid_username "InvalidUsername " 41 | assert_output '3' 42 | } 43 | 44 | @test "valid_username() invalid username, invalid characters" { 45 | testusername=$(head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9"$<>|' | head -c 36) 46 | invalidchars='|<>' 47 | usernameconcat="${testusername}${invalidchars}" 48 | run valid_username $usernameconcat 49 | assert_output '4' 50 | } 51 | 52 | @test "valid_pass() valid password" { 53 | testpass=$(head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9!"#$%&()*+,-./:;<=>?@[\]^_`{|}~' | head -c 18) 54 | run valid_pass $testpass 55 | assert_output '0' 56 | } 57 | 58 | @test "valid_pass() invalid password, length > 39" { 59 | testpass=$(head /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9!"#$%&()*+,-./:;<=>?@[\]^_`{|}~' | head -c 40) 60 | run valid_pass $testpass 61 | assert_output '1' 62 | } 63 | 64 | @test "valid_ip() valid IP" { 65 | run valid_ip '192.168.100.1' 66 | assert_output '0' 67 | } 68 | 69 | @test "valid_ip() invalid IP, IP out of range (192.168.100.256)" { 70 | run valid_ip '192.168.100.256' 71 | assert_output '1' 72 | } 73 | 74 | @test "valid_ip() invalid IP, incorrect format (192.168.100))" { 75 | run valid_ip '192.168.100' 76 | assert_output '1' 77 | } 78 | --------------------------------------------------------------------------------