├── .github └── workflows │ └── release.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── cmd ├── main │ └── main.go └── ssh │ ├── connect.go │ └── main.go ├── coverage_badge.png ├── demo.png ├── go.mod ├── go.sum ├── internal ├── helpers │ └── helpers.go └── types │ └── types.go └── pkg └── sshproxy ├── main.go ├── main_test.go └── test_data ├── example.yml └── example.yml-ssh-proxy /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Main 2 | 3 | on: push 4 | 5 | jobs: 6 | release: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Set up Go 1.13 10 | uses: actions/setup-go@v1 11 | with: 12 | go-version: 1.13 13 | id: go 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | - name: Test 17 | run: make test 18 | - name: Build release 19 | run: make release 20 | if: startsWith(github.ref, 'refs/tags/') 21 | - name: Release 22 | uses: softprops/action-gh-release@v1 23 | if: startsWith(github.ref, 'refs/tags/') 24 | env: 25 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 26 | with: 27 | files: releases/*.tar.gz 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /bin/ 2 | /cover.out 3 | /coverage.out 4 | /releases/ 5 | -------------------------------------------------------------------------------- /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 YYshow c' for details. 657 | 658 | The hypothetical commands Yshow c' should show the appropriate 659 | parts of the General Public License. Of course, your program's commands 660 | might be different; for a GUI interface, you would use an "about box". 661 | 662 | You should also get your employer (if you work as a programmer) or school, 663 | if any, to sign a "copyright disclaimer" for the program, if necessary. 664 | For more information on this, and how to apply and follow the GNU GPL, see 665 | . 666 | 667 | The GNU General Public License does not permit incorporating your program 668 | into proprietary programs. If your program is a subroutine library, you 669 | may consider it more useful to permit linking proprietary applications with 670 | the library. If this is what you want to do, use the GNU Lesser General 671 | Public License instead of this License. But first, please read 672 | . 673 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | BIN = $(CURDIR)/bin 2 | $(BIN): 3 | @mkdir -p $@ 4 | $(BIN)/%: | $(BIN) 5 | @tmp=$$(mktemp -d); \ 6 | env GO111MODULE=off GOPATH=$$tmp GOBIN=$(BIN) go get $(PACKAGE) \ 7 | || ret=$$?; \ 8 | rm -rf $$tmp ; exit $$ret 9 | 10 | $(BIN)/golint: PACKAGE=golang.org/x/lint/golint 11 | $(BIN)/gopherbadger: PACKAGE=github.com/jpoles1/gopherbadger 12 | 13 | GOPHERBADGER = $(BIN)/gopherbadger 14 | all: clean lint test build | $(GOPHERBADGER) 15 | $(GOPHERBADGER) -md="README.md" 16 | 17 | # Build binaries 18 | build: 19 | go build -a -o bin/kubectl-ssh_proxy cmd/main/main.go 20 | go build -a -o bin/kube-ssh-proxy-ssh-bin cmd/ssh/*.go 21 | 22 | # Run go fmt against code 23 | fmt: 24 | go fmt ./... 25 | 26 | # Run go vet against code 27 | vet: 28 | go vet ./... 29 | 30 | clean: 31 | rm bin/* 2> /dev/null 32 | 33 | GOLINT = $(BIN)/golint 34 | lint: | $(GOLINT) 35 | $(GOLINT) ./... 36 | 37 | test: fmt vet 38 | go test -coverprofile cover.out ./... 39 | 40 | PLATFORMS := linux-amd64 linux-386 darwin-amd64 darwin-386 windows-amd64 windows-386 41 | temp = $(subst -, ,$@) 42 | os = $(word 1, $(temp)) 43 | arch = $(word 2, $(temp)) 44 | release: $(PLATFORMS) 45 | $(PLATFORMS): 46 | @mkdir -p releases; \ 47 | CGO_ENABLED=0 GOOS=$(os) GOARCH=$(arch) go build -a -o bin/kubectl-ssh_proxy-$(os)-$(arch) cmd/main/main.go; \ 48 | CGO_ENABLED=0 GOOS=$(os) GOARCH=$(arch) go build -a -o bin/kube-ssh-proxy-ssh-bin-$(os)-$(arch) cmd/ssh/*.go; \ 49 | tar -cvzf releases/kubectl-ssh-proxy-$(os)-$(arch).tar.gz bin/*-$(os)-$(arch) 50 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kubectl SSH Proxy 2 | 3 | [![License](https://img.shields.io/github/license/little-angry-clouds/kubectl-ssh-proxy.svg)](https://github.com/little-angry-clouds/kubectl-ssh-proxy/blob/master/LICENSE) 4 | [![Go Report Card](https://goreportcard.com/badge/github.com/little-angry-clouds/kubectl-ssh-proxy)](https://goreportcard.com/report/github.com/little-angry-clouds/kubectl-ssh-proxy) 5 | ![gopherbadger-tag-do-not-edit](https://img.shields.io/badge/Go%20Coverage-33%25-brightgreen.svg?longCache=true&style=flat) 6 | ![Main](https://github.com/little-angry-clouds/kubectl-ssh-proxy/workflows/Main/badge.svg) 7 | 8 | This plugin aims to make your life easier when using `kubectl` a cluster 9 | that's behind a SSH bastion. 10 | 11 | ## TL;DR 12 | 13 | `kubectl` SSH Proxy basically spans a socks proxy in the background that 14 | `kubectl` can use. The configuration is pretty simple, edit your 15 | `$KUBECONFIG`-ssh-proxy file and add the next section: 16 | 17 | ``` yaml 18 | kube-ssh-proxy: 19 | ssh: 20 | host: my-bastion 21 | port: 22 22 | user: my-user 23 | key_path: /home/my-user/.ssh/id_rsa 24 | bind_port: 8080 25 | ``` 26 | 27 | It should be straightforward. The SSH connection sets the host at `my-bastion`, the 28 | port at `22`, the user at `my-user` and the key to be used is 29 | `/home/my-user/.ssh/id_rsa`. The `bind_port` is the port that will be set as a 30 | proxy in your local machine. 31 | 32 | The `key_path` is optional, if you don't set it, the plugin will try to use 33 | an existing `ssh-agent` session. 34 | 35 | The plugin's configuration path can also be set with the `$KUBECONFIG-SSH-PROXY` 36 | environment variable. 37 | 38 | ## Install 39 | 40 | Get the latest release from 41 | [Github](https://github.com/little-angry-clouds/kubectl-ssh-proxy/releases): 42 | 43 | ``` bash 44 | latest=$(curl --silent "https://api.github.com/repos/little-angry-clouds/kubectl-ssh-proxy/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/') 45 | curl --silent https://github.com/little-angry-clouds/kubectl-ssh-proxy/releases/download/$latest/kubectl-ssh-proxy-linux-386.tar.gz -O -L 46 | tar xf kubectl-ssh-proxy-linux*.tar.gz 47 | sudo mv bin/kubectl-ssh_proxy* /usr/local/bin/kubectl-ssh_proxy 48 | sudo mv bin/kube-ssh-proxy* /usr/local/bin/kube-ssh-proxy-ssh-bin 49 | ``` 50 | 51 | Disclaimer: There's binaries for windows and macOs too, but I haven't test them. 52 | If you do and have some feedback, please share! 53 | 54 | ## Demo 55 | 56 | ![Image](./demo.png) 57 | 58 | ## FAQ 59 | ### Why there's two binaries? 60 | 61 | First let's explain what these binaries do. The main program, the plugin, sends the second 62 | one, a minimalistic ssh binary, to the background. 63 | 64 | The plugin's domain is the reading of the configuration and managing the status 65 | of the SSH proxy. The ssh's binary domain is just span a ssh proxy. 66 | 67 | Said that, what we're trying to do here is to have a process running a ssh proxy 68 | and have `kubectl` to use it. To do so they have to be two different process, 69 | because otherwise the proxy would make it impossible to use `kubectl`. 70 | 71 | ### Why make a ssh binary if there's already one? 72 | 73 | It's a minimalistic version. Openssh it's pretty cool, but this is more simple. 74 | You can start a ssh proxy like this: 75 | 76 | ```bash 77 | kube-ssh-proxy-ssh-bin -H your.domain.com -p 22 -u your-user -b 8080 -k /home/your-user/.ssh/id_rsa 78 | ``` 79 | 80 | It only does this, so using openssh for this was a bit of an overkill. Also, 81 | this way we don't have that dependency, which theoretically makes it easier to 82 | have a multiplatform program. 83 | 84 | ### Why two different configuration files? 85 | 86 | The development first started with the ssh's proxy configuration in the 87 | `kubeconfig` file, but one day when changing the context, I realized that 88 | changing the context **deletes** and rewrites all the file. So, if something is 89 | not part of what `kubectl` expects, it's deleted. 90 | 91 | ### Why doesn't the proxy automatically set the environment variable? 92 | 93 | Because the program is executed in a subshell, and a subshell can't never modify 94 | variables from it's parent shell. Another example of this is aws cli's command 95 | [ecr 96 | get-login](https://docs.aws.amazon.com/cli/latest/reference/ecr/get-login.html). 97 | What you can do is to just eval the output, since everything that should not be 98 | evaluated has a comment first: 99 | 100 | ``` bash 101 | > kubectl ssh-proxy --start 102 | # The SSH Proxy started! 103 | # Eval the next: 104 | export HTTPS_PROXY=socks5://localhost:8080 105 | ``` 106 | 107 | You can do it like this: 108 | 109 | ``` bash 110 | > eval `kubectl ssh-proxy --start` 111 | ``` 112 | 113 | ### What if the cluster's domain is private? 114 | 115 | No worries, the DNS resolution is done in the bastion machine. If the bastion 116 | can resolve the domain, `kubectl` will. 117 | 118 | ### What OS does it support? 119 | 120 | Since it's Go, it should work on any OS. There's binaries for windows and macOs 121 | too, but I haven't test them. If you do and have some feedback, please share! 122 | 123 | ## Others 124 | 125 | Thanks to the folks at #go-nuts freenode's irc channel for being so friendly, 126 | some of them helped to define what I need to do with this plugin. 127 | 128 | ## License 129 | 130 | GPL3 131 | 132 | -------------------------------------------------------------------------------- /cmd/main/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | 7 | . "github.com/little-angry-clouds/kubectl-ssh-proxy/internal/helpers" 8 | . "github.com/little-angry-clouds/kubectl-ssh-proxy/pkg/sshproxy" 9 | ) 10 | 11 | func main() { 12 | var err error 13 | start := flag.Bool("start", false, "start ssh proxy") 14 | stop := flag.Bool("stop", false, "stop ssh proxy") 15 | status := flag.Bool("status", true, "status of the ssh proxy") 16 | flag.Parse() 17 | SSHProxy := SSHProxy{} 18 | err = SSHProxy.Init() 19 | if err != nil { 20 | CheckGenericError(err) 21 | } 22 | if *start { 23 | err = SSHProxy.Start() 24 | if err != nil { 25 | CheckGenericError(err) 26 | } 27 | } else if *stop { 28 | err = SSHProxy.Stop() 29 | if err != nil { 30 | CheckGenericError(err) 31 | } 32 | } else if *status { 33 | message := SSHProxy.Status() 34 | fmt.Println(message) 35 | } else { 36 | message := SSHProxy.Status() 37 | fmt.Println(message) 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /cmd/ssh/connect.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "context" 5 | "github.com/armon/go-socks5" 6 | "golang.org/x/crypto/ssh" 7 | "golang.org/x/net/proxy" 8 | "net" 9 | "time" 10 | ) 11 | 12 | // All the credit goes to https://github.com/blacknon/go-sshlib/ 13 | // This file has a different license, the one you can see in the projects github 14 | 15 | type connect struct { 16 | Client *ssh.Client 17 | } 18 | 19 | func (c *connect) CreateClient(host, port, user string, authMethods []ssh.AuthMethod) (err error) { 20 | uri := net.JoinHostPort(host, port) 21 | 22 | timeout := 20 23 | 24 | // Create new ssh.ClientConfig{} 25 | config := &ssh.ClientConfig{ 26 | User: user, 27 | Auth: authMethods, 28 | HostKeyCallback: ssh.InsecureIgnoreHostKey(), 29 | Timeout: time.Duration(timeout) * time.Second, 30 | } 31 | 32 | proxyDialer := proxy.Direct 33 | 34 | // Dial to host:port 35 | netConn, err := proxyDialer.Dial("tcp", uri) 36 | if err != nil { 37 | return 38 | } 39 | 40 | // Create new ssh connect 41 | sshCon, channel, req, err := ssh.NewClientConn(netConn, uri, config) 42 | if err != nil { 43 | return 44 | } 45 | 46 | // Create *ssh.Client 47 | c.Client = ssh.NewClient(sshCon, channel, req) 48 | 49 | return 50 | } 51 | 52 | // socks5Resolver prevents DNS from resolving on the local machine, rather than over the SSH connection. 53 | type socks5Resolver struct{} 54 | 55 | func (socks5Resolver) Resolve(ctx context.Context, name string) (context.Context, net.IP, error) { 56 | return ctx, nil, nil 57 | } 58 | 59 | func (c *connect) TCPDynamicForward(address, port string) (err error) { 60 | // Create Socks5 config 61 | conf := &socks5.Config{ 62 | Dial: func(ctx context.Context, n, addr string) (net.Conn, error) { 63 | return c.Client.Dial(n, addr) 64 | }, 65 | Resolver: socks5Resolver{}, 66 | } 67 | 68 | // Create Socks5 server 69 | s, err := socks5.New(conf) 70 | if err != nil { 71 | return 72 | } 73 | 74 | // Listen 75 | err = s.ListenAndServe("tcp", net.JoinHostPort(address, port)) 76 | 77 | return 78 | } 79 | -------------------------------------------------------------------------------- /cmd/ssh/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "io/ioutil" 5 | "net" 6 | "os" 7 | "strconv" 8 | 9 | "github.com/jessevdk/go-flags" 10 | . "github.com/little-angry-clouds/kubectl-ssh-proxy/internal/helpers" 11 | . "github.com/little-angry-clouds/kubectl-ssh-proxy/internal/types" 12 | "golang.org/x/crypto/ssh" 13 | "golang.org/x/crypto/ssh/agent" 14 | ) 15 | 16 | type options struct { 17 | SSHHost string `short:"H" long:"ssh-host" description:"ssh's host to login" optional:"no"` 18 | SSHPort int `short:"p" long:"ssh-port" description:"ssh's port to use in login" optional:"no"` 19 | SSHUser string `short:"u" long:"ssh-user" description:"ssh's user to use in login" optional:"no"` 20 | BindPort int `short:"b" long:"bind-port" description:"local port to bind the proxy" optional:"no"` 21 | SSHKeyPath string `short:"k" long:"ssh-key-path" description:"ssh's key to use in login" optional:"no"` 22 | } 23 | 24 | func getAuthType(keyPath string) []ssh.AuthMethod { 25 | var auth []ssh.AuthMethod 26 | if keyPath == "" { 27 | // Will probably not work with windows 28 | socket := os.Getenv("SSH_AUTH_SOCK") 29 | conn, err := net.Dial("unix", socket) 30 | CheckGenericError(err) 31 | agentClient := agent.NewClient(conn) 32 | auth = []ssh.AuthMethod{ssh.PublicKeysCallback(agentClient.Signers)} 33 | } else { 34 | buff, _ := ioutil.ReadFile(keyPath) 35 | key, err := ssh.ParsePrivateKey(buff) 36 | CheckGenericError(err) 37 | auth = []ssh.AuthMethod{ssh.PublicKeys(key)} 38 | } 39 | return auth 40 | } 41 | 42 | func createSSHTunnel(configuration KubeSSHProxyConfig) { 43 | var auth []ssh.AuthMethod 44 | auth = getAuthType(configuration.KubeSSHProxy.SSH.KeyPath) 45 | con := &connect{} 46 | err := con.CreateClient( 47 | configuration.KubeSSHProxy.SSH.Host, 48 | strconv.Itoa(configuration.KubeSSHProxy.SSH.Port), 49 | configuration.KubeSSHProxy.SSH.User, 50 | auth, 51 | ) 52 | CheckGenericError(err) 53 | err = con.TCPDynamicForward("localhost", strconv.Itoa(configuration.KubeSSHProxy.BindPort)) 54 | CheckGenericError(err) 55 | } 56 | 57 | func main() { 58 | var conf KubeSSHProxyConfig 59 | var opt options 60 | var parser = flags.NewParser(&opt, flags.Default) 61 | 62 | if _, err := parser.Parse(); err != nil { 63 | if flagsErr, ok := err.(*flags.Error); ok && flagsErr.Type == flags.ErrHelp { 64 | os.Exit(0) 65 | } else { 66 | os.Exit(1) 67 | } 68 | } 69 | conf.KubeSSHProxy.SSH.Host = opt.SSHHost 70 | conf.KubeSSHProxy.SSH.Port = opt.SSHPort 71 | conf.KubeSSHProxy.SSH.User = opt.SSHUser 72 | conf.KubeSSHProxy.SSH.KeyPath = opt.SSHKeyPath 73 | conf.KubeSSHProxy.BindPort = opt.BindPort 74 | createSSHTunnel(conf) 75 | } 76 | -------------------------------------------------------------------------------- /coverage_badge.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/little-angry-clouds/kubectl-ssh-proxy/c96d5ba7919dc94ab225d47506c8ed34f0b9386b/coverage_badge.png -------------------------------------------------------------------------------- /demo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/little-angry-clouds/kubectl-ssh-proxy/c96d5ba7919dc94ab225d47506c8ed34f0b9386b/demo.png -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/little-angry-clouds/kubectl-ssh-proxy 2 | 3 | go 1.13 4 | 5 | require ( 6 | github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 7 | github.com/jessevdk/go-flags v1.4.0 8 | github.com/stretchr/testify v1.4.0 9 | golang.org/x/crypto v0.0.0-20200117160349-530e935923ad 10 | golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa 11 | gopkg.in/yaml.v2 v2.2.8 12 | ) 13 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio= 2 | github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs= 3 | github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= 4 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 5 | github.com/jessevdk/go-flags v1.4.0 h1:4IU2WS7AumrZ/40jfhf4QVDMsQwqA7VEHozFRrGARJA= 6 | github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= 7 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 8 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 9 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 10 | github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= 11 | github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= 12 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 13 | golang.org/x/crypto v0.0.0-20200117160349-530e935923ad h1:Jh8cai0fqIK+f6nG0UgPW5wFk8wmiMhM3AyciDBdtQg= 14 | golang.org/x/crypto v0.0.0-20200117160349-530e935923ad/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= 15 | golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 16 | golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa h1:F+8P+gmewFQYRk6JoLQLwjBCTu3mcIURZfNkVweuRKA= 17 | golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= 18 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 19 | golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 20 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 21 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 22 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 23 | gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 24 | gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= 25 | gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 26 | -------------------------------------------------------------------------------- /internal/helpers/helpers.go: -------------------------------------------------------------------------------- 1 | package helpers 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | ) 7 | 8 | // CheckGenericError checks if there's an error, shows it and exits the program if it is 9 | func CheckGenericError(err error) { 10 | if err != nil { 11 | message := fmt.Sprintf("An error was detected, exiting: %s", err) 12 | fmt.Println(message) 13 | os.Exit(1) 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /internal/types/types.go: -------------------------------------------------------------------------------- 1 | package types 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | ) 7 | 8 | // KubeSSHProxyConfig is the Kubeconfig section that stores SSHProxy's stuff 9 | type KubeSSHProxyConfig struct { 10 | KubeSSHProxy struct { 11 | SSH struct { 12 | Host string `yaml:"host"` 13 | Port int `yaml:"port"` 14 | User string `yaml:"user"` 15 | // TODO añadir soporte para ssh-agent y contraseñas 16 | KeyPath string `yaml:"key_path"` 17 | } `yaml:"ssh"` 18 | BindPort int `yaml:"bind_port"` 19 | } 20 | } 21 | 22 | // Kubeconfig stores the relevant Kubeconfig information 23 | type Kubeconfig struct { 24 | CurrentCluster string 25 | CurrentContext string `yaml:"current-context"` 26 | Contexts []struct { 27 | Name string `yaml:"name"` 28 | } `yaml:"context"` 29 | KubeSSHProxyConfig 30 | } 31 | 32 | // UnmarshalYAML unmarshals yaml to match kubeconfig config 33 | func (k *Kubeconfig) UnmarshalYAML(unmarshal func(interface{}) error) error { 34 | var err error 35 | var aux map[string]interface{} 36 | if unmarshal(&aux); err != nil { 37 | fmt.Println(err) 38 | os.Exit(1) 39 | } 40 | if aux["current-context"] == nil { 41 | fmt.Println("Your configuration is incorrect, you're missing a value.") 42 | os.Exit(1) 43 | } 44 | k.CurrentContext = aux["current-context"].(string) 45 | // Search the name of the cluster of the current context 46 | for key := range aux { 47 | if key == "contexts" { 48 | c := aux[key].([]interface{}) 49 | for _, v := range c { 50 | n := v.(map[interface{}]interface{}) 51 | if n["name"] == k.CurrentContext { 52 | l := n["context"].(map[interface{}]interface{}) 53 | k.CurrentCluster = l["cluster"].(string) 54 | break 55 | } 56 | } 57 | } 58 | } 59 | return nil 60 | } 61 | 62 | // UnmarshalYAML unmarshals yaml to match kube-ssh-proxy config 63 | func (k *KubeSSHProxyConfig) UnmarshalYAML(unmarshal func(interface{}) error) error { 64 | var err error 65 | var aux map[string]interface{} 66 | if unmarshal(&aux); err != nil { 67 | fmt.Println(err) 68 | os.Exit(1) 69 | } 70 | if aux["kube-ssh-proxy"] == nil { 71 | fmt.Println("Your configuration is incorrect, you're missing the `kube-ssh-proxy` value.") 72 | os.Exit(1) 73 | } 74 | kubeSSHProxyConfig := aux["kube-ssh-proxy"].(map[interface{}]interface{}) 75 | if kubeSSHProxyConfig["ssh"] == nil { 76 | fmt.Println("Your configuration is incorrect, you're missing the `kube-ssh-proxy.ssh` value.") 77 | os.Exit(1) 78 | } 79 | kubeSSHProxyConfigSSH := kubeSSHProxyConfig["ssh"].(map[interface{}]interface{}) 80 | if kubeSSHProxyConfigSSH["host"] == nil { 81 | fmt.Println("Your configuration is incorrect, you're missing the `kube-ssh-proxy.ssh.host` value.") 82 | os.Exit(1) 83 | } 84 | if kubeSSHProxyConfigSSH["user"] == nil { 85 | fmt.Println("Your configuration is incorrect, you're missing the `kube-ssh-proxy.ssh.host` value.") 86 | os.Exit(1) 87 | } 88 | if kubeSSHProxyConfigSSH["port"] == nil { 89 | fmt.Println("Your configuration is incorrect, you're missing the `kube-ssh-proxy.ssh.host` value.") 90 | os.Exit(1) 91 | } 92 | if kubeSSHProxyConfig["bind_port"] == nil { 93 | fmt.Println("Your configuration is incorrect, you're missing the `kube-ssh-proxy.ssh.host` value.") 94 | os.Exit(1) 95 | } 96 | k.KubeSSHProxy.SSH.Host = kubeSSHProxyConfigSSH["host"].(string) 97 | k.KubeSSHProxy.SSH.User = kubeSSHProxyConfigSSH["user"].(string) 98 | k.KubeSSHProxy.SSH.Port = kubeSSHProxyConfigSSH["port"].(int) 99 | k.KubeSSHProxy.BindPort = kubeSSHProxyConfig["bind_port"].(int) 100 | if kubeSSHProxyConfigSSH["key_path"] != nil { 101 | k.KubeSSHProxy.SSH.KeyPath = kubeSSHProxyConfigSSH["key_path"].(string) 102 | } 103 | return nil 104 | } 105 | -------------------------------------------------------------------------------- /pkg/sshproxy/main.go: -------------------------------------------------------------------------------- 1 | package sshproxy 2 | 3 | import ( 4 | "fmt" 5 | "io/ioutil" 6 | "os" 7 | "os/exec" 8 | "path" 9 | "runtime" 10 | "strconv" 11 | "time" 12 | 13 | . "github.com/little-angry-clouds/kubectl-ssh-proxy/internal/types" 14 | "gopkg.in/yaml.v2" 15 | ) 16 | 17 | // SSHProxy is the main object 18 | type SSHProxy struct { 19 | kubeconfig Kubeconfig 20 | pidPath string 21 | } 22 | 23 | // Init initializes the SSHProxy object 24 | func (proxy *SSHProxy) Init() error { 25 | var err error 26 | err = proxy.getKubeconfig() 27 | if err != nil { 28 | return err 29 | } 30 | proxy.getPidPath() 31 | return nil 32 | } 33 | 34 | // Start starts the SSHProxy 35 | func (proxy *SSHProxy) Start() error { 36 | var err error 37 | pidPath := proxy.pidPath 38 | pidDir := path.Dir(pidPath) 39 | if _, err := os.Stat(pidPath); err == nil { 40 | return err 41 | } 42 | if _, err := os.Stat(pidDir); os.IsNotExist(err) { 43 | err = os.MkdirAll(pidDir, 0755) 44 | return err 45 | } 46 | args := proxy.createArgs() 47 | cmd := exec.Command("kube-ssh-proxy-ssh-bin", args...) 48 | err = cmd.Start() 49 | if err != nil { 50 | return err 51 | } 52 | // Capture the state of the subcommand. To do it it's necessary to add a little sleep 53 | done := make(chan error) 54 | go func() { done <- cmd.Wait() }() 55 | select { 56 | case err = <-done: 57 | message := fmt.Sprintf("# The ssh proxy failed. The error is: %s", err) 58 | fmt.Println(message) 59 | message = fmt.Sprintf("# You may debug the error by executing the ssh binary manually: %s", cmd.String()) 60 | fmt.Println(message) 61 | os.Exit(1) 62 | case <-time.After(1000 * time.Millisecond): 63 | // timeout, which means that all works correctly 64 | } 65 | pid := []byte(strconv.Itoa(cmd.Process.Pid)) 66 | err = ioutil.WriteFile(pidPath, pid, 0644) 67 | if err != nil { 68 | return err 69 | } 70 | fmt.Println("# The SSH Proxy started!") 71 | if runtime.GOOS == "windows" { 72 | fmt.Println("# Eval the next: \nset HTTPS_PROXY=socks5://localhost:8080") 73 | } else { 74 | fmt.Println("# Eval the next: \nexport HTTPS_PROXY=socks5://localhost:8080") 75 | } 76 | return nil 77 | } 78 | 79 | // Stop stops the SSHProxy 80 | func (proxy *SSHProxy) Stop() error { 81 | pidPath := proxy.pidPath 82 | if _, err := os.Stat(pidPath); err != nil { 83 | fmt.Println("# The ssh proxy is already stopped!") 84 | os.Exit(0) 85 | } 86 | file, err := os.Open(pidPath) 87 | if err != nil { 88 | return err 89 | } 90 | defer file.Close() 91 | pid, err := ioutil.ReadAll(file) 92 | if err != nil { 93 | return err 94 | } 95 | p, err := strconv.Atoi(string(pid)) 96 | if err != nil { 97 | return err 98 | } 99 | process, err := os.FindProcess(p) 100 | if err != nil { 101 | return err 102 | } 103 | process.Signal(os.Interrupt) 104 | if runtime.GOOS == "windows" { 105 | fmt.Println("# The SSH Proxy is already stopped! Eval the next:\nset HTTPS_PROXY=") 106 | } else { 107 | fmt.Println("# The SSH Proxy is already stopped! Eval the next:\nunset HTTPS_PROXY") 108 | } 109 | os.Remove(pidPath) 110 | return nil 111 | } 112 | 113 | // Status gets the SSHProxy status 114 | func (proxy *SSHProxy) Status() string { 115 | var message string 116 | pidPath := proxy.pidPath 117 | if _, err := os.Stat(pidPath); err == nil { 118 | message = "# The SSH Proxy is active." 119 | } else { 120 | message = "# The SSH Proxy is not active." 121 | } 122 | return message 123 | } 124 | 125 | func (proxy *SSHProxy) getPidPath() { 126 | var path string 127 | if runtime.GOOS == "linux" { 128 | path = os.Getenv("XDG_RUNTIME_DIR") 129 | } else if runtime.GOOS == "darwin" { 130 | // Not sure if XDG_RUNTIME_DIR exists, so just to be sure let's set it 131 | path = "/tmp/" 132 | } else if runtime.GOOS == "windows" { 133 | path = "%USERPROFILE%\\AppData\\Local\\Temp" 134 | } 135 | pidDir := fmt.Sprintf("%s/kubectl-ssh-proxy/%s", path, proxy.kubeconfig.CurrentCluster) 136 | pidPath := fmt.Sprintf("%s/PID", pidDir) 137 | proxy.pidPath = pidPath 138 | } 139 | 140 | func (proxy *SSHProxy) createArgs() []string { 141 | args := []string{ 142 | "-H", proxy.kubeconfig.KubeSSHProxy.SSH.Host, 143 | "-p", strconv.Itoa(proxy.kubeconfig.KubeSSHProxy.SSH.Port), 144 | "-u", proxy.kubeconfig.KubeSSHProxy.SSH.User, 145 | "-b", strconv.Itoa(proxy.kubeconfig.KubeSSHProxy.BindPort), 146 | } 147 | if proxy.kubeconfig.KubeSSHProxy.SSH.KeyPath != "" { 148 | args = append(args, "-k", proxy.kubeconfig.KubeSSHProxy.SSH.KeyPath) 149 | } 150 | return args 151 | } 152 | 153 | func (proxy *SSHProxy) getKubeconfig() error { 154 | var kubeconfig Kubeconfig 155 | var kubeSSHProxyConfig KubeSSHProxyConfig 156 | kubeconfigPath := os.Getenv("KUBECONFIG") 157 | if kubeconfigPath == "" { 158 | home, err := os.UserHomeDir() 159 | if err != nil { 160 | return err 161 | } 162 | kubeconfigPath = fmt.Sprintf("%s/.kube/config", home) 163 | } 164 | yamlFile, err := ioutil.ReadFile(kubeconfigPath) 165 | if err != nil { 166 | return err 167 | } 168 | err = yaml.Unmarshal(yamlFile, &kubeconfig) 169 | if err != nil { 170 | return err 171 | } 172 | proxy.kubeconfig = kubeconfig 173 | kubeSSHProxyConfigPath := os.Getenv("KUBECONFIG-SSH-PROXY") 174 | if kubeSSHProxyConfigPath == "" { 175 | kubeSSHProxyConfigPath = fmt.Sprintf("%s-ssh-proxy", kubeconfigPath) 176 | } 177 | yamlFile, err = ioutil.ReadFile(kubeSSHProxyConfigPath) 178 | if err != nil { 179 | return err 180 | } 181 | err = yaml.Unmarshal(yamlFile, &kubeSSHProxyConfig) 182 | if err != nil { 183 | return err 184 | } 185 | proxy.kubeconfig.KubeSSHProxyConfig = kubeSSHProxyConfig 186 | return nil 187 | } 188 | -------------------------------------------------------------------------------- /pkg/sshproxy/main_test.go: -------------------------------------------------------------------------------- 1 | package sshproxy 2 | 3 | import ( 4 | . "github.com/little-angry-clouds/kubectl-ssh-proxy/internal/types" 5 | "github.com/stretchr/testify/assert" 6 | "github.com/stretchr/testify/suite" 7 | "os" 8 | "path/filepath" 9 | "strings" 10 | "testing" 11 | ) 12 | 13 | // Set base suite 14 | type Suite struct { 15 | suite.Suite 16 | sshProxy SSHProxy 17 | } 18 | 19 | func (suite *Suite) SetupTest() { 20 | os.Setenv("KUBECONFIG", "./test_data/example.yml") 21 | suite.sshProxy = SSHProxy{} 22 | suite.sshProxy.getKubeconfig() 23 | os.Setenv("KUBECONFIG", "") 24 | } 25 | 26 | func TestSuite(t *testing.T) { 27 | suite.Run(t, new(Suite)) 28 | } 29 | 30 | // Start tests 31 | func (suite *Suite) TestGetKubeconfig() { 32 | var kubeconfig Kubeconfig 33 | kubeconfig.CurrentCluster = "MyCluster" 34 | kubeconfig.CurrentContext = "default" 35 | kubeconfig.KubeSSHProxy.SSH.Host = "anywhere" 36 | kubeconfig.KubeSSHProxy.SSH.Port = 22 37 | kubeconfig.KubeSSHProxy.SSH.User = "nobody" 38 | kubeconfig.KubeSSHProxy.SSH.KeyPath = "/home/nobody/.ssh/nobody" 39 | kubeconfig.KubeSSHProxy.BindPort = 8080 40 | assert.Equal(suite.T(), kubeconfig, suite.sshProxy.kubeconfig, "they should be equal") 41 | } 42 | 43 | func (suite *Suite) TestCreateArgs() { 44 | args := suite.sshProxy.createArgs() 45 | expectedArgs := "-H anywhere -p 22 -u nobody -b 8080 -k /home/nobody/.ssh/nobody" 46 | assert.Equal(suite.T(), expectedArgs, strings.Join(args[:], " "), "they should be equal") 47 | } 48 | 49 | func (suite *Suite) TestGetPidPath() { 50 | os.Setenv("XDG_RUNTIME_DIR", "/run/user/1000") 51 | suite.sshProxy.getPidPath() 52 | os.Setenv("XDG_RUNTIME_DIR", "") 53 | assert.Equal(suite.T(), "/run/user/1000/kubectl-ssh-proxy/MyCluster/PID", suite.sshProxy.pidPath, "they should be equal") 54 | } 55 | 56 | func (suite *Suite) TestSSHProxyStatusActive() { 57 | os.Setenv("XDG_RUNTIME_DIR", "/tmp/user/1000") 58 | expectedMessage := "# The SSH Proxy is active." 59 | err := os.MkdirAll(filepath.Dir("/tmp/user/1000/kubectl-ssh-proxy/MyCluster/"), 0777) 60 | assert.Equal(suite.T(), nil, err, "they should be equal") 61 | emptyFile, err := os.Create("/tmp/user/1000/kubectl-ssh-proxy/MyCluster/PID") 62 | assert.Equal(suite.T(), nil, err, "they should be equal") 63 | defer emptyFile.Close() 64 | suite.sshProxy.pidPath = "/tmp/user/1000/kubectl-ssh-proxy/MyCluster/PID" 65 | message := suite.sshProxy.Status() 66 | os.Remove("/tmp/user/1000/kubectl-ssh-proxy/MyCluster/PID") 67 | os.Setenv("XDG_RUNTIME_DIR", "") 68 | assert.Equal(suite.T(), expectedMessage, message, "they should be equal") 69 | } 70 | 71 | func (suite *Suite) TestSSHProxyStatusNotActive() { 72 | os.Setenv("XDG_RUNTIME_DIR", "/run/user/1000") 73 | expectedMessage := "# The SSH Proxy is not active." 74 | message := suite.sshProxy.Status() 75 | os.Setenv("XDG_RUNTIME_DIR", "") 76 | assert.Equal(suite.T(), expectedMessage, message, "they should be equal") 77 | } 78 | -------------------------------------------------------------------------------- /pkg/sshproxy/test_data/example.yml: -------------------------------------------------------------------------------- 1 | contexts: 2 | - context: 3 | cluster: MyCluster 4 | namespace: kube-system 5 | user: default 6 | name: default 7 | current-context: default 8 | -------------------------------------------------------------------------------- /pkg/sshproxy/test_data/example.yml-ssh-proxy: -------------------------------------------------------------------------------- 1 | kube-ssh-proxy: 2 | ssh: 3 | host: anywhere 4 | port: 22 5 | user: nobody 6 | key_path: /home/nobody/.ssh/nobody 7 | bind_port: 8080 8 | 9 | --------------------------------------------------------------------------------