├── .gitignore
├── LICENSE
├── README.md
├── config
├── config.go
├── lexer.go
└── parser.go
├── go.mod
├── log.go
├── main.go
├── proxy.go
├── proxy_protocol.go
├── sni.go
└── sni_test.go
/.gitignore:
--------------------------------------------------------------------------------
1 | sniproxy
2 | sniproxy.conf
3 |
--------------------------------------------------------------------------------
/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 | # SNIProxy
2 |
3 | _SNIProxy_ is a TLS proxy which, based on the
4 | [TLS SNI](https://en.wikipedia.org/wiki/Server_Name_Indication) contained in TLS
5 | handshakes, routes TCP connections to backends. The proxy does not need the TLS
6 | encryption keys and can not decrypt the TLS traffic.
7 |
8 | _SNIProxy_ is meant to be simple to use and configure, with sane defaults and
9 | few parameters.
10 |
11 | ## Docker image
12 |
13 | ```shell
14 | $ docker run --name sniproxy -p 443:443/tcp \
15 | -v $(pwd)/sniproxy.conf:/sniproxy.conf \
16 | atenart/sniproxy:latest -conf sniproxy.conf
17 | ```
18 |
19 | _SNIProxy_ can be bound to a custom address or port using the `-bind` command
20 | line option.
21 |
22 | ```shell
23 | $ docker run --name sniproxy -p 443:443/tcp \
24 | -v $(pwd)/sniproxy.conf:/sniproxy.conf \
25 | atenart/sniproxy:latest -bind 192.168.0.1:8080 -conf sniproxy.conf
26 | ```
27 |
28 | ## Configuration file
29 |
30 | The configuration is made of a list of blocks. Each block represents a route. A
31 | route is defined by a list of hostnames, a backend to route the connection to
32 | and optional parameters. Empty blocks (`{}`) can be omitted.
33 |
34 | ```
35 | hostname0, hostname1, … {
36 | backend :port {
37 | optional-parameter
38 | }
39 | parameter0
40 | parameter1 arg0, arg1, …
41 | …
42 | }
43 | ```
44 |
45 | A route can be as simple as:
46 |
47 | ```
48 | example.net {
49 | backend 1.2.3.4:8080
50 | }
51 | ```
52 |
53 | Hostnames can contain regexp:
54 |
55 | ```
56 | # Matches example.net and all its subdomains.
57 | example.net, *.example.net {
58 | backend localhost:1234
59 | }
60 | ```
61 |
62 | By leaving hostname blank, passthrough mode is enabled:
63 |
64 | ```
65 | # Uses example.com:443 as the backend
66 | example.com {
67 | backend :443
68 | }
69 | ```
70 |
71 | ### Optional parameters
72 |
73 | [HAProxy's PROXY protocol](https://www.haproxy.org/download/2.0/doc/proxy-protocol.txt)
74 | v1 and v2 are supported.
75 |
76 | ```
77 | example.net {
78 | backend 1.2.3.4:443 {
79 | # Send a PROXY header using the PROXY protocol v1.
80 | send-proxy
81 | }
82 | }
83 |
84 | blog.example.net {
85 | backend 1.2.3.5:443 {
86 | # Send a PROXY header using the PROXY protocol v2.
87 | send-proxy-v2
88 | }
89 | }
90 | ```
91 |
92 | _SNIProxy_ also has the ability to block or allow connections based on the
93 | client IP address. Single IPs or subnets (using a CIDR range) are supported.
94 |
95 | ```
96 | # Deny a single client. All other connections will be routed to the backend.
97 | example.net {
98 | backend 1.2.3.4:443
99 | deny 10.0.0.42
100 | }
101 |
102 | # Lists can be used as well, either using commas (,) or using multiple
103 | # statements.
104 | example.net {
105 | backend 1.2.3.4:443
106 | deny 10.0.0.42, 10.0.0.43, 10.0.0.44
107 | deny 10.0.0.45
108 | }
109 |
110 | # When at least one IP is allowed, all IPs are denied automatically (0.0.0.0/0
111 | # and ::/0).
112 | example.net {
113 | backend 1.2.3.4:443
114 | # 192.168.0.42 is allowed, all other IPs are denied.
115 | allow 192.168.0.42
116 | }
117 |
118 | # Example with ranges.
119 | example.net {
120 | backend 1.2.3.4:443
121 | deny 192.168.0.0/24
122 | }
123 |
124 | # The most specific range wins (if the range is the same, deny wins).
125 | example.net {
126 | backend 1.2.3.4:443
127 | # Deny 192.168.0.0/22 except for 192.168.0.2 and 192.168.1.8/29.
128 | deny 192.168.0.0/22
129 | allow 192.168.1.8/29, 192.168.0.2
130 | }
131 | ```
132 |
133 | _SNIProxy_ can use a different dedicated backend for ACME TLS.
134 |
135 | ```
136 | example.net {
137 | backend 1.2.3.4:443
138 | acme 1.2.3.5:443
139 | }
140 | ```
141 |
142 | ACLs can be bypassed for ACME:
143 |
144 | ```
145 | # All IPs are denied except for 192.168.0.0/24 and ACME TLS.
146 | example.net {
147 | backend 1.2.3.4:443
148 | acme 1.2.3.5:443
149 | allow 192.168.0.0/24, acme
150 | }
151 | ```
152 |
--------------------------------------------------------------------------------
/config/config.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package config
17 |
18 | import (
19 | "log"
20 | "net"
21 | "os"
22 | "regexp"
23 | "strings"
24 | )
25 |
26 | // Config holds the entire current configuration.
27 | type Config struct {
28 | Routes []*Route
29 | }
30 |
31 | // Route represents a route between matched domains and a backend.
32 | type Route struct {
33 | Domains []*regexp.Regexp
34 | // Default backend.
35 | Backend *Backend
36 | // Backend for ACME.
37 | ACME *Backend
38 | // Bypass ACLs for ACME.
39 | AllowACME bool
40 | // Deny and Allow contain lists of IP ranges and/or addresses to
41 | // whitelist or blacklist for a given route. If Allow is used, all
42 | // addresses are then blocked by default.
43 | // The more specific subnet takes precedence, and Deny wins over Allow
44 | // in case none is more specific.
45 | Deny []*net.IPNet
46 | Allow []*net.IPNet
47 | }
48 |
49 | // Backend represents a backend and its options.
50 | type Backend struct {
51 | Address string
52 | // HAProxy PROXY protocol support (None, v1, v2).
53 | SendProxy uint
54 | }
55 |
56 | // SendProxy possible values.
57 | const (
58 | ProxyNone = iota
59 | ProxyV1 = iota
60 | ProxyV2 = iota
61 | )
62 |
63 | // Reads a configuration file and transforms it into a Config struct.
64 | func (c *Config) ReadFile(file string) error {
65 | f, err := os.Open(file)
66 | if err != nil {
67 | return err
68 | }
69 | defer f.Close()
70 |
71 | l := newLexer(f)
72 | c.parse(parseDirective(&l))
73 |
74 | return nil
75 | }
76 |
77 | // Parses the directives generated by the parser and generate the configuration.
78 | func (c *Config) parse(root *Directive) {
79 | for _, directive := range(root.Directives) {
80 | route := &Route{}
81 | c.Routes = append(c.Routes, route)
82 |
83 | domains := strings.Split(directive.Name, ",")
84 | for _, domain := range(domains) {
85 | rgp, err := domain2Regex(domain)
86 | if err != nil {
87 | log.Fatal("Invalid domain: " + domain)
88 | }
89 |
90 | route.Domains = append(route.Domains, rgp)
91 | }
92 |
93 | for _, dir := range(directive.Directives) {
94 | switch dir.Name {
95 | case "backend":
96 | if len(dir.Args) != 1 {
97 | log.Fatal("Invalid backend directive")
98 | }
99 | route.Backend = parseBackend(dir)
100 | break
101 | case "acme":
102 | if len(dir.Args) != 1 {
103 | log.Fatal("Invalid acme directive")
104 | }
105 | route.ACME = parseBackend(dir)
106 | break
107 | case "deny":
108 | if len(dir.Args) != 1 {
109 | log.Fatal("Invalid deny directive")
110 | }
111 | for _, subnet := range(strings.Split(dir.Args[0], ",")) {
112 | route.Deny = append(route.Deny, parseRange(subnet))
113 | }
114 | break
115 | case "allow":
116 | if len(dir.Args) != 1 {
117 | log.Fatal("Invalid allow directive")
118 | }
119 | for _, subnet := range(strings.Split(dir.Args[0], ",")) {
120 | if subnet == "acme" {
121 | route.AllowACME = true
122 | continue
123 | }
124 | route.Allow = append(route.Allow, parseRange(subnet))
125 | }
126 | break
127 | default:
128 | continue
129 | }
130 | }
131 |
132 | if len(route.Allow) > 0 {
133 | // When using the allow directive, we should block all
134 | // other IPs. Set Deny to match all IPs.
135 | _, all4, _ := net.ParseCIDR("0.0.0.0/0")
136 | _, all6, _ := net.ParseCIDR("::/0")
137 | route.Deny = append(route.Deny, all4)
138 | route.Deny = append(route.Deny, all6)
139 | }
140 | }
141 | }
142 |
143 | func parseBackend(directive *Directive) *Backend {
144 | backend := &Backend{
145 | Address: directive.Args[0],
146 | SendProxy: ProxyNone,
147 | }
148 |
149 | for _, d := range(directive.Directives) {
150 | switch d.Name {
151 | // HAProxy PROXY protocol (v1)
152 | case "send-proxy":
153 | if len(d.Args) > 0 {
154 | log.Fatal("Invalid send-proxy directive")
155 | }
156 | backend.SendProxy = ProxyV1
157 | break
158 | // HAProxy PROXY protocol (v2)
159 | case "send-proxy-v2":
160 | if len(d.Args) > 0 {
161 | log.Fatal("Invalid send-proxy directive")
162 | }
163 | backend.SendProxy = ProxyV2
164 | break
165 | }
166 | }
167 |
168 | return backend
169 | }
170 |
171 | // Converts a domain to a regexp.Regexp.
172 | func domain2Regex(domain string) (*regexp.Regexp, error) {
173 | // Translate the domains into a regexp valid string.
174 | regex := "^"
175 | for _, r := range domain {
176 | switch r {
177 | case '*':
178 | regex += `.*`
179 | break
180 | case '.':
181 | regex += `\.`
182 | break
183 | default:
184 | regex += string(r)
185 | }
186 | }
187 | regex += "$"
188 |
189 | return regexp.Compile(regex)
190 | }
191 |
192 | // Parse a subnet string.
193 | func parseRange(subnet string) *net.IPNet {
194 | _, ipnet, err := net.ParseCIDR(subnet)
195 | if err == nil {
196 | return ipnet
197 | }
198 |
199 | ip := net.ParseIP(subnet)
200 | if ip == nil {
201 | log.Fatal("Could not parse subnet " + subnet)
202 | }
203 |
204 | // IP is an IPv4 address, its CIDR should be /32.
205 | if v4 := ip.To4(); v4 != nil {
206 | return &net.IPNet{ IP: ip, Mask: net.CIDRMask(32, 32) }
207 | }
208 |
209 | // IP is an IPv6 address, its CIDR should be /128.
210 | return &net.IPNet{ IP: ip, Mask: net.CIDRMask(128, 128) }
211 | }
212 |
--------------------------------------------------------------------------------
/config/lexer.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package config
17 |
18 | import (
19 | "bufio"
20 | "io"
21 | "unicode"
22 | )
23 |
24 | // Lexer gets values, token by token, from an io.Reader.
25 | type Lexer struct {
26 | reader *bufio.Reader
27 | tokens []*Token
28 | cursor int
29 | line uint
30 | }
31 |
32 | // Token stores a value, and metadata associated to it.
33 | type Token struct {
34 | Val string
35 | Line uint
36 | }
37 |
38 | // Loads an io.Reader and wraps it into a bufio.Reader to prepare the Lexer for
39 | // scanning tokens.
40 | func newLexer(input io.Reader) Lexer {
41 | l := Lexer{
42 | reader: bufio.NewReader(input),
43 | cursor: -1,
44 | line: 1,
45 | }
46 |
47 | // Parse all tokens and store them in l.tokens.
48 | for l.parseNext() {
49 | }
50 |
51 | return l
52 | }
53 |
54 | // Loads for the next token in Lexer.Token. A token is delimited by whitespaces,
55 | // unless it starts with a quote ("). The rest of a line is dropped if an hash
56 | // (#) is read. Values separated by a comma (,) are considered being members of
57 | // a list and will end up in the same uniq token; it's up to the upper layer to
58 | // split them. Commas (,) can be followed by spaces or new lines.
59 | func (l *Lexer) parseNext() bool {
60 | var comment, quote, list bool
61 | var val []rune
62 |
63 | token := &Token{}
64 |
65 | finalize := func() bool {
66 | token.Val = string(val)
67 | l.tokens = append(l.tokens, token)
68 | return true
69 | }
70 |
71 | for {
72 | ch, _, err := l.reader.ReadRune()
73 |
74 | // Handle EOF and unexpected errors. If a token was being made
75 | // return it.
76 | if err != nil {
77 | if len(val) > 0 {
78 | return finalize()
79 | }
80 | return false
81 | }
82 |
83 | // End of quoted values.
84 | if quote && ch == '"' {
85 | return finalize()
86 | }
87 |
88 | // Handle spaces.
89 | if unicode.IsSpace(ch) {
90 | // Carriage return is discarded.
91 | if ch == '\r' {
92 | continue
93 | }
94 | if ch == '\n' {
95 | if quote {
96 | // Unexpected EOL. We should handle this
97 | // with a real error being reported.
98 | return false
99 | }
100 | l.line++
101 | comment = false
102 | }
103 | if !quote && !list && len(val) > 0 {
104 | list = false
105 | return finalize()
106 | }
107 | continue
108 | }
109 |
110 | // Detect the start of a comment.
111 | if ch == '#' {
112 | comment = true
113 | }
114 |
115 | // Discard commented runes.
116 | if comment {
117 | continue
118 | }
119 |
120 | // Understand lists
121 | if ch == ',' {
122 | list = true
123 | } else {
124 | // Next rune isn't a space, reset the list state.
125 | list = false
126 | }
127 |
128 | if len(val) == 0 {
129 | token.Line = l.line
130 | if ch == '"' {
131 | quote = true
132 | continue
133 | }
134 | }
135 |
136 | val = append(val, ch)
137 | }
138 | }
139 |
140 | // Loads a token only if on the same line. Returns true if a token is found,
141 | // false otherwise.
142 | func (l *Lexer) Next() bool {
143 | // No more token available
144 | if l.cursor + 1 == len(l.tokens) {
145 | return false
146 | }
147 |
148 | // We are not currently on a line.
149 | if l.cursor == -1 {
150 | return false
151 | }
152 |
153 | // Next token is on a new line.
154 | if l.tokens[l.cursor].Line != l.tokens[l.cursor + 1].Line {
155 | return false
156 | }
157 |
158 | l.cursor++
159 | return true
160 | }
161 |
162 | // Loads the first token of the next line. Returns true if a token is found,
163 | // false otherwise.
164 | func (l *Lexer) NextLine() bool {
165 | // Loop through all remaining tokens on the current line.
166 | for l.Next() {
167 | }
168 |
169 | // No more token available
170 | if l.cursor + 1 == len(l.tokens) {
171 | return false
172 | }
173 |
174 | l.cursor++
175 | return true
176 | }
177 |
178 | // Returns the current token value.
179 | func (l *Lexer) Val() string {
180 | if l.cursor == -1 || l.cursor + 1 == len(l.tokens) {
181 | return ""
182 | }
183 |
184 | return l.tokens[l.cursor].Val
185 | }
186 |
187 | // Returns the next token value.
188 | func (l *Lexer) NextVal() string {
189 | if l.cursor + 2 >= len(l.tokens) {
190 | return ""
191 | }
192 |
193 | return l.tokens[l.cursor + 1].Val
194 | }
195 |
--------------------------------------------------------------------------------
/config/parser.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package config
17 |
18 | type Directive struct {
19 | Name string
20 | Args []string
21 | Directives []*Directive
22 | }
23 |
24 | func parseDirective(l *Lexer) *Directive {
25 | d := &Directive{ Name: l.Val() }
26 |
27 | // Quick hack, special case the first block.
28 | // Real default: false
29 | block := l.Val() == ""
30 |
31 | // Retrieve all the arguments on the current line.
32 | for l.Next() {
33 | // Start of a new block.
34 | if l.Val() == "{" {
35 | block = true
36 | break
37 | }
38 |
39 | // Directive's arguments.
40 | d.Args = append(d.Args, l.Val())
41 | }
42 |
43 | // Parse the directive's block.
44 | for block && l.NextLine() {
45 | // End of block, return to previous one.
46 | if l.Val() == "}" {
47 | break
48 | }
49 |
50 | // Parse new directives.
51 | d.Directives = append(d.Directives, parseDirective(l))
52 | }
53 |
54 | return d
55 | }
56 |
--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/atenart/sniproxy
2 |
3 | go 1.16
4 |
--------------------------------------------------------------------------------
/log.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package main
17 |
18 | import (
19 | "fmt"
20 | "log"
21 | )
22 |
23 | func (conn *Conn) logf(format string, v ...interface{}) {
24 | log.Printf("%s %s", conn.RemoteAddr(), fmt.Sprintf(format, v...))
25 | }
26 |
27 | func (conn *Conn) log(v ...interface{}) {
28 | log.Printf("%s %s", conn.RemoteAddr(), fmt.Sprint(v...))
29 | }
30 |
--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package main
17 |
18 | import (
19 | "flag"
20 | "log"
21 | "net/http"
22 | )
23 |
24 | var (
25 | conf = flag.String("conf", "", "Configuration file.")
26 | bind = flag.String("bind", ":443", "Address and port to bind to.")
27 | )
28 |
29 | func newRedirect(redirectPort string) func(w http.ResponseWriter, r *http.Request) {
30 | return func(w http.ResponseWriter, r *http.Request) {
31 | http.Redirect(w, r, "https://"+r.Host+redirectPort+r.RequestURI, http.StatusMovedPermanently)
32 | }
33 | }
34 |
35 | func main() {
36 | flag.Parse()
37 | if *conf == "" {
38 | log.Fatal("No config provided. Aborting.")
39 | }
40 |
41 | p := &Proxy{}
42 | if err := p.Config.ReadFile(*conf); err != nil {
43 | log.Fatalf("Could not read config %q (%s)", *conf, err)
44 | }
45 |
46 | go func() {
47 | if err := http.ListenAndServe(":80", http.HandlerFunc(newRedirect(*bind))); err != nil {
48 | log.Fatalf("ListenAndServe error: %v", err)
49 | }
50 | }()
51 |
52 | if err := p.ListenAndServe(*bind); err != nil {
53 | log.Fatal(err)
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/proxy.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package main
17 |
18 | import (
19 | "bytes"
20 | "fmt"
21 | "io"
22 | "log"
23 | "net"
24 | "sync"
25 | "time"
26 |
27 | "github.com/atenart/sniproxy/config"
28 | )
29 |
30 | // Represents the proxy itself.
31 | type Proxy struct {
32 | Config config.Config
33 | }
34 |
35 | // Represents a connection being routed.
36 | type Conn struct {
37 | *net.TCPConn
38 | Config *config.Config
39 | }
40 |
41 | // Listen and serve the connections.
42 | func (p *Proxy) ListenAndServe(bind string) error {
43 | l, err := net.Listen("tcp", bind)
44 | if err != nil {
45 | return err
46 | }
47 | defer l.Close()
48 |
49 | // Accept connections and handle them to a go routine.
50 | for {
51 | c, err := l.Accept()
52 | if err != nil {
53 | return err
54 | }
55 |
56 | conn := &Conn{
57 | TCPConn: c.(*net.TCPConn),
58 | Config: &p.Config,
59 | }
60 |
61 | go conn.dispatch()
62 | }
63 |
64 | return nil
65 | }
66 |
67 | // Dispatch a net.Conn. This cannot fail.
68 | func (conn *Conn) dispatch() {
69 | defer conn.Close()
70 | client := conn.RemoteAddr().(*net.TCPAddr).IP
71 |
72 | // Set a deadline for reading the TLS handshake.
73 | if err := conn.SetReadDeadline(time.Now().Add(3*time.Second)); err != nil {
74 | conn.alert(tlsInternalError)
75 | conn.logf("Could not set a read deadline (%s)", err)
76 | return
77 | }
78 |
79 | var buf bytes.Buffer
80 | sni, acme, err := extractInfo(io.TeeReader(conn, &buf))
81 | if err != nil {
82 | conn.alert(tlsInternalError)
83 | conn.log(err)
84 | return
85 | }
86 |
87 | // We found an SNI, reset the read deadline.
88 | if err := conn.SetReadDeadline(time.Time{}); err != nil {
89 | conn.alert(tlsInternalError)
90 | conn.logf("Could not clear the read deadline (%s)", err)
91 | return
92 | }
93 |
94 | route, err := conn.Match(sni)
95 | if err != nil {
96 | conn.alert(tlsUnrecognizedName)
97 | conn.log(err)
98 | return
99 | }
100 |
101 | // Choose backend.
102 | backend := route.Backend
103 | if acme && route.ACME != nil {
104 | backend = route.ACME
105 | }
106 |
107 | if acme && route.AllowACME {
108 | goto bypassACLs
109 | }
110 |
111 | // Check if the client has the right to connect to a given backend.
112 | if !clientAllowed(route, client) {
113 | conn.alert(tlsAccessDenied)
114 | conn.logf("Denied %s / %s access to %s", client.String(), sni, backend.Address)
115 | return
116 | }
117 |
118 | bypassACLs:
119 | host, port, err := net.SplitHostPort(backend.Address)
120 | if len(host) == 0 {
121 | host = sni
122 | }
123 | if err != nil {
124 | conn.log(err)
125 | return
126 | }
127 | upstream := func() *net.TCPConn {
128 | up, err := net.DialTimeout("tcp", host+":"+port, 3*time.Second)
129 | if err != nil {
130 | conn.alert(tlsInternalError)
131 | conn.log(err)
132 | return nil
133 | }
134 | return up.(*net.TCPConn)
135 | }()
136 | if upstream == nil {
137 | return
138 | }
139 | defer upstream.Close()
140 |
141 | // Check if the HAProxy PROXY protocol header has to be sent.
142 | if backend.SendProxy != config.ProxyNone {
143 | if err := proxyHeader(backend.SendProxy, conn, upstream); err != nil {
144 | log.Print(err)
145 | return
146 | }
147 | }
148 |
149 | // Replay the handshake we read.
150 | if _, err := io.Copy(upstream, &buf); err != nil {
151 | conn.alert(tlsInternalError)
152 | conn.logf("Failed to replay handshake to %s", backend.Address)
153 | return
154 | }
155 |
156 | var wg sync.WaitGroup
157 | wg.Add(2)
158 |
159 | go func () {
160 | defer wg.Done()
161 | if _, err := io.Copy(upstream, conn.TCPConn); err != nil {
162 | conn.logf("Error copying to %s (%s): %s", conn.RemoteAddr(), sni, err)
163 | }
164 | upstream.CloseRead()
165 | conn.CloseWrite()
166 | }()
167 | go func () {
168 | defer wg.Done()
169 | if _, err := io.Copy(conn.TCPConn, upstream); err != nil {
170 | conn.logf("Error copying to %s (%s): %s", backend.Address, sni, err)
171 | }
172 | conn.CloseRead()
173 | upstream.CloseWrite()
174 | }()
175 |
176 | // Send keep alive messages to both the client and the backend.
177 | conn.SetKeepAlive(true)
178 | conn.SetKeepAlivePeriod(time.Minute)
179 | upstream.SetKeepAlive(true)
180 | upstream.SetKeepAlivePeriod(time.Minute)
181 |
182 | conn.logf("Routing %s to %s", sni, backend.Address)
183 |
184 | wg.Wait()
185 | }
186 |
187 | // TLS alert message descriptions.
188 | const (
189 | tlsAccessDenied = 49
190 | tlsInternalError = 80
191 | tlsUnrecognizedName = 112
192 | )
193 |
194 | // Sends an alert message with a fatal level to the remote.
195 | func (conn *Conn) alert(desc byte) {
196 | // Craft an alert message (content type 21, TLS version 3.x, level: 2).
197 | message := bytes.NewBuffer([]byte{21, 3, 0, 0, 2, 2})
198 |
199 | // Set the alert description.
200 | message.WriteByte(desc)
201 |
202 | // Set a write timeout before sending the alert.
203 | if err := conn.SetWriteDeadline(time.Now().Add(3*time.Second)); err != nil {
204 | conn.logf("Could not set a write deadline for the alert message (%s)", err)
205 | return
206 | }
207 |
208 | if _, err := message.WriteTo(conn); err != nil {
209 | conn.logf("Failed to send an alert message (%s)", err)
210 | }
211 | }
212 |
213 | // Matches a connection to a backend.
214 | func (conn *Conn) Match(sni string) (*config.Route, error) {
215 | // Loop over each route described in the configuration.
216 | for _, route := range conn.Config.Routes {
217 | // Loop over each domain of a given route.
218 | for _, domain := range route.Domains {
219 | if domain.MatchString(sni) {
220 | return route, nil
221 | }
222 | }
223 | }
224 |
225 | return nil, fmt.Errorf("No route matching the requested domain (%s)", sni)
226 | }
227 |
228 | // Check an IP against a route deny/allow rules.
229 | // The more specific subnet takes precedence, and Deny wins over Allow in case
230 | // none is more specific.
231 | func clientAllowed(route *config.Route, ip net.IP) bool {
232 | // Check if filtering is enabled for the route.
233 | if len(route.Allow) == 0 && len(route.Deny) == 0 {
234 | return true
235 | }
236 |
237 | var cidr int = 0
238 | for _, subnet := range(route.Allow) {
239 | if subnet.Contains(ip) {
240 | sz, _ := subnet.Mask.Size()
241 | if sz > cidr {
242 | cidr = sz
243 | }
244 | }
245 | }
246 | for _, subnet := range(route.Deny) {
247 | if subnet.Contains(ip) {
248 | sz, _ := subnet.Mask.Size()
249 | if sz >= cidr {
250 | return false
251 | }
252 | }
253 | }
254 | return true
255 | }
256 |
--------------------------------------------------------------------------------
/proxy_protocol.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package main
17 |
18 | import (
19 | "bytes"
20 | "encoding/binary"
21 | "fmt"
22 | "net"
23 |
24 | "github.com/atenart/sniproxy/config"
25 | )
26 |
27 | // Handles sending an HAProxy PROXY header to a backend.
28 | func proxyHeader(version uint, client, upstream net.Conn) error {
29 | var header bytes.Buffer
30 |
31 | // Retrieve the PROXY header to be sent.
32 | switch (version) {
33 | case config.ProxyV1:
34 | header = proxyHeaderV1(client)
35 | break
36 | case config.ProxyV2:
37 | header = proxyHeaderV2(client)
38 | break
39 | default:
40 | return fmt.Errorf("PROXY protocol version not supported (%d)", version)
41 | }
42 |
43 | // Send the PROXY header to the backend.
44 | if _, err := header.WriteTo(upstream); err != nil {
45 | return fmt.Errorf("Could not send the PROXY header (%s)", err)
46 | }
47 |
48 | return nil
49 | }
50 |
51 | // Returns an HAProxy PROXY header (protocol v1).
52 | func proxyHeaderV1(conn net.Conn) bytes.Buffer {
53 | client := conn.RemoteAddr().(*net.TCPAddr)
54 | local := conn.LocalAddr().(*net.TCPAddr)
55 |
56 | inetProto := "TCP6"
57 | if local.IP.To4() != nil {
58 | inetProto = "TCP4"
59 | }
60 |
61 | var buf bytes.Buffer
62 | buf.WriteString(fmt.Sprintf("PROXY %s %s %s %d %d\r\n", inetProto,
63 | client.IP.String(), local.IP.String(),
64 | client.Port, local.Port))
65 | return buf
66 | }
67 |
68 | // Returns an HAProxy PROXY header (protocol v2).
69 | // See https://www.haproxy.org/download/2.0/doc/proxy-protocol.txt
70 | func proxyHeaderV2(conn net.Conn) bytes.Buffer {
71 | client := conn.RemoteAddr().(*net.TCPAddr)
72 | local := conn.LocalAddr().(*net.TCPAddr)
73 | ipv4 := local.IP.To4() != nil
74 |
75 | var buf bytes.Buffer
76 |
77 | // Protocol signature.
78 | buf.Write([]byte{0x0d, 0x0a, 0x0d, 0x0a, 0x00, 0x0d, 0x0a, 0x51, 0x55, 0x49, 0x54, 0x0a})
79 |
80 | // Command. Must be \x2 followed by \x0 for 'local' or \x1 for 'proxy'.
81 | buf.WriteByte(0x21)
82 |
83 | // Transport protocol and address family. The highest 4 bits represent
84 | // the address family (0x1: AF_INET, 0x2: AF_INET6) and the lowest 4
85 | // bits the protocol (0x1: SOCK_STREAM).
86 | // The address family part is set at the begining of the function.
87 | if ipv4 {
88 | buf.WriteByte(0x11)
89 | } else {
90 | buf.WriteByte(0x21)
91 | }
92 |
93 | tmp := make([]byte, 2)
94 |
95 | // Address length.
96 | if ipv4 {
97 | binary.BigEndian.PutUint16(tmp, 12)
98 | } else {
99 | binary.BigEndian.PutUint16(tmp, 36)
100 | }
101 | buf.Write(tmp)
102 |
103 | // Addresses (client, local).
104 | if ipv4 {
105 | buf.Write(client.IP.To4())
106 | buf.Write(local.IP.To4())
107 | } else {
108 | buf.Write(client.IP.To16())
109 | buf.Write(local.IP.To16())
110 | }
111 |
112 | // TCP ports (client, local).
113 | binary.BigEndian.PutUint16(tmp, uint16(client.Port))
114 | buf.Write(tmp)
115 | binary.BigEndian.PutUint16(tmp, uint16(local.Port))
116 | buf.Write(tmp)
117 |
118 | return buf
119 | }
120 |
--------------------------------------------------------------------------------
/sni.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package main
17 |
18 | import (
19 | "encoding/binary"
20 | "fmt"
21 | "io"
22 | )
23 |
24 | // Extracts required information from a TLS handshake.
25 | // Returns the SNI and checks for acme-tls.
26 | func extractInfo(r io.Reader) (string, bool, error) {
27 | if err := parseRecord(r); err != nil {
28 | return "", false, err
29 | }
30 |
31 | if err := parseHandshake(r); err != nil {
32 | return "", false, err
33 | }
34 |
35 | if err := parseClientHello(r); err != nil {
36 | return "", false, err
37 | }
38 |
39 | // Parse the TLS extension, looking for a server name indication.
40 | b, err := parseVector(r, 2)
41 | if err != nil {
42 | // No extension (not an error).
43 | if err == io.EOF {
44 | err = nil
45 | }
46 | return "", false, err
47 | }
48 |
49 | sni := ""
50 | acme := false
51 |
52 | // Loop over the TLS extensions.
53 | for len(b) >= 4 {
54 | extType := binary.BigEndian.Uint16(b[:2])
55 | length := binary.BigEndian.Uint16(b[2:4])
56 | b = b[4:]
57 |
58 | switch(extType) {
59 | // SNI.
60 | case 0:
61 | sni, err = parseSNI(b[:length])
62 | if err != nil {
63 | break
64 | }
65 | // ALPN.
66 | case 16:
67 | acme, err = parseACME(b[:length])
68 | if err != nil {
69 | break
70 | }
71 | }
72 |
73 | b = b[length:]
74 | }
75 |
76 | return sni, acme, err
77 | }
78 |
79 | // Parse a TLS Plaintext record.
80 | func parseRecord(r io.Reader) error {
81 | var record struct {
82 | Type uint8
83 | Major, Minor uint8
84 | Length uint16
85 | }
86 | if err := binary.Read(r, binary.BigEndian, &record); err != nil {
87 | return fmt.Errorf("Could not read TLS handshake (%s)", err)
88 | }
89 |
90 | // Check if record type is 22, aka handshake.
91 | if record.Type != 22 {
92 | return fmt.Errorf("Record is not a TLS handshake")
93 | }
94 |
95 | // Checks the TLS version is supported:
96 | // 3.1: TLS 1.0, 3.2: TLS 1.1, 3.3: TLS 1.2 & TLS 1.3
97 | if record.Major != 3 {
98 | return fmt.Errorf("TLS version not supported (%d.%d)", record.Major, record.Minor)
99 | }
100 | switch (record.Minor) {
101 | default:
102 | return fmt.Errorf("TLS version not supported (%d.%d)", record.Major, record.Minor)
103 | case 1,2,3:
104 | }
105 |
106 | // Check the handshake does not exceed the max authorized.
107 | if record.Length > (16 * 1024) {
108 | return fmt.Errorf("TLS record length exceed maximum (%d > 2^14)", record.Length)
109 | }
110 |
111 | return nil
112 | }
113 |
114 | // Parse a TLS handshake message.
115 | func parseHandshake(r io.Reader) error {
116 | var handshake struct {
117 | MessageType uint8
118 | MessageLength [3]byte
119 | }
120 | if err := binary.Read(r, binary.BigEndian, &handshake); err != nil {
121 | return fmt.Errorf("Could not read TLS message header (%s)", err)
122 | }
123 |
124 | // Check if the message type is ClientHello.
125 | if handshake.MessageType != 1 {
126 | return fmt.Errorf("TLS handshake is not a ClientHello message (%d)", handshake.MessageType)
127 | }
128 |
129 | // We do not check the handshake length as we'll try to read it fully anyway.
130 |
131 | return nil
132 | }
133 |
134 | // Parse a TLS ClientHello message.
135 | func parseClientHello(r io.Reader) error {
136 | var hello struct {
137 | Version uint16
138 | Random [32]byte
139 | }
140 | if err := binary.Read(r, binary.BigEndian, &hello); err != nil {
141 | return fmt.Errorf("Could not read TLS ClientHello message (%s)", err)
142 | }
143 |
144 | // Checks the version:
145 | // 0x301: TLS 1.0, 0x302: TLS 1.1, 0x303 after TLS 1.2.
146 | switch (hello.Version) {
147 | default:
148 | return fmt.Errorf("ClientHello version is not 0x303 (%#x)", hello.Version)
149 | case 0x301, 0x302, 0x303:
150 | }
151 |
152 | // We do not check other fields strictly, but reading them ensure they
153 | // are present (ie. the message seems to be a valid ClientHello).
154 |
155 | // SessionID.
156 | b, err := parseVector(r, 1)
157 | if err != nil {
158 | return fmt.Errorf("Could not read ClientHello session ID (%s)", err)
159 | }
160 | if len(b) > 32 {
161 | return fmt.Errorf("ClientHello SessionID has an invalid length (%d)", len(b))
162 | }
163 |
164 | // Cipher Suites.
165 | b, err = parseVector(r, 2)
166 | if err != nil {
167 | return fmt.Errorf("Could not read ClientHello cipher suites (%s)", err)
168 | }
169 | if len(b) < 2 || len(b) % 2 != 0 {
170 | return fmt.Errorf("ClientHello cipher suites has an invalid length (%d)", len(b))
171 | }
172 |
173 | // Compression methods.
174 | b, err = parseVector(r, 1)
175 | if err != nil {
176 | return fmt.Errorf("Could not read ClientHello compression methods (%s)", err)
177 | }
178 | if len(b) < 1 {
179 | return fmt.Errorf("ClientHello compression methods has an invalid length (%d)", len(b))
180 | }
181 |
182 | // We reached the extensions (or none, which is valid).
183 | return nil
184 | }
185 |
186 | // Parse the SNI from an SNI extension.
187 | func parseSNI(b []byte) (string, error) {
188 | if len(b) < 2 {
189 | return "", fmt.Errorf("SNI extension is empty.")
190 | }
191 |
192 | length := binary.BigEndian.Uint16(b[:2])
193 | if int(length) > len(b[2:]) {
194 | return "", fmt.Errorf("SNI extension is too short.")
195 | }
196 |
197 | b = b[2:2+length]
198 |
199 | for len(b) >= 3 {
200 | nameType := b[0]
201 | vectLength := binary.BigEndian.Uint16(b[1:3])
202 | if int(vectLength) > len(b[3:]) {
203 | return "", fmt.Errorf("SNI vector is too short.")
204 | }
205 |
206 | if nameType != 0 {
207 | b = b[3+vectLength:]
208 | continue
209 | }
210 |
211 | return string(b[3 : 3+vectLength]), nil
212 | }
213 |
214 | // No DNS-based SNI.
215 | return "", nil
216 | }
217 |
218 | // Parse a vector and returns a byte array. Takes the length of the len field as
219 | // an argument.
220 | func parseVector(r io.Reader, l uint) ([]byte, error) {
221 | rawLen := make([]byte, l)
222 | if err := binary.Read(r, binary.BigEndian, &rawLen); err != nil {
223 | // No data to read. This can be valid.
224 | if err == io.EOF {
225 | return nil, err
226 | }
227 | return nil, fmt.Errorf("Could not read the vector length (%s)", err)
228 | }
229 |
230 | var length uint = 0
231 | for _, b := range rawLen {
232 | length = (length << 8) + uint(b)
233 | }
234 |
235 | if length == 0 {
236 | return nil, nil
237 | }
238 |
239 | data := make([]byte, length)
240 | if err := binary.Read(r, binary.BigEndian, &data); err != nil {
241 | return nil, fmt.Errorf("Could not read the vector data (%s)", err)
242 | }
243 |
244 | return data, nil
245 | }
246 |
247 | // Parse an ALPN extension looking for acme-tls/1.
248 | func parseACME(b []byte) (bool, error) {
249 | if len(b) < 2 {
250 | return false, fmt.Errorf("ALPN extension is empty.")
251 | }
252 |
253 | length := binary.BigEndian.Uint16(b[:2])
254 | if int(length) > len(b[2:]) {
255 | return false, fmt.Errorf("ALPN extension is too short.")
256 | }
257 |
258 | b = b[2:2+length]
259 |
260 | for len(b) > 2 {
261 | stringLen := int(b[0])
262 |
263 | b = b[1:]
264 | if stringLen == 0 || stringLen > len(b) {
265 | return false, fmt.Errorf("ALPN string length overflowed")
266 | }
267 |
268 | if string(b[:stringLen]) == "acme-tls/1" {
269 | return true, nil
270 | }
271 |
272 | b = b[stringLen:]
273 | }
274 |
275 | return false, nil
276 | }
277 |
--------------------------------------------------------------------------------
/sni_test.go:
--------------------------------------------------------------------------------
1 | // Copyright (C) 2019-2021 Antoine Tenart
2 | //
3 | // This program is free software: you can redistribute it and/or modify
4 | // it under the terms of the GNU General Public License as published by
5 | // the Free Software Foundation, either version 3 of the License, or
6 | // any later version.
7 | //
8 | // This program is distributed in the hope that it will be useful,
9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 | // GNU General Public License for more details.
12 | //
13 | // You should have received a copy of the GNU General Public License
14 | // along with this program. If not, see .
15 |
16 | package main
17 |
18 | import (
19 | "bytes"
20 | "testing"
21 | )
22 |
23 | func craft(bs ...[]byte) []byte {
24 | var packet []byte
25 | for _, b := range(bs) {
26 | packet = append(packet, b...)
27 | }
28 | return packet
29 | }
30 |
31 | func TestParseRecord(t *testing.T) {
32 | tests := []struct {
33 | desc string
34 | in []byte
35 | success bool
36 | }{
37 | {
38 | "Empty message",
39 | []byte{},
40 | false,
41 | },
42 | {
43 | "Truncated message #0",
44 | []byte{22},
45 | false,
46 | },
47 | {
48 | "Truncated message #2",
49 | []byte{22, 3},
50 | false,
51 | },
52 | {
53 | "Truncated message #3",
54 | []byte{22, 3, 2},
55 | false,
56 | },
57 | {
58 | "Truncated message #4",
59 | []byte{22, 3, 2, 0},
60 | false,
61 | },
62 | {
63 | "SSL 3.0",
64 | []byte{22, 3, 0, 0, 0},
65 | false,
66 | },
67 | {
68 | "TLS 1.0, empty payload",
69 | []byte{22, 3, 1, 0, 0},
70 | true,
71 | },
72 | {
73 | "TLS 1.1, empty payload",
74 | []byte{22, 3, 2, 0, 0},
75 | true,
76 | },
77 | {
78 | "TLS 1.2 or later, empty payload",
79 | []byte{22, 3, 3, 0, 0},
80 | true,
81 | },
82 | {
83 | "TLS 1.2 or later, 1b payload",
84 | []byte{22, 3, 3, 0, 1, 0},
85 | true,
86 | },
87 | {
88 | "TLS 1.2 or later, max message length payload",
89 | []byte{22, 3, 3, 64, 0},
90 | true,
91 | },
92 | {
93 | "TLS 1.2 or later, (max message length + 1) payload",
94 | []byte{22, 3, 3, 64, 1},
95 | false,
96 | },
97 | {
98 | "Wrong TLS content type",
99 | []byte{99, 3, 2, 0, 0},
100 | false,
101 | },
102 | {
103 | "Wrong TLS major version",
104 | []byte{22, 4, 2, 0, 0},
105 | false,
106 | },
107 | {
108 | "Wrong TLS minor version",
109 | []byte{22, 3, 99, 0, 0},
110 | false,
111 | },
112 | }
113 |
114 | for _, test := range(tests) {
115 | err := parseRecord(bytes.NewBuffer(test.in))
116 | if (test.success && (err != nil)) || (!test.success && (err == nil)) {
117 | t.Errorf(test.desc)
118 | }
119 | }
120 | }
121 |
122 | func TestParseHandshake(t *testing.T) {
123 | tests := []struct {
124 | desc string
125 | in []byte
126 | success bool
127 | }{
128 | {
129 | "Empty handshake",
130 | []byte{},
131 | false,
132 | },
133 | {
134 | "Truncated handshake #0",
135 | []byte{1, 0},
136 | false,
137 | },
138 | {
139 | "Truncated handshake #1",
140 | []byte{1, 0, 0},
141 | false,
142 | },
143 | {
144 | "Wrong message type",
145 | []byte{99, 0, 0, 0},
146 | false,
147 | },
148 | {
149 | "ClientHello handshake, no payload",
150 | []byte{1, 0, 0, 0},
151 | true,
152 | },
153 | {
154 | "ClientHello handshake, 34b payload",
155 | []byte{1, 0, 0, 34},
156 | true,
157 | },
158 | }
159 |
160 | for _, test := range(tests) {
161 | err := parseHandshake(bytes.NewBuffer(test.in))
162 | if (test.success && (err != nil)) || (!test.success && (err == nil)) {
163 | t.Errorf(test.desc)
164 | }
165 | }
166 | }
167 |
168 | func TestParseClientHello(t *testing.T) {
169 | tests := []struct {
170 | desc string
171 | in []byte
172 | success bool
173 | }{
174 | {
175 | "Empty message",
176 | []byte{},
177 | false,
178 | },
179 | {
180 | "ClientHello TLS 1.2 or later, no payload",
181 | craft([]byte{3, 3}, make([]byte, 32)),
182 | false,
183 | },
184 | {
185 | "ClientHello TLS 1.2 or later, 0'ed payload",
186 | craft([]byte{3, 3}, make([]byte, 32), []byte{0, 0, 0, 0}),
187 | false,
188 | },
189 | {
190 | "ClientHello TLS1.0, valid payload",
191 | craft([]byte{3, 1}, make([]byte, 32), []byte{0, 0, 2, 0, 0, 1, 0}),
192 | true,
193 | },
194 | {
195 | "ClientHello TLS1.1, valid payload",
196 | craft([]byte{3, 2}, make([]byte, 32), []byte{0, 0, 2, 0, 0, 1, 0}),
197 | true,
198 | },
199 | {
200 | "ClientHello TLS 1.2 or later, valid payload",
201 | craft([]byte{3, 3}, make([]byte, 32), []byte{0, 0, 2, 0, 0, 1, 0}),
202 | true,
203 | },
204 | {
205 | "ClientHello wrong TLS major version",
206 | craft([]byte{4, 2}, make([]byte, 32), []byte{0, 0, 2, 0, 0, 1, 0}),
207 | false,
208 | },
209 | {
210 | "ClientHello wrong TLS minor version",
211 | craft([]byte{3, 99}, make([]byte, 32), []byte{0, 0, 2, 0, 0, 1, 0}),
212 | false,
213 | },
214 | {
215 | "ClientHello TLS 1.2 or later, max session ID length",
216 | craft([]byte{3, 3}, make([]byte, 32), []byte{32}, make([]byte, 32),
217 | []byte{0, 2, 0, 0, 1, 0}),
218 | true,
219 | },
220 | {
221 | "ClientHello TLS 1.2 or later, (max + 1) session ID length",
222 | craft([]byte{3, 3}, make([]byte, 32), []byte{33}, make([]byte, 33),
223 | []byte{0, 2, 0, 0, 1, 0}),
224 | false,
225 | },
226 | {
227 | "ClientHello TLS 1.2 or later, invalid cipher suites length #0",
228 | craft([]byte{3, 3}, make([]byte, 32), []byte{0, 0, 1, 0, 1, 0}),
229 | false,
230 | },
231 | {
232 | "ClientHello TLS 1.2 or later, invalid cipher suites length #1",
233 | craft([]byte{3, 3}, make([]byte, 32), []byte{0, 0, 33}, make([]byte, 33),
234 | []byte{0, 1, 0}),
235 | false,
236 | },
237 | {
238 | "ClientHello TLS 1.2 or later, invalid compression methods length",
239 | craft([]byte{3, 3}, make([]byte, 32), []byte{0, 0, 1, 0, 0}),
240 | false,
241 | },
242 | {
243 | "ClientHello TLS 1.2 or later, valid payload, max size",
244 | craft([]byte{3, 3}, make([]byte, 32), []byte{32}, make([]byte, 32),
245 | []byte{0xff, 0xfe}, make([]byte, 0xfffe),
246 | []byte{0xff}, make([]byte, 0xff)),
247 | true,
248 | },
249 | }
250 |
251 | for _, test := range(tests) {
252 | err := parseClientHello(bytes.NewBuffer(test.in))
253 | if (test.success && (err != nil)) || (!test.success && (err == nil)) {
254 | t.Errorf(test.desc)
255 | }
256 | }
257 | }
258 |
259 | func TestParseSNI(t *testing.T) {
260 | tests := []struct{
261 | desc string
262 | in []byte
263 | out string
264 | success bool
265 | }{
266 | {
267 | "Empty SNI extension",
268 | []byte{},
269 | "",
270 | false,
271 | },
272 | {
273 | "Invalid SNI extension vector",
274 | []byte{0},
275 | "",
276 | false,
277 | },
278 | {
279 | "Empty SNI extension",
280 | []byte{0, 0},
281 | "",
282 | true,
283 | },
284 | {
285 | "Invalid SNI vector",
286 | []byte{0, 2, 0, 0},
287 | "",
288 | true,
289 | },
290 | {
291 | "Empty SNI vector",
292 | []byte{0, 3, 0, 0, 0},
293 | "",
294 | true,
295 | },
296 | {
297 | "Invalid name type",
298 | []byte{0, 6, 1, 0, 3, 1, 2, 3},
299 | "",
300 | true,
301 | },
302 | {
303 | "Valid SNI",
304 | craft([]byte{0, 14, 0, 0, 11}, []byte("example.net")),
305 | "example.net",
306 | true,
307 | },
308 | {
309 | "Multiple SNI vectors",
310 | craft([]byte{0, 28, 0, 0, 11}, []byte("example.net"),
311 | []byte{0, 0, 11}, []byte("example.org")),
312 | "example.net",
313 | true,
314 | },
315 | {
316 | "SNI in second vector",
317 | craft([]byte{0, 22, 1, 0, 5, 1, 2, 3, 4, 5},
318 | []byte{0, 0, 11}, []byte("example.net")),
319 | "example.net",
320 | true,
321 | },
322 | }
323 |
324 | for _, test := range(tests) {
325 | sni, err := parseSNI(test.in)
326 | if (test.success && (err != nil)) || (!test.success && (err == nil)) {
327 | t.Errorf(test.desc)
328 | }
329 | if sni != test.out {
330 | t.Errorf("%s: wrong SNI: got '%s', wanted '%s'", test.desc, sni, test.out)
331 | }
332 | }
333 | }
334 |
--------------------------------------------------------------------------------