├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── Gemfile ├── LICENSE ├── README.md ├── Rakefile ├── bundler.d └── vault.rb ├── documentation ├── CHEF.md └── DEVELOPMENT.md ├── lib ├── smart_proxy_vault.rb └── smart_proxy_vault │ ├── api.rb │ ├── authentication.rb │ ├── authentication │ └── chef.rb │ ├── endpoint.rb │ ├── helpers.rb │ ├── https_config.ru │ ├── vault.rb │ └── version.rb ├── settings.d └── vault.yml.example ├── smart_proxy_vault.gemspec └── test ├── authentication_chef_test.rb ├── factories └── rsa.rb ├── fixtures └── authentication │ └── chef │ ├── bender.pem │ └── fry.pem ├── helpers └── helpers.rb ├── request_test.rb └── test_helper.rb /.gitignore: -------------------------------------------------------------------------------- 1 | *.gem 2 | *.rbc 3 | .bundle 4 | .config 5 | .DS_Store 6 | .yardoc 7 | Gemfile.lock 8 | InstalledFiles 9 | _yardoc 10 | coverage 11 | doc/ 12 | lib/bundler/man 13 | pkg 14 | rdoc 15 | sftp-config.json 16 | spec/reports 17 | test/tmp 18 | test/version_tmp 19 | tmp 20 | vendor/ 21 | logs/ 22 | coverage/ 23 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | --- 2 | language: ruby 3 | cache: bundler 4 | sudo: false 5 | script: bundle exec rake test 6 | before_install: 7 | - gem update bundler 8 | - gem update --system 9 | after_script: 10 | - bundle exec codeclimate-test-reporter 11 | rvm: 12 | - 2.1 13 | - 2.2 14 | branches: 15 | only: 16 | - master 17 | - travis-ci 18 | matrix: 19 | fast_finish: true 20 | addons: 21 | code_climate: 22 | repo_token: fcadc9418b773b9905383be20e8b4147a0bf5d542224501d9cb0885c5e7855e9 -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | ## [v0.4.2](https://github.com/theforeman/smart_proxy_vault/tree/v0.4.1) 4 | - Fixed issue with requesting a role token that didn't contain the default policy 5 | 6 | ## [v0.4.1](https://github.com/theforeman/smart_proxy_vault/tree/v0.4.1) 7 | - Fix for https://github.com/hashicorp/vault-ruby/issues/121 8 | 9 | ## [v0.4.0](https://github.com/theforeman/smart_proxy_vault/tree/v0.4.0) 10 | - Added creating tokens from roles 11 | - Fixed days to seconds calculation 12 | - Updated Vault gem dependency to 0.7.0 13 | 14 | ## [v0.3.0](https://github.com/theforeman/smart_proxy_vault/tree/v0.3.0) 15 | - Added token renewal (Closes [\#2](https://github.com/theforeman/smart_proxy_vault/issues/2)) 16 | - Cleaned up lib/ directory layout & module namespaces 17 | - Updated Vault gem dependency to 0.4.0 18 | 19 | ## [v0.2.0](https://github.com/theforeman/smart_proxy_vault/tree/v0.2.0) 20 | - Released as a gem 21 | - Added unit tests 22 | - Fixed several assumptions that may have caused issues 23 | 24 | ## [v0.1.0](https://github.com/theforeman/smart_proxy_vault/tree/v0.1.0) 25 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | gemspec 4 | 5 | group :development do 6 | gem 'smart_proxy', :github => "theforeman/smart-proxy", :branch => 'develop' 7 | end 8 | 9 | gem "codeclimate-test-reporter", group: :test, require: nil 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | GNU GENERAL PUBLIC LICENSE 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for 12 | software and other kinds of works. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | the GNU General Public License is intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. We, the Free Software Foundation, use the 19 | GNU General Public License for most of our software; it applies also to 20 | any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you 31 | these rights or asking you to surrender the rights. Therefore, you have 32 | certain responsibilities if you distribute copies of the software, or if 33 | you modify it: responsibilities to respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must pass on to the recipients the same 37 | freedoms that you received. You must make sure that they, too, receive 38 | or can get the source code. And you must show them these terms so they 39 | know their rights. 40 | 41 | Developers that use the GNU GPL protect your rights with two steps: 42 | (1) assert copyright on the software, and (2) offer you this License 43 | giving you legal permission to copy, distribute and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains 46 | that there is no warranty for this free software. For both users' and 47 | authors' sake, the GPL requires that modified versions be marked as 48 | changed, so that their problems will not be attributed erroneously to 49 | authors of previous versions. 50 | 51 | Some devices are designed to deny users access to install or run 52 | modified versions of the software inside them, although the manufacturer 53 | can do so. This is fundamentally incompatible with the aim of 54 | protecting users' freedom to change the software. The systematic 55 | pattern of such abuse occurs in the area of products for individuals to 56 | use, which is precisely where it is most unacceptable. Therefore, we 57 | have designed this version of the GPL to prohibit the practice for those 58 | products. If such problems arise substantially in other domains, we 59 | stand ready to extend this provision to those domains in future versions 60 | of the GPL, as needed to protect the freedom of users. 61 | 62 | Finally, every program is threatened constantly by software patents. 63 | States should not allow patents to restrict development and use of 64 | software on general-purpose computers, but in those that do, we wish to 65 | avoid the special danger that patents applied to a free program could 66 | make it effectively proprietary. To prevent this, the GPL assures that 67 | patents cannot be used to render the program non-free. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Use with the GNU Affero General Public License. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU Affero General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the special requirements of the GNU Affero General Public License, 561 | section 13, concerning interaction through a network will apply to the 562 | combination as such. 563 | 564 | 14. Revised Versions of this License. 565 | 566 | The Free Software Foundation may publish revised and/or new versions of 567 | the GNU General Public License from time to time. Such new versions will 568 | be similar in spirit to the present version, but may differ in detail to 569 | address new problems or concerns. 570 | 571 | Each version is given a distinguishing version number. If the 572 | Program specifies that a certain numbered version of the GNU General 573 | Public License "or any later version" applies to it, you have the 574 | option of following the terms and conditions either of that numbered 575 | version or of any later version published by the Free Software 576 | Foundation. If the Program does not specify a version number of the 577 | GNU General Public License, you may choose any version ever published 578 | by the Free Software Foundation. 579 | 580 | If the Program specifies that a proxy can decide which future 581 | versions of the GNU General Public License can be used, that proxy's 582 | public statement of acceptance of a version permanently authorizes you 583 | to choose that version for the Program. 584 | 585 | Later license versions may give you additional or different 586 | permissions. However, no additional obligations are imposed on any 587 | author or copyright holder as a result of your choosing to follow a 588 | later version. 589 | 590 | 15. Disclaimer of Warranty. 591 | 592 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 593 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 594 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 595 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 596 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 597 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 598 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 599 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 600 | 601 | 16. Limitation of Liability. 602 | 603 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 604 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 605 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 606 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 607 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 608 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 609 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 610 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 611 | SUCH DAMAGES. 612 | 613 | 17. Interpretation of Sections 15 and 16. 614 | 615 | If the disclaimer of warranty and limitation of liability provided 616 | above cannot be given local legal effect according to their terms, 617 | reviewing courts shall apply local law that most closely approximates 618 | an absolute waiver of all civil liability in connection with the 619 | Program, unless a warranty or assumption of liability accompanies a 620 | copy of the Program in return for a fee. 621 | 622 | END OF TERMS AND CONDITIONS 623 | 624 | How to Apply These Terms to Your New Programs 625 | 626 | If you develop a new program, and you want it to be of the greatest 627 | possible use to the public, the best way to achieve this is to make it 628 | free software which everyone can redistribute and change under these terms. 629 | 630 | To do so, attach the following notices to the program. It is safest 631 | to attach them to the start of each source file to most effectively 632 | state the exclusion of warranty; and each file should have at least 633 | the "copyright" line and a pointer to where the full notice is found. 634 | 635 | smart_proxy_vault, authenticates a client & returns a Vault token 636 | Copyright (C) 2016 Vision Critical Inc. 637 | 638 | This program is free software: you can redistribute it and/or modify 639 | it under the terms of the GNU General Public License as published by 640 | the Free Software Foundation, either version 3 of the License, or 641 | (at your option) any later version. 642 | 643 | This program is distributed in the hope that it will be useful, 644 | but WITHOUT ANY WARRANTY; without even the implied warranty of 645 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 646 | GNU General Public License for more details. 647 | 648 | You should have received a copy of the GNU General Public License 649 | along with this program. If not, see . 650 | 651 | Also add information on how to contact you by electronic and paper mail. 652 | 653 | If the program does terminal interaction, make it output a short 654 | notice like this when it starts in an interactive mode: 655 | 656 | smart_proxy_vault Copyright (C) 2016 Vision Critical Inc. 657 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 658 | This is free software, and you are welcome to redistribute it 659 | under certain conditions; type `show c' for details. 660 | 661 | The hypothetical commands `show w' and `show c' should show the appropriate 662 | parts of the General Public License. Of course, your program's commands 663 | might be different; for a GUI interface, you would use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or school, 666 | if any, to sign a "copyright disclaimer" for the program, if necessary. 667 | For more information on this, and how to apply and follow the GNU GPL, see 668 | . 669 | 670 | The GNU General Public License does not permit incorporating your program 671 | into proprietary programs. If your program is a subroutine library, you 672 | may consider it more useful to permit linking proprietary applications with 673 | the library. If this is what you want to do, use the GNU Lesser General 674 | Public License instead of this License. But first, please read 675 | . 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Build Status](https://img.shields.io/travis/theforeman/smart_proxy_vault/master.svg)](https://travis-ci.org/theforeman/smart_proxy_vault) 2 | [![Code Quality](https://img.shields.io/codeclimate/github/visioncritical/smart_proxy_vault.svg)](https://codeclimate.com/github/visioncritical/smart_proxy_vault) 3 | [![Code Climate](https://img.shields.io/codeclimate/coverage/github/visioncritical/smart_proxy_vault.svg)](https://codeclimate.com/github/visioncritical/smart_proxy_vault/coverage) 4 | [![Gem](https://img.shields.io/gem/v/smart_proxy_vault.svg)](https://rubygems.org/gems/smart_proxy_vault/versions) 5 | [![GitHub license](https://img.shields.io/badge/license-GPLv3-blue.svg)](./LICENSE) 6 | 7 | 8 | # Smart Proxy - Hashicorp Vault Plugin 9 | 10 | A Smart Proxy plugin that will return a Vault token after authenticating a client. 11 | 12 | ## Design 13 | 14 | The authentication portion of this plugin has been designed to be modular. Below is a current list of clients this plugin knows how to authenticate: 15 | 16 | * Chef 17 | 18 | If you're unable to use one of the above to authenticate your clients, you can always write your own & submit a PR (see [DEVELOPMENT.md](documentation/DEVELOPMENT.md)). 19 | 20 | ## Installation 21 | 22 | Add this line to your Smart Proxy's `bundler.d/vault.rb` gemfile: 23 | 24 | ```ruby 25 | gem 'smart_proxy_vault' 26 | ``` 27 | 28 | And then execute: 29 | 30 | ```bash 31 | bundle install 32 | ``` 33 | 34 | ## Settings 35 | 36 | Example: 37 | 38 | ```yaml 39 | --- 40 | :enabled: true 41 | :auth_backend: 'chef' 42 | :vault: 43 | :address: "https://vault.example.com" 44 | :token: "UUID" 45 | :ssl_verify: true 46 | :add_token_metadata: true 47 | :token_options: 48 | :policies: ['policyname'] 49 | :ttl: '72h' 50 | :chef: 51 | :endpoint: 'https://chef.example.com' 52 | :client: 'user' 53 | :key: '/path/to/client.pem' 54 | :ssl_verify: true 55 | ``` 56 | 57 | #### General 58 | 59 | ##### :enabled: 60 | 61 | Toggles whether or not this plugin is enabled. 62 | 63 | ##### :auth_backend: 64 | 65 | Specifies what authentication module you would like to use to authenticate your clients (must correspond to a filename in [lib/smart_proxy_vault/authentication/](lib/smart_proxy_vault/authentication/)) 66 | 67 | ##### :vault: 68 | 69 | A hash of Vault settings that are used to configure a connection to the Vault server (determined by the [Vault](https://github.com/hashicorp/vault-ruby) gem). 70 | 71 | ```yaml 72 | # https://github.com/hashicorp/vault-ruby/blob/master/lib/vault/configurable.rb 73 | :vault: 74 | :address: 75 | :token: 76 | :open_timeout: 77 | :proxy_address: 78 | :proxy_password: 79 | :proxy_port: 80 | :proxy_username: 81 | :read_timeout: 82 | :ssl_ciphers: 83 | :ssl_pem_file: 84 | :ssl_pem_passphrase: 85 | :ssl_ca_cert: 86 | :ssl_ca_path: 87 | :ssl_verify: 88 | :ssl_timeout: 89 | :timeout: 90 | ``` 91 | 92 | ##### :add_token_metadata: 93 | 94 | If set to true, this plugin will add the requesting client's ID (as determined by the auth_backend) in the metadata & display-name fields when requesting a token. 95 | 96 | ##### :token_options: 97 | 98 | A hash of parameters that will be passed to the token creation call except when requesting a role token ([/auth/token/create](https://www.vaultproject.io/docs/auth/token.html)). 99 | 100 | #### Chef Backend 101 | 102 | Only to be specified when the `:auth_backend:` is `chef`. Refer to the [Chef backend](documentation/CHEF.md) documentation for more information. 103 | 104 | ##### :chef: 105 | 106 | A hash of settings that are used to configure a connection to the Chef server (used by the [Chef API](https://github.com/sethvargo/chef-api) gem). 107 | 108 | ```yaml 109 | # https://github.com/sethvargo/chef-api/blob/master/lib/chef-api/configurable.rb 110 | :chef: 111 | :endpoint: 112 | :flavor: 113 | :client: 114 | :key: 115 | :proxy_address: 116 | :proxy_password: 117 | :proxy_port: 118 | :proxy_username: 119 | :ssl_pem_file: 120 | :ssl_verify: 121 | :user_agent: 122 | ``` 123 | 124 | ## Usage 125 | 126 | To configure this plugin you can use template from [settings.d/vault.yml.example](settings.d/vault.yml.example). You must place the `vault.yml` config file in your Smart Proxy's `config/settings.d/` directory. 127 | 128 | The token specified in the [`:vault:`](#vault) section must be a role token so that this plugin can renew it indefinitely. 129 | 130 | ### Endpoints 131 | 132 | #### `/vault/token/issue` 133 | 134 | ##### Parameters 135 | 136 | ###### `ttl=X[d,h,m,s]` 137 | 138 | Overrides the token TTL specified in the [`:token_options:`](#token_options) section. However, this value must be **lower** than the Vault server's `max_lease_ttl` value. 139 | 140 | Example: 141 | 142 | `/vault/token/issue?ttl=60s` 143 | 144 | ###### `role=foo` 145 | 146 | A role to assign the token. Tokens issued under roles are able to be renewed indefinitely. This is useful for applications like Consul Template. The role must be created on the Vault server first. 147 | 148 | Example: 149 | 150 | `/vault/token/issue?role=foobar` 151 | 152 | ### Caveats 153 | 154 | In order to use this plugin effectively, the Ruby installation on your Smart Proxy server should be version 2.0.0 or higher, and be compiled against a version of OpenSSL that supports TLS (=>1.0.1). I recommend using [RVM](https://rvm.io/) & [Passenger](https://www.phusionpassenger.com) to run your Smart Proxy server. 155 | 156 | ``` 157 | $ irb 158 | 2.2.1 :001 > require 'openssl' 159 | => true 160 | 2.2.1 :002 > OpenSSL::OPENSSL_VERSION 161 | => "OpenSSL 1.0.1e 11 Feb 2013" 162 | ``` 163 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'rake' 2 | require 'rake/testtask' 3 | require "bundler/gem_tasks" 4 | 5 | desc 'Default: run unit tests.' 6 | task :default => :test 7 | 8 | desc 'Test Vault plugin.' 9 | Rake::TestTask.new(:test) do |t| 10 | t.libs << %w(. lib test) 11 | t.test_files = FileList['test/**/*_test.rb'] 12 | t.verbose = true 13 | end 14 | -------------------------------------------------------------------------------- /bundler.d/vault.rb: -------------------------------------------------------------------------------- 1 | gem 'smart_proxy_vault' 2 | -------------------------------------------------------------------------------- /documentation/CHEF.md: -------------------------------------------------------------------------------- 1 | # Authentication Backend - Chef 2 | 3 | This backend verifies Chef clients by expecting clients to hit the endpoint with two HTTP headers defined: 4 | 5 | ## X_VAULT_CLIENT 6 | 7 | This header should contain the Chef client ID (e.g. `knife client [name]`). This is used by the [Chef API](https://github.com/sethvargo/chef-api) gem to fetch a client. 8 | 9 | ## X_VAULT_SIGNATURE 10 | 11 | This header should be a Base64 encoded signature with the body containing the client's public key. An example of how to generate on your client nodes: 12 | 13 | ```ruby 14 | require 'openssl' 15 | require 'base64' 16 | 17 | def sign_request(key_path) 18 | rsa = OpenSSL::PKey::RSA.new File.read key_path 19 | body = Digest::MD5.hexdigest rsa.public_key.to_s 20 | Base64.strict_encode64(rsa.sign(OpenSSL::Digest::SHA512.new, body)) 21 | end 22 | 23 | signature = sign_request('/etc/chef/client.pem') 24 | ``` -------------------------------------------------------------------------------- /documentation/DEVELOPMENT.md: -------------------------------------------------------------------------------- 1 | # Development 2 | 3 | ## Versioning 4 | This module uses [Semantic Versioning](http://semver.org/). 5 | 6 | ## Branching 7 | Please adhere to the branching guidelines set out by Vincent Driessen in this [post](http://nvie.com/posts/a-successful-git-branching-model/). 8 | 9 | ## Authentication Methods 10 | 11 | Any new authentication backend will need to placed in `lib/smart_proxy_vault/authentication/`. The name of the file will be the name of the backend in `vault.yml`. Your backend needs to be nested underneath `::VaultPlugin::Authentication`, and it must define at least two methods (i.e. `authorized?`, & `vault_client`). Please also submit a markdown document explaining how your backend authenticates its clients, along with a unit test or two. 12 | 13 | ``` 14 | module VaultPlugin 15 | module Authentication 16 | # Must match the name of the file 17 | module BackendName 18 | def vault_client 19 | end 20 | 21 | def authorized? 22 | end 23 | end 24 | end 25 | end 26 | ``` -------------------------------------------------------------------------------- /lib/smart_proxy_vault.rb: -------------------------------------------------------------------------------- 1 | require 'sinatra/base' 2 | require 'vault' 3 | require 'base64' 4 | require 'openssl' 5 | 6 | require 'smart_proxy_vault/vault' 7 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/api.rb: -------------------------------------------------------------------------------- 1 | require_relative './authentication' 2 | require_relative './helpers' 3 | 4 | module VaultPlugin 5 | module API 6 | def self.included(klass) 7 | klass.send :include, Backend 8 | klass.extend Backend 9 | end 10 | 11 | module Backend 12 | include ::VaultPlugin::Authentication 13 | include ::VaultPlugin::Helpers 14 | 15 | class Client 16 | extend ::VaultPlugin::Helpers 17 | 18 | def self.issue_token(options) 19 | Vault.auth_token.create(options).auth.client_token 20 | end 21 | 22 | def self.issue_role_token(role, options) 23 | Vault.auth_token.create_with_role(role, options).auth.client_token 24 | end 25 | 26 | def self.lookup_self 27 | Vault.auth_token.lookup_self 28 | end 29 | 30 | def self.renew_self 31 | Vault.auth_token.renew_self(lookup_self.data[:creation_ttl]) 32 | end 33 | end 34 | 35 | def metadata 36 | return {} unless add_token_metadata? 37 | { display_name: vault_client, 38 | meta: { client: vault_client, smartproxy_generated: true } } 39 | end 40 | 41 | def options(ttl) 42 | options = metadata.merge token_options 43 | options.merge(ttl: ttl) unless ttl.nil? 44 | end 45 | 46 | def issue(ttl, role) 47 | begin 48 | opts = options ttl 49 | role.nil? ? Client.issue_token(opts) : Client.issue_role_token(role, metadata) 50 | rescue StandardError => e 51 | log_halt 500, 'Failed to generate Vault token ' + e.message 52 | end 53 | end 54 | 55 | def creation_ttl 56 | Client.lookup_self[:data][:creation_ttl] 57 | end 58 | 59 | def renew 60 | begin 61 | Client.renew_self 62 | rescue StandardError => e 63 | puts 'Failed to renew Vault token ' + e.message 64 | end 65 | end 66 | 67 | def start_renewal 68 | Thread.new do 69 | while true do 70 | renew 71 | sleep to_seconds(creation_ttl/3) 72 | end 73 | end 74 | end 75 | end 76 | end 77 | end 78 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/authentication.rb: -------------------------------------------------------------------------------- 1 | require_relative 'authentication/chef' 2 | 3 | module VaultPlugin 4 | module Authentication 5 | def auth_backend 6 | ::VaultPlugin::Plugin.settings.auth_backend.to_sym 7 | end 8 | 9 | def auth_module 10 | Object.const_get('::VaultPlugin::Authentication::' + auth_backend.capitalize.to_s) 11 | end 12 | 13 | # Creates convenient accessor methods for all keys underneath auth_backend 14 | def create_setting_accessors 15 | ::VaultPlugin::Plugin.settings[auth_backend].each do |key,value| 16 | define_singleton_method(key.to_sym) { value } 17 | end 18 | end 19 | 20 | def authorized? 21 | create_setting_accessors 22 | extend auth_module 23 | authorized? 24 | end 25 | 26 | # Returns the human-readable identity for the requesting client 27 | # Optionally used in a token's metadata & display-name 28 | def vault_client 29 | extend auth_module 30 | vault_client 31 | end 32 | end 33 | end 34 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/authentication/chef.rb: -------------------------------------------------------------------------------- 1 | require 'chef-api' 2 | 3 | module VaultPlugin 4 | module Authentication 5 | module Chef 6 | def vault_client 7 | request.env['HTTP_X_VAULT_CLIENT'] 8 | end 9 | 10 | def signature 11 | request.env['HTTP_X_VAULT_SIGNATURE'] || request.env['HTTP_X_VAULT_SIGNATURE'].chomp 12 | end 13 | 14 | def authorized? 15 | logger.info('Starting Chef client authentication for smart_proxy_vault') 16 | request.env.each do |key,value| 17 | logger.debug("header #{key}: #{value}") 18 | end if logger.level == 0 19 | 20 | if vault_client.nil? || signature.nil? 21 | log_halt 401, "Failed to authenticate Chef client - #{vault_client}. Missing headers." 22 | end 23 | 24 | unless authenticate 25 | log_halt 401, "Failed to authenticate Chef client - #{vault_client}. Verification failed." 26 | end 27 | logger.info("Successfully authenticated Chef client - #{vault_client}") 28 | end 29 | 30 | def chefapi 31 | chefapi_settings = ::VaultPlugin::Plugin.settings.chef 32 | connection = ::ChefAPI::Connection.new(chefapi_settings) 33 | connection.ssl_verify = chefapi_settings[:ssl_verify] || false 34 | connection 35 | end 36 | 37 | def authenticate 38 | begin 39 | node = chefapi.clients.fetch vault_client 40 | rescue StandardError => e 41 | log_halt 401, 'Failed to authenticate to the Chef server: ' + e.message 42 | end 43 | log_halt(401, "Could not find Chef client - #{vault_client}") if node.nil? 44 | 45 | rsa = OpenSSL::PKey::RSA.new node.public_key 46 | decoded_signature = Base64.decode64(signature) 47 | # The body should contain the public key of the node 48 | body = Digest::MD5.hexdigest rsa.public_key.to_s 49 | 50 | rsa.verify(OpenSSL::Digest::SHA512.new, decoded_signature, body) 51 | end 52 | end 53 | end 54 | end 55 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/endpoint.rb: -------------------------------------------------------------------------------- 1 | require_relative './authentication' 2 | require_relative './api' 3 | require_relative './helpers' 4 | 5 | module VaultPlugin 6 | class Endpoint < ::Sinatra::Base 7 | include ::Proxy::Log 8 | include ::VaultPlugin::Authentication 9 | include ::VaultPlugin::API 10 | helpers ::Proxy::Helpers, ::VaultPlugin::Helpers 11 | 12 | ::Sinatra::Base.register Authentication 13 | 14 | before do 15 | content_type :json 16 | authorized? 17 | end 18 | 19 | vault_client_configure 20 | start_renewal 21 | 22 | get '/token/issue' do 23 | ttl = params[:ttl] 24 | role = params[:role] 25 | issue(ttl, role) if valid_ttl? ttl 26 | end 27 | end 28 | end 29 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/helpers.rb: -------------------------------------------------------------------------------- 1 | module VaultPlugin 2 | module Helpers 3 | def vault_settings 4 | ::VaultPlugin::Plugin.settings.vault 5 | end 6 | 7 | def settings_ttl 8 | ::VaultPlugin::Plugin.settings.token_options[:ttl] 9 | end 10 | 11 | def token_options 12 | ::VaultPlugin::Plugin.settings.token_options 13 | end 14 | 15 | def add_token_metadata? 16 | ::VaultPlugin::Plugin.settings.add_token_metadata 17 | end 18 | 19 | def vault_client_configure 20 | Vault.configure do |config| 21 | vault_settings.each do |k, v| 22 | config.send("#{k}=", v) 23 | end 24 | end 25 | end 26 | 27 | def to_seconds(string) 28 | case string.slice(-1) 29 | when 'd' 30 | string.tr('d', '').to_i * 24 * 3600 31 | when 'h' 32 | string.tr('h', '').to_i * 3600 33 | when 'm' 34 | string.tr('m', '').to_i * 60 35 | when 's' 36 | string.tr('s', '').to_i 37 | else 38 | log_halt 400, "Invalid TTL - #{string}. Must end with 'd', 'h', 'm' or 's'." 39 | end 40 | end 41 | 42 | # Only allow clients to specify a TTL that is shorter than the default 43 | def valid_ttl?(ttl) 44 | return true if ttl.nil? || settings_ttl.nil? 45 | unless (to_seconds(settings_ttl) >= to_seconds(ttl)) 46 | log_halt 400, "Invalid TTL - #{ttl}. Must be shorter or equal to #{settings_ttl}." 47 | end 48 | true 49 | end 50 | end 51 | end 52 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/https_config.ru: -------------------------------------------------------------------------------- 1 | require 'smart_proxy_vault/endpoint' 2 | 3 | map '/vault' do 4 | run VaultPlugin::Endpoint 5 | end 6 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/vault.rb: -------------------------------------------------------------------------------- 1 | require_relative './version' 2 | 3 | module VaultPlugin 4 | class Plugin < ::Proxy::Plugin 5 | plugin 'vault', VaultPlugin::VERSION 6 | 7 | settings_file 'vault.yml' 8 | default_settings auth_backend: 'chef', 9 | vault: {}, 10 | add_token_metadata: false, 11 | token_options: {}, 12 | chef: {} 13 | 14 | https_rackup_path File.expand_path('https_config.ru', File.expand_path('../', __FILE__)) 15 | end 16 | end 17 | -------------------------------------------------------------------------------- /lib/smart_proxy_vault/version.rb: -------------------------------------------------------------------------------- 1 | module VaultPlugin 2 | VERSION = '0.4.2' 3 | end 4 | -------------------------------------------------------------------------------- /settings.d/vault.yml.example: -------------------------------------------------------------------------------- 1 | --- 2 | :enabled: true 3 | :auth_backend: 'chef' 4 | :vault: 5 | :address: "https://vault.example.com" 6 | :token: "UUID" 7 | :ssl_verify: true 8 | :add_token_metadata: true 9 | :token_options: 10 | :policies: ['policyname'] 11 | :ttl: '72h' 12 | :chef: 13 | :endpoint: 'https://chef.example.com' 14 | :client: 'user' 15 | :key: '/path/to/client.pem' 16 | :ssl_verify: true -------------------------------------------------------------------------------- /smart_proxy_vault.gemspec: -------------------------------------------------------------------------------- 1 | require File.expand_path('../lib/smart_proxy_vault/version', __FILE__) 2 | 3 | Gem::Specification.new do |s| 4 | s.name = 'smart_proxy_vault' 5 | s.version = VaultPlugin::VERSION 6 | 7 | s.summary = 'Authenticates a client & returns a Vault token' 8 | s.description = 'Authenticates a client & returns a Vault token' 9 | s.authors = %w{Riley Shott} 10 | s.email = 'riley.shott@visioncritical.com' 11 | s.extra_rdoc_files = ['README.md', 'LICENSE', 'CHANGELOG.md'] 12 | s.files = Dir['{lib,settings.d,bundler.d,test}/**/*'] + s.extra_rdoc_files 13 | s.test_files = s.files.grep(%r{^(test)/}) 14 | s.homepage = 'https://github.com/theforeman/smart_proxy_vault' 15 | s.license = 'GPL-3.0' 16 | 17 | s.add_development_dependency('bundler', '~> 1.11') 18 | s.add_development_dependency('rake', '~> 10') 19 | s.add_development_dependency('pry', '~> 0.10') 20 | s.add_development_dependency('test-unit', '~> 2') 21 | s.add_development_dependency('test-unit-rr', '~> 1.0') 22 | s.add_development_dependency('mocha', '~> 1') 23 | s.add_development_dependency('webmock', '~> 1') 24 | s.add_development_dependency('rack-test', '~> 0') 25 | s.add_development_dependency('factory_girl', '~> 4.0') 26 | s.add_development_dependency('simplecov', '~> 0.12') 27 | s.add_development_dependency('codeclimate-test-reporter', '~> 1.0') 28 | s.add_development_dependency('activesupport', (RUBY_VERSION >= '2.3' ? '>= 4.0' : '~> 4.0')) 29 | 30 | s.add_runtime_dependency('chef-api', '~> 0.5.0') 31 | s.add_runtime_dependency('vault', '~> 0.7.0') 32 | end 33 | -------------------------------------------------------------------------------- /test/authentication_chef_test.rb: -------------------------------------------------------------------------------- 1 | require_relative './test_helper' 2 | require 'smart_proxy_vault/authentication/chef' 3 | 4 | class AuthenticationChefTest < Test::Unit::TestCase 5 | include Rack::Test::Methods 6 | include Proxy::Pluggable 7 | 8 | ### 9 | # Classes 10 | ### 11 | 12 | class Mock 13 | include VaultPlugin::Authentication::Chef 14 | 15 | def logger 16 | @logger ||= Logger.new(StringIO.new) 17 | @logger.level = Logger::INFO 18 | @logger 19 | end 20 | 21 | def log_halt(*args) 22 | throw :halt 23 | end 24 | end 25 | 26 | ### 27 | # Helper Methods 28 | ### 29 | 30 | def sign_request(key_path) 31 | rsa = OpenSSL::PKey::RSA.new File.read key_path 32 | body = Digest::MD5.hexdigest rsa.public_key.to_s 33 | Base64.strict_encode64(rsa.sign(OpenSSL::Digest::SHA512.new, body)) 34 | end 35 | 36 | def stub_client(client, signature) 37 | stub.proxy(AuthenticationChefTest::Mock).new do |obj| 38 | stub(obj).vault_client { client } 39 | stub(obj).signature { signature } 40 | end 41 | end 42 | 43 | def stub_response(client, public_key, status=200) 44 | response = %({"name": "#{client}", "admin": false, "public_key": "#{public_key.gsub("\n","\\n")}", "private_key": false, "validator": false}) 45 | stub_request(:get, "https://chef.example.com/clients/#{client}").to_return(:status => status, :body => response.to_s, :headers => {'content-type' => 'application/json'} ) 46 | end 47 | 48 | ### 49 | # Test Methods 50 | ### 51 | 52 | def setup 53 | stub.proxy(::VaultPlugin::Plugin.settings).chef {{ 54 | :endpoint => 'https://chef.example.com', 55 | :client => 'fry', 56 | :key => 'test/fixtures/authentication/chef/fry.pem', 57 | :ssl_verify => true 58 | }} 59 | 60 | @fry_client = FactoryGirl.create(:rsa, file: 'test/fixtures/authentication/chef/fry.pem' ) 61 | @fry_client_path = 'test/fixtures/authentication/chef/fry.pem' 62 | @bender_client = FactoryGirl.create(:rsa, file: 'test/fixtures/authentication/chef/bender.pem' ) 63 | @bender_client_path = 'test/fixtures/authentication/chef/bender.pem' 64 | 65 | @fry_signature = sign_request @fry_client_path 66 | @bender_signature = sign_request @bender_client_path 67 | end 68 | 69 | def test_signature_verification_match 70 | stub_client 'fry', @fry_signature 71 | stub_response 'fry', @fry_client.public_key.to_s 72 | chefauth = Mock.new 73 | assert_nothing_thrown do 74 | assert chefauth.authorized?, 'Encoding & Decoding a message with the same key should pass verification' 75 | end 76 | end 77 | 78 | def test_signature_verification_mismatch 79 | stub_client 'bender', @bender_signature 80 | stub_response 'bender', @fry_client.public_key.to_s 81 | chefauth = Mock.new 82 | assert_throws :halt do 83 | refute chefauth.authorized?, 'Encoding & Decoding a message with the different key should fail verification' 84 | end 85 | end 86 | 87 | def test_header_requirement 88 | stub_client(nil, nil) 89 | chefauth = Mock.new 90 | assert_throws :halt do 91 | refute chefauth.authorized?, 'A request without headers should fail' 92 | end 93 | end 94 | 95 | def test_client_not_found 96 | stub_client('zoidberg', @bender_signature) 97 | stub_response('zoidberg', @bender_signature, 404) 98 | chefauth = Mock.new 99 | assert_throws :halt do 100 | refute chefauth.authorized?, %(It should fail when a client can't be found on the Chef server) 101 | end 102 | end 103 | end 104 | -------------------------------------------------------------------------------- /test/factories/rsa.rb: -------------------------------------------------------------------------------- 1 | FactoryGirl.define do 2 | factory :rsa, class: OpenSSL::PKey::RSA do 3 | skip_create 4 | 5 | transient do 6 | file nil 7 | end 8 | 9 | initialize_with { new(File.read(file)) } 10 | end 11 | end 12 | -------------------------------------------------------------------------------- /test/fixtures/authentication/chef/bender.pem: -------------------------------------------------------------------------------- 1 | -----BEGIN RSA PRIVATE KEY----- 2 | MIIEowIBAAKCAQEA1HErnHpWXQansmIIjhdxfaFrA5CO+Zfz5Q7RIB4KbM4hwi/L 3 | 0KrfOL5r6mGsBiTU4jYMMSRYZx5djIF718taLu4oM18ydzHOsaDROWuDLfLm33xI 4 | u6U3n8gQCgDXxJghQzjEaC4Dv4DLYmHXkrEXd+O6dIrCW7tMCCQ+bBojkyMx0U2z 5 | V1JQUjaBzxaY34a7Lkvp32QdcCazMrV+VYExIECChaBDG+kgPGihPGPEqzzcNOgT 6 | LCrEnhElX6yT2qIhTJKW9/babMuc/ETgT1EwotWLiRMshg2ebvHkNaGYEUtPUvQp 7 | BwGhxZoltlzZTjsj/+RB+65Ao6tZ8XSIfWGLJQIDAQABAoIBAQCssAXMX+G+Ir/E 8 | kE31+vaFMeaEckjWeP+H7eBupBzDT1g/uoyJ5awoOxoL3zNvlxb5fwewFqRJxnQy 9 | 17psst9vEKbbA4JJQ9KJr3kDnPJ4MmAbwLJ63hV2K7FmAENkimlXdFireuQPEknB 10 | glky5AN4sEQLohPVb02hvJyFUUYjvlbfGhu0hJNIFtddTJ+kLANpB6AIw8EBnkZN 11 | U1G7aOxbEsrKPFClTofHlcHRnaVmbw3aoi5FK9hWSEXTQv9WITcNbux+IpxFCWVg 12 | t1aei+pS7Ylo9ZjqcH8pla2xhndGtbjrWh7JSEiMLXRtGBwO01cNHfKQAn2L3Y5O 13 | yOTbjXYBAoGBAPwuf46opRMQTO+sjmz0OK1DtHwfkNRdus5d4a95+xmrhn4NFuem 14 | 4c/J0ri//U/i4NbUWySdS0SIvV0aK7iWOZtw9m7drzBxdMI8ZhdftMepAs/feT76 15 | h9u/Ihvq+QTK5dq/esu43Z8IUSdaLFfzHigQsRIuUxl8bFd1hU1hRv2BAoGBANeo 16 | omQGSvqLkwcOJvGGRHgyr/NWrH4ENxoLO0YLEggnzO1xbItfvB5NZMtuM+Xqqczn 17 | uPM7ap68kCl/UEfBDwQVfJ03NUp2Bg8G/L2JvOthuhu+rE8uguTAikZ1Fvi2S7M0 18 | eG0/a9kVarSkX8kGRXX9gXgEupYTUoJjhtbdwaelAoGAEw0UN9vHtLv7g/O+Qr7k 19 | dTpzLRlZYKHAFg0DmrUVYigSHf2xKEj0MDVoBOsEIP/byn76b7auU/wciicK/IPk 20 | 0DhldZSrwnYfwvi7IbLqPlcnTjrstvRIRTKYShGjRFhrqu3iQfeyTmxbbSSjyvUj 21 | 5xTzu5LiVj+PE8BeFK1vpoECgYB1fFoTcdYxDg6oHk6a75Gnhb2TLJnGARffqVS+ 22 | QNOu+7fJdywx9ZKvU2xg4wWE8MVWarq4T5szJPjIkqIypPtAN1Bu+Z+flBKS5zST 23 | MVFpThEsgkCu1mDarAXogmtkTTOKSkB9C7r+RYufI5lHE5KNx/BbaQAZOCeP/xZ7 24 | Qc35PQKBgGYpFugtnwKhzVTVTRFNcJRpq067ipF+7wuPTxp7QwGrQaskkvmk7hwF 25 | pH8bkz66Qbkpt4d1X19iNjWDk50o/qdrrpgy58Smmm0fGasu8D38GCLX1bHuyt1g 26 | gcH5fJhMRpcja71fpm+4x2TtbfQHwEP0DB3+v+HIjrrRAPw4+pBD 27 | -----END RSA PRIVATE KEY----- -------------------------------------------------------------------------------- /test/fixtures/authentication/chef/fry.pem: -------------------------------------------------------------------------------- 1 | -----BEGIN RSA PRIVATE KEY----- 2 | MIIEpAIBAAKCAQEAvTDysb7cu7imRl9Qsh/L1qH3+it7a1oZR2Da0Gx7pWNnEfbb 3 | 5bafinjZH1Bqf7EWzOYW+FnRkosuRBJ5yStXJFAGPsocorQ22nY9YVpovnSQItx5 4 | QilWgw8SfNnhG5KNGFpp6pdh7p6lB0jCIz0q7d4x+obnnnUL6vGAvfGR8UDjcvtG 5 | KAuPd1iS44FdcA2MvClj6ZUTg12UmYJHltGype59Ng98h4C2dxfWUAXK9EODuvDI 6 | OakwQPr8w3To07EqtNc0mbv6miPYKiRbYA/0/t+ExJqnk685Vr2Y6Yq2GP/DZTGG 7 | ZwILmMXaoQ7p9sMILVSQ7hNFht2B/U++bop5qwIDAQABAoIBAFaBYRcg3DEBdxXK 8 | U01++GdFW+uJoj8tzU0z3hla4RZ4YxJ1u4pHfJ+GLlEBJhEI2hIKSwp3lznYZek+ 9 | QW1YYdn6tUBUjc9fc41kbyBqhGZBSf6GrPMxj5sRczSfMyy2T8mI3dEkMuU2qOKx 10 | xAL03wIwjM2ujY2Im1Br6J/xKvgSGCGSsf3MSD5n0dkpaSqGSMFYbd2UebCxj3nR 11 | cPknFEXTVpWNkY/Ijg/VE7TPGY6U9FXvT/MA1HAgseHu+bzN22cghDCcvRFCAHsi 12 | dp8TzxzQQSuem0gIA72J87T8IKErzIJOu5BnPbQozaFNHAvv4QIuAEoC2YAwIdLs 13 | lHDYXaECgYEA4JzcE8K4s6U+JWMzYZAVUJj210x6tz4Oy2EBturfVMGzOjBW5ec1 14 | bhhofcIOAWlU0qsWMNdbI7n1YUGRrIXDYAqBFDDqnFrxFTaO9UCxCbVeRuv31nCA 15 | 2YK3CmndwRhl1/tijLXdz3qKoPAPY4oWYinFMq1AxNPY7HYYbPIBBdkCgYEA16Dx 16 | bVagmYnCq/WW533mijlL8iOIb1Qpc5ugpVuXN7sOtwvEqJ+O8dfH78iz6x6V40DK 17 | kM2dltSmscg9lty8xSNf43iUj8vgIr5AAUji2xWRl9KFZ3jShZM4joq/r8aXK+Uk 18 | VpiZYDEbabgmn54SHUYeW28U3nnECHCXOkV+9SMCgYBP7IEDJw7CHdJ3S01FMhfj 19 | jgqHodcozRRGmkYZ6Il/h01XL0w8koEYo+bKmPqS1gAw1mAXEQqFM+50pPhJA2/6 20 | BMLZhG53JIUUn01PR623XqolYmHWFEJFI5YuRm16AEx9Bh6TI0PCSEB78/AF42UD 21 | mQlqduvNHfTab0tRuOtUQQKBgQDPeBJzYmNZ95uwOrd8er3kBucUzq2KeI79piL2 22 | l16zB69L3e3VVNiDx1ufUhwSwLX1FzUQCFZ1dpwA+KqRykdy4utzAWTnyoEYzLbm 23 | xYtIwsL4Ml2bRjxAu3syYzu2U7zGRk4lZ+RDElzO5pl7AOtq8TlqPkH1IXHFsRdA 24 | wPc7wwKBgQCu4qfs2ZRMQ6U33uEos72NNyP3U8dXf2t1uzCJeUQyJW3YjPnI2u4G 25 | VbFRnQz3YzDzCwcA0QWvP5zaYnh4BGm+FmTvkpxwRwnvEoN6SkQl0UCkCMRnnn3b 26 | lV/ydwWLv4dPoSFFSBs6SZEZXUS+C87d0/dpzVmMkJn0xAP4s3ufaA== 27 | -----END RSA PRIVATE KEY----- -------------------------------------------------------------------------------- /test/helpers/helpers.rb: -------------------------------------------------------------------------------- 1 | module RequestHelpers 2 | extend RR::DSL 3 | extend self 4 | 5 | # Need to stub this before we require smart_proxy_vault/endpoint 6 | def configure_settings 7 | stub.proxy(::VaultPlugin::Plugin.settings).token_options {{ 8 | ttl: '12h' 9 | }} 10 | stub.proxy(::VaultPlugin::Plugin.settings).vault {{ 11 | address: 'https://vault.example.com', 12 | token: 'GUID', 13 | ssl_verify: true 14 | }} 15 | end 16 | 17 | RequestHelpers.configure_settings 18 | end 19 | -------------------------------------------------------------------------------- /test/request_test.rb: -------------------------------------------------------------------------------- 1 | require_relative './test_helper' 2 | require 'smart_proxy_vault' 3 | require_relative './helpers/helpers' 4 | require 'smart_proxy_vault/endpoint' 5 | 6 | class RequestTest < Test::Unit::TestCase 7 | include Rack::Test::Methods 8 | include RequestHelpers 9 | include VaultPlugin::API 10 | 11 | ### 12 | # Helper Methods 13 | ### 14 | 15 | def stub_authorized?(bool) 16 | any_instance_of(VaultPlugin::Endpoint) do |klass| 17 | stub(klass).authorized? { true } 18 | end 19 | end 20 | 21 | def stub_client 22 | any_instance_of(VaultPlugin::Endpoint) do |klass| 23 | stub(klass).client { 'fry' } 24 | end 25 | end 26 | 27 | def stub_add_token_metadata 28 | any_instance_of(VaultPlugin::Endpoint) do |klass| 29 | stub(klass).add_token_metadata? { false } 30 | end 31 | end 32 | 33 | def token 34 | {lease_id: "", 35 | renewable: false, 36 | lease_duration: 43200, 37 | data: nil, 38 | warnings: nil, 39 | auth: { client_token: "GUID", lease_duration: 43200, renewable: true }} 40 | end 41 | 42 | def token_lookup 43 | {request_id: "GUID", 44 | lease_id: "", 45 | renewable: false, 46 | lease_duration: 0, 47 | data: 48 | {accessor: "GUID", 49 | creation_time: 1111111111, 50 | creation_ttl: 43200, 51 | display_name: "token", 52 | explicit_max_ttl: 0, 53 | id: "GUID", 54 | last_renewal_time: 1111111111, 55 | meta: nil, 56 | num_uses: 0, 57 | orphan: false, 58 | path: "auth/token/create/foorole", 59 | policies: ["default"], 60 | renewable: true, 61 | role: "foorole", 62 | ttl: 84971}, 63 | wrap_info: nil, 64 | warnings: nil, 65 | auth: nil} 66 | end 67 | 68 | def token_renew 69 | {client_token: "GUID", 70 | accessor: "GUID", 71 | policies: ["default"], 72 | metadata: nil, 73 | lease_duration: 43200, 74 | renewable: true} 75 | end 76 | 77 | def stub_response 78 | stub_request(:post, "https://vault.example.com/v1/auth/token/create"). 79 | with(:body => "{\"ttl\":\"12h\"}", 80 | :headers => { 'Accept'=>['*/*', 'application/json'], 81 | 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 82 | 'Content-Type'=>'application/json', 83 | 'User-Agent'=>['Ruby', 'VaultRuby/0.7.3 (+github.com/hashicorp/vault-ruby)'], 84 | 'X-Vault-Token'=>'GUID'}). 85 | to_return(:status => 200, :body => token.to_json, :headers => { 'Content-Type'=>'application/json' }) 86 | end 87 | 88 | def stub_response_role 89 | stub_request(:post, "https://vault.example.com/v1/auth/token/create/foo"). 90 | with(:headers => { 'Accept'=>['*/*', 'application/json'], 91 | 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 92 | 'Content-Type'=>'application/json', 93 | 'User-Agent'=>['Ruby', 'VaultRuby/0.7.3 (+github.com/hashicorp/vault-ruby)'], 94 | 'X-Vault-Token'=>'GUID'}). 95 | to_return(:status => 200, :body => token.to_json, :headers => { 'Content-Type'=>'application/json' }) 96 | end 97 | 98 | def stub_response_lookup 99 | stub_request(:get, "https://vault.example.com/v1/auth/token/lookup-self"). 100 | with(:headers => { 'Accept'=>['*/*', 'application/json'], 101 | 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 102 | 'Content-Type'=>'application/json', 103 | 'User-Agent'=>['Ruby', 104 | 'VaultRuby/0.7.3 (+github.com/hashicorp/vault-ruby)'], 105 | 'X-Vault-Token'=>'GUID'}). 106 | to_return(:status => 200, :body => token_lookup.to_json, :headers => { 'Content-Type'=>'application/json' }) 107 | end 108 | 109 | def stub_response_renew 110 | stub_request(:put, "https://vault.example.com/v1/auth/token/renew-self"). 111 | with(:body => "{\"increment\":43200}", 112 | :headers => { 'Accept'=>['*/*', 'application/json'], 113 | 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 114 | 'Content-Type'=>'application/json', 115 | 'User-Agent'=>['Ruby', 116 | 'VaultRuby/0.7.3 (+github.com/hashicorp/vault-ruby)'], 117 | 'X-Vault-Token'=>'GUID'}). 118 | to_return(:status => 200, :body => token_renew.to_json, :headers => { 'Content-Type'=>'application/json' }) 119 | end 120 | 121 | ### 122 | # Test Methods 123 | ### 124 | 125 | def app 126 | VaultPlugin::Endpoint.new 127 | end 128 | 129 | def setup 130 | stub_authorized?(true) 131 | stub_client 132 | configure_settings 133 | end 134 | 135 | def test_vault_token_issue 136 | stub_response 137 | get '/token/issue', ttl: '12h' 138 | assert last_response.ok? 139 | end 140 | 141 | def test_vault_token_issue_role 142 | stub_add_token_metadata 143 | stub_response_role 144 | get '/token/issue', role: 'foo' 145 | assert last_response.ok? 146 | end 147 | 148 | def test_bad_ttl_override 149 | get '/token/issue', ttl: '24h' 150 | assert last_response.bad_request? 151 | end 152 | 153 | def test_token_renewal 154 | stub_response_lookup 155 | stub_response_renew 156 | renew 157 | end 158 | 159 | def test_vault_settings 160 | failure_msg = 'Unexpected Vault Configuration' 161 | assert_equal [], vault_settings.values - Vault.options.values.compact, failure_msg 162 | end 163 | end 164 | -------------------------------------------------------------------------------- /test/test_helper.rb: -------------------------------------------------------------------------------- 1 | require 'simplecov' 2 | SimpleCov.start 3 | 4 | $: << File.join(File.dirname(__FILE__), '..', 'lib') 5 | 6 | require 'openssl' 7 | require 'test/unit' 8 | require "test/unit/rr" 9 | require 'webmock/test_unit' 10 | require 'rack/test' 11 | require 'factory_girl' 12 | require 'pry' 13 | FactoryGirl.find_definitions 14 | 15 | require 'smart_proxy_for_testing' 16 | 17 | class Test::Unit::TestCase 18 | include FactoryGirl::Syntax::Methods 19 | end 20 | 21 | logdir = File.join(File.dirname(__FILE__), '..', 'logs') 22 | FileUtils.mkdir_p(logdir) unless File.exists?(logdir) 23 | 24 | WebMock.disable_net_connect!(:allow => 'codeclimate.com') 25 | --------------------------------------------------------------------------------