├── .github
├── shellcheck.sh
├── test_execution.sh
└── workflows
│ └── tests.yml
├── LICENSE
├── README.md
└── hapos-upd
/.github/shellcheck.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -e
4 |
5 | sudo apt-get update
6 | sudo apt-get install shellcheck
7 |
8 | shellcheck -C hapos-upd
9 |
--------------------------------------------------------------------------------
/.github/test_execution.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | set -e
4 |
5 | sudo apt-get update
6 | sudo apt-get install -y openssl socat ca-certificates
7 |
8 | echo "" | \
9 | openssl s_client \
10 | -connect github.com:443 \
11 | -showcerts 2>/dev/null | \
12 | sed -n -e "/-----BEGIN CERTIFICATE/,/-----END CERTIFICATE/p" > github.com.pem
13 |
14 | ./hapos-upd --cert github.com.pem -d --VAfile - > output
15 |
16 | grep "Response verify OK" output
17 |
--------------------------------------------------------------------------------
/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
1 | name: Test
2 |
3 | on: [push, pull_request]
4 |
5 | jobs:
6 | shellcheck:
7 | name: Shellcheck
8 | runs-on: ubuntu-latest
9 |
10 | steps:
11 | - name: Checkout code
12 | uses: actions/checkout@v2
13 |
14 | - name: Run shellcheck
15 | run: .github/shellcheck.sh
16 | env:
17 | DEFAULT_BRANCH: main
18 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
19 |
20 | test-execution:
21 | name: Test execution
22 | runs-on: ubuntu-latest
23 |
24 | steps:
25 | - name: Checkout code
26 | uses: actions/checkout@v2
27 |
28 | - name: Run test execution
29 | run: .github/test_execution.sh
30 | env:
31 | DEFAULT_BRANCH: main
32 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
33 |
34 |
--------------------------------------------------------------------------------
/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 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
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 | {project} Copyright (C) {year} {fullname}
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 | HAProxy OCSP Stapling Updater
2 | =============================
3 |
4 | This script extracts and queries the OCSP server present in a certificate to obtain its revocation status, then updates HAProxy by writing the '.issuer' and the '.ocsp' files and by sending it the `set ssl ocsp-response` command through the local UNIX admin socket.
5 |
6 | ## Usage
7 |
8 | ```
9 | hapos-upd [options] --cert crt_full_path
10 |
11 | The crt_full_path argument is the full path to the certificate bundle
12 | used in haproxy 'crt' setting. End-entity (EE) certificate plus any
13 | intermediate CA certificates must be concatenated there.
14 | An OCSP query is sent to the OCSP server given on the command line
15 | (--ocsp-url and --ocsp-host argument); if these arguments are missing,
16 | URL and Host header values are automatically extracted from the
17 | certificate.
18 | If the '.issuer' file already exists it's used to build the OCSP
19 | request, otherwise the chain is extracted from crt_full_path and used
20 | to identify the issuer.
21 | Finally, it writes the related '.issuer' and .'ocsp' files and updates
22 | haproxy, using 'socat' and the local UNIX socket (--socket argument,
23 | default /run/haproxy/admin.sock).
24 |
25 | Exit codes:
26 | 0 OK
27 | 1 openssl certificates handling error
28 | 2 OCSP server URL not found
29 | 3 string parsing / PEM manipulation error
30 | 4 OCSP error
31 | 5 haproxy management error
32 | 9 program error (wrong arguments, missing dependencies)
33 |
34 | Options:
35 |
36 | -d, --debug : don't do anything, print debug messages only.
37 |
38 | --keep-temp : keep temporary directory after exiting (for
39 | debug purposes).
40 |
41 | -g, --good-only : do not update haproxy if OCSP response
42 | certificate status value is not 'good'.
43 |
44 | -l, --syslog priority : log errors to syslog system log module.
45 | The priority may be specified numerically
46 | or as a facility.level pair (e.g.
47 | local7.error).
48 |
49 | --ocsp-url url : OCSP server URL; use this instead of the
50 | one in the EE certificate.
51 |
52 | --ocsp-host host : OCSP server hostname to be used in the
53 | 'Host:' header; use this instead of the one
54 | extracted from the OCSP server URL.
55 |
56 | --ocsp-proxy proxy : OCSP server proxy; use this to reach OCSP server
57 | through proxy
58 |
59 | --use-curl : Uses curl instead of OpenSSL's basic HTTP client.
60 | This is useful for networks with complex proxy setups.
61 |
62 | --partial-chain : Allow partial certificate chain if at least one certificate
63 | is in trusted store. Useful when validating an intermediate
64 | certificate without the root CA.
65 |
66 | -s, --socket file : haproxy admin socket. If omitted,
67 | /run/haproxy/admin.sock is used by default.
68 | This script is distributed with only one
69 | method to update haproxy: using 'socat'
70 | with a local admin-level UNIX socket.
71 | Feel free to implement other mechanisms as
72 | needed! The right section in the code is
73 | "UPDATE HAPROXY", at the end of the script.
74 |
75 | -v, --VAfile file : same as the openssl ocsp -VAfile option
76 | with 'file' as argument. For more details:
77 | 'man ocsp'.
78 | If file = "-" then the chain extracted
79 | from the certificate's bundle (or .issuer
80 | file) is used (useful for OCSP responses
81 | that don't include the signer certificate).
82 |
83 | --noverify : Do not verify OCSP response.
84 |
85 | -S, --skip-update : Do not notify haproxy of the new OCSP response.
86 |
87 | -h, --help : this help.
88 | ```
89 |
90 | ## Examples
91 |
92 | Extract OCSP server information from site.pem and use them to create /etc/haproxy/site.pem.issuer and /etc/haproxy/site.pem.ocsp, then update HAProxy via default local UNIX socket (/run/haproxy/admin.sock):
93 |
94 | ```
95 | :~$ hapos-upd --cert /etc/haproxy/site.pem
96 | ```
97 |
98 | Download the certificate (EE + intermediate) used by github.com, then run a debug execution on it:
99 |
100 | ```
101 | :~$ echo "" | openssl s_client -connect github.com:443 -showcerts 2>/dev/null | sed -n -e "/-----BEGIN CERTIFICATE/,/-----END CERTIFICATE/p" > github.com.pem
102 | :~$ ./hapos-upd --cert github.com.pem -d --VAfile -
103 | Temporary directory: /tmp/hapos-upd.MV7LJsQPXd
104 | OCSP server URL found: http://ocsp.digicert.com
105 | OCSP server hostname: ocsp.digicert.com
106 | Extracting chain from certificates bundle
107 | EE certificate's fingerprint: SHA1 Fingerprint=A0:C4:A7:46:00:ED:A7:2D:C0:BE:CB:9A:8C:B6:07:CA:58:EE:74:5E
108 | 2 certificates found in the bundle
109 | Bundle certificate n. 1 fingerprint: SHA1 Fingerprint=A0:C4:A7:46:00:ED:A7:2D:C0:BE:CB:9A:8C:B6:07:CA:58:EE:74:5E - EE certificate
110 | Bundle certificate n. 2 fingerprint: SHA1 Fingerprint=7E:2F:3A:4F:8F:E8:FA:8A:57:30:AE:CA:02:96:96:63:7E:98:6F:3F - it's part of the chain
111 | OCSP response verification results: Response verify OK
112 | OCSP response: /tmp/hapos-upd.MV7LJsQPXd/ee.pem: good
113 | This Update: Apr 17 12:29:00 2015 GMT
114 | Next Update: Apr 24 12:44:00 2015 GMT
115 | Debug mode: haproxy update skipped.
116 | ```
117 |
118 | ## Author
119 |
120 | Pier Carlo Chiodi - http://pierky.com
121 |
122 | Blog: http://blog.pierky.com Twitter: [@pierky](http://twitter.com/pierky)
123 |
124 |
--------------------------------------------------------------------------------
/hapos-upd:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | # HAProxy OCSP Stapling Updater
4 | # Copyright (c) 2015 Pier Carlo Chiodi - http://www.pierky.com
5 | #
6 | # https://github.com/pierky/haproxy-ocsp-stapling-updater
7 |
8 | set -o nounset
9 |
10 | VERSION="0.5.0"
11 |
12 | PROGNAME="hapos-upd"
13 |
14 | if [ -z "${OPENSSL_BIN+x}" ]; then
15 | OPENSSL_BIN="openssl"
16 | fi
17 |
18 | SOCAT_BIN="socat"
19 | CURL_BIN="curl"
20 |
21 | CERT=""
22 | VAFILE=""
23 | HAPROXY_ADMIN_SOCKET_DEFAULT="/run/haproxy/admin.sock"
24 | HAPROXY_ADMIN_SOCKET="$HAPROXY_ADMIN_SOCKET_DEFAULT"
25 | GOOD_ONLY=0
26 | SYSLOG_PRIO=""
27 | typeset -i DEBUG=0
28 | typeset -i NUM_OF_CERTS
29 | KEEP_TEMP=0
30 | OCSP_URL=""
31 | OCSP_HOST=""
32 | OCSP_PROXY=""
33 | VERIFY=1
34 | TMP=""
35 | SKIP_UPDATE=0
36 | PARTIAL_CHAIN=""
37 | USE_CURL=0
38 |
39 | function Quit() {
40 | local -i err=$1
41 | if [ "$KEEP_TEMP" -eq 0 ]; then
42 | if [ -n "${TMP}" ]; then
43 | rm -r "${TMP}" &>/dev/null
44 | fi
45 | fi
46 | exit "${err}"
47 | }
48 |
49 | function LogError() {
50 | MSG="$1"
51 |
52 | if [ -z "$SYSLOG_PRIO" ]; then
53 | echo "$MSG" >&2
54 | else
55 | logger -p "$SYSLOG_PRIO" -s -- "$PROGNAME - $MSG"
56 | fi
57 |
58 | echo "$MSG" >>"${TMP}"/log
59 | }
60 |
61 | function Error() {
62 | local -i err=$1
63 |
64 | if [ "${err}" -eq 9 ]; then
65 | MSG="Error: $2"
66 | else
67 | MSG="Error processing '${CERT}': $2"
68 | fi
69 |
70 | LogError "$MSG"
71 |
72 | if [ "${err}" -eq 9 ]; then
73 | echo "Run $PROGNAME -h for help" >&2
74 | fi
75 |
76 | Quit "${err}"
77 | }
78 |
79 | function Debug() {
80 | if [ ${DEBUG} -eq 1 ]; then
81 | echo "${@}"
82 | fi
83 | echo "${@}" >>"${TMP}"/log
84 | }
85 |
86 | function Trap() {
87 | Debug "Aborting"
88 | Quit 9
89 | }
90 |
91 | function Usage() {
92 | echo "
93 | HAProxy OCSP Stapling Updater - $VERSION
94 | Copyright (c) 2015 Pier Carlo Chiodi - http://www.pierky.com
95 |
96 | https://github.com/pierky/haproxy-ocsp-stapling-updater
97 |
98 | Usage:
99 | $PROGNAME [options] --cert crt_full_path
100 |
101 | This script extracts and queries the OCSP server present in a
102 | certificate to obtain its revocation status, then updates HAProxy by
103 | writing the '.issuer' and the '.ocsp' files and by sending it the
104 | 'set ssl ocsp-response' command through the local UNIX admin socket.
105 |
106 | The crt_full_path argument is the full path to the certificate bundle
107 | used in haproxy 'crt' setting. End-entity (EE) certificate plus any
108 | intermediate CA certificates must be concatenated there.
109 | An OCSP query is sent to the OCSP server given on the command line
110 | (--ocsp-url and --ocsp-host argument); if these arguments are missing,
111 | URL and Host header values are automatically extracted from the
112 | certificate.
113 | If the '.issuer' file already exists it's used to build the OCSP
114 | request, otherwise the chain is extracted from crt_full_path and used
115 | to identify the issuer.
116 | Finally, it writes the related '.issuer' and .'ocsp' files and updates
117 | haproxy, using 'socat' and the local UNIX socket (--socket argument,
118 | default $HAPROXY_ADMIN_SOCKET_DEFAULT).
119 |
120 | Exit codes:
121 | 0 OK
122 | 1 openssl certificates handling error
123 | 2 OCSP server URL not found
124 | 3 string parsing / PEM manipulation error
125 | 4 OCSP error
126 | 5 haproxy management error
127 | 9 program error (wrong arguments, missing dependencies)
128 |
129 | Options:
130 |
131 | -d, --debug : don't do anything, print debug messages only.
132 |
133 | --keep-temp : keep temporary directory after exiting (for
134 | debug purposes).
135 |
136 | -g, --good-only : do not update haproxy if OCSP response
137 | certificate status value is not 'good'.
138 |
139 | -l, --syslog priority : log errors to syslog system log module.
140 | The priority may be specified numerically
141 | or as a facility.level pair (e.g.
142 | local7.error).
143 |
144 | --ocsp-url url : OCSP server URL; use this instead of the
145 | one in the EE certificate.
146 |
147 | --ocsp-host host : OCSP server hostname to be used in the
148 | 'Host:' header; use this instead of the one
149 | extracted from the OCSP server URL.
150 |
151 | --ocsp-proxy proxy : OCSP server proxy; use this to reach OCSP server
152 | through proxy
153 |
154 | --use-curl : Uses curl instead of OpenSSL's basic HTTP client.
155 | This is useful for networks with complex proxy setups.
156 |
157 | --partial-chain : Allow partial certificate chain if at least one certificate
158 | is in trusted store. Useful when validating an intermediate
159 | certificate without the root CA.
160 |
161 | -s, --socket file : haproxy admin socket. If omitted,
162 | $HAPROXY_ADMIN_SOCKET_DEFAULT is used by default.
163 | This script is distributed with only one
164 | method to update haproxy: using 'socat'
165 | with a local admin-level UNIX socket.
166 | Feel free to implement other mechanisms as
167 | needed! The right section in the code is
168 | \"UPDATE HAPROXY\", at the end of the script.
169 |
170 | -v, --VAfile file : same as the openssl ocsp -VAfile option
171 | with 'file' as argument. For more details:
172 | 'man ocsp'.
173 | If file = \"-\" then the chain extracted
174 | from the certificate's bundle (or .issuer
175 | file) is used (useful for OCSP responses
176 | that don't include the signer certificate).
177 |
178 | --noverify : Do not verify OCSP response.
179 |
180 | -S, --skip-update : Do not notify haproxy of the new OCSP response.
181 |
182 | -h, --help : this help."
183 | }
184 |
185 | trap Trap INT TERM
186 |
187 | TMP="$(mktemp -d -q -t "$PROGNAME.XXXXXXXXXX")"
188 |
189 | # COMMAND LINE PROCESSING
190 | # ----------------------------------
191 |
192 | while [[ $# -gt 0 ]]
193 | do
194 |
195 | case "$1" in
196 | -h|--help)
197 | Usage
198 | Quit 0
199 | ;;
200 |
201 | -d|--debug)
202 | DEBUG=1
203 | ;;
204 |
205 | --keep-temp)
206 | KEEP_TEMP=1
207 | ;;
208 |
209 | -g|--good-only)
210 | GOOD_ONLY=1
211 | ;;
212 |
213 | --noverify)
214 | VERIFY=0
215 | ;;
216 |
217 | --partial-chain)
218 | PARTIAL_CHAIN="-partial_chain"
219 | ;;
220 |
221 | -l|--syslog)
222 | if [ $# -le 1 ]; then
223 | Error 9 "mandatory value is missing for $1 argument"
224 | fi
225 | SYSLOG_PRIO="$2"
226 | shift
227 | ;;
228 |
229 | --ocsp-url)
230 | if [ $# -le 1 ]; then
231 | Error 9 "mandatory value is missing for $1 argument"
232 | fi
233 | OCSP_URL="$2"
234 | shift
235 | ;;
236 |
237 | --ocsp-host)
238 | if [ $# -le 1 ]; then
239 | Error 9 "mandatory value is missing for $1 argument"
240 | fi
241 | OCSP_HOST="$2"
242 | shift
243 | ;;
244 |
245 | --ocsp-proxy)
246 | OCSP_PROXY="$2"
247 | shift
248 | ;;
249 |
250 | --use-curl)
251 | USE_CURL=1
252 | ;;
253 |
254 | -c|--cert)
255 | if [ $# -le 1 ]; then
256 | Error 9 "mandatory value is missing for $1 argument"
257 | fi
258 | CERT="$2"
259 | shift
260 | ;;
261 |
262 | -v|--VAfile)
263 | if [ $# -le 1 ]; then
264 | Error 9 "mandatory value is missing for $1 argument"
265 | fi
266 | VAFILE="$2"
267 | if [ "${VAFILE}" == "-" ]; then
268 | VAFILE="${TMP}/chain.pem"
269 | else
270 | if [ ! -e "${VAFILE}" ]; then
271 | Error 9 "VAfile does not exists: ${VAFILE}"
272 | fi
273 | fi
274 | shift
275 | ;;
276 |
277 | -s|--socket)
278 | if [ $# -le 1 ]; then
279 | Error 9 "mandatory value is missing for $1 argument"
280 | fi
281 | HAPROXY_ADMIN_SOCKET="$2"
282 | shift
283 | ;;
284 |
285 | -S|--skip-update)
286 | SKIP_UPDATE=1
287 | ;;
288 |
289 | *)
290 | Error 9 "unknown option: $1"
291 | esac
292 |
293 | shift
294 | done
295 |
296 | Debug "Temporary directory: ${TMP}"
297 |
298 | if ! $OPENSSL_BIN version | grep OpenSSL &>>"${TMP}"/log ; then
299 | Error 9 "openssl binary not found; adjust OPENSSL_BIN variable in the script"
300 | fi
301 |
302 | if [ "$SKIP_UPDATE" -eq 0 ]; then
303 | if ! $SOCAT_BIN -V | grep socat &>>"${TMP}"/log ; then
304 | Error 9 "socat binary not found; adjust SOCAT_BIN variable in the script"
305 | fi
306 | fi
307 |
308 | if [ -z "${CERT}" ]; then
309 | Error 9 "certificate not provided (--cert argument)"
310 | fi
311 |
312 | if [ "$USE_CURL" -eq 1 ]; then
313 | if ! $CURL_BIN -V | grep curl &>>"${TMP}"/log ; then
314 | Error 9 "curl binary not found; adjust CURL_BIN variable in the script"
315 | fi
316 | fi
317 |
318 | # CURRENT RESPONSE EXPIRED?
319 | # ----------------------------------
320 |
321 | ISNEW=1
322 | if [ -e "${CERT}".ocsp ]; then
323 | ISNEW=0
324 | Debug "An OCSP response already exists: checking its expiration."
325 |
326 | if $OPENSSL_BIN ocsp -respin "${CERT}".ocsp -text -noverify | \
327 | grep "Next Update:" &>>"${TMP}"/log ; then
328 | CURR_EXP=$($OPENSSL_BIN ocsp -respin "${CERT}".ocsp -text -noverify | grep "Next Update:" | cut -d ':' -f 2-)
329 | if ! CURR_EXP_EPOCH=$(date --date="${CURR_EXP}" +%s) ; then
330 | Error 3 "can't parse Next Update from current OCSP response"
331 | fi
332 |
333 | if [ "${CURR_EXP_EPOCH}" -lt "$(date +%s)" ]; then
334 | Debug "Current OCSP response expiration: ${CURR_EXP} - expired"
335 | LogError "current OCSP response is expired: please consider running this script more frequently"
336 | else
337 | Debug "Current OCSP response expiration: ${CURR_EXP} - NOT expired"
338 | fi
339 | fi
340 | fi
341 |
342 | # EXTRACT EE CERTIFICATE INFO
343 | # ----------------------------------
344 |
345 | # extract EE certificate
346 | if ! $OPENSSL_BIN x509 -in "${CERT}" -outform PEM -out "${TMP}"/ee.pem &>>"${TMP}"/log ; then
347 | Error 1 "can't extract EE certificate from ${CERT}"
348 | fi
349 |
350 | # get OCSP server URL
351 | if [ -z "${OCSP_URL}" ]; then
352 | if ! OCSP_URL="$($OPENSSL_BIN x509 -in "${TMP}"/ee.pem -ocsp_uri -noout)" ; then
353 | Error 1 "can't obtain OCSP server URL from ${CERT}"
354 | fi
355 |
356 | if [ -z "${OCSP_URL}" ]; then
357 | Error 2 "OCSP server URL not found in the EE certificate"
358 | fi
359 |
360 | Debug "OCSP server URL found: ${OCSP_URL}"
361 | else
362 | Debug "Using OCSP server URL from command line: ${OCSP_URL}"
363 | fi
364 |
365 | # check OCSP server URL format (http:// or https://)
366 | if ! echo "${OCSP_URL}" | grep -Ei "(http://|https://)" &>/dev/null ; then
367 | Error 3 "OCSP server URL not in http[s]:// format"
368 | fi
369 |
370 | # get OCSP server URL host name
371 | if [ -z "$OCSP_HOST" ]; then
372 | if ! OCSP_HOST="$(echo "${OCSP_URL}" | grep -Ei "(http://|https://)" | cut -d'/' -f 3)" ; then
373 | Error 3 "can't extract hostname from OCSP server URL ${OCSP_URL}"
374 | fi
375 |
376 | Debug "OCSP server hostname: $OCSP_HOST"
377 | else
378 | Debug "Using OCSP server hostname from command line: $OCSP_HOST"
379 | fi
380 |
381 | # check OCSP server PROXY format (http:// or https://)
382 | if [ -n "${OCSP_PROXY}" ]; then
383 | if ! echo "${OCSP_PROXY}" | grep -Ei "(http://|https://)" &>/dev/null ; then
384 | Error 3 "OCSP server PROXY not in http[s]:// format"
385 | fi
386 | OCSP_URL=${OCSP_PROXY}
387 | fi
388 |
389 | # EXTRACT CHAIN INFO
390 | # ----------------------------------
391 |
392 | if [ -e "${CERT}".issuer ]; then
393 | Debug "Using existing chain (${CERT}.issuer)"
394 |
395 | # copy .issuer file to temporary chain.pem
396 | if ! cp "${CERT}".issuer "${TMP}"/chain.pem &>>"${TMP}"/log ; then
397 | Error 3 "can't copy current chain from ${CERT}.issuer"
398 | fi
399 | else
400 | Debug "Extracting chain from certificates bundle"
401 |
402 | # get EE certificate's fingerprint
403 | if ! FP_EE="$($OPENSSL_BIN x509 -fingerprint -noout -in "${TMP}"/ee.pem)" ||
404 | [ -z "$FP_EE" ]; then
405 | Error 1 "can't obtain EE certificate's fingerprint"
406 | fi
407 |
408 | Debug "EE certificate's fingerprint: $FP_EE"
409 |
410 | # get BEGIN CERTIFICATE and END CERTIFICATE separators
411 | PEM_BEGIN_CERT="$(head -n 1 "${TMP}"/ee.pem)"
412 | PEM_END_CERT="$(tail -n 1 "${TMP}"/ee.pem)"
413 |
414 | # get number of certificates in the bundle file
415 | NUM_OF_CERTS=$(grep -ce "$PEM_BEGIN_CERT" < "${CERT}")
416 |
417 | if [ "$NUM_OF_CERTS" -le 1 ]; then
418 | Error 3 "can't obtain the number of certificates in the chain"
419 | fi
420 |
421 | Debug "$NUM_OF_CERTS certificates found in the bundle"
422 |
423 | # save each certificate in the bundle into "${TMP}"/chain-X.pem
424 | if ! sed <"${CERT}" -n -e "/$PEM_BEGIN_CERT/,/$PEM_END_CERT/p" | \
425 | awk "/$PEM_BEGIN_CERT/{x=\"${TMP}/chain-\" ++i \".pem\";}{print > x;}" &>>"${TMP}"/log ; then
426 | Error 3 "can't extract certificates from bundle"
427 | fi
428 |
429 | # for each certificate that is extracted from the bundle check if
430 | # it's the EE certificate, otherwise uses it to build the chain file
431 | for c in $(seq 1 "$NUM_OF_CERTS");
432 | do
433 | # check fingerprint of current and EE certificates
434 | if ! FP=$($OPENSSL_BIN x509 -fingerprint -noout -in "${TMP}"/chain-"${c}".pem) ||
435 | [ -z "$FP" ]; then
436 | Error 1 "can't obtain the fingerprint of the certificate n. ${c} in the bundle"
437 | else
438 | if [ ! "$FP" == "$FP_EE" ]; then
439 | Debug "Bundle certificate n. ${c} fingerprint: $FP - it's part of the chain"
440 |
441 | # current certificate is not the same as the EE; append to the chain
442 | cat "${TMP}"/chain-"${c}".pem >> "${TMP}"/chain.pem
443 | else
444 | Debug "Bundle certificate n. ${c} fingerprint: $FP - EE certificate"
445 | fi
446 | fi
447 | done
448 | fi
449 |
450 | # check if the EE certificate validates against the chain
451 | if ! $OPENSSL_BIN verify $PARTIAL_CHAIN -CAfile "${TMP}"/chain.pem "${TMP}"/ee.pem &>>"${TMP}"/log ; then
452 | if [ -e "${CERT}".issuer ]; then
453 | Error 1 "can't validate the EE certificate against the existing chain; if it has been changed recently consider removing the current ${CERT}.issuer file and let this script to figure out a new one"
454 | else
455 | Error 1 "can't validate the EE certificate against the extracted chain"
456 | fi
457 | fi
458 |
459 | # OCSP
460 | # ----------------------------------
461 |
462 | # query the OCSP server and save its response
463 |
464 | OPENSSL_VERSION=$($OPENSSL_BIN version | sed -rn 's/^OpenSSL\s([0-9]\.[0-9]).*/\1/p')
465 |
466 | if [ "$USE_CURL" -eq 0 ]; then
467 | typeset -a hdr
468 | case $OPENSSL_VERSION in
469 | '0.9')
470 | hdr=(-header "Host=$OCSP_HOST")
471 | ;;
472 | '1.0')
473 | hdr=(-header "Host" "$OCSP_HOST")
474 | ;;
475 | *)
476 | hdr=()
477 | ;;
478 | esac
479 |
480 | if ! $OPENSSL_BIN ocsp $PARTIAL_CHAIN \
481 | -issuer "${TMP}"/chain.pem -cert "${TMP}"/ee.pem \
482 | -respout "${TMP}"/ocsp.der -noverify \
483 | -no_nonce -url "${OCSP_URL}" "${hdr[@]}" &>>"${TMP}"/log ; then
484 | Error 1 "can't receive the OCSP server response"
485 | fi
486 | else # USE_CURL
487 | if ! $OPENSSL_BIN ocsp $PARTIAL_CHAIN \
488 | -issuer "${TMP}"/chain.pem -cert "${TMP}"/ee.pem \
489 | -reqout "${TMP}"/ocsp.req.der -noverify -no_nonce &>>"${TMP}"/log ; then
490 | Error 1 "can't create the OCSP request"
491 | fi
492 |
493 | if ! $CURL_BIN --fail-with-body --data-binary @"${TMP}"/ocsp.req.der \
494 | --header "Content-Type:application/ocsp-request" \
495 | --output "${TMP}"/ocsp.der "${OCSP_URL}" &>>"${TMP}"/log ; then
496 | Error 1 "can't receive the OCSP server response"
497 | fi
498 | fi
499 |
500 | # process the OCSP response
501 | VERIFYOPT=""
502 | if [ "$VERIFY" -eq 0 ]; then
503 | VERIFYOPT="-noverify"
504 | fi
505 | typeset -a vaarg=()
506 | if [[ -n "${VAFILE}" ]] ; then
507 | vaarg=(-VAfile "${VAFILE}")
508 | fi
509 |
510 | if ! $OPENSSL_BIN ocsp $PARTIAL_CHAIN $VERIFYOPT -issuer "${TMP}"/chain.pem \
511 | -cert "${TMP}"/ee.pem -respin "${TMP}"/ocsp.der -no_nonce \
512 | -CAfile "${TMP}"/chain.pem "${vaarg[@]}" \
513 | -out "${TMP}"/ocsp.txt &>>"${TMP}"/ocsp-verify.txt ; then
514 | Error 1 "can't receive OCSP response"
515 | fi
516 |
517 | if [ "$VERIFY" -eq 1 ]; then
518 | Debug "OCSP response verification results: $(cat "${TMP}"/ocsp-verify.txt)"
519 |
520 | if ! grep < "${TMP}"/ocsp-verify.txt "Response verify OK" &>>"${TMP}"/log ; then
521 | if grep "signer certificate not found" \
522 | "${TMP}"/ocsp-verify.txt &>/dev/null ; then
523 | Error 4 "OCSP response verification failure: signer certificate not found; try with '--VAfile -' or '--VAfile OCSP-response-signing-certificate-file' arguments"
524 | else
525 | Error 4 "OCSP response verification failure."
526 | fi
527 | fi
528 | fi
529 |
530 | Debug "OCSP response: $(cat "${TMP}"/ocsp.txt)"
531 |
532 | if [ "$GOOD_ONLY" -eq 1 ]; then
533 | if ! head -n 1 "${TMP}"/ocsp.txt | grep ": good" &>>"${TMP}"/log ; then
534 | Error 4 "OCSP response, certificate status not good"
535 | fi
536 | fi
537 |
538 | # UPDATE HAPROXY
539 | # ----------------------------------
540 |
541 | # Status:
542 | # - "${TMP}"/ocsp.der contains the OCSP response, DER format
543 | # - "${TMP}"/ocsp.txt contains the textual OCSP response as produced
544 | # by openssl
545 | # - the OCSP response has been verified against the chain or
546 | # the --VAfile
547 |
548 | if [ "${DEBUG}" -eq 0 ]; then
549 | # update .ocsp and .issuer files
550 |
551 | if ! cp "${TMP}"/ocsp.der "${CERT}".ocsp &>>"${TMP}"/log ; then
552 | Error 5 "can't update ${CERT}.ocsp file"
553 | fi
554 |
555 | if [ ! -e "${CERT}".issuer ]; then
556 | if ! cp "${TMP}"/chain.pem "${CERT}".issuer &>>"${TMP}"/log ; then
557 | Error 5 "can't update ${CERT}.issuer file"
558 | fi
559 | fi
560 |
561 | if [ "$SKIP_UPDATE" -eq 0 ]; then
562 | if [ "$ISNEW" -eq 1 ]; then
563 | # no .ocsp file found, maybe it's an initial run
564 | Debug "Reloading haproxy."
565 |
566 | if ! service haproxy reload ; then
567 | Error 5 "can't reload haproxy with 'service haproxy reload'"
568 | fi
569 | else
570 | # update haproxy via local UNIX socket
571 | Debug "Updating haproxy."
572 |
573 | if ! echo "set ssl ocsp-response $($OPENSSL_BIN enc -base64 -A -in "$TMP"/ocsp.der)" |
574 | $SOCAT_BIN stdio "${HAPROXY_ADMIN_SOCKET}" &>>"${TMP}"/log ; then
575 | Error 5 "can't update haproxy ssl ocsp-response using ${HAPROXY_ADMIN_SOCKET} socket"
576 | fi
577 | fi
578 | else
579 | Debug "Not notifying haproxy because skip-update is set."
580 | fi
581 |
582 | else
583 | Debug "Debug mode: haproxy update skipped."
584 | fi
585 |
586 | # remove temporary files and quit with success
587 | Quit 0
588 |
589 | # vim: set tabstop=4 shiftwidth=4 expandtab:
590 |
--------------------------------------------------------------------------------