mirror of
https://github.com/TrustTunnel/TrustTunnelClient.git
synced 2026-05-22 19:41:36 +00:00
Nikita Gorskikh
72461d0994
Merge in ADGUARD-CORE-LIBS/vpn-libs from feature/add_opensource_vpn_client to master Squashed commit of the following: commit 0b68e8bebcb5ab4ab76aa5d63267f224c5bd56f2 Author: Sergei Gunchenko <s.gunchenko@adguard.com> Date: Mon Aug 1 19:28:49 2022 +0300 common/src/utils.cpp edited online with Bitbucket commit 237afe76b1e03c8e95fd7564b100d72956598550 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 16:58:00 2022 +0300 Maybe fix conan-upload-recipes commit 940c4abfc8808b7e464a37302d7eca5215eda14e Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 16:57:52 2022 +0300 Un-simplify conan export script commit c6ee05e3642d27daadf6b1d49374b187bdeec818 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 16:51:12 2022 +0300 Debug commit b3956633a8ad4d6ada4559b2fc4fb0d4d09e97ea Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 16:49:27 2022 +0300 Maybe fix upload-conan-recipes 2 commit 447f05addd243bce179d99812309c3f9bb1b7412 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 16:42:20 2022 +0300 Maybe fix upload-conan-recipes commit 8ff27ec486c4176676d3c186dfda13e652fb0344 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 15:39:37 2022 +0300 Check subprocess return in conan_export.py commit 5652549b863232f573e18c71844323e3298bf080 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 15:22:30 2022 +0300 Fix bamboo spec commit 28ae435a1500afd0e288c33695003f9feb59100f Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 15:20:16 2022 +0300 Get rid of version.h, use increment_version.sh from native_libs_common commit 01f4f4892d3718ee48e25192259239c6e95183cd Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 15:16:02 2022 +0300 Fix conandata.yml commit b4163a3dfdbdd5dc2817988a8325d21754165e83 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 15:10:30 2022 +0300 Simplify conan export script commit 03343cd1ae47a1e60fddb09e58bacf498f765991 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 14:57:26 2022 +0300 Fix bamboo spec commit 9ba118b74ddc41e1ccd3d7c754120e03e86699ee Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 14:56:19 2022 +0300 Update changelog commit ce1c14cdcf18ab1032d12555db1efaa177ef6101 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 14:55:36 2022 +0300 Fix increment_version.sh and increment version commit 56186e50fd51925f6fb7dc17e9d1fc7a5831a2c8 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 14:53:19 2022 +0300 Add versioning system from native_libs_common commit e6570a1afdda8da0afad51c94e8d1b7375739fea Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 14:20:13 2022 +0300 Add missing includes commit 5e708c71553f31e7998dcc5d310e1abecef44ab4 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 14:17:52 2022 +0300 Add license commit 09ee4698adc2514a23962f0549f9a571d40f4f96 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 13:30:12 2022 +0300 Pull variable out of namespace ag commit 7bfc263756c175c6ac85fd8310c387c666a5038b Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 12:25:21 2022 +0300 Update native_libs_common to 2.0.10 commit 68025494e7c781cdfd8ee1f4ef801014c8179d67 Author: Nikita Gorskikh <n.gorskikh@adguard.com> Date: Mon Aug 1 12:25:05 2022 +0300 Permanently add /Oy- and -fno-omit-frame-pointer compiler flags ... and 123 more commits
AdGuard VPN libs
A VPN client library that provides client network traffic tunnelling to an AdGuard VPN server.
Build instructions
Prerequisites
- CMake 3.7 or higher
- Clang 8 or higher
- Conan 1.38 or higher
Building
If it is a clean build, export custom conan packages to the local conan repository. See https://github.com/AdguardTeam/NativeLibsCommon/blob/master/README.md for details.
To build the main library:
mkdir build && cd build
cmake ..
make vpnlibs_core
To run tests:
make tests && ctest
To build a minimal working example application, run:
make standalone_client
Refer to core/test/standalone_client/README.md
Project structure
Every subproject consists of the following directories and files:
include/<module_name>/- public headers (add theincludedirectory to includes only, so that include header from other module would look like#include "module/header.h")include/<module_name>/internal- not so public headers (they are not part of the public API, but may be needed by other modules, or to extend the library)src/- source code files and private headerstest/- tests and their dataCMakeLists.txt- cmake build config
Root project consists of the following directories and files:
common/- Set of useful general-purpose utilitiescore/- VPN client core module (configuration, traffic tunnelling, etc.)net/- network communicationtcpip/- L3 and L4 protocols handling (the network and transport layers)third-party/- third-party libraries (this is not a subproject, so subproject's rules are not enforced)CMakeLists.txt- main cmake build config.
The public API is in core/include/vpn.h.
License
Copyright (C) AdGuard Software Ltd.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.