mirror of https://github.com/wg-easy/wg-easy
tetuaoro
9 months ago
3 changed files with 23 additions and 100 deletions
@ -1,2 +1 @@ |
|||||
/src/node_modules |
/src/node_modules |
||||
/wg-password/node_modules |
|
||||
@ -1,110 +1,34 @@ |
|||||
<!-- created by Mathys Lopinto (@mathys-lopinto) --> |
# wg-password |
||||
# How to generate bcrypt hash |
|
||||
|
|
||||
## Prerequisites |
`wg-password` (wgpg) is a script that generates bcrypt password hashes for use with `wg-easy`, enhancing security by requiring passwords. |
||||
- Python 3 |
|
||||
- bcrypt library |
|
||||
|
|
||||
## Prerequisites Installation |
## Features |
||||
### Windows |
|
||||
Download and install Python 3 from [official website](https://www.python.org/downloads/). |
|
||||
Check "Add python.exe to PATH" before running "Install Now". |
|
||||
|
|
||||
Open Command Prompt (win + r, type "cmd" and press enter) and run the following command to install bcrypt library: |
- Generate bcrypt password hashes. |
||||
```bash |
- Easily integrate with `wg-easy` to enforce password requirements. |
||||
pip install bcrypt |
|
||||
``` |
|
||||
|
|
||||
### Debian based distributions |
## Usage with Docker |
||||
```bash |
|
||||
sudo apt-get update |
|
||||
sudo apt-get install python3 python3-pip |
|
||||
# If you use have install python using apt |
|
||||
sudo apt-get install python3-bcrypt |
|
||||
# If don't install python using apt |
|
||||
pip3 install bcrypt |
|
||||
# If you got externally-managed-environment error |
|
||||
pip3 install bcrypt --break-system-packages |
|
||||
``` |
|
||||
|
|
||||
### Fedora based distributions |
To generate a bcrypt password hash using Docker, run the following command: |
||||
```bash |
|
||||
sudo dnf update |
|
||||
sudo dnf install python3 python3-pip |
|
||||
# If you use have install python using dnf |
|
||||
sudo dnf install python3-bcrypt |
|
||||
# If don't install python using dnf |
|
||||
pip3 install bcrypt |
|
||||
# If you got externally-managed-environment error |
|
||||
pip3 install bcrypt --break-system-packages |
|
||||
``` |
|
||||
|
|
||||
### Arch Linux based distributions |
```sh |
||||
```bash |
docker run ghcr.io/wg-easy/wg-easy wgpw YOUR_PASSWORD |
||||
sudo pacman -Syy |
PASSWORD_HASH='$2b$12$coPqCsPtcFO.Ab99xylBNOW4.Iu7OOA2/ZIboHN6/oyxca3MWo7fW' // litteraly YOUR_PASSWORD |
||||
sudo pacman -S python python-pip |
|
||||
# If you use have install python using pacman |
|
||||
sudo pacman -S python-bcrypt |
|
||||
# If don't install python using pacman |
|
||||
pip3 install bcrypt |
|
||||
# If you got externally-managed-environment error |
|
||||
pip3 install bcrypt --break-system-packages |
|
||||
``` |
``` |
||||
|
|
||||
### macOS |
## Important |
||||
```bash |
|
||||
brew install bcrypt |
|
||||
# If don't install bcrypt using homebrew |
|
||||
pip3 install bcrypt |
|
||||
# If you got externally-managed-environment error |
|
||||
pip3 install bcrypt --break-system-packages |
|
||||
``` |
|
||||
|
|
||||
## Generating bcrypt hash from the command line |
Make sure to enclose your password in single quotes when you run a linux host. |
||||
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('$', '$'*2); 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 |
```bash |
||||
### Do not name the file `bcrypt.py` as it will cause an error. |
$ echo $2b$12$coPqCsPtcF |
||||
Create a python file with the following content: |
b2 |
||||
```python |
$ echo "$2b$12$coPqCsPtcF" |
||||
import bcrypt |
b2 |
||||
|
$ echo '$2b$12$coPqCsPtcF' |
||||
# Initial password |
$2b$12$coPqCsPtcF |
||||
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()}') |
|
||||
|
|
||||
# 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. |
## LICENSE |
||||
|
|
||||
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__ |
[wg-easy license](./LICENSE) |
||||
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 |
|
||||
``` |
|
||||
Loading…
Reference in new issue