Commit Graph

407 Commits

Author SHA1 Message Date
Stanislas
2ecd4bd6e4 feat: add Data Channel Offload (DCO) availability check (#1331)
- Add detection and logging for OpenVPN Data Channel Offload (DCO)
support during installation
- DCO is a kernel acceleration feature (merged into Linux 6.16) that
improves VPN performance
- Add DCO documentation to README
2025-12-10 18:53:45 +01:00
renovate[bot]
3e46cfb3bd chore(deps): update dependency openvpn/easy-rsa to v3.2.4 (#1335)
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [OpenVPN/easy-rsa](https://redirect.github.com/OpenVPN/easy-rsa) |
patch | `3.2.3` -> `3.2.4` |

---

### Release Notes

<details>
<summary>OpenVPN/easy-rsa (OpenVPN/easy-rsa)</summary>

###
[`v3.2.4`](https://redirect.github.com/OpenVPN/easy-rsa/releases/tag/v3.2.4):
3.2.4

[Compare
Source](https://redirect.github.com/OpenVPN/easy-rsa/compare/v3.2.3...v3.2.4)

#### What's Changed

- export-p12: Move inline file to 'inline/private' folder by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1356](https://redirect.github.com/OpenVPN/easy-rsa/pull/1356)
- Restructure help by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1363](https://redirect.github.com/OpenVPN/easy-rsa/pull/1363)
- New global option: `--no-lockfile` = env-var: `$EASYRSA_NO_LOCKFILE`
by [@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1364](https://redirect.github.com/OpenVPN/easy-rsa/pull/1364)
- Restructure `verify_working_env()` by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1367](https://redirect.github.com/OpenVPN/easy-rsa/pull/1367)
- Improve verbose by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1368](https://redirect.github.com/OpenVPN/easy-rsa/pull/1368)
- Windows easyrsa-shell-init.sh: Replace 'read -p' by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1371](https://redirect.github.com/OpenVPN/easy-rsa/pull/1371)
- mutual\_exclusions(): Include basic checks for --startdate/--enddate
by [@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1372](https://redirect.github.com/OpenVPN/easy-rsa/pull/1372)
- easyrsa-shell-init.sh: Allow Easy-RSA to use '\User$HOME' directory by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1374](https://redirect.github.com/OpenVPN/easy-rsa/pull/1374)
- Remove 'easyrsa\_mkdir()', use only 'mkdir' by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1376](https://redirect.github.com/OpenVPN/easy-rsa/pull/1376)
- revoke: Archive request and private key files and expand help by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1378](https://redirect.github.com/OpenVPN/easy-rsa/pull/1378)
- set\_no\_clobber(): Add simple error detection by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1379](https://redirect.github.com/OpenVPN/easy-rsa/pull/1379)
- random: Use verify\_working\_env() to configure EASYRSA\_OPENSSL by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1381](https://redirect.github.com/OpenVPN/easy-rsa/pull/1381)
- self\_sign(): Force use of Easy-RSA X509-type file 'selfsign' by
[@&#8203;TinCanTech](https://redirect.github.com/TinCanTech) in
[#&#8203;1383](https://redirect.github.com/OpenVPN/easy-rsa/pull/1383)

**Full Changelog**:
<https://github.com/OpenVPN/easy-rsa/compare/v3.2.3...v3.2.4>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/).
View the [repository job
log](https://developer.mend.io/github/angristan/openvpn-install).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi40Mi4yIiwidXBkYXRlZEluVmVyIjoiNDIuNDIuMiIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6W119-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-12-10 18:39:39 +01:00
Stanislas
b9a1650027 feat: drop Amazon Linux 2 support (#1332)
## Summary

- Remove Amazon Linux 2 support from the installer
- Amazon Linux 2023 remains fully supported

## Motivation

Amazon Linux 2 is reaching EOL.

Additionally, Amazon Linux 2 ships with **OpenSSL 1.0.2k** (from 2017)
which is incompatible with Easy-RSA 3.2.x. The newer Easy-RSA versions
use `openssl x509 -ext` which doesn't exist in OpenSSL 1.0.x, causing
certificate generation to fail.

This blocks our ability to upgrade Easy-RSA:
bda450948a

## Changes

- Updated OS detection to reject Amazon Linux 2 with a clear message
- Removed Amazon Linux 2 specific code paths (EPEL installation, yum
commands)
- Removed from CI test matrix
- Updated README supported distributions table
- Updated Makefile test targets
- Also, add Amazon Linux 2023 Unbound handling
2025-12-10 17:54:00 +01:00
Stanislas Lange
bda450948a feat: update EasyRSA version and revoke command 2025-12-10 16:58:35 +01:00
Stanislas
c0fcf91972 feat: add ChaCha20-Poly1305 cipher support (#1330)
## Summary

- Add `CHACHA20-POLY1305` as a data channel cipher option
- Add `ECDHE-*-CHACHA20-POLY1305` control channel cipher options  
- Add version check (requires OpenVPN 2.5+)
- Update README documentation

ChaCha20-Poly1305 is particularly useful on devices without hardware AES
acceleration (AES-NI), such as ARM-based devices (Raspberry Pi, etc.)
and older CPUs, where it can provide better performance than AES.

Closes #1244 Closes #190
2025-12-10 00:11:25 +01:00
Stanislas
ffcffac061 refactor: improve certificate duration variable naming (#1329)
## Summary

- Rename constants to `DEFAULT_CERT_VALIDITY_DURATION_DAYS` and
`DEFAULT_CRL_VALIDITY_DURATION_DAYS` for clarity
- Replace all hardcoded `3650` values with the constants
- Split `DAYS_VALID` into `CLIENT_CERT_DURATION_DAYS` and
`SERVER_CERT_DURATION_DAYS` for more granular control over client vs
server certificate validity
- Increase CRL validity to 15 years (5475 days) to provide a 5-year
safety buffer over the default 10-year certificate validity
- Update README with new headless install variables

## Breaking changes

- `DAYS_VALID` environment variable is replaced by
`CLIENT_CERT_DURATION_DAYS` and `SERVER_CERT_DURATION_DAYS`
2025-12-09 23:33:57 +01:00
Stanislas
6b09270347 feat: add certificate renewal functionality (#1328)
## Summary

- Add certificate renewal for both client and server certificates
- Allow custom validity period during renewal (prompts user, defaults to
3650 days)
- Show expiry info inline in menus (e.g., "Renew the server certificate
(expires in 3542 days)")
- Regenerate `.ovpn` files after client renewal
- Restart OpenVPN service after server renewal
- Extract reusable helper functions to reduce code duplication
- Add robust input validation and error handling

## New menu option

```
What do you want to do?
   1) Add a new user
   2) Revoke existing user
   3) Renew certificate        ← NEW
   4) Remove OpenVPN
   5) Exit
```

## Renewal submenu

```
What do you want to renew?
   1) Renew a client certificate
   2) Renew the server certificate (expires in 3542 days)
   3) Back to main menu
```

Client list shows expiry for each:
```
Select the existing client certificate you want to renew
     1) alice (expires in 3542 days)
     2) bob (expires in 30 days)
     3) charlie (EXPIRED 5 days ago)
```

## Helper functions added

Extracted common code into reusable functions:
- `getHomeDir()` - home directory detection
- `regenerateCRL()` - CRL regeneration after cert changes
- `generateClientConfig()` - .ovpn file generation  
- `selectClient()` - client listing with optional expiry display
- `getDaysUntilExpiry()` - certificate expiry calculation
- `formatExpiry()` - human-readable expiry formatting

## Test plan

- [x] Client certificate renewal tested in Docker CI
- [x] Server certificate renewal tested in Docker CI
- [x] Certificate validity verified after renewal (~3650 days)
- [x] VPN connectivity tested with renewed certificate

Closes #974 #1002 #1228 #1060
2025-12-09 21:49:19 +01:00
Stanislas Lange
fb2041d9bb Improve command logging in run_cmd function 2025-12-09 21:41:08 +01:00
Omid Shojaee
625821dfd0 Allow custom certificate duration when creating clients (#1250)
For those who need it, the script asks for how many days the new client
should be valid. This defaults to 3650 days. Then it sets the
```EASYRSA_CERT_EXPIRE``` variable accordingly.

This script is meant to be simple which means it is for those who are
not tech-savvy to handle the complex task of installing and configuring
OpenVPN.

However if the user has a large number of clients and all of them are
valid for 10 years, it is very hard to keep track of them. This PR helps
them to set a reasonable validity period, while the default is the same.

---------

Co-authored-by: Stanislas Lange <git@slange.me>
2025-12-09 20:04:29 +01:00
Stanislas
8bd0c73f8f Use official OpenVPN repositories for latest stable versions (#1323)
## Summary

- Install OpenVPN from official upstream repositories instead of
distribution packages
- Gets the latest stable releases with security fixes and new features
- Properly cleans up repos and GPG keys on uninstall

## Repository sources

| OS | Repository |
|---|---|
| Debian/Ubuntu | `build.openvpn.net/debian/openvpn/stable` |
| CentOS/Oracle/Fedora | Fedora Copr `@OpenVPN/openvpn-release-2.6` |
| Amazon Linux/Arch | Distribution packages (no official repo available)
|

## Changes

- Add `installOpenVPNRepo()` function to configure official repos before
package installation
- Remove duplicate package installations between repo setup and install
functions
- Clean up repos and GPG keys during uninstall
- Standardize `log_success` (`[OK]`) for major milestones only


---

Close https://github.com/angristan/openvpn-install/pull/1294
2025-12-09 19:45:56 +01:00
Stanislas Lange
b23517dbb0 Fix MULTI_CLIENT prompt blocking auto-install mode
The duplicate-cn feature added an interactive prompt that wasn't
following the auto-install pattern, causing the script to hang
when running with AUTO_INSTALL=y.
2025-12-09 18:30:57 +01:00
Shahzain Ali
9e439b60ad Add option to allow multiple devices per client profile (duplicate-cn) (#1278)
Added duplicate-cn for connecting multiple clients using same .ovpn

---------

Co-authored-by: Stanislas Lange <git@slange.me>
2025-12-09 18:12:23 +01:00
Stanislas
004fbb477a Add structured logging system with color-coded output and file logging (#1321)
## Summary
- Add comprehensive logging system with color-coded log levels ([INFO],
[WARN], [ERROR], [OK])
- Wrap all command executions with `run_cmd()` to capture output and
prevent leaks to stdout
- Add file logging with timestamps (default: `openvpn-install.log`)
- Suppress interactive prompts in auto-install mode for cleaner
CI/scripted usage
- Show log file location hint on errors for easier debugging

## Changes
- **openvpn-install.sh**: New logging functions (`log_info`, `log_warn`,
`log_error`, `log_fatal`, `log_success`, `log_prompt`, `log_header`,
`log_menu`, `run_cmd`), all `echo` statements converted to use logging
functions
- **test/validate-output.sh**: New E2E validator that ensures all script
output uses proper log formatting (catches raw echo leaks)
- **test/server-entrypoint.sh**: Integrates output validation into
Docker tests
- **test/Dockerfile.server**: Copies validation script into container

## Configuration
- `VERBOSE=1` - Show command output in terminal
- `LOG_FILE=path` - Customize log location (default:
`openvpn-install.log`)
- `LOG_FILE=""` - Disable file logging
- `FORCE_COLOR=1` - Force colored output in non-TTY environments
2025-12-09 15:52:37 +01:00
Stanislas
a3389c126c Add Docker-based E2E testing (#1320)
### Summary
- Add automated end-to-end testing using Docker to verify the installation script works across 18 Linux distributions
- Add Oracle Linux 9 support to the installation script
- Drop support for EOL distributions (Debian 8/9/10, CentOS 7, Ubuntu 16.04) 
- Disable Digital Ocean droplets based end-to-end tests, let's use docker from now on

### Changes
**New test infrastructure:**
- `test/Dockerfile.server` - Multi-OS server image with `BASE_IMAGE` build arg
- `test/Dockerfile.client` - Ubuntu 24.04 client for connectivity testing
- `test/server-entrypoint.sh` - Runs install script, verifies files exist, asserts iptables NAT rules, starts OpenVPN
- `test/client-entrypoint.sh` - Connects to VPN, verifies tun0 interface, pings gateway
- `docker-compose.yml` - Orchestrates server + client with shared volume
- `.github/workflows/docker-test.yml` - CI matrix testing 18 OS variants
- `.github/workflows/test.yml` - Removed push/PR triggers, now manual only for DO tests
- `Makefile` - Local testing commands (`make test`, `make test-ubuntu-24.04`, etc.)

**Distributions tested (18 total):**
| Family | Versions |
|--------|----------|
| Ubuntu | 18.04, 20.04, 22.04, 24.04 |
| Debian | 11, 12 |
| Fedora | 40, 41 |
| Rocky Linux | 8, 9 |
| AlmaLinux | 8, 9 |
| Oracle Linux | 8, 9 |
| Amazon Linux | 2, 2023 |
| CentOS Stream | 9 |
| Arch Linux | latest |
2025-12-07 12:27:41 +01:00
Stanislas Lange
cc834519ff Fix path to easy-rsa tarball in checksum verification 2025-12-04 23:04:11 +01:00
Stanislas Lange
7e9a713657 Fix shfmt formatting for constant comments 2025-12-04 23:04:11 +01:00
Stanislas Lange
3a0260e9b8 Make openvpn-install.sh executable 2025-12-04 23:04:11 +01:00
Stanislas Lange
b7557dd77f refactor: extract magic numbers to named constants
Move hardcoded values to readonly constants at the top of the script:
- CERT_VALIDITY_DAYS: certificate expiry (10 years)
- CRL_VALIDITY_DAYS: CRL expiry (10 years)
- EASYRSA_VERSION: easy-rsa version
- EASYRSA_SHA256: easy-rsa checksum

This improves maintainability and makes it easier to update these
values in the future.
2025-12-04 23:04:11 +01:00
Stanislas Lange
7304dbaac8 style: reduce shellcheck disables and fix warnings
- Remove unnecessary shellcheck disables (SC2164, SC1072, SC1073, SC1009)
- Add explanatory comments for remaining disables
- Fix SC2181: use direct exit code check instead of $?
- Fix SC2086: quote DH_KEY_SIZE variable
2025-12-04 23:04:11 +01:00
Stanislas Lange
960be1a658 security: add validation for root.hints download
Verify that the downloaded root.hints file is not empty and contains
expected DNS root server content before using it.
2025-12-04 23:04:11 +01:00
Stanislas Lange
94f0967878 security: add SHA256 checksum verification for easy-rsa download
Adds integrity verification to prevent supply chain attacks when
downloading easy-rsa from GitHub releases.
2025-12-04 23:04:11 +01:00
Stanislas Lange
1c5381cc03 fix: correct DNS prompt range from [1-12] to [1-13]
The prompt incorrectly showed [1-12] when option 13 (Custom DNS) is valid.
2025-12-04 23:04:11 +01:00
Stanislas Lange
74dcf67844 fix: remove duplicate echo in resolvePublicIP error message 2025-12-04 23:04:11 +01:00
mags0ft
a680d1f7e3 Correct numerous smaller spelling mistakes 2025-05-01 18:13:27 +02:00
Blake Fleischer
399c3c87b9 Add support for Amazon Linux 2023 out of the box (#1259)
Co-authored-by: Stanislas Lange <git@slange.me>
2025-03-10 10:24:45 +01:00
Raphael Pinto
e1f19e0f24 Fix Public IP detection - Fix issue when seeip.org is unreachable #1241 (#1243)
The script does work when seeip.org is unreachable, so I changed the policy to define the public IP.

It solves the issue #1241

* Timeout limit on each try to solve the IP to avoid long waits;
* Extra public IP providers as failovers;
* the script only will try to solve an IP if the ENDPOINT is empty;

Co-authored-by: Stanislas <github@slange.me>
2024-11-07 20:55:14 +01:00
xiahare
56660eefeb Fix public IP detection: ip.seeip.org has been changed to api.seeip.org (#1252) 2024-11-07 20:39:28 +01:00
Stanislas
a189535563 Set client and server certificates validity to 10 years (#1235)
Prevent #974
2024-07-12 18:16:19 +02:00
David Salbeï
651e36c6cb Fix syntax error on Rocky Linux version check (#1182)
Co-authored-by: David Salbei <david@incolab.fr>
2023-11-20 21:19:13 +01:00
Stanislas Lange
d2556ff235 Add support for CentOS 9 + update supported distributions 2023-01-22 00:57:40 +01:00
Stanislas Lange
2f76bb5e40 Update easy-rsa to 3.1.2 and fix compatibility with Ubuntu 22.04
Based on this patch by @zerodivisi0n: https://github.com/angristan/openvpn-install/issues/1000#issuecomment-1283484772
2023-01-22 00:10:46 +01:00
Stanislas Lange
2a57e89489 Public IP detection: change provider
Close #1076 #924 #1039 #925
2023-01-06 21:39:02 +01:00
Jan Stárek
4ee44c8e46 Use DNS fallback to ifconfig.co (#1066)
Co-authored-by: Jan Stárek <jan.starek@ysoft.com>
2023-01-06 21:33:54 +01:00
Christian Ramelow
9b5361d32d Adds the --no-same-owner flag to tar command (#1070)
Close #1069
2023-01-03 14:09:37 +01:00
xumia
039ebaafe1 Fix the wrong client config when the certificate contains END string (#1067) 2023-01-03 14:06:59 +01:00
Stanislas Lange
86a6d2d3e7 Revert "Use --genkey secret filename instead (#1059)"
This reverts commit 0de56f8f33.
2022-11-21 19:33:24 +01:00
Padraig Doran
0de56f8f33 Use --genkey secret filename instead (#1059)
Fix for:
WARNING: Using --genkey --secret filename is DEPRECATED.  Use --genkey secret filename instead.

https://community.openvpn.net/openvpn/wiki/DeprecatedOptions#Option:--secret

Status 	Removed
Deprecated in: 	OpenVPN v2.4
Removed in: 	OpenVPN v2.5
Affects: 	--genkey
Result if used: 	User Warning printed
Replaced by: 	secret (No leading double dash)
Examples: 	Use --genkey secret filename
Notes:
2022-11-21 19:12:46 +01:00
climbTheStairs
3d0014c026 Fix typo (#957) 2022-01-07 15:54:46 +01:00
randomshell
3a5bcf5d2d Remove unnecessary cipher configuration on Fedora (#762) 2021-12-13 22:50:21 +01:00
Stanislas
8f83781d00 Add retries to curl ifconfig.co (#708)
Fix for #670
2021-12-13 22:48:27 +01:00
TinCanTech
89b591a160 revokeClient: Do not remove revoked client record from index.txt (#945)
Deleting a revoked (^R) client record from index.txt means that the
client will not be listed in the Certificate Revocation List.  This
effectively "unrevokes" the client and allows the client to continue
using the VPN.

Signed-off-by: Richard T Bonhomme <tincantech@protonmail.com>
2021-12-13 22:45:35 +01:00
Woodie-07
506c86f720 Fix a very small typo (#933)
Changed the word 'make' to 'makes' in 'Do you want to use compression? It is not recommended since the VORACLE attack make use of it.'
2021-10-20 14:06:11 +02:00
fabiogiorgione
29deb4cfdf Delete old client references in easy-rsa PKI index (#873) 2021-10-18 10:43:36 +02:00
Łukasz Filipek
7d5c2d962d Enable oracle-epel-release for Oracle Linux (#930) 2021-10-18 10:41:06 +02:00
James Lee
8783719459 Add support for AlmaLinux 8 (#891) 2021-08-27 15:24:53 +02:00
Stanislas
bcd1d8a53e Document Rocky Linux support 2021-07-06 10:56:15 +02:00
derek-j-pitman
1d55f856ae Add support for Rocky Linux 8 (#869) 2021-07-06 10:53:12 +02:00
rvva
bfdf48c392 Add support for Oracle Linux 8 (#810)
Co-authored-by: Stanislas <stanislas.lange@pm.me>
2021-03-22 10:48:15 +01:00
Stanislas Lange
319459ae77 Fix home dir detection
Fix e965518dc7
Fix https://github.com/angristan/openvpn-install/issues/806
2021-03-11 18:59:45 +01:00
Stanislas Lange
e965518dc7 Fix home dir detection when using sudo as root
Close https://github.com/angristan/openvpn-install/issues/780
2021-03-10 22:16:16 +01:00