├── .dockerignore ├── Dockerfile ├── Dockerfile.aarch64 ├── Dockerfile.armhf ├── LICENSE ├── README.md ├── docker-compose.yml ├── hooks ├── post_checkout ├── post_push └── pre_build ├── logo.png ├── multi-arch-manifest.yaml └── openvpn.sh /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | LICENSE 3 | README.md 4 | logo.png 5 | docker-compose.yml -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine 2 | MAINTAINER David Personette 3 | 4 | # Install openvpn 5 | RUN apk --no-cache --no-progress upgrade && \ 6 | apk --no-cache --no-progress add bash curl ip6tables iptables openvpn \ 7 | shadow tini tzdata && \ 8 | addgroup -S vpn && \ 9 | rm -rf /tmp/* 10 | 11 | COPY openvpn.sh /usr/bin/ 12 | 13 | HEALTHCHECK --interval=60s --timeout=15s --start-period=120s \ 14 | CMD curl -LSs 'https://api.ipify.org' 15 | 16 | VOLUME ["/vpn"] 17 | 18 | ENTRYPOINT ["/sbin/tini", "--", "/usr/bin/openvpn.sh"] -------------------------------------------------------------------------------- /Dockerfile.aarch64: -------------------------------------------------------------------------------- 1 | FROM arm64v8/alpine 2 | COPY qemu-aarch64-static /usr/bin/ 3 | MAINTAINER David Personette 4 | 5 | # Install openvpn 6 | RUN apk --no-cache --no-progress upgrade && \ 7 | apk --no-cache --no-progress add bash curl ip6tables iptables openvpn \ 8 | shadow tini tzdata && \ 9 | addgroup -S vpn && \ 10 | rm -rf /tmp/* 11 | 12 | COPY openvpn.sh /usr/bin/ 13 | 14 | HEALTHCHECK --interval=60s --timeout=15s --start-period=120s \ 15 | CMD curl -LSs 'https://api.ipify.org' 16 | 17 | VOLUME ["/vpn"] 18 | 19 | ENTRYPOINT ["/sbin/tini", "--", "/usr/bin/openvpn.sh"] -------------------------------------------------------------------------------- /Dockerfile.armhf: -------------------------------------------------------------------------------- 1 | FROM arm32v6/alpine 2 | COPY qemu-arm-static /usr/bin/ 3 | MAINTAINER David Personette 4 | 5 | # Install openvpn 6 | RUN apk --no-cache --no-progress upgrade && \ 7 | apk --no-cache --no-progress add bash curl ip6tables iptables openvpn \ 8 | shadow tini tzdata && \ 9 | addgroup -S vpn && \ 10 | rm -rf /tmp/* 11 | 12 | COPY openvpn.sh /usr/bin/ 13 | 14 | HEALTHCHECK --interval=60s --timeout=15s --start-period=120s \ 15 | CMD curl -LSs 'https://api.ipify.org' 16 | 17 | VOLUME ["/vpn"] 18 | 19 | ENTRYPOINT ["/sbin/tini", "--", "/usr/bin/openvpn.sh"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![logo](https://raw.githubusercontent.com/dperson/openvpn-client/master/logo.png)](https://openvpn.net/) 2 | 3 | # OpenVPN 4 | 5 | This is an OpenVPN client docker container. It makes routing containers' 6 | traffic through OpenVPN easy. 7 | 8 | # What is OpenVPN? 9 | 10 | OpenVPN is an open-source software application that implements virtual private 11 | network (VPN) techniques for creating secure point-to-point or site-to-site 12 | connections in routed or bridged configurations and remote access facilities. 13 | It uses a custom security protocol that utilizes SSL/TLS for key exchange. It is 14 | capable of traversing network address translators (NATs) and firewalls. 15 | 16 | # How to use this image 17 | 18 | This OpenVPN container was designed to be started first to provide a connection 19 | to other containers (using `--net=container:vpn`, see below *Starting an OpenVPN 20 | client instance*). 21 | 22 | **NOTE**: More than the basic privileges are needed for OpenVPN. With docker 1.2 23 | or newer you can use the `--cap-add=NET_ADMIN` and `--device /dev/net/tun` 24 | options. Earlier versions, or with fig, and you'll have to run it in privileged 25 | mode. 26 | 27 | **NOTE 2**: If you have connectivity issues, please see the DNS instructions 28 | below. 29 | 30 | **NOTE 3**: If you need access to other non HTTP proxy-able ports, please see 31 | the Routing instructions below. 32 | 33 | **NOTE 4**: If you have a VPN service that allows making local services 34 | available, you'll need to reuse the VPN container's network stack with the 35 | `--net=container:vpn` (replacing 'vpn' with what you named your instance of this 36 | container) when you launch the service in its container. 37 | 38 | **NOTE 5**: If you need a template for using this container with 39 | `docker-compose`, see the example 40 | [file](https://github.com/dperson/openvpn-client/raw/master/docker-compose.yml). 41 | 42 | **NOTE 6**: If you need IPv6, or the errors really bother you add a 43 | `--sysctl net.ipv6.conf.all.disable_ipv6=0` to the docker run command. 44 | 45 | ## Starting an OpenVPN client instance 46 | 47 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 48 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 49 | -v /some/path:/vpn -d dperson/openvpn-client \ 50 | -v 'vpn.server.name;username;password' 51 | sudo docker restart vpn 52 | 53 | Once it's up other containers can be started using its network connection: 54 | 55 | sudo docker run -it --net=container:vpn -d some/docker-container 56 | 57 | ## Local Network access to services connecting to the internet through the VPN. 58 | 59 | However to access them from your normal network (off the 'local' docker bridge), 60 | you'll also need to run a web proxy, like so: 61 | 62 | sudo docker run -it --name web -p 80:80 -p 443:443 \ 63 | --link vpn: -d dperson/nginx \ 64 | -w "http://:/;/" 65 | 66 | Which will start a Nginx web server on local ports 80 and 443, and proxy any 67 | requests under `/` to the to `http://:/`. To use 68 | a concrete example: 69 | 70 | sudo docker run -it --name bit --net=container:vpn -d dperson/transmission 71 | sudo docker run -it --name web -p 80:80 -p 443:443 --link vpn:bit \ 72 | -d dperson/nginx -w "http://bit:9091/transmission;/transmission" 73 | 74 | For multiple services (non-existant 'foo' used as an example): 75 | 76 | sudo docker run -it --name bit --net=container:vpn -d dperson/transmission 77 | sudo docker run -it --name foo --net=container:vpn -d dperson/foo 78 | sudo docker run -it --name web -p 80:80 -p 443:443 --link vpn:bit \ 79 | --link vpn:foo -d dperson/nginx \ 80 | -w "http://bit:9091/transmission;/transmission" \ 81 | -w "http://foo:8000/foo;/foo" 82 | 83 | ## Routing for local access to non HTTP proxy-able ports 84 | 85 | The argument to the `-r` (route) command line argument must be your local 86 | network that you would connect to the server running the docker containers on. 87 | Running the following on your docker host should give you the correct network: 88 | `ip route | awk '!/ (docker0|br-)/ && /src/ {print $1}'` 89 | 90 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 91 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 92 | -v /some/path:/vpn -d dperson/openvpn-client \ 93 | -r 192.168.1.0/24 -v 'vpn.server.name;username;password' 94 | 95 | **NOTE**: if you have a port you want to make available, you have to add the 96 | docker `-p` option to the VPN container. The network stack will be reused by 97 | the second container (that's what `--net=container:vpn` does). 98 | 99 | ## Configuration 100 | 101 | sudo docker run -it --rm dperson/openvpn-client -h 102 | 103 | Usage: openvpn.sh [-opt] [command] 104 | Options (fields in '[]' are optional, '<>' are required): 105 | -h This help 106 | -c '' Configure an authentication password to open the cert 107 | required arg: '' 108 | password to access the certificate file 109 | -a '' Configure authentication username and password 110 | -D Don't use the connection as the default route 111 | -d Use the VPN provider's DNS resolvers 112 | -f '[port]' Firewall rules so that only the VPN and DNS are allowed to 113 | send internet traffic (IE if VPN is down it's offline) 114 | optional arg: [port] to use, instead of default 115 | -m '' Maximum Segment Size 116 | required arg: '' 117 | -o '' Allow to pass any arguments directly to openvpn 118 | required arg: '' 119 | could be any string matching openvpn arguments 120 | i.e '--arg1 value --arg2 value' 121 | -p '[;protocol]' Forward port 122 | required arg: '' 123 | optional arg: [protocol] to use instead of default (tcp) 124 | -R '' CIDR IPv6 network (IE fe00:d34d:b33f::/64) 125 | required arg: '' 126 | add a route to (allows replies once the VPN is up) 127 | -r '' CIDR network (IE 192.168.1.0/24) 128 | required arg: '' 129 | add a route to (allows replies once the VPN is up) 130 | -v '' Configure OpenVPN 131 | required arg: ';;' 132 | to connect to (multiple servers are separated by :) 133 | to authenticate as 134 | to authenticate with 135 | optional args: 136 | [port] to use, instead of default 137 | [proto] to use, instead of udp (IE, tcp) 138 | 139 | The 'command' (if provided and valid) will be run instead of openvpn 140 | 141 | ENVIRONMENT VARIABLES 142 | 143 | * `CERT_AUTH` - As above (-c) provide authentication to access certificate 144 | * `DNS` - As above (-d) use the VPN provider's DNS resolvers 145 | * `DEFAULT_GATEWAY` - As above (-D) if set to 'false', don't use default route 146 | * `FIREWALL` - As above (-f) setup firewall to disallow net access w/o the VPN 147 | * `CIPHER` - Set openvpn cipher option when generating conf file with -v 148 | * `AUTH` - Set openvpn auth option when generating conf file with -v 149 | * `MSS` - As above (-m) set Maximum Segment Size 150 | * `OTHER_ARGS` - As above (-o) pass arguments directly to openvpn 151 | * `ROUTE6` - As above (-R) add a route to allow replies to your private network 152 | * `ROUTE` - As above (-r) add a route to allow replies to your private network 153 | * `TZ` - Set a timezone, IE `EST5EDT` 154 | * `VPN_FILES` - specify the '[;cert]' files to use (relative to `/vpn`) 155 | * `VPN` - As above (-v) setup a VPN connection 156 | * `VPN_AUTH` - As above (-a) provide authentication to vpn server 157 | * `VPNPORT` - As above (-p) setup port forwarding (See NOTE below) 158 | * `GROUPID` - Set the GID for the vpn 159 | 160 | **NOTE**: optionally supports additional variables starting with the same name, 161 | IE `VPNPORT` also will work for `VPNPORT_2`, `VPNPORT_3`... `VPNPORT_x`, etc. 162 | 163 | **NOTE2**: if you are using `-d` or `DNS` and set the container as read-only, 164 | you will get errors as it tries to write to `/etc/resolv.conf`, the 2 are 165 | incompatible. 166 | 167 | ## Examples 168 | 169 | Any of the commands can be run at creation with `docker run` or later with 170 | `docker exec -it openvpn openvpn.sh` (as of version 1.3 of docker). 171 | 172 | ### Setting the Timezone 173 | 174 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 175 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 176 | -v /some/path:/vpn -e TZ=EST5EDT -d dperson/openvpn \ 177 | -v 'vpn.server.name;username;password' 178 | 179 | ### VPN configuration 180 | 181 | **NOTE**: When using `-v` (`VPN` variable) a vpn configuration is generated. 182 | 183 | **NOTE2**: See the `-a` (`VPN_AUTH` variable) to just provide user / password 184 | authentication to an existing configuration. 185 | 186 | **NOTE3**: If the auto detect isn't picking the correct configuration, you can 187 | use the `VPN_FILES` environment variable. All files must still be in `/vpn`, and 188 | will only be looked for there. IE, you could use the following to specify the 189 | `vpn.conf` configuration and `vpn.crt` certificate files: 190 | `-e VPN_FILES="vpn.conf;vpn.crt` 191 | 192 | In order to work you must provide VPN configuration and the certificate. You can 193 | use external storage for `/vpn`: 194 | 195 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 196 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 197 | -v /some/path:/vpn -d dperson/openvpn-client \ 198 | -v 'vpn.server.name;username;password' 199 | 200 | Or you can store it in the container: 201 | 202 | cat /path/to/vpn.crt | sudo docker run -it --cap-add=NET_ADMIN \ 203 | --device /dev/net/tun --name vpn -d dperson/openvpn-client \ 204 | -v 'vpn.server.name;username;password' tee /vpn/vpn-ca.crt \ 205 | >/dev/null 206 | sudo docker restart vpn 207 | 208 | ### Firewall 209 | 210 | It's just a simple command line argument (`-f ""`) to turn on the firewall, and 211 | block all outbound traffic if the VPN is down. 212 | 213 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 214 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 215 | -v /some/path:/vpn -d dperson/openvpn-client -f "" \ 216 | -v 'vpn.server.name;username;password' 217 | 218 | ### DNS Issues (May Look Like You Can't Connect To Anything) 219 | 220 | Often local DNS and/or your ISP won't be accessable from the new IP address you 221 | get from your VPN. You'll need to add the `--dns` command line option to the 222 | `docker run` statement. Here's an example of doing so, with a Google DNS server: 223 | 224 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 225 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 226 | --dns 8.8.4.4 -v /some/path:/vpn -d dperson/openvpn-client \ 227 | -v 'vpn.server.name;username;password' 228 | 229 | ### Run with client certificates 230 | 231 | In case you want to use client certificates you just copy them into the /vpn 232 | directory. 233 | 234 | sudo cp /path/to/vpn.crt /some/path/vpn-ca.crt 235 | sudo cp /path/to/client.crt /some/path/client.crt 236 | sudo cp /path/to/client.key /some/path/client.key 237 | sudo cp /path/to/vpn.conf /some/path/vpn.conf 238 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 239 | -v /some/path:/vpn -d dperson/openvpn-client 240 | 241 | The vpn.conf should look like this: 242 | 243 | client 244 | dev tun 245 | port 1194 246 | proto udp 247 | 248 | remote vpn.server.name 1194 249 | nobind 250 | 251 | ca /vpn/vpn-ca.crt 252 | cert /vpn/client.crt 253 | key /vpn/client.key 254 | 255 | persist-key 256 | persist-tun 257 | 258 | ### Run with openvpn client configuration and provided auth 259 | 260 | In case you want to use your client configuration in /vpn named vpn.conf 261 | but adding your vpn user and password by command line 262 | 263 | sudo docker run -it --cap-add=NET_ADMIN --device /dev/net/tun --name vpn \ 264 | -v /some/path:/vpn -d dperson/openvpn-client -a 'username;password' 265 | 266 | # User Feedback 267 | 268 | ## Issues 269 | 270 | If you have any problems with or questions about this image, please contact me 271 | through a [GitHub issue](https://github.com/dperson/openvpn-client/issues). -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.4' 2 | 3 | services: 4 | vpn: 5 | image: dperson/openvpn-client 6 | # cap_add, security_opt, and volume required for the image to function 7 | cap_add: 8 | - net_admin 9 | environment: 10 | TZ: 'EST5EDT' 11 | networks: 12 | - default 13 | # if using '-d' or 'DNS' you can't enable the `read_only: true` option 14 | read_only: true 15 | tmpfs: 16 | - /run 17 | - /tmp 18 | restart: unless-stopped 19 | security_opt: 20 | - label:disable 21 | stdin_open: true 22 | tty: true 23 | volumes: 24 | - /dev/net:/dev/net:z 25 | # Put .ovpn configuration file in the /vpn directory (in "volumes:" above or 26 | # launch using the command line arguments, IE pick one: 27 | # - ./vpn:/vpn 28 | # command: 'server;user;password[;port]' 29 | 30 | # Replace "service1" with and image with an actual service you want to run 31 | service1: 32 | image: docker_hub_user/container_name 33 | depends_on: 34 | - vpn 35 | environment: 36 | TZ: 'EST5EDT' 37 | network_mode: "service:vpn" 38 | restart: unless-stopped 39 | stdin_open: true 40 | tty: true 41 | volumes: 42 | - /srv/service1:/var/lib/service1:Z 43 | 44 | web: 45 | image: dperson/nginx 46 | depends_on: 47 | - service1 48 | environment: 49 | TZ: 'EST5EDT' 50 | links: 51 | - vpn:service1 52 | networks: 53 | - default 54 | ports: 55 | - "80:80" 56 | - "443:443" 57 | read_only: true 58 | tmpfs: 59 | - /run 60 | - /tmp 61 | - /var/cache/nginx 62 | restart: unless-stopped 63 | stdin_open: true 64 | tty: true 65 | command: -w "http://service1:8888;/service1" 66 | # service1 shares the network stack of vpn. The service can by reached using 67 | # the name of the service as a hostname. 68 | 69 | networks: 70 | default: -------------------------------------------------------------------------------- /hooks/post_checkout: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | API="https://api.github.com/repos/estesp/manifest-tool/tags" 4 | URL="https://github.com/estesp/manifest-tool/releases/download" 5 | TAG=$(curl -Ls $API | awk -F'"' '/name.*v[0-9]/ {print $4; exit}') 6 | curl -LSso manifest-tool "${URL}/${TAG}/manifest-tool-linux-amd64" 7 | chmod +x manifest-tool 8 | 9 | [[ "${DOCKER_TAG}" == "amd64" ]] && \ 10 | { echo 'qemu-user-static: Download not required for this arch'; exit 0; } 11 | 12 | API="https://api.github.com/repos/multiarch/qemu-user-static/tags" 13 | URL="https://github.com/multiarch/qemu-user-static/releases/download" 14 | TAG=$(curl -Ls $API | awk -F'"' '/name.*v[0-9]/ {print $4; exit}') 15 | ARCH=$([[ "${DOCKER_TAG}" == "armhf" ]] && \ 16 | echo "${DOCKER_TAG::-2}" || echo "${DOCKER_TAG}") 17 | 18 | curl -LSs "${URL}/${TAG}/x86_64_qemu-${ARCH}-static.tar.gz" | tar xzv -------------------------------------------------------------------------------- /hooks/post_push: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Use manifest-tool to create the manifest, given the experimental 4 | # "docker manifest" command isn't available yet on Docker Hub. 5 | 6 | ./manifest-tool push from-spec multi-arch-manifest.yaml --ignore-missing -------------------------------------------------------------------------------- /hooks/pre_build: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | [[ "${DOCKER_TAG}" == "amd64" ]] && \ 4 | { echo 'qemu-user-static: Registration not required for this arch';exit 0; } 5 | 6 | docker run --rm --privileged multiarch/qemu-user-static:register --reset -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dperson/openvpn-client/a08d70a5fd4c192390305accd5593f3348e04d4d/logo.png -------------------------------------------------------------------------------- /multi-arch-manifest.yaml: -------------------------------------------------------------------------------- 1 | image: dperson/openvpn-client:latest 2 | manifests: 3 | - image: dperson/openvpn-client:amd64 4 | platform: 5 | architecture: amd64 6 | os: linux 7 | - image: dperson/openvpn-client:aarch64 8 | platform: 9 | architecture: arm64 10 | os: linux 11 | variant: v8 12 | - image: dperson/openvpn-client:armhf 13 | platform: 14 | architecture: arm 15 | os: linux 16 | variant: v6 -------------------------------------------------------------------------------- /openvpn.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | #=============================================================================== 3 | # FILE: openvpn.sh 4 | # 5 | # USAGE: ./openvpn.sh 6 | # 7 | # DESCRIPTION: Entrypoint for openvpn docker container 8 | # 9 | # OPTIONS: --- 10 | # REQUIREMENTS: --- 11 | # BUGS: --- 12 | # NOTES: --- 13 | # AUTHOR: David Personette (dperson@gmail.com), 14 | # ORGANIZATION: 15 | # CREATED: 09/28/2014 12:11 16 | # REVISION: 1.0 17 | #=============================================================================== 18 | 19 | set -o nounset # Treat unset variables as an error 20 | 21 | ### cert_auth: setup auth passwd for accessing certificate 22 | # Arguments: 23 | # passwd) Password to access the cert 24 | # Return: openvpn argument to support certificate authentication 25 | cert_auth() { local passwd="$1" 26 | grep -q "^${passwd}\$" $cert_auth || { 27 | echo "$passwd" >$cert_auth 28 | } 29 | chmod 0600 $cert_auth 30 | } 31 | 32 | ### dns: setup openvpn client DNS 33 | # Arguments: 34 | # none) 35 | # Return: openvpn arguments to use VPN provider's DNS resolvers 36 | dns() { 37 | ext_args+=" --up /etc/openvpn/up.sh" 38 | ext_args+=" --down /etc/openvpn/down.sh" 39 | } 40 | 41 | ### firewall: firewall all output not DNS/VPN that's not over the VPN connection 42 | # Arguments: 43 | # port) optional port that will be used to connect to VPN (should auto detect) 44 | # Return: configured firewall 45 | firewall() { local port="${1:-1194}" docker_network="$(ip -o addr show dev eth0| 46 | awk '$3 == "inet" {print $4}')" \ 47 | docker6_network="$(ip -o addr show dev eth0 | 48 | awk '$3 == "inet6" {print $4; exit}')" 49 | [[ -z "${1:-}" && -r $conf ]] && 50 | port="$(awk -F"[\r\t ]+" '/^remote/ && $3~/^[0-9]+$/ {print $3}' $conf | 51 | uniq | grep ^ || echo 1194)" 52 | 53 | test -f /proc/net/if_inet6 && { lsmod |grep -qF ip6table_filter || { \ 54 | echo "WARNING: ip6tables disabled!" 55 | echo "Run 'sudo modprobe ip6table_filter' on your host"; };} 56 | 57 | ip6tables -F 2>/dev/null 58 | ip6tables -X 2>/dev/null 59 | ip6tables -P INPUT DROP 2>/dev/null 60 | ip6tables -P FORWARD DROP 2>/dev/null 61 | ip6tables -P OUTPUT DROP 2>/dev/null 62 | ip6tables -A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT \ 63 | 2>/dev/null 64 | ip6tables -A INPUT -p icmp -j ACCEPT 2>/dev/null 65 | ip6tables -A INPUT -i lo -j ACCEPT 2>/dev/null 66 | ip6tables -A INPUT -s ${docker6_network} -j ACCEPT 2>/dev/null 67 | ip6tables -A FORWARD -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT \ 68 | 2>/dev/null 69 | ip6tables -A FORWARD -p icmp -j ACCEPT 2>/dev/null 70 | ip6tables -A FORWARD -i lo -j ACCEPT 2>/dev/null 71 | ip6tables -A FORWARD -d ${docker6_network} -j ACCEPT 2>/dev/null 72 | ip6tables -A FORWARD -s ${docker6_network} -j ACCEPT 2>/dev/null 73 | ip6tables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT \ 74 | 2>/dev/null 75 | ip6tables -A OUTPUT -o lo -j ACCEPT 2>/dev/null 76 | ip6tables -A OUTPUT -o tap+ -j ACCEPT 2>/dev/null 77 | ip6tables -A OUTPUT -o tun+ -j ACCEPT 2>/dev/null 78 | ip6tables -A OUTPUT -d ${docker6_network} -j ACCEPT 2>/dev/null 79 | ip6tables -A OUTPUT -p tcp -m owner --gid-owner vpn -j ACCEPT 2>/dev/null && 80 | ip6tables -A OUTPUT -p udp -m owner --gid-owner vpn -j ACCEPT 2>/dev/null||{ 81 | for i in $port; do 82 | ip6tables -A OUTPUT -p tcp -m tcp --dport $i -j ACCEPT 2>/dev/null 83 | ip6tables -A OUTPUT -p udp -m udp --dport $i -j ACCEPT 2>/dev/null 84 | done 85 | ip6tables -A OUTPUT -p udp -m udp --dport 53 -j ACCEPT 2>/dev/null; } 86 | ip6tables -t nat -A POSTROUTING -o tap+ -j MASQUERADE 87 | ip6tables -t nat -A POSTROUTING -o tun+ -j MASQUERADE 88 | iptables -F 89 | iptables -X 90 | iptables -P INPUT DROP 91 | iptables -P FORWARD DROP 92 | iptables -P OUTPUT DROP 93 | iptables -A INPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT 94 | iptables -A INPUT -i lo -j ACCEPT 95 | iptables -A INPUT -s ${docker_network} -j ACCEPT 96 | iptables -A FORWARD -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT 97 | iptables -A FORWARD -i lo -j ACCEPT 98 | iptables -A FORWARD -d ${docker_network} -j ACCEPT 99 | iptables -A FORWARD -s ${docker_network} -j ACCEPT 100 | iptables -A OUTPUT -m conntrack --ctstate ESTABLISHED,RELATED -j ACCEPT 101 | iptables -A OUTPUT -o lo -j ACCEPT 102 | iptables -A OUTPUT -o tap+ -j ACCEPT 103 | iptables -A OUTPUT -o tun+ -j ACCEPT 104 | iptables -A OUTPUT -d ${docker_network} -j ACCEPT 105 | iptables -A OUTPUT -p tcp -m owner --gid-owner vpn -j ACCEPT 2>/dev/null && 106 | iptables -A OUTPUT -p udp -m owner --gid-owner vpn -j ACCEPT || { 107 | for i in $port; do 108 | iptables -A OUTPUT -p tcp -m tcp --dport $i -j ACCEPT 109 | iptables -A OUTPUT -p udp -m udp --dport $i -j ACCEPT 110 | done 111 | iptables -A OUTPUT -p udp -m udp --dport 53 -j ACCEPT; } 112 | if grep -Fq "127.0.0.11" /etc/resolv.conf; then 113 | iptables -A OUTPUT -d 127.0.0.11 -m owner --gid-owner vpn -j ACCEPT \ 114 | 2>/dev/null && { 115 | iptables -A OUTPUT -p udp -m udp --dport 53 -j ACCEPT 116 | ext_args+=" --route-up '/bin/sh -c \"" 117 | ext_args+=" iptables -A OUTPUT -d 127.0.0.11 -j ACCEPT\"'" 118 | ext_args+=" --route-pre-down '/bin/sh -c \"" 119 | ext_args+=" iptables -D OUTPUT -d 127.0.0.11 -j ACCEPT\"'" 120 | } || iptables -A OUTPUT -d 127.0.0.11 -j ACCEPT; fi 121 | iptables -t nat -A POSTROUTING -o tap+ -j MASQUERADE 122 | iptables -t nat -A POSTROUTING -o tun+ -j MASQUERADE 123 | [[ -r $firewall_cust ]] && . $firewall_cust 124 | for i in $route6 $route; do [[ -e $i ]] || touch $i; done 125 | [[ -s $route6 ]] && for net in $(cat $route6); do return_route6 $net; done 126 | [[ -s $route ]] && for net in $(cat $route); do return_route $net; done 127 | } 128 | 129 | ### global_return_routes: add a route back to all networks for return traffic 130 | # Arguments: 131 | # none) 132 | # Return: configured return routes 133 | global_return_routes() { local if=$(ip r | awk '/^default/ {print $5; quit}') 134 | local gw6="$(ip -6 r show dev $if | awk '/default/ {print $3}')" \ 135 | gw="$(ip -4 r show dev $if | awk '/default/ {print $3}')" \ 136 | ip6=$(ip -6 a show dev $if | awk -F '[ \t/]+' '/inet6.*global/ {print $3}')\ 137 | ip=$(ip -4 a show dev $if | awk -F '[ \t/]+' '/inet .*global/ {print $3}') 138 | 139 | for i in $ip6; do 140 | ip -6 rule show table 10 | grep -q "$i\\>" || 141 | ip -6 rule add from $i lookup 10 142 | ip6tables -S 2>/dev/null | grep -q "$i\\>" || 143 | ip6tables -A INPUT -d $i -j ACCEPT 2>/dev/null 144 | done 145 | for i in $gw6; do 146 | ip -6 route show table 10 | grep -q "$i\\>" || 147 | ip -6 route add default via $i table 10 148 | done 149 | 150 | for i in $ip; do 151 | ip -4 rule show table 10 | grep -q "$i\\>" || 152 | ip rule add from $i lookup 10 153 | iptables -S | grep -q "$i\\>" || iptables -A INPUT -d $i -j ACCEPT 154 | done 155 | for i in $gw; do 156 | ip -4 route show table 10 | grep -q "$i\\>" || 157 | ip route add default via $i table 10 158 | done 159 | } 160 | 161 | ### return_route: add a route back to your network, so that return traffic works 162 | # Arguments: 163 | # network) a CIDR specified network range 164 | # Return: configured return route 165 | return_route6() { local network="$1" gw="$(ip -6 route | 166 | awk '/default/ {print $3}')" 167 | echo "The use of ROUTE6 or -R may no longer be needed, try it without!!" 168 | ip -6 route | grep -q "$network" || 169 | ip -6 route add to $network via $gw dev eth0 170 | ip6tables -A INPUT -s $network -j ACCEPT 2>/dev/null 171 | ip6tables -A FORWARD -d $network -j ACCEPT 2>/dev/null 172 | ip6tables -A FORWARD -s $network -j ACCEPT 2>/dev/null 173 | ip6tables -A OUTPUT -d $network -j ACCEPT 2>/dev/null 174 | [[ -e $route6 ]] &&grep -q "^$network\$" $route6 ||echo "$network" >>$route6 175 | } 176 | 177 | ### return_route: add a route back to your network, so that return traffic works 178 | # Arguments: 179 | # network) a CIDR specified network range 180 | # Return: configured return route 181 | return_route() { local network="$1" gw="$(ip route |awk '/default/ {print $3}')" 182 | echo "The use of ROUTE or -r may no longer be needed, try it without!" 183 | ip route | grep -q "$network" || 184 | ip route add to $network via $gw dev eth0 185 | iptables -A INPUT -s $network -j ACCEPT 186 | iptables -A FORWARD -d $network -j ACCEPT 187 | iptables -A FORWARD -s $network -j ACCEPT 188 | iptables -A OUTPUT -d $network -j ACCEPT 189 | [[ -e $route ]] && grep -q "^$network\$" $route || echo "$network" >>$route 190 | } 191 | 192 | ### vpn_auth: configure authentication username and password 193 | # Arguments: 194 | # user) user name on VPN 195 | # pass) password on VPN 196 | # Return: configured auth file 197 | vpn_auth() { local user="$1" pass="$2" 198 | echo "$user" >$auth 199 | echo "$pass" >>$auth 200 | chmod 0600 $auth 201 | } 202 | 203 | ### vpn: setup openvpn client 204 | # Arguments: 205 | # server) VPN GW server 206 | # user) user name on VPN 207 | # pass) password on VPN 208 | # port) port to connect to VPN (optional) 209 | # proto) protocol to connect to VPN (optional) 210 | # Return: configured .ovpn file 211 | vpn() { local server="$1" user="$2" pass="$3" port="${4:-1194}" proto=${5:-udp}\ 212 | i pem="$(\ls $dir/*.pem 2>&-)" 213 | 214 | echo "client" >$conf 215 | echo "dev tun" >>$conf 216 | echo "proto $proto" >>$conf 217 | for i in $(sed 's/:/ /g' <<< $server); do 218 | echo "remote $i $port" >>$conf 219 | done 220 | [[ $server =~ : ]] && echo "remote-random" >>$conf 221 | echo "resolv-retry infinite" >>$conf 222 | echo "keepalive 10 60" >>$conf 223 | echo "nobind" >>$conf 224 | echo "persist-key" >>$conf 225 | echo "persist-tun" >>$conf 226 | [[ "${CIPHER:-}" ]] && echo "cipher $CIPHER" >>$conf 227 | [[ "${AUTH:-}" ]] && echo "auth $AUTH" >>$conf 228 | echo "tls-client" >>$conf 229 | echo "remote-cert-tls server" >>$conf 230 | echo "comp-lzo" >>$conf 231 | echo "verb 1" >>$conf 232 | echo "reneg-sec 0" >>$conf 233 | echo "disable-occ" >>$conf 234 | echo "fast-io" >>$conf 235 | echo "ca $cert" >>$conf 236 | [[ $(wc -w <<< $pem) -eq 1 ]] && echo "crl-verify $pem" >>$conf 237 | 238 | vpn_auth "$user" "$pass" 239 | 240 | [[ "${FIREWALL:-}" || -e $route6 || -e $route ]] && 241 | [[ "${4:-}" ]] && firewall $port 242 | } 243 | 244 | ### vpnportforward: setup vpn port forwarding 245 | # Arguments: 246 | # port) forwarded port 247 | # protocol) optional protocol (defaults to TCP) 248 | # Return: configured NAT rule 249 | vpnportforward() { local port="$1" protocol="${2:-tcp}" 250 | ip6tables -A INPUT -p $protocol -m $protocol --dport $port -j ACCEPT \ 251 | 2>/dev/null 252 | iptables -A INPUT -p $protocol -m $protocol --dport $port -j ACCEPT 253 | echo "Setup forwarded port: $port $protocol" 254 | } 255 | 256 | ### usage: Help 257 | # Arguments: 258 | # none) 259 | # Return: Help text 260 | usage() { local RC="${1:-0}" 261 | echo "Usage: ${0##*/} [-opt] [command] 262 | Options (fields in '[]' are optional, '<>' are required): 263 | -h This help 264 | -c '' Configure an authentication password to open the cert 265 | required arg: '' 266 | password to access the certificate file 267 | -a '' Configure authentication username and password 268 | -D Don't use the connection as the default route 269 | -d Use the VPN provider's DNS resolvers 270 | -f '[port]' Firewall rules so that only the VPN and DNS are allowed to 271 | send internet traffic (IE if VPN is down it's offline) 272 | optional arg: [port] to use, instead of default 273 | -m '' Maximum Segment Size 274 | required arg: '' 275 | -o '' Allow to pass any arguments directly to openvpn 276 | required arg: '' 277 | could be any string matching openvpn arguments 278 | i.e '--arg1 value --arg2 value' 279 | -p '[;protocol]' Forward port 280 | required arg: '' 281 | optional arg: [protocol] to use instead of default (tcp) 282 | -R '' CIDR IPv6 network (IE fe00:d34d:b33f::/64) 283 | required arg: '' 284 | add a route to (allows replies once the VPN is up) 285 | -r '' CIDR network (IE 192.168.1.0/24) 286 | required arg: '' 287 | add a route to (allows replies once the VPN is up) 288 | -v '' Configure OpenVPN 289 | required arg: ';;' 290 | to connect to (multiple servers are separated by :) 291 | to authenticate as 292 | to authenticate with 293 | optional args: 294 | [port] to use, instead of default 295 | [proto] to use, instead of udp (IE, tcp) 296 | 297 | The 'command' (if provided and valid) will be run instead of openvpn 298 | " >&2 299 | exit $RC 300 | } 301 | 302 | dir="/vpn" 303 | auth="$dir/vpn.auth" 304 | cert_auth="$dir/vpn.cert_auth" 305 | conf="$dir/vpn.conf" 306 | cert="$dir/vpn-ca.crt" 307 | firewall_cust="$dir/.firewall_cust" 308 | route="$dir/.firewall" 309 | route6="$dir/.firewall6" 310 | export ext_args="--script-security 2 --redirect-gateway def1" 311 | [[ -f $conf ]] || { [[ $(ls -d $dir/*|egrep '\.(conf|ovpn)$' 2>&-|wc -w) -eq 1 \ 312 | ]] && conf="$(ls -d $dir/* | egrep '\.(conf|ovpn)$' 2>&-)"; } 313 | [[ -f $cert ]] || { [[ $(ls -d $dir/* | egrep '\.ce?rt$' 2>&- | wc -w) -eq 1 \ 314 | ]] && cert="$(ls -d $dir/* | egrep '\.ce?rt$' 2>&-)"; } 315 | 316 | while getopts ":hc:Ddf:a:m:o:p:R:r:v:" opt; do 317 | case "$opt" in 318 | h) usage ;; 319 | a) VPN_AUTH="$OPTARG" ;; 320 | c) CERT_AUTH="$OPTARG" ;; 321 | D) DEFAULT_GATEWAY="false" ;; 322 | d) DNS="true" ;; 323 | f) FIREWALL="$OPTARG" ;; 324 | m) MSS="$OPTARG" ;; 325 | o) OTHER_ARGS+=" $OPTARG" ;; 326 | p) export VPNPORT$OPTIND="$OPTARG" ;; 327 | R) return_route6 "$OPTARG" ;; 328 | r) return_route "$OPTARG" ;; 329 | v) VPN="$OPTARG" ;; 330 | "?") echo "Unknown option: -$OPTARG"; usage 1 ;; 331 | ":") echo "No argument value for option: -$OPTARG"; usage 2 ;; 332 | esac 333 | done 334 | shift $(( OPTIND - 1 )) 335 | 336 | [[ "${CERT_AUTH:-}" ]] && cert_auth "$CERT_AUTH" 337 | [[ "${DNS:-}" ]] && dns 338 | [[ "${GROUPID:-}" =~ ^[0-9]+$ ]] && groupmod -g $GROUPID -o vpn 339 | [[ ! -z "${FIREWALL+x}" || -e $route6 || -e $route ]] &&firewall "${FIREWALL:-}" 340 | while read i; do 341 | return_route6 "$i" 342 | done < <(env | awk '/^ROUTE6[=_]/ {sub (/^[^=]*=/, "", $0); print}') 343 | while read i; do 344 | return_route "$i" 345 | done < <(env | awk '/^ROUTE[=_]/ {sub (/^[^=]*=/, "", $0); print}') 346 | [[ "${VPN_AUTH:-}" ]] && 347 | eval vpn_auth $(sed 's/^/"/; s/$/"/; s/;/" "/g' <<< $VPN_AUTH) 348 | [[ "${VPN_FILES:-}" ]] && { [[ -e $dir/$(cut -d';' -f1 <<< $VPN_FILES) ]] && 349 | conf=$dir/$(cut -d';' -f1 <<< $VPN_FILES) 350 | [[ -e $dir/$(cut -d';' -f2 <<< $VPN_FILES) ]] && 351 | cert=$dir/$(cut -d';' -f2 <<< $VPN_FILES); } 352 | [[ "${VPN:-}" ]] && eval vpn $(sed 's/^/"/; s/$/"/; s/;/" "/g' <<< $VPN) 353 | while read i; do 354 | eval vpnportforward $(sed 's/^/"/; s/$/"/; s/;/" "/g' <<< $i) 355 | done < <(env | awk '/^VPNPORT[0-9=_]/ {sub (/^[^=]*=/, "", $0); print}') 356 | 357 | global_return_routes 358 | 359 | [[ ${DEFAULT_GATEWAY:-} == "false" ]] && 360 | ext_args=$(sed 's/ --redirect-gateway def1//' <<< $ext_args) 361 | [[ -e $auth ]] && ext_args+=" --auth-user-pass $auth" 362 | [[ -e $cert_auth ]] && ext_args+=" --askpass $cert_auth" 363 | 364 | if [[ $# -ge 1 && -x $(which $1 2>&-) ]]; then 365 | exec "$@" 366 | elif [[ $# -ge 1 ]]; then 367 | echo "ERROR: command not found: $1" 368 | exit 13 369 | elif ps -ef | egrep -v 'grep|openvpn.sh' | grep -q openvpn; then 370 | echo "Service already running, please restart container to apply changes" 371 | else 372 | mkdir -p /dev/net 373 | [[ -c /dev/net/tun ]] || mknod -m 0666 /dev/net/tun c 10 200 374 | [[ -e $conf ]] || { echo "ERROR: VPN not configured!"; sleep 120; } 375 | [[ -e $cert ]] || grep -Eq '^ *(|ca +)' $conf || 376 | { echo "ERROR: VPN CA cert missing!"; sleep 120; } 377 | set -x 378 | exec sg vpn -c "openvpn --cd $dir --config $conf $ext_args \ 379 | ${OTHER_ARGS:-} ${MSS:+--fragment $MSS --mssfix}" 380 | fi --------------------------------------------------------------------------------