This project is a core piece of the OpenVPN-Access project.
It intercepts all incoming OpenVPN connections and verifies the provided usernames and passwords against those stored in a MariaDB
database.
This project is part of the OpenVPN Access eco-system. Be sure to check out the main repository to get started.
OpenVPN-Authenticator uses cmake
to create its build files and configurations, and depends on the following pieces of software:
- Googletest to build and run tests (optional).
- libbcrypt to verify passwords against their hashed versions in the database.
- mariadbpp to connect to the
MariaDB
database instance. - yaml-cpp to parse
authenticator
configuration files.
These, however, are all pulled from their GitHub repositories at compile time by cmake
, so there is no need to install them beforehand.
To build OpenVPN-Authenticator, you will need:
- A C++20 compatible compiler. We recommend
g++
. cmake
to generate build files.doxygen
to generate documentation files (optional).
If you meet these requirements, building OpenVPN-Authenticator is as simple as:
mkdir build && cd build
cmake ..
cmake --build .
If you have any problems, questions or comments, please don't hesitate to open an issue, or contact us on mattermost.
OpenVPN-Authenticator is well documented in-source, but for the sake of completion, you can find a full doxygen
generated HTML documentation site here.
Issues, pull requests, etc. are very welcome. We are always looking for more people to help us maintain and improve this project. If you don't know where to start, or have any questions, please contact us on mattermost, or send an email to Nathan Seymour <nathan@seymour..