├── .github └── workflows │ └── ci.yaml ├── .gitignore ├── LICENSE ├── README.md ├── go.mod ├── go.sum ├── lex.go ├── parser.go └── parser_test.go /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: ci 2 | on: [push, pull_request] 3 | jobs: 4 | tests: 5 | runs-on: ubuntu-latest 6 | steps: 7 | - uses: actions/checkout@v2 8 | - uses: actions/setup-go@v2 9 | with: 10 | go-version: '^1.21' 11 | - run: go install github.com/mattn/goveralls@latest 12 | - run: go test -v -coverprofile=profile.cov 13 | - run: goveralls -coverprofile=profile.cov -service=github 14 | env: 15 | COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }} 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | profile.cov 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenSSH config parser for golang 2 | 3 | [![Go Reference](https://pkg.go.dev/badge/github.com/mikkeloscar/sshconfig.svg)](https://pkg.go.dev/github.com/mikkeloscar/sshconfig) 4 | [![Go Report Card](https://goreportcard.com/badge/github.com/mikkeloscar/sshconfig)](https://goreportcard.com/report/github.com/mikkeloscar/sshconfig) 5 | [![Coverage Status](https://coveralls.io/repos/github/mikkeloscar/sshconfig/badge.svg)](https://coveralls.io/github/mikkeloscar/sshconfig) 6 | 7 | Parses the config usually found in `~/.ssh/config` or `/etc/ssh/ssh_config`. 8 | Only `Host`, `HostName`, `User`, `Port`, `IdentityFile`, `IdentityAgent`, `HostKeyAlgorithms`, `ProxyCommand`, `ProxyJump`, `LocalForward`, `RemoteForward`, `DynamicForward`, `Ciphers` and `MACs` is implemented at 9 | this point. 10 | 11 | [OpenSSH Reference.][openssh_man] 12 | 13 | ## Usage 14 | 15 | Example usage 16 | 17 | ```go 18 | package main 19 | 20 | import ( 21 | "fmt" 22 | 23 | "github.com/mikkeloscar/sshconfig" 24 | ) 25 | 26 | func main() { 27 | hosts, err := sshconfig.Parse("/path/to/ssh_config") 28 | if err != nil { 29 | fmt.Println(err) 30 | } 31 | 32 | for _, host := range hosts { 33 | fmt.Printf("Hostname: %s", host.HostName) 34 | } 35 | } 36 | ``` 37 | 38 | ## LICENSE 39 | 40 | Copyright (C) 2022 Mikkel Oscar Lyderik Larsen & Contributors 41 | 42 | This program is free software: you can redistribute it and/or modify 43 | it under the terms of the GNU General Public License as published by 44 | the Free Software Foundation, either version 3 of the License, or 45 | (at your option) any later version. 46 | 47 | This program is distributed in the hope that it will be useful, 48 | but WITHOUT ANY WARRANTY; without even the implied warranty of 49 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 50 | GNU General Public License for more details. 51 | 52 | You should have received a copy of the GNU General Public License 53 | along with this program. If not, see . 54 | 55 | [openssh_man]: http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man5/ssh_config.5?query=ssh_config&sec=5 56 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/mikkeloscar/sshconfig 2 | 3 | go 1.21 4 | 5 | require github.com/mitchellh/go-homedir v1.1.0 6 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= 2 | github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= 3 | -------------------------------------------------------------------------------- /lex.go: -------------------------------------------------------------------------------- 1 | // Copyright 2011 The Go Authors. All rights reserved. 2 | // Use of this source code is governed by a BSD-style 3 | // license that can be found in the LICENSE file. 4 | 5 | // based on the lexer from: src/pkg/text/template/parse/lex.go (golang source) 6 | 7 | package sshconfig 8 | 9 | import ( 10 | "fmt" 11 | "strings" 12 | "unicode" 13 | "unicode/utf8" 14 | ) 15 | 16 | // pos is a position in input being scanned 17 | type pos int 18 | 19 | type item struct { 20 | typ itemType 21 | pos pos 22 | val string 23 | } 24 | 25 | func (i item) String() string { 26 | switch { 27 | case i.typ == itemEOF: 28 | return "EOF" 29 | case i.typ == itemError: 30 | return i.val 31 | case len(i.val) > 10: 32 | return fmt.Sprintf("%.10q...", i.val) 33 | } 34 | return fmt.Sprintf("%q", i.val) 35 | } 36 | 37 | type itemType int 38 | 39 | const ( 40 | itemError itemType = iota 41 | itemEOF 42 | itemValue 43 | itemHost 44 | itemHostValue 45 | itemHostName 46 | itemUser 47 | itemPort 48 | itemProxyCommand 49 | itemProxyJumpHost 50 | itemHostKeyAlgorithms 51 | itemIdentityFile 52 | itemIdentityAgent 53 | itemLocalForward 54 | itemRemoteForward 55 | itemDynamicForward 56 | itemInclude 57 | itemCiphers 58 | itemMACs 59 | ) 60 | 61 | // variables 62 | var variables = map[string]itemType{ 63 | "host": itemHost, 64 | "hostname": itemHostName, 65 | "user": itemUser, 66 | "port": itemPort, 67 | "proxycommand": itemProxyCommand, 68 | "proxyjump": itemProxyJumpHost, 69 | "hostkeyalgorithms": itemHostKeyAlgorithms, 70 | "identityfile": itemIdentityFile, 71 | "identityagent": itemIdentityAgent, 72 | "localforward": itemLocalForward, 73 | "remoteforward": itemRemoteForward, 74 | "dynamicforward": itemDynamicForward, 75 | "include": itemInclude, 76 | "ciphers": itemCiphers, 77 | "macs": itemMACs, 78 | } 79 | 80 | const eof = -1 81 | 82 | // stateFn represents the state of the scanner as a function that returns the next state 83 | type stateFn func(*lexer) stateFn 84 | 85 | // lexer holds the state of the scanner 86 | type lexer struct { 87 | input string 88 | state stateFn 89 | pos pos 90 | start pos 91 | width pos 92 | lastPos pos 93 | items chan item // channel of scanned items 94 | } 95 | 96 | // next returns the next rune in the input 97 | func (l *lexer) next() rune { 98 | if int(l.pos) >= len(l.input) { 99 | l.width = 0 100 | return eof 101 | } 102 | r, w := utf8.DecodeRuneInString(l.input[l.pos:]) 103 | l.width = pos(w) 104 | l.pos += l.width 105 | return r 106 | } 107 | 108 | // peek returns but does not consume the next rune in the input 109 | func (l *lexer) peek() rune { 110 | r := l.next() 111 | l.backup() 112 | return r 113 | } 114 | 115 | // backup steps back one rune. Can only be called once per call of next 116 | func (l *lexer) backup() { 117 | l.pos -= l.width 118 | } 119 | 120 | // emit passes an item back to the client 121 | func (l *lexer) emit(t itemType) { 122 | l.items <- item{t, l.start, l.input[l.start:l.pos]} 123 | l.start = l.pos 124 | } 125 | 126 | // ignore skips over the pending input before this point 127 | func (l *lexer) ignore() { 128 | l.start = l.pos 129 | } 130 | 131 | // errorf returns an error token and terminates the scan by passing 132 | // back a nil pointer that will be the next state, terminating l.nextItem. 133 | func (l *lexer) errorf(format string, args ...interface{}) stateFn { 134 | l.items <- item{itemError, l.start, fmt.Sprintf(format, args...)} 135 | return nil 136 | } 137 | 138 | // nextItem returns the next item from the input. 139 | func (l *lexer) nextItem() item { 140 | item := <-l.items 141 | l.lastPos = item.pos 142 | return item 143 | } 144 | 145 | func lex(input string) *lexer { 146 | l := &lexer{ 147 | input: input, 148 | items: make(chan item), 149 | } 150 | go l.run() 151 | return l 152 | } 153 | 154 | func (l *lexer) run() { 155 | for l.state = lexEnv; l.state != nil; { 156 | l.state = l.state(l) 157 | } 158 | } 159 | 160 | func lexEnv(l *lexer) stateFn { 161 | switch r := l.next(); { 162 | case r == eof: 163 | l.emit(itemEOF) 164 | return nil 165 | case isAlphaNumeric(r): 166 | return lexVariable 167 | case r == '#': 168 | return lexComment 169 | case r == '\r': 170 | l.ignore() 171 | if l.next() != '\n' { 172 | l.errorf("expected \\n") 173 | return nil 174 | } 175 | l.ignore() 176 | return lexEnv 177 | case r == '\t' || r == ' ' || r == '\n': 178 | l.ignore() 179 | return lexEnv 180 | default: 181 | l.errorf("unable to parse character: %c", r) 182 | return nil 183 | } 184 | } 185 | 186 | func lexComment(l *lexer) stateFn { 187 | for { 188 | switch l.next() { 189 | case '\r': 190 | l.ignore() 191 | if l.next() != '\n' { 192 | l.errorf("expected \\n") 193 | return nil 194 | } 195 | l.ignore() 196 | return lexEnv 197 | case '\n', eof: 198 | l.ignore() 199 | return lexEnv 200 | default: 201 | l.ignore() 202 | } 203 | } 204 | } 205 | 206 | func lexVariable(l *lexer) stateFn { 207 | for { 208 | switch r := l.next(); { 209 | case isAlphaNumeric(r): 210 | // absorb 211 | case r == ' ' || r == '=': 212 | l.backup() 213 | variable := strings.ToLower(l.input[l.start:l.pos]) 214 | 215 | if _, ok := variables[variable]; ok { 216 | l.emit(variables[variable]) 217 | l.next() 218 | l.ignore() 219 | if variable == "host" { 220 | return lexHostValue 221 | } 222 | return lexValue 223 | } 224 | return lexValue 225 | default: 226 | pattern := l.input[l.start:l.pos] 227 | return l.errorf("invalid pattern: %#v", pattern) 228 | } 229 | } 230 | } 231 | 232 | func lexHostValue(l *lexer) stateFn { 233 | for { 234 | switch l.next() { 235 | case ' ': 236 | switch l.peek() { 237 | case '\r': 238 | if l.peek() != '\n' { 239 | return l.errorf("expected \\n") 240 | } 241 | fallthrough 242 | case '\n', eof: 243 | break 244 | default: 245 | // more coming, wait 246 | continue 247 | } 248 | l.emit(itemValue) 249 | case '\r': 250 | if l.peek() != '\n' { 251 | return l.errorf("expected \\n") 252 | } 253 | fallthrough 254 | case '\n': 255 | l.backup() 256 | l.emit(itemHostValue) 257 | return lexEnv 258 | case eof: 259 | l.backup() 260 | l.emit(itemHostValue) 261 | l.next() 262 | l.emit(itemEOF) 263 | return nil 264 | } 265 | } 266 | } 267 | 268 | func lexValue(l *lexer) stateFn { 269 | for { 270 | switch l.next() { 271 | case '\r': 272 | if l.peek() != '\n' { 273 | return l.errorf("expected \\n") 274 | } 275 | fallthrough 276 | case '\n': 277 | l.backup() 278 | l.emit(itemValue) 279 | return lexEnv 280 | case eof: 281 | l.backup() 282 | l.emit(itemValue) 283 | l.next() 284 | l.emit(itemEOF) 285 | return nil 286 | } 287 | } 288 | } 289 | 290 | // isAlphaNumeric reports whether r is an alphabetic or digit. 291 | func isAlphaNumeric(r rune) bool { 292 | return unicode.IsLetter(r) || unicode.IsDigit(r) 293 | } 294 | -------------------------------------------------------------------------------- /parser.go: -------------------------------------------------------------------------------- 1 | package sshconfig 2 | 3 | import ( 4 | "fmt" 5 | "io/fs" 6 | "os" 7 | "path/filepath" 8 | "regexp" 9 | "strconv" 10 | "strings" 11 | 12 | "github.com/mitchellh/go-homedir" 13 | ) 14 | 15 | // SSHHost defines a single host entry in a ssh config 16 | type SSHHost struct { 17 | Host []string 18 | HostName string 19 | User string 20 | Port int 21 | ProxyCommand string 22 | ProxyJump []string 23 | HostKeyAlgorithms string 24 | IdentityFile string 25 | IdentityAgent string 26 | LocalForwards []Forward 27 | RemoteForwards []Forward 28 | DynamicForwards []DynamicForward 29 | Ciphers []string 30 | MACs []string 31 | } 32 | 33 | // Forward defines a single port forward entry 34 | type Forward struct { 35 | InHost string 36 | InPort int 37 | OutHost string 38 | OutPort int 39 | } 40 | 41 | // NewForward returns Forward object parsed from LocalForward or RemoteForward string 42 | func NewForward(f string) (Forward, error) { 43 | r := regexp.MustCompile(`((\S+):)?(\d+)\s+(\S+):(\d+)`) 44 | m := r.FindStringSubmatch(f) 45 | 46 | if len(m) < 6 { 47 | return Forward{}, fmt.Errorf("Invalid forward: %#v", f) 48 | } 49 | 50 | InPort, err := strconv.Atoi(m[3]) 51 | if err != nil { 52 | return Forward{}, err 53 | } 54 | 55 | OutPort, err := strconv.Atoi(m[5]) 56 | if err != nil { 57 | return Forward{}, err 58 | } 59 | 60 | return Forward{ 61 | InHost: m[2], 62 | InPort: InPort, 63 | OutHost: m[4], 64 | OutPort: OutPort, 65 | }, nil 66 | } 67 | 68 | // DynamicForward defines a single dynamic port forward entry 69 | type DynamicForward struct { 70 | Host string 71 | Port int 72 | } 73 | 74 | // NewDynamicForward returns DForward object parsed from DynamicForward string 75 | func NewDynamicForward(f string) (DynamicForward, error) { 76 | r := regexp.MustCompile(`((\S+):)?(\d+)`) 77 | m := r.FindStringSubmatch(f) 78 | 79 | if len(m) < 4 { 80 | return DynamicForward{}, fmt.Errorf("Invalid dynamic forward: %#v", f) 81 | } 82 | 83 | InPort, err := strconv.Atoi(m[3]) 84 | if err != nil { 85 | return DynamicForward{}, err 86 | } 87 | 88 | return DynamicForward{ 89 | Host: m[2], 90 | Port: InPort, 91 | }, nil 92 | } 93 | 94 | // MustParse must parse the SSH config given by path or it will panic 95 | func MustParse(path string) []*SSHHost { 96 | config, err := Parse(path) 97 | if err != nil { 98 | panic(err) 99 | } 100 | return config 101 | } 102 | 103 | // MustParseSSHConfig must parse the SSH config given by path or it will panic 104 | // Deprecated: Use MustParse instead. 105 | func MustParseSSHConfig(path string) []*SSHHost { 106 | return MustParse(path) 107 | } 108 | 109 | // ParseSSHConfig parses a SSH config given by path. 110 | // Deprecated: Use Parse instead. 111 | func ParseSSHConfig(path string) ([]*SSHHost, error) { 112 | return Parse(path) 113 | } 114 | 115 | // Parse parses a SSH config given by path. 116 | func Parse(path string) ([]*SSHHost, error) { 117 | // read config file 118 | content, err := os.ReadFile(path) 119 | if err != nil { 120 | return nil, err 121 | } 122 | 123 | return parse(string(content), path) 124 | } 125 | 126 | // ParseFS parses a SSH config given by path contained in fsys. 127 | func ParseFS(fsys fs.FS, path string) ([]*SSHHost, error) { 128 | // read config file 129 | content, err := fs.ReadFile(fsys, path) 130 | if err != nil { 131 | return nil, err 132 | } 133 | 134 | return parse(string(content), path) 135 | } 136 | 137 | // parses an openssh config file 138 | func parse(input string, path string) ([]*SSHHost, error) { 139 | var sshConfigs []*SSHHost 140 | var next item 141 | var sshHost *SSHHost 142 | var onlyIncludes bool = !strings.Contains(input, "Host ") && strings.Contains(input, "Include ") 143 | 144 | lexer := lex(input) 145 | Loop: 146 | for { 147 | token := lexer.nextItem() 148 | 149 | if sshHost == nil { 150 | if token.typ == itemEOF { 151 | break Loop 152 | } 153 | if token.typ != itemHost && token.typ != itemInclude { 154 | // File has no `Host` but has `Include`. Continue trying to parse it. 155 | if onlyIncludes { 156 | continue Loop 157 | } 158 | return nil, fmt.Errorf("%s:%d: config variable before Host variable", path, token.pos) 159 | } 160 | } else if token.typ == itemInclude { 161 | return nil, fmt.Errorf("include not allowed in Host block") 162 | } 163 | 164 | switch token.typ { 165 | case itemHost: 166 | if sshHost != nil { 167 | sshConfigs = append(sshConfigs, sshHost) 168 | } 169 | 170 | sshHost = &SSHHost{Host: []string{}, Port: 22} 171 | case itemHostValue: 172 | sshHost.Host = strings.Split(token.val, " ") 173 | case itemHostName: 174 | next = lexer.nextItem() 175 | if next.typ != itemValue { 176 | return nil, fmt.Errorf(next.val) 177 | } 178 | sshHost.HostName = next.val 179 | case itemUser: 180 | next = lexer.nextItem() 181 | if next.typ != itemValue { 182 | return nil, fmt.Errorf(next.val) 183 | } 184 | sshHost.User = next.val 185 | case itemPort: 186 | next = lexer.nextItem() 187 | if next.typ != itemValue { 188 | return nil, fmt.Errorf(next.val) 189 | } 190 | port, err := strconv.Atoi(next.val) 191 | if err != nil { 192 | return nil, err 193 | } 194 | sshHost.Port = port 195 | case itemProxyCommand: 196 | next = lexer.nextItem() 197 | if next.typ != itemValue { 198 | return nil, fmt.Errorf(next.val) 199 | } 200 | sshHost.ProxyCommand = next.val 201 | case itemProxyJumpHost: 202 | next = lexer.nextItem() 203 | if next.typ != itemValue { 204 | return nil, fmt.Errorf(next.val) 205 | } 206 | sshHost.ProxyJump = strings.Split(next.val, ",") 207 | case itemHostKeyAlgorithms: 208 | next = lexer.nextItem() 209 | if next.typ != itemValue { 210 | return nil, fmt.Errorf(next.val) 211 | } 212 | sshHost.HostKeyAlgorithms = next.val 213 | case itemIdentityFile: 214 | next = lexer.nextItem() 215 | if next.typ != itemValue { 216 | return nil, fmt.Errorf(next.val) 217 | } 218 | sshHost.IdentityFile = next.val 219 | case itemIdentityAgent: 220 | next = lexer.nextItem() 221 | if next.typ != itemValue { 222 | return nil, fmt.Errorf(next.val) 223 | } 224 | sshHost.IdentityAgent = next.val 225 | case itemLocalForward: 226 | next = lexer.nextItem() 227 | f, err := NewForward(next.val) 228 | if err != nil { 229 | return nil, err 230 | } 231 | sshHost.LocalForwards = append(sshHost.LocalForwards, f) 232 | case itemRemoteForward: 233 | next = lexer.nextItem() 234 | f, err := NewForward(next.val) 235 | if err != nil { 236 | return nil, err 237 | } 238 | sshHost.RemoteForwards = append(sshHost.RemoteForwards, f) 239 | case itemDynamicForward: 240 | next = lexer.nextItem() 241 | f, err := NewDynamicForward(next.val) 242 | if err != nil { 243 | return nil, err 244 | } 245 | sshHost.DynamicForwards = append(sshHost.DynamicForwards, f) 246 | case itemInclude: 247 | next = lexer.nextItem() 248 | if next.typ != itemValue { 249 | return nil, fmt.Errorf(next.val) 250 | } 251 | 252 | includePath, err := parseIncludePath(path, next.val) 253 | if err != nil { 254 | return nil, err 255 | } 256 | 257 | files, err := filepath.Glob(includePath) 258 | if err != nil { 259 | return nil, err 260 | } 261 | 262 | if len(files) == 0 { 263 | return nil, fmt.Errorf("no files found for include path %s", includePath) 264 | } 265 | 266 | for _, f := range files { 267 | includeSshConfigs, err := Parse(f) 268 | if err != nil { 269 | return nil, err 270 | } 271 | 272 | sshConfigs = append(sshConfigs, includeSshConfigs...) 273 | } 274 | case itemCiphers: 275 | next = lexer.nextItem() 276 | if next.typ != itemValue { 277 | return nil, fmt.Errorf(next.val) 278 | } 279 | sshHost.Ciphers = strings.Split(next.val, ",") 280 | case itemMACs: 281 | next = lexer.nextItem() 282 | if next.typ != itemValue { 283 | return nil, fmt.Errorf(next.val) 284 | } 285 | sshHost.MACs = strings.Split(next.val, ",") 286 | case itemError: 287 | return nil, fmt.Errorf("%s at pos %d", token.val, token.pos) 288 | case itemEOF: 289 | if sshHost != nil { 290 | sshConfigs = append(sshConfigs, sshHost) 291 | } 292 | break Loop 293 | default: 294 | // continue onwards 295 | } 296 | } 297 | return sshConfigs, nil 298 | } 299 | 300 | func parseIncludePath(currentPath string, includePath string) (string, error) { 301 | if strings.HasPrefix(includePath, "~") { 302 | expandedPath, err := homedir.Expand(includePath) 303 | if err != nil { 304 | return "", err 305 | } 306 | 307 | return expandedPath, nil 308 | } else if !strings.HasPrefix(includePath, "/") { 309 | return filepath.Join(filepath.Dir(currentPath), includePath), nil 310 | } 311 | 312 | return includePath, nil 313 | } 314 | -------------------------------------------------------------------------------- /parser_test.go: -------------------------------------------------------------------------------- 1 | package sshconfig 2 | 3 | import ( 4 | "encoding/json" 5 | "fmt" 6 | "os" 7 | "reflect" 8 | "runtime" 9 | "strings" 10 | "testing" 11 | "testing/fstest" 12 | 13 | "github.com/mitchellh/go-homedir" 14 | ) 15 | 16 | // Test parsing 17 | func TestParsing(t *testing.T) { 18 | config := `Host google 19 | HostName google.se 20 | User goog 21 | Port 2222 22 | ProxyCommand ssh -q pluto nc saturn 22 23 | HostKeyAlgorithms ssh-dss 24 | # comment 25 | IdentityFile ~/.ssh/company 26 | IdentityAgent /dummy/agent.sock 27 | Ciphers aes256-ctr,aes128-cbc 28 | MACs hmac-md5,hmac-sha2-256 29 | 30 | 31 | Host face 32 | HostName facebook.com 33 | User mark 34 | Port 22 35 | ProxyJump google` 36 | 37 | _, err := parse(config, "~/.ssh/config") 38 | 39 | if err != nil { 40 | t.Errorf("unable to parse config: %s", err.Error()) 41 | } 42 | 43 | configCR := strings.Replace(`Host google 44 | HostName google.se 45 | User goog 46 | Port 2222 47 | ProxyCommand ssh -q pluto nc saturn 22 48 | HostKeyAlgorithms ssh-dss 49 | # comment 50 | IdentityFile ~/.ssh/company 51 | 52 | Host face 53 | HostName facebook.com 54 | User mark 55 | Port 22 56 | ProxyJump google`, "\n", "\r\n", -1) 57 | 58 | _, err = parse(configCR, "~/.ssh/config") 59 | 60 | if err != nil { 61 | t.Errorf("unable to parse config: %s", err.Error()) 62 | } 63 | } 64 | 65 | func TestTrailingComment(t *testing.T) { 66 | config := "Host *\n#comment" 67 | _, err := parse(config, "~/.ssh/config") 68 | if err != nil { 69 | t.Errorf("unable to parse config: %s", err.Error()) 70 | } 71 | } 72 | 73 | func TestMultipleHost(t *testing.T) { 74 | config := `Host google google2 aws 75 | HostName google.se 76 | User goog 77 | Port 2222` 78 | 79 | hosts, err := parse(config, "~/.ssh/config") 80 | 81 | if err != nil { 82 | t.Errorf("unable to parse config: %s", err.Error()) 83 | } 84 | 85 | h := hosts[0] 86 | if ok := reflect.DeepEqual([]string{"google", "google2", "aws"}, h.Host); !ok { 87 | t.Error("unexpected host mismatch") 88 | } 89 | 90 | } 91 | 92 | // TestTrailingSpace ensures the parser does not hang when attempting to parse 93 | // a Host declaration with a trailing space after a pattern 94 | func TestTrailingSpace(t *testing.T) { 95 | // in the config below, the first line is "Host google \n" 96 | config := ` 97 | Host googlespace 98 | HostName google.com 99 | ` 100 | _, err := parse(config, "~/.ssh/config") 101 | if err != nil { 102 | t.Errorf("unable to parse config: %s", err.Error()) 103 | } 104 | } 105 | 106 | func TestIgnoreKeyword(t *testing.T) { 107 | config := `Host google 108 | HostName google.se 109 | User goog 110 | Port 2222 111 | ProxyCommand ssh -q pluto nc saturn 22 112 | HostKeyAlgorithms ssh-dss 113 | # comment 114 | IdentityOnly yes 115 | IdentityFile ~/.ssh/company 116 | IdentityAgent /dummy/agent.sock 117 | 118 | Host face 119 | HostName facebook.com 120 | User mark 121 | ProxyJump google,other 122 | Port 22 123 | 124 | Host other 125 | HostName example.org 126 | User root 127 | Port 22 128 | Ciphers 3des-cbc,blowfish-cbc,cast128-cbc 129 | MACs hmac-sha1,hmac-sha1-96 130 | ` 131 | 132 | expected := []*SSHHost{ 133 | { 134 | Host: []string{"google"}, 135 | HostName: "google.se", 136 | User: "goog", 137 | Port: 2222, 138 | HostKeyAlgorithms: "ssh-dss", 139 | ProxyCommand: "ssh -q pluto nc saturn 22", 140 | IdentityFile: "~/.ssh/company", 141 | IdentityAgent: "/dummy/agent.sock", 142 | }, 143 | { 144 | Host: []string{"face"}, 145 | User: "mark", 146 | Port: 22, 147 | HostName: "facebook.com", 148 | HostKeyAlgorithms: "", 149 | ProxyCommand: "", 150 | ProxyJump: []string{"google", "other"}, 151 | IdentityFile: "", 152 | }, 153 | { 154 | Host: []string{"other"}, 155 | User: "root", 156 | Port: 22, 157 | HostName: "example.org", 158 | Ciphers: []string{"3des-cbc", "blowfish-cbc", "cast128-cbc"}, 159 | MACs: []string{"hmac-sha1", "hmac-sha1-96"}, 160 | }, 161 | } 162 | actual, err := parse(config, "~/.ssh/config") 163 | if err != nil { 164 | t.Errorf("unexpected error parsing config: %s", err.Error()) 165 | } 166 | 167 | compare(t, expected, actual) 168 | } 169 | 170 | func TestIncludeRelative(t *testing.T) { 171 | configA := `Include ./b.conf` 172 | configB := `Host google 173 | HostName google.se 174 | User goog 175 | Port 2222 176 | ProxyCommand ssh -q pluto nc saturn 22 177 | HostKeyAlgorithms ssh-dss 178 | # comment 179 | IdentityFile ~/.ssh/company 180 | 181 | Host face 182 | HostName facebook.com 183 | User mark 184 | Port 22` 185 | 186 | tmpdir := t.TempDir() 187 | 188 | f, err := os.Create(tmpdir + "/b.conf") 189 | if err != nil { 190 | t.Errorf("unable to create file: %s", err.Error()) 191 | } 192 | defer f.Close() 193 | 194 | _, err = f.WriteString(configB) 195 | if err != nil { 196 | t.Errorf("unable to write to file: %s", err.Error()) 197 | } 198 | 199 | _, err = parse(configA, tmpdir+"/a.conf") 200 | if err != nil { 201 | t.Errorf("unable to parse config: %s", err.Error()) 202 | } 203 | } 204 | 205 | func TestIncludeHome(t *testing.T) { 206 | configA := `Include ~/b.conf` 207 | configB := `Host google 208 | HostName google.se 209 | User goog 210 | Port 2222 211 | ProxyCommand ssh -q pluto nc saturn 22 212 | HostKeyAlgorithms ssh-dss 213 | # comment 214 | IdentityFile ~/.ssh/company 215 | 216 | Host face 217 | HostName facebook.com 218 | User mark 219 | Port 22` 220 | 221 | tmpdir := t.TempDir() 222 | 223 | homedir.DisableCache = true 224 | homeEnv := "HOME" 225 | if runtime.GOOS == "plan9" { 226 | // On plan9, env vars are lowercase. 227 | homeEnv = "home" 228 | } 229 | err := os.Setenv(homeEnv, tmpdir) 230 | if err != nil { 231 | t.Errorf("unable to set HOME env var: %s", err.Error()) 232 | } 233 | 234 | f, err := os.Create(tmpdir + "/b.conf") 235 | if err != nil { 236 | t.Errorf("unable to create file: %s", err.Error()) 237 | } 238 | defer f.Close() 239 | 240 | _, err = f.WriteString(configB) 241 | if err != nil { 242 | t.Errorf("unable to write to file: %s", err.Error()) 243 | } 244 | 245 | _, err = parse(configA, tmpdir+"/a.conf") 246 | if err != nil { 247 | t.Errorf("unable to parse config: %s", err.Error()) 248 | } 249 | } 250 | 251 | func TestIncludeRoot(t *testing.T) { 252 | tmpdir := t.TempDir() 253 | 254 | configA := fmt.Sprintf(`Include %s/b.conf`, tmpdir) 255 | configB := `Host google 256 | HostName google.se 257 | User goog 258 | Port 2222 259 | ProxyCommand ssh -q pluto nc saturn 22 260 | HostKeyAlgorithms ssh-dss 261 | # comment 262 | IdentityFile ~/.ssh/company 263 | 264 | Host face 265 | HostName facebook.com 266 | User mark 267 | Port 22` 268 | 269 | homedir.DisableCache = true 270 | homeEnv := "HOME" 271 | if runtime.GOOS == "plan9" { 272 | // On plan9, env vars are lowercase. 273 | homeEnv = "home" 274 | } 275 | err := os.Setenv(homeEnv, tmpdir) 276 | if err != nil { 277 | t.Errorf("unable to set HOME env var: %s", err.Error()) 278 | } 279 | 280 | f, err := os.Create(tmpdir + "/b.conf") 281 | if err != nil { 282 | t.Errorf("unable to create file: %s", err.Error()) 283 | } 284 | defer f.Close() 285 | 286 | _, err = f.WriteString(configB) 287 | if err != nil { 288 | t.Errorf("unable to write to file: %s", err.Error()) 289 | } 290 | 291 | _, err = parse(configA, tmpdir+"/a.conf") 292 | if err != nil { 293 | t.Errorf("unable to parse config: %s", err.Error()) 294 | } 295 | } 296 | 297 | func TestLocalForward(t *testing.T) { 298 | config := `Host google 299 | HostName google.se 300 | User goog 301 | Port 2222 302 | ProxyCommand ssh -q pluto nc saturn 22 303 | HostKeyAlgorithms ssh-dss 304 | # comment 305 | IdentityOnly yes 306 | IdentityFile ~/.ssh/company 307 | LocalForward 1337 duckduckgo.com:443 308 | 309 | Host face 310 | HostName facebook.com 311 | User mark 312 | Port 22 313 | LocalForward 2222 totalylegitserver:22 314 | LocalForward 0.0.0.0:666 instagram.com:1234` 315 | 316 | expected := []*SSHHost{ 317 | { 318 | Host: []string{"google"}, 319 | HostName: "google.se", 320 | User: "goog", 321 | Port: 2222, 322 | HostKeyAlgorithms: "ssh-dss", 323 | ProxyCommand: "ssh -q pluto nc saturn 22", 324 | IdentityFile: "~/.ssh/company", 325 | LocalForwards: []Forward{ 326 | { 327 | InHost: "", 328 | InPort: 1337, 329 | OutHost: "duckduckgo.com", 330 | OutPort: 443, 331 | }, 332 | }, 333 | }, 334 | { 335 | Host: []string{"face"}, 336 | User: "mark", 337 | Port: 22, 338 | HostName: "facebook.com", 339 | HostKeyAlgorithms: "", 340 | ProxyCommand: "", 341 | IdentityFile: "", 342 | LocalForwards: []Forward{ 343 | { 344 | InHost: "", 345 | InPort: 2222, 346 | OutHost: "totalylegitserver", 347 | OutPort: 22, 348 | }, 349 | { 350 | InHost: "0.0.0.0", 351 | InPort: 666, 352 | OutHost: "instagram.com", 353 | OutPort: 1234, 354 | }, 355 | }, 356 | }, 357 | } 358 | actual, err := parse(config, "~/.ssh/config") 359 | if err != nil { 360 | t.Errorf("unexpected error parsing config: %s", err.Error()) 361 | } 362 | 363 | compare(t, expected, actual) 364 | } 365 | 366 | func TestLocalForwardInvalid1(t *testing.T) { 367 | config := `Host face 368 | HostName facebook.com 369 | User mark 370 | Port 22 371 | LocalForward 2222 totalylegitserver 22` 372 | 373 | var expected []*SSHHost 374 | 375 | expectedErr := "Invalid forward: \"2222 totalylegitserver 22\"" 376 | 377 | actual, err := parse(config, "~/.ssh/config") 378 | if err == nil || err.Error() != expectedErr { 379 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 380 | } 381 | 382 | compare(t, expected, actual) 383 | } 384 | 385 | func TestLocalForwardInvalid2(t *testing.T) { 386 | config := `Host face 387 | HostName facebook.com 388 | User mark 389 | Port 22 390 | LocalForward 9223372036854775808 totalylegitserver:22` 391 | 392 | var expected []*SSHHost 393 | 394 | expectedErr := "strconv.Atoi: parsing \"9223372036854775808\": value out of range" 395 | 396 | actual, err := parse(config, "~/.ssh/config") 397 | if err == nil || err.Error() != expectedErr { 398 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 399 | } 400 | 401 | compare(t, expected, actual) 402 | } 403 | 404 | func TestLocalForwardInvalid3(t *testing.T) { 405 | config := `Host face 406 | HostName facebook.com 407 | User mark 408 | Port 22 409 | LocalForward 2222 totalylegitserver:9223372036854775808` 410 | 411 | var expected []*SSHHost 412 | 413 | expectedErr := "strconv.Atoi: parsing \"9223372036854775808\": value out of range" 414 | 415 | actual, err := parse(config, "~/.ssh/config") 416 | if err == nil || err.Error() != expectedErr { 417 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 418 | } 419 | 420 | compare(t, expected, actual) 421 | } 422 | 423 | func TestRemoteForward(t *testing.T) { 424 | config := `Host google 425 | HostName google.se 426 | User goog 427 | Port 2222 428 | ProxyCommand ssh -q pluto nc saturn 22 429 | HostKeyAlgorithms ssh-dss 430 | # comment 431 | IdentityOnly yes 432 | IdentityFile ~/.ssh/company 433 | RemoteForward 1337 duckduckgo.com:443 434 | 435 | Host face 436 | HostName facebook.com 437 | User mark 438 | Port 22 439 | RemoteForward 2222 totalylegitserver:22 440 | RemoteForward 0.0.0.0:666 instagram.com:1234` 441 | 442 | expected := []*SSHHost{ 443 | { 444 | Host: []string{"google"}, 445 | HostName: "google.se", 446 | User: "goog", 447 | Port: 2222, 448 | HostKeyAlgorithms: "ssh-dss", 449 | ProxyCommand: "ssh -q pluto nc saturn 22", 450 | IdentityFile: "~/.ssh/company", 451 | RemoteForwards: []Forward{ 452 | { 453 | InHost: "", 454 | InPort: 1337, 455 | OutHost: "duckduckgo.com", 456 | OutPort: 443, 457 | }, 458 | }, 459 | }, 460 | { 461 | Host: []string{"face"}, 462 | User: "mark", 463 | Port: 22, 464 | HostName: "facebook.com", 465 | HostKeyAlgorithms: "", 466 | ProxyCommand: "", 467 | IdentityFile: "", 468 | RemoteForwards: []Forward{ 469 | { 470 | InHost: "", 471 | InPort: 2222, 472 | OutHost: "totalylegitserver", 473 | OutPort: 22, 474 | }, 475 | { 476 | InHost: "0.0.0.0", 477 | InPort: 666, 478 | OutHost: "instagram.com", 479 | OutPort: 1234, 480 | }, 481 | }, 482 | }, 483 | } 484 | actual, err := parse(config, "~/.ssh/config") 485 | if err != nil { 486 | t.Errorf("unexpected error parsing config: %s", err.Error()) 487 | } 488 | 489 | compare(t, expected, actual) 490 | } 491 | 492 | func TestRemoteForwardInvalid1(t *testing.T) { 493 | config := `Host face 494 | HostName facebook.com 495 | User mark 496 | Port 22 497 | RemoteForward abc totalylegitserver:22` 498 | 499 | var expected []*SSHHost 500 | 501 | expectedErr := "Invalid forward: \"abc totalylegitserver:22\"" 502 | 503 | actual, err := parse(config, "~/.ssh/config") 504 | if err == nil || err.Error() != expectedErr { 505 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 506 | } 507 | 508 | compare(t, expected, actual) 509 | } 510 | 511 | func TestDynamicForward(t *testing.T) { 512 | config := `Host google 513 | HostName google.se 514 | User goog 515 | Port 2222 516 | ProxyCommand ssh -q pluto nc saturn 22 517 | HostKeyAlgorithms ssh-dss 518 | # comment 519 | IdentityOnly yes 520 | IdentityFile ~/.ssh/company 521 | DynamicForward 8080 522 | 523 | Host face 524 | HostName facebook.com 525 | User mark 526 | Port 22 527 | DynamicForward 8080 528 | DynamicForward 0.0.0.0:8443` 529 | 530 | expected := []*SSHHost{ 531 | { 532 | Host: []string{"google"}, 533 | HostName: "google.se", 534 | User: "goog", 535 | Port: 2222, 536 | HostKeyAlgorithms: "ssh-dss", 537 | ProxyCommand: "ssh -q pluto nc saturn 22", 538 | IdentityFile: "~/.ssh/company", 539 | DynamicForwards: []DynamicForward{ 540 | { 541 | Host: "", 542 | Port: 8080, 543 | }, 544 | }, 545 | }, 546 | { 547 | Host: []string{"face"}, 548 | User: "mark", 549 | Port: 22, 550 | HostName: "facebook.com", 551 | HostKeyAlgorithms: "", 552 | ProxyCommand: "", 553 | IdentityFile: "", 554 | DynamicForwards: []DynamicForward{ 555 | { 556 | Host: "", 557 | Port: 8080, 558 | }, 559 | { 560 | Host: "0.0.0.0", 561 | Port: 8443, 562 | }, 563 | }, 564 | }, 565 | } 566 | actual, err := parse(config, "~/.ssh/config") 567 | if err != nil { 568 | t.Errorf("unexpected error parsing config: %s", err.Error()) 569 | } 570 | 571 | compare(t, expected, actual) 572 | } 573 | 574 | func TestDynamicForward1(t *testing.T) { 575 | config := `Host face 576 | HostName facebook.com 577 | User mark 578 | Port 22 579 | DynamicForward abc` 580 | 581 | var expected []*SSHHost 582 | 583 | expectedErr := "Invalid dynamic forward: \"abc\"" 584 | 585 | actual, err := parse(config, "~/.ssh/config") 586 | if err == nil || err.Error() != expectedErr { 587 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 588 | } 589 | 590 | compare(t, expected, actual) 591 | } 592 | 593 | func TestDynamicForward2(t *testing.T) { 594 | config := `Host face 595 | HostName facebook.com 596 | User mark 597 | Port 22 598 | DynamicForward 9223372036854775808` 599 | 600 | var expected []*SSHHost 601 | 602 | expectedErr := "strconv.Atoi: parsing \"9223372036854775808\": value out of range" 603 | 604 | actual, err := parse(config, "~/.ssh/config") 605 | if err == nil || err.Error() != expectedErr { 606 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 607 | } 608 | 609 | compare(t, expected, actual) 610 | } 611 | 612 | func compare(t *testing.T, expected, actual []*SSHHost) { 613 | for i, ac := range actual { 614 | exMap := toMap(t, expected[i]) 615 | acMap := toMap(t, ac) 616 | 617 | if ok := reflect.DeepEqual(exMap, acMap); !ok { 618 | t.Errorf("unexpected parsed \n expected: %+v \n actual: %+v", exMap, acMap) 619 | } 620 | } 621 | } 622 | 623 | func toMap(t *testing.T, a *SSHHost) map[string]interface{} { 624 | ab, err := json.Marshal(a) 625 | if err != nil { 626 | t.Errorf("marshaling expected %s", err) 627 | } 628 | 629 | var aMap map[string]interface{} 630 | if err := json.Unmarshal(ab, &aMap); err != nil { 631 | t.Errorf("unmarshaling expected %s", err) 632 | } 633 | 634 | return aMap 635 | } 636 | 637 | func TestParse(t *testing.T) { 638 | config := `Host face 639 | HostName facebook.com 640 | User mark 641 | Port 22 642 | DynamicForward 9223372036854775808` 643 | 644 | os.WriteFile("/tmp/example", []byte(config), os.FileMode(0644)) 645 | 646 | actual, err := Parse("/tmp/example") 647 | 648 | var expected []*SSHHost 649 | 650 | expectedErr := "strconv.Atoi: parsing \"9223372036854775808\": value out of range" 651 | 652 | if err == nil || err.Error() != expectedErr { 653 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 654 | } 655 | 656 | compare(t, expected, actual) 657 | 658 | } 659 | 660 | func TestParseFS(t *testing.T) { 661 | config := `Host face 662 | HostName facebook.com 663 | User mark 664 | Port 22 665 | DynamicForward 9223372036854775808` 666 | 667 | memfs := fstest.MapFS{ 668 | "config": &fstest.MapFile{ 669 | Data: []byte(config), 670 | }, 671 | } 672 | 673 | actual, err := ParseFS(memfs, "config") 674 | 675 | var expected []*SSHHost 676 | 677 | expectedErr := "strconv.Atoi: parsing \"9223372036854775808\": value out of range" 678 | 679 | if err == nil || err.Error() != expectedErr { 680 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 681 | } 682 | 683 | compare(t, expected, actual) 684 | 685 | } 686 | 687 | func TestParseFSNonExitentFile(t *testing.T) { 688 | memfs := fstest.MapFS{} 689 | 690 | _, err := ParseFS(memfs, "config") 691 | 692 | expectedErr := "open config: file does not exist" 693 | 694 | if err == nil { 695 | t.Errorf("Did not get expected error: %#v, got nil", expectedErr) 696 | } 697 | 698 | if err.Error() != expectedErr { 699 | t.Errorf("Did not get expected error: %#v, got %#v", expectedErr, err.Error()) 700 | } 701 | 702 | } 703 | 704 | func TestHostlessFile(t *testing.T) { 705 | config := `Include ./b.conf 706 | Include ./a.conf 707 | VisualHostKey yes` 708 | 709 | configB := `Host google 710 | HostName google.se 711 | User goog 712 | Port 2222` 713 | configA := `Host face 714 | HostName facebook.com 715 | User mark 716 | Port 22` 717 | 718 | tmpdir := t.TempDir() 719 | 720 | f, err := os.Create(tmpdir + "/b.conf") 721 | if err != nil { 722 | t.Errorf("unable to create file: %s", err.Error()) 723 | } 724 | defer f.Close() 725 | 726 | _, err = f.WriteString(configB) 727 | if err != nil { 728 | t.Errorf("unable to write to file: %s", err.Error()) 729 | } 730 | 731 | f, err = os.Create(tmpdir + "/a.conf") 732 | if err != nil { 733 | t.Errorf("unable to create file: %s", err.Error()) 734 | } 735 | defer f.Close() 736 | 737 | _, err = f.WriteString(configA) 738 | if err != nil { 739 | t.Errorf("unable to write to file: %s", err.Error()) 740 | } 741 | 742 | _, err = parse(config, tmpdir+"/config") 743 | 744 | if err != nil { 745 | t.Errorf("unable to parse config: %s", err.Error()) 746 | } 747 | } 748 | --------------------------------------------------------------------------------