From 8145809e22c843c3bfc1ff5109fd36c7a900810f Mon Sep 17 00:00:00 2001 From: Vadim Babadzhanyan Date: Mon, 19 Aug 2024 00:18:09 +0300 Subject: [PATCH] Feat expiration date (#1296) Closes #1287 Co-authored-by: Vadim Babadzhanyan --- .editorconfig | 23 +++++++++++++++++++ README.md | 19 ++++++++------- docker-compose.yml | 3 ++- src/config.js | 1 + src/lib/Server.js | 25 +++++++++++++++++++- src/lib/WireGuard.js | 51 +++++++++++++++++++++++++++++++++++++---- src/package-lock.json | 24 +++++++++++++++++++ src/package.json | 5 ++-- src/www/css/app.css | 12 ++++++++++ src/www/index.html | 40 ++++++++++++++++++++++++++++++-- src/www/js/api.js | 22 ++++++++++++++++-- src/www/js/app.js | 29 ++++++++++++++++++++++- src/www/js/i18n.js | 4 ++++ src/www/src/css/app.css | 4 ++++ 14 files changed, 241 insertions(+), 21 deletions(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..2d06f13e --- /dev/null +++ b/.editorconfig @@ -0,0 +1,23 @@ +# http://editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +# The JSON files contain newlines inconsistently +[*.json] +insert_final_newline = ignore + +# Minified JavaScript files shouldn't be changed +[**.min.js] +indent_style = ignore +insert_final_newline = ignore + +[*.md] +trim_trailing_whitespace = false + diff --git a/README.md b/README.md index 199ae82a..a282d2d6 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ You have found the easiest way to install & manage WireGuard on any Linux host! * Multilanguage Support * UI_TRAFFIC_STATS (default off) * UI_SHOW_LINKS (default off) +* WG_ENABLE_EXPIRES_TIME (default off) ## Requirements @@ -111,19 +112,21 @@ These options can be configured by setting environment variables using `-e KEY=" | `WG_CONFIG_PORT`| `51820` | `12345` | The UDP port used on [Home Assistant Plugin](https://github.com/adriy-be/homeassistant-addons-jdeath/tree/main/wgeasy) | `WG_MTU` | `null` | `1420` | The MTU the clients will use. Server uses default WG MTU. | | `WG_PERSISTENT_KEEPALIVE` | `0` | `25` | Value in seconds to keep the "connection" open. If this value is 0, then connections won't be kept alive. | -| `WG_DEFAULT_ADDRESS` | `10.8.0.x` | `10.6.0.x` | Clients IP address range. | -| `WG_DEFAULT_DNS` | `1.1.1.1` | `8.8.8.8, 8.8.4.4` | DNS server clients will use. If set to blank value, clients will not use any DNS. | -| `WG_ALLOWED_IPS` | `0.0.0.0/0, ::/0` | `192.168.15.0/24, 10.0.1.0/24` | Allowed IPs clients will use. | +| `WG_DEFAULT_ADDRESS` | `10.8.0.x` | `10.6.0.x` | Clients IP address range. | +| `WG_DEFAULT_DNS` | `1.1.1.1` | `8.8.8.8, 8.8.4.4` | DNS server clients will use. If set to blank value, clients will not use any DNS. | +| `WG_ALLOWED_IPS` | `0.0.0.0/0, ::/0` | `192.168.15.0/24, 10.0.1.0/24` | Allowed IPs clients will use. | | `WG_PRE_UP` | `...` | - | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L19) for the default value. | | `WG_POST_UP` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L20) for the default value. | | `WG_PRE_DOWN` | `...` | - | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L27) for the default value. | | `WG_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L28) for the default value. | +| `WG_ENABLE_EXPIRES_TIME` | `false` | `true` | Enable expire time for clients | | `LANG` | `en` | `de` | Web UI language (Supports: en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th, hi). | -| `UI_TRAFFIC_STATS` | `false` | `true` | Enable detailed RX / TX client stats in Web UI | -| `UI_CHART_TYPE` | `0` | `1` | UI_CHART_TYPE=0 # Charts disabled, UI_CHART_TYPE=1 # Line chart, UI_CHART_TYPE=2 # Area chart, UI_CHART_TYPE=3 # Bar chart | -| `UI_SHOW_LINKS` | `false` | `true` | Enable display of a short download link in Web UI | -| `MAX_AGE` | `0` | `1440` | The maximum age of Web UI sessions in minutes. `0` means that the session will exist until the browser is closed. | -| `UI_ENABLE_SORT_CLIENTS` | `false` | `true` | Enable UI sort clients by name | +| `UI_TRAFFIC_STATS` | `false` | `true` | Enable detailed RX / TX client stats in Web UI | +| `UI_CHART_TYPE` | `0` | `1` | UI_CHART_TYPE=0 # Charts disabled, UI_CHART_TYPE=1 # Line chart, UI_CHART_TYPE=2 # Area chart, UI_CHART_TYPE=3 # Bar chart | +| `UI_SHOW_LINKS` | `false` | `true` | Enable display of a short download link in Web UI | +| `MAX_AGE` | `0` | `1440` | The maximum age of Web UI sessions in minutes. `0` means that the session will exist until the browser is closed. | +| `UI_ENABLE_SORT_CLIENTS` | `false` | `true` | Enable UI sort clients by name | + > If you change `WG_PORT`, make sure to also change the exposed port. diff --git a/docker-compose.yml b/docker-compose.yml index 379c0d54..9de55e32 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,7 +6,7 @@ services: environment: # Change Language: # (Supports: en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th, hi) - - LANG=de + - LANG=en # ⚠️ Required: # Change this to your host's public address - WG_HOST=raspberrypi.local @@ -29,6 +29,7 @@ services: # - UI_CHART_TYPE=0 # (0 Charts disabled, 1 # Line chart, 2 # Area chart, 3 # Bar chart) # - UI_SHOW_LINKS=true # - UI_ENABLE_SORT_CLIENTS=true + # - WG_ENABLE_EXPIRES_TIME=true image: ghcr.io/wg-easy/wg-easy container_name: wg-easy diff --git a/src/config.js b/src/config.js index d7a7831d..6168e589 100644 --- a/src/config.js +++ b/src/config.js @@ -40,3 +40,4 @@ module.exports.UI_TRAFFIC_STATS = process.env.UI_TRAFFIC_STATS || 'false'; module.exports.UI_CHART_TYPE = process.env.UI_CHART_TYPE || 0; module.exports.UI_SHOW_LINKS = process.env.UI_SHOW_LINKS || 'false'; module.exports.UI_ENABLE_SORT_CLIENTS = process.env.UI_ENABLE_SORT_CLIENTS || 'false'; +module.exports.WG_ENABLE_EXPIRES_TIME = process.env.WG_ENABLE_EXPIRES_TIME || 'false'; diff --git a/src/lib/Server.js b/src/lib/Server.js index 56780431..40b9bb1f 100644 --- a/src/lib/Server.js +++ b/src/lib/Server.js @@ -35,6 +35,7 @@ const { UI_CHART_TYPE, UI_SHOW_LINKS, UI_ENABLE_SORT_CLIENTS, + WG_ENABLE_EXPIRES_TIME, } = require('../config'); const requiresPassword = !!PASSWORD_HASH; @@ -59,6 +60,11 @@ const isPasswordValid = (password) => { return false; }; +const cronJobEveryMinute = async () => { + await WireGuard.cronJobEveryMinute(); + setTimeout(cronJobEveryMinute, 60 * 1000); +}; + module.exports = class Server { constructor() { @@ -110,6 +116,11 @@ module.exports = class Server { return `${UI_ENABLE_SORT_CLIENTS}`; })) + .get('/api/wg-enable-expire-time', defineEventHandler((event) => { + setHeader(event, 'Content-Type', 'application/json'); + return `${WG_ENABLE_EXPIRES_TIME}`; + })) + // Authentication .get('/api/session', defineEventHandler((event) => { const authenticated = requiresPassword @@ -224,7 +235,8 @@ module.exports = class Server { })) .post('/api/wireguard/client', defineEventHandler(async (event) => { const { name } = await readBody(event); - await WireGuard.createClient({ name }); + const { expiredDate } = await readBody(event); + await WireGuard.createClient({ name, expiredDate }); return { success: true }; })) .delete('/api/wireguard/client/:clientId', defineEventHandler(async (event) => { @@ -265,6 +277,15 @@ module.exports = class Server { const { address } = await readBody(event); await WireGuard.updateClientAddress({ clientId, address }); return { success: true }; + })) + .put('/api/wireguard/client/:clientId/expireDate', defineEventHandler(async (event) => { + const clientId = getRouterParam(event, 'clientId'); + if (clientId === '__proto__' || clientId === 'constructor' || clientId === 'prototype') { + throw createError({ status: 403 }); + } + const { expireDate } = await readBody(event); + await WireGuard.updateClientExpireDate({ clientId, expireDate }); + return { success: true }; })); const safePathJoin = (base, target) => { @@ -340,6 +361,8 @@ module.exports = class Server { createServer(toNodeListener(app)).listen(PORT, WEBUI_HOST); debug(`Listening on http://${WEBUI_HOST}:${PORT}`); + + cronJobEveryMinute(); } }; diff --git a/src/lib/WireGuard.js b/src/lib/WireGuard.js index 95b8c9d1..120dd238 100644 --- a/src/lib/WireGuard.js +++ b/src/lib/WireGuard.js @@ -24,6 +24,7 @@ const { WG_POST_UP, WG_PRE_DOWN, WG_POST_DOWN, + WG_ENABLE_EXPIRES_TIME, } = require('../config'); module.exports = class WireGuard { @@ -147,6 +148,9 @@ ${client.preSharedKey ? `PresharedKey = ${client.preSharedKey}\n` : '' publicKey: client.publicKey, createdAt: new Date(client.createdAt), updatedAt: new Date(client.updatedAt), + expiredAt: client.expiredAt !== null + ? new Date(client.expiredAt) + : null, allowedIPs: client.allowedIPs, hash: Math.abs(CRC32.str(clientId)).toString(16), downloadableConfig: 'privateKey' in client, @@ -227,7 +231,7 @@ Endpoint = ${WG_HOST}:${WG_CONFIG_PORT}`; }); } - async createClient({ name }) { + async createClient({ name, expiredDate }) { if (!name) { throw new Error('Missing: Name'); } @@ -256,7 +260,6 @@ Endpoint = ${WG_HOST}:${WG_CONFIG_PORT}`; if (!address) { throw new Error('Maximum number of clients reached.'); } - // Create Client const id = crypto.randomUUID(); const client = { @@ -269,10 +272,15 @@ Endpoint = ${WG_HOST}:${WG_CONFIG_PORT}`; createdAt: new Date(), updatedAt: new Date(), - + expiredAt: null, enabled: true, }; - + if (expiredDate) { + client.expiredAt = new Date(expiredDate); + client.expiredAt.setHours(23); + client.expiredAt.setMinutes(59); + client.expiredAt.setSeconds(59); + } config.clients[id] = client; await this.saveConfig(); @@ -329,6 +337,22 @@ Endpoint = ${WG_HOST}:${WG_CONFIG_PORT}`; await this.saveConfig(); } + async updateClientExpireDate({ clientId, expireDate }) { + const client = await this.getClient({ clientId }); + + if (expireDate) { + client.expiredAt = new Date(expireDate); + client.expiredAt.setHours(23); + client.expiredAt.setMinutes(59); + client.expiredAt.setSeconds(59); + } else { + client.expiredAt = null; + } + client.updatedAt = new Date(); + + await this.saveConfig(); + } + async __reloadConfig() { await this.__buildConfig(); await this.__syncConfig(); @@ -355,4 +379,23 @@ Endpoint = ${WG_HOST}:${WG_CONFIG_PORT}`; await Util.exec('wg-quick down wg0').catch(() => {}); } + async cronJobEveryMinute() { + const config = await this.getConfig(); + if (WG_ENABLE_EXPIRES_TIME === 'true') { + let needSaveConfig = false; + for (const client of Object.values(config.clients)) { + if (client.enabled !== true) continue; + if (client.expiredAt !== null && new Date() > new Date(client.expiredAt)) { + debug(`Client ${client.id} expired.`); + needSaveConfig = true; + client.enabled = false; + client.updatedAt = new Date(); + } + } + if (needSaveConfig) { + await this.saveConfig(); + } + } + } + }; diff --git a/src/package-lock.json b/src/package-lock.json index b1ff1375..09668cd6 100644 --- a/src/package-lock.json +++ b/src/package-lock.json @@ -17,6 +17,7 @@ "qrcode": "^1.5.4" }, "devDependencies": { + "@tailwindcss/forms": "^0.5.7", "eslint-config-athom": "^3.1.3", "nodemon": "^3.1.4", "tailwindcss": "^3.4.10" @@ -452,6 +453,19 @@ "node": ">=14" } }, + "node_modules/@tailwindcss/forms": { + "version": "0.5.7", + "resolved": "https://registry.npmjs.org/@tailwindcss/forms/-/forms-0.5.7.tgz", + "integrity": "sha512-QE7X69iQI+ZXwldE+rzasvbJiyV/ju1FGHH0Qn2W3FKbuYtqp8LKcy6iSw79fVUT5/Vvf+0XgLCeYVG+UV6hOw==", + "dev": true, + "license": "MIT", + "dependencies": { + "mini-svg-data-uri": "^1.2.3" + }, + "peerDependencies": { + "tailwindcss": ">=3.0.0 || >= 3.0.0-alpha.1" + } + }, "node_modules/@types/json-schema": { "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", @@ -3261,6 +3275,16 @@ "node": ">=10.0.0" } }, + "node_modules/mini-svg-data-uri": { + "version": "1.4.4", + "resolved": "https://registry.npmjs.org/mini-svg-data-uri/-/mini-svg-data-uri-1.4.4.tgz", + "integrity": "sha512-r9deDe9p5FJUPZAk3A59wGH7Ii9YrjjWw0jmw/liSbHl2CHiyXj6FcDXDu2K3TjVAXqiJdaw3xxwlZZr9E6nHg==", + "dev": true, + "license": "MIT", + "bin": { + "mini-svg-data-uri": "cli.js" + } + }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", diff --git a/src/package.json b/src/package.json index c90bbc9f..b0032c2a 100644 --- a/src/package.json +++ b/src/package.json @@ -16,13 +16,14 @@ "license": "CC BY-NC-SA 4.0", "dependencies": { "bcryptjs": "^2.4.3", + "crc-32": "^1.2.2", "debug": "^4.3.6", "express-session": "^1.18.0", "h3": "^1.12.0", - "qrcode": "^1.5.4", - "crc-32": "^1.2.2" + "qrcode": "^1.5.4" }, "devDependencies": { + "@tailwindcss/forms": "^0.5.7", "eslint-config-athom": "^3.1.3", "nodemon": "^3.1.4", "tailwindcss": "^3.4.10" diff --git a/src/www/css/app.css b/src/www/css/app.css index ae3fc3c3..1b5515a9 100644 --- a/src/www/css/app.css +++ b/src/www/css/app.css @@ -714,6 +714,10 @@ video { margin-bottom: 2.5rem; } +.mb-2 { + margin-bottom: 0.5rem; +} + .mb-4 { margin-bottom: 1rem; } @@ -1160,6 +1164,10 @@ video { fill: #4b5563; } +.p-0 { + padding: 0px; +} + .p-1 { padding: 0.25rem; } @@ -1465,6 +1473,10 @@ video { cursor: default; } +.p-0 { + padding: 0; +} + .last\:border-b-0:last-child { border-bottom-width: 0px; } diff --git a/src/www/index.html b/src/www/index.html index 34bf718f..a611e9c0 100644 --- a/src/www/index.html +++ b/src/www/index.html @@ -127,7 +127,7 @@ -