Enhance bcrypt doc: rename, add one-liner, usage info, and assert
- Rename the file to a more readable name - Add one-liner command for quick execution - Include dedicated paragraph on using the output - Implement assert to prevent bcrypt limitation issues - Comment the python script - Improves clarity and usability of bcrypt documentation - Mention documentation file in docker-compose.yml and README.me file
This commit is contained in:
Mathys Lopinto
parent
436ccac824
commit
4d849fc508
|
|
@ -1,5 +1,5 @@
|
||||||
<!-- created by Mathys Lopinto (@mathys-lopinto) -->
|
<!-- created by Mathys Lopinto (@mathys-lopinto) -->
|
||||||
# How to generate bcrypt
|
# How to generate bcrypt hash
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
- Python 3
|
- Python 3
|
||||||
|
|
@ -51,20 +51,51 @@ pip3 install bcrypt
|
||||||
pip3 install bcrypt --break-system-packages
|
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.
|
### Do not name the file `bcrypt.py` as it will cause an error.
|
||||||
Create a python file with the following content:
|
Create a python file with the following content:
|
||||||
```python
|
```python
|
||||||
import bcrypt
|
import bcrypt
|
||||||
password = b"your_password_here" # DO NOT REMOVE THE b
|
|
||||||
|
# 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())
|
hashed = bcrypt.hashpw(password, bcrypt.gensalt())
|
||||||
|
|
||||||
|
# Print the hashed password
|
||||||
print(f'The hashed password is: {hashed.decode()}')
|
print(f'The hashed password is: {hashed.decode()}')
|
||||||
|
|
||||||
docker_interpolation= hashed.decode().replace("$", "$$")
|
# Prepare the hashed password for Docker environment variables
|
||||||
print(f'The hashed password for an docker env is: {docker_interpolation}')
|
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.
|
Replace `your_password_here` with the password you want to hash.
|
||||||
|
|
||||||
Run the python file and you will get the hashed password.
|
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.
|
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
|
||||||
|
```
|
||||||
44
README.md
44
README.md
|
|
@ -98,28 +98,28 @@ 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.
|
These options can be configured by setting environment variables using `-e KEY="VALUE"` in the `docker run` command.
|
||||||
|
|
||||||
| Env | Default | Example | Description |
|
| Env | Default | Example | Description |
|
||||||
| - | - | - | - |
|
| - | - | - |------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
| `PORT` | `51821` | `6789` | TCP port for Web UI. |
|
| `PORT` | `51821` | `6789` | TCP port for Web UI. |
|
||||||
| `WEBUI_HOST` | `0.0.0.0` | `localhost` | IP address web UI binds to. |
|
| `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]("How_to_generate_an_bcrypt_hash.md") for know how to 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)* |
|
| `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_HOST` | - | `vpn.myserver.com` | The public hostname of your VPN server. |
|
||||||
| `WG_DEVICE` | `eth0` | `ens6f0` | Ethernet device the wireguard traffic should be forwarded through. |
|
| `WG_DEVICE` | `eth0` | `ens6f0` | Ethernet device the wireguard traffic should be forwarded through. |
|
||||||
| `WG_PORT` | `51820` | `12345` | The public UDP port of your VPN server. WireGuard will listen on that (othwise default) inside the Docker container. |
|
| `WG_PORT` | `51820` | `12345` | The public UDP port of your VPN server. WireGuard will listen on that (othwise default) inside the Docker container. |
|
||||||
| `WG_CONFIG_PORT`| `51820` | `12345` | The UDP port used on [Home Assistent Plugin](https://github.com/adriy-be/homeassistant-addons-jdeath/tree/main/wgeasy)
|
| `WG_CONFIG_PORT`| `51820` | `12345` | The UDP port used on [Home Assistent 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_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_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_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_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_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_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_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_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_POST_DOWN` | `...` | `iptables ...` | See [config.js](https://github.com/wg-easy/wg-easy/blob/master/src/config.js#L28) for the default value. |
|
||||||
| `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). |
|
| `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_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_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 |
|
||||||
|
|
||||||
> If you change `WG_PORT`, make sure to also change the exposed port.
|
> If you change `WG_PORT`, make sure to also change the exposed port.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@ services:
|
||||||
|
|
||||||
# Optional:
|
# Optional:
|
||||||
# - PASSWORD=foobar123 (deprecated, see readme)
|
# - 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
|
# - PORT=51821
|
||||||
# - WG_PORT=51820
|
# - WG_PORT=51820
|
||||||
# - WG_CONFIG_PORT=92820
|
# - WG_CONFIG_PORT=92820
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue