Merge branch 'master' into ipv6_support_v2

2 years ago · 3d362cb6ad
5 changed files with 81 additions and 50 deletions
--- a/How_to_generate_an_bcrypt_hash.md
+++ b/How_to_generate_an_bcrypt_hash.md
@ -1,5 +1,5 @@
 <!-- created by Mathys Lopinto (@mathys-lopinto) -->
-# How to generate bcrypt
+# How to generate bcrypt hash

 ## Prerequisites
 - Python 3
@ -51,20 +51,51 @@ pip3 install bcrypt
 pip3 install bcrypt --break-system-packages
 ```

-## Generating bcrypt
+## Generating bcrypt hash from the command line
+You can use the following one-liner command to generate a bcrypt hash directly in the cmd/ terminal: 
+```bash
+python3 -c "import bcrypt; password = b'your_password_here'; assert len(password) < 72, 'Password must be less than 72 bytes due to bcrypt limitation'; hashed = bcrypt.hashpw(password, bcrypt.gensalt()); print(f'The hashed password is: {hashed.decode()}'); docker_interpolation = hashed.decode().replace('$', '$$'); print(f'The hashed password for a Docker env is: {docker_interpolation}')" # or python if you run this on Windows. CHANGE your_password_here BY YOUR PASSWORD
+```
+Please change ``your_password_here`` in the line by your own password.
+
+## Generating bcrypt hash from an script file
 ### Do not name the file `bcrypt.py` as it will cause an error.
 Create a python file with the following content:
 ```python
 import bcrypt
+
+# Initial password
 password = b"your_password_here"  # DO NOT REMOVE THE b
+
+# Assert that the password is under 72 bytes
+assert len(password) < 72, "Password must be less than 72 bytes due to bcrypt limitation"
+
+# Generate a salt and hash the password
 hashed = bcrypt.hashpw(password, bcrypt.gensalt())
+
+# Print the hashed password
 print(f'The hashed password is: {hashed.decode()}')

-docker_interpolation= hashed.decode().replace("$", "$$")
-print(f'The hashed password for an docker env is: {docker_interpolation}')
+# Prepare the hashed password for Docker environment variables
+docker_interpolation = hashed.decode().replace("$", "$$")
+print(f'The hashed password for a Docker env is: {docker_interpolation}')
 ```

 Replace `your_password_here` with the password you want to hash.

 Run the python file and you will get the hashed password.
+
+## Get the right hash
 Copy the 2nd line of the output (after the : ) and use it as your hashed password.
+
+__Exemple__
+If the output is:
+```txt
+The hashed password is: $2b$12$NRiL4Kw4dKid.ix2WvZltOmaQBZjoX30shjHJXRVdEGshAxYWXXMe
+The hashed password for an docker env is: $$2b$$12$$NRiL4Kw4dKid.ix2WvZltOmaQBZjoX30shjHJXRVdEGshAxYWXXMe
+``` 
+
+The docker line ``PASSWORD_HASH`` will be:
+```txt
+PASSWORD_HASH=$$2b$$12$$NRiL4Kw4dKid.ix2WvZltOmaQBZjoX30shjHJXRVdEGshAxYWXXMe
+```
--- a/README.md
+++ b/README.md
@ -80,7 +80,7 @@ To automatically install & run wg-easy, simply run:

 > 💡 Replace `YOUR_SERVER_IP` with your WAN IP, or a Dynamic DNS hostname.
 >
-> 💡 Replace `YOUR_ADMIN_PASSWORD_HASH` with a bcrypt password hash to log in on the Web UI.
+> 💡 Replace `YOUR_ADMIN_PASSWORD_HASH` with a bcrypt password hash to log in on the Web UI. See How_to_generate_an_bcrypt_hash.md for know how generate the hash.

 The Web UI will now be available on `http://0.0.0.0:51821`.

@ -99,10 +99,10 @@ Are you enjoying this project? [Buy Emile a beer!](https://github.com/sponsors/W
 These options can be configured by setting environment variables using `-e KEY="VALUE"` in the `docker run` command.

 | Env | Default | Example | Description                                                                                                                                          |
-| - | - | - | - |
+| - | - | - |------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `PORT` | `51821` | `6789` | TCP port for Web UI.                                                                                                                                 |
 | `WEBUI_HOST` | `0.0.0.0` | `localhost` | IP address web UI binds to.                                                                                                                          |
-| `PASSWORD_HASH` | - | `$2y$05$Ci...` | When set, requires a password when logging in to the Web UI. |
+| `PASSWORD_HASH` | - | `$2y$05$Ci...` | When set, requires a password when logging in to the Web UI. See [How to generate an bcrypt hash.md]("https://github.com/wg-easy/wg-easy/blob/master/How_to_generate_an_bcrypt_hash.md") for know how generate the hash. |
 | `PASSWORD` (deprecated) | - | `foobar123` | When set, requires a password when logging in to the Web UI. *(Not used if `PASSWORD_HASH` is set)*                                                  |
 | `WG_HOST` | - | `vpn.myserver.com` | The public hostname of your VPN server.                                                                                                              |
 | `WG_DEVICE` | `eth0` | `ens6f0` | Ethernet device the wireguard traffic should be forwarded through.                                                                                   |
--- a/docker-compose.yml
+++ b/docker-compose.yml
@ -13,7 +13,7 @@ services:

      # Optional:
      # - PASSWORD=foobar123 (deprecated, see readme)
-      # - PASSWORD_HASH=$$2y$$10$$hBCoykrB95WSzuV4fafBzOHWKu9sbyVa34GJr8VV5R/pIelfEMYyG (needs double $$, hash of 'foobar123')
+      # - PASSWORD_HASH=$$2y$$10$$hBCoykrB95WSzuV4fafBzOHWKu9sbyVa34GJr8VV5R/pIelfEMYyG (needs double $$, hash of 'foobar123'; see "How_to_generate_an_bcrypt_hash.md" for generate the hash)
      # - PORT=51821
      # - WG_PORT=51820
      # - WG_CONFIG_PORT=92820
--- a/src/package-lock.json
+++ b/src/package-lock.json
@ -166,9 +166,9 @@
      }
    },
    "node_modules/@eslint-community/regexpp": {
-      "version": "4.10.1",
-      "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.10.1.tgz",
-      "integrity": "sha512-Zm2NGpWELsQAD1xsJzGQpYfvICSsFkEpU0jxBjfdC6uNEWXcHnfs9hScFWtXVDVl+rBQJGrl4g1vcKIejpH9dA==",
+      "version": "4.11.0",
+      "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.0.tgz",
+      "integrity": "sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==",
      "dev": true,
      "engines": {
        "node": "^12.0.0 || ^14.0.0 || >=16.0.0"
@ -2972,9 +2972,9 @@
      "peer": true
    },
    "node_modules/lru-cache": {
-      "version": "10.2.2",
-      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.2.2.tgz",
-      "integrity": "sha512-9hp3Vp2/hFQUiIwKo8XCeFVnrg8Pk3TYNPIR7tJADKi5YfcF7vEaK7avFHTlSy3kOKYaJQaalfEo6YuXdceBOQ==",
+      "version": "10.3.0",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.3.0.tgz",
+      "integrity": "sha512-CQl19J/g+Hbjbv4Y3mFNNXFEL/5t/KCg8POCuUqd4rMKjGG+j1ybER83hxV58zL+dFI1PTkt3GNFSHRt+d8qEQ==",
      "dev": true,
      "engines": {
        "node": "14 || >=16.14"
@ -3484,9 +3484,9 @@
      }
    },
    "node_modules/postcss": {
-      "version": "8.4.38",
-      "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz",
-      "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==",
+      "version": "8.4.39",
+      "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.39.tgz",
+      "integrity": "sha512-0vzE+lAiG7hZl1/9I8yzKLx3aR9Xbof3fBHKunvMfOCYAtMhrsnccJY2iTURb9EZd5+pLuiNV9/c/GZJOHsgIw==",
      "dev": true,
      "funding": [
        {
@ -3504,7 +3504,7 @@
      ],
      "dependencies": {
        "nanoid": "^3.3.7",
-        "picocolors": "^1.0.0",
+        "picocolors": "^1.0.1",
        "source-map-js": "^1.2.0"
      },
      "engines": {
--- a/src/www/js/i18n.js
+++ b/src/www/js/i18n.js
@ -445,27 +445,27 @@ const messages = { // eslint-disable-line no-unused-vars
    password: '密碼',
    signIn: '登入',
    logout: '登出',
-    updateAvailable: '有新版本可用！',
+    updateAvailable: '有新版本可以使用！',
    update: '更新',
-    clients: '客戶',
-    new: '新建',
-    deleteClient: '刪除客戶',
+    clients: '使用者',
+    new: '建立',
+    deleteClient: '刪除使用者',
    deleteDialog1: '您確定要刪除',
-    deleteDialog2: '此操作無法撤銷。',
+    deleteDialog2: '此作業無法復原。',
    cancel: '取消',
    create: '建立',
    createdOn: '建立於 ',
-    lastSeen: '最後訪問於 ',
+    lastSeen: '最後存取於 ',
    totalDownload: '總下載: ',
    totalUpload: '總上傳: ',
-    newClient: '新客戶',
-    disableClient: '禁用客戶',
-    enableClient: '啟用客戶',
-    noClients: '目前沒有客戶。',
-    showQR: '顯示二維碼',
-    downloadConfig: '下載配置',
+    newClient: '新用戶',
+    disableClient: '停用使用者',
+    enableClient: '啟用使用者',
+    noClients: '目前沒有使用者。',
+    showQR: '顯示 QR Code',
+    downloadConfig: '下載 Config 檔',
    madeBy: '由',
-    donate: '捐贈',
+    donate: '抖內',
  },
  it: {
    name: 'Nome',