Skip to content

Commit

Permalink
Chore
Browse files Browse the repository at this point in the history
  • Loading branch information
elegos committed Dec 15, 2021
1 parent b562b9d commit 15fa547
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 15 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,18 @@ It currently supports IPv6 only, but IPv4 is in the plans (it needs a proper IP

It has been designed and tested on Linux, specifically due to the paths and commands used, but it should work on any POSIX / UNIX operating systems (like MacOS).

## Security

The VPN can be accessed only knowing a pre-shared key, generated by the server / central node the first time it is being executed. In case of PSK exposure, the `--refresh-psk` might be used to generate a new one.

Every message exchanged with the protocol is encrypted and decrypted via the given PSK.

Once the peer joins the network, the WireGuard asymmetric encryption secures the connection between the peers.

## Software requirement

- WireGuard kernel's module (it should be enabled by default)
- `wg-quick` command (provided by most Linux distributions via the `wireguard-tools` package)
- `wg` and `wg-quick` commands (provided by most Linux distributions via the `wireguard-tools` package)

## Setting up the server

Expand Down
1 change: 0 additions & 1 deletion requirements.txt

This file was deleted.

4 changes: 4 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ description = WireGuard manager to connect two or more peers in a star VPN
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/elegos/py-wgstarman
license = MIT
classifiers =
Development Status :: 1 - Planning
License :: OSI Approved :: MIT License
Expand All @@ -15,11 +16,14 @@ classifiers =
Programming Language :: Python :: 3
Topic :: System :: Networking
Topic :: Utilities
keywords = vpn, wireguard, cli, star, unix, posix, linux

[options]
package_dir =
= src
packages = find:
install_requires =
cryptography
python_requires = >=3.6

[options.entry_points]
Expand Down
14 changes: 1 addition & 13 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
#!/usr/bin/env python3

import pathlib

import pkg_resources
import setuptools

with pathlib.Path('requirements.txt').open() as requirements_txt:
install_requires = [
str(requirement)
for requirement
in pkg_resources.parse_requirements(requirements_txt)
]

setuptools.setup(
install_requires=install_requires,
)
setuptools.setup()

0 comments on commit 15fa547

Please sign in to comment.