# DnsLibs

**Repository Path**: ixuea/DnsLibs

## Basic Information

- **Project Name**: DnsLibs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-08
- **Last Updated**: 2021-07-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AdGuard C++ DNS libraries

A DNS proxy library that supports all existing DNS protocols including `DNS-over-TLS`,
`DNS-over-HTTPS`, `DNSCrypt` and `DNS-over-QUIC` (experimental).

## After checkout

```
git submodule init
git submodule update
```
In order to reset submodules you can use
```
git submodule update --force
```
## Build instructions

### Native library

#### Prerequisites

* Conan C++ package manager 1.38 or higher
* CMake 3.6 or higher
* GCC 9 or higher / Clang 8 or higher

#### How to use conan

Conan is C++ package manager. It is similar to maven, but with recipes and binaries separately.
Binaries can be uploaded to repo and reused.

We recommend to use custom remote repo as main conan repo (`-i 0`)
Conan looks up binaries in the repo from which recipes were downloaded.
So if recipe is from conan-center, you won't be able to store binaries because it has highest priority by default.

```
conan remote add -i 0 $REMOTE_NAME https://$ARTIFACTORY_HOST/artifactory/api/conan/$REPO_NAME
```

We customized some packages, so they need to be exported to local conan repository.

```
cd conan/recipes
./export.sh
```

If you want to upload exported recipes to conan remote repository, use following command:

```
conan upload -r $REMOTE_NAME -c '*'
```

After successful build, you may want to upload built binaries to remote repo:
```
conan upload -t $REMOTE_NAME -c '*' --all
```

#### Building

Execute the following commands in Terminal:
```
cd <path/to/dnsproxy>
mkdir build && cd build
cmake ..
make -j 4 dnsproxy
```

For testing execute the following:
```
make -j 4 tests
ctest -j 4
```

### MacOS/iOS framework

#### Prerequisites

* Conan C++ package manager 1.38 or higher
* CMake 3.6 or higher
* Clang 8 or higher
* Xcode 11 or higher

#### Building

Execute the following commands in Terminal:
```
cd <path/to/dnsproxy>
bash platform/mac/framework/build_dnsproxy_framework.sh --bp <build_path> --fwp <path/to/dnsproxy>/platform/mac/framework/ --iosv 13.0
```

For details of the building script usage execute the following:
```
bash platform/mac/framework/build_dnsproxy_framework.sh --help
```

As a result the DNS proxy framework will be located in `<build_path>/<target_name>.<framework_type>`,
where `<build_path>` is the build path one passed to script, `<target_name>` is the framework name,
`<framework_type>` is either `framework` (if one specified the target platform) or
`xcframework` (if one didn't specify any platform, or passed `all`).

## Useful notes

* Proxy configuration: [native](proxy/include/dnsproxy_settings.h), [mac](platform/mac/framework/AGDnsProxy.h),
[android](platform/android/dnsproxy/lib/src/main/java/com/adguard/dnslibs/proxy/DnsProxySettings.java)
* [Rules syntax](https://github.com/AdguardTeam/AdguardHome/wiki/Hosts-Blocklists)
* [Developer documentation](documentation/DEV_DOCS.en.md)

## License

Apache 2.0