diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-07-22 17:31:33 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-07-22 17:47:14 -0700 |
| commit | 6e5cf2967bc8717ab712a6cdda9d297d18bdeef0 (patch) | |
| tree | 270b05f01fa01367fef07d7da3503ae7f882a1b4 /docs/BUILD_TLS.adoc | |
| parent | 0812cedcffef826b9793741ec5bb59fe6cf2f138 (diff) | |
| download | nng-6e5cf2967bc8717ab712a6cdda9d297d18bdeef0.tar.gz nng-6e5cf2967bc8717ab712a6cdda9d297d18bdeef0.tar.bz2 nng-6e5cf2967bc8717ab712a6cdda9d297d18bdeef0.zip | |
Add WolfSSL building information
Also, converted to Markdown, and provided revised information about test.
Diffstat (limited to 'docs/BUILD_TLS.adoc')
| -rw-r--r-- | docs/BUILD_TLS.adoc | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/docs/BUILD_TLS.adoc b/docs/BUILD_TLS.adoc deleted file mode 100644 index 80a843dd..00000000 --- a/docs/BUILD_TLS.adoc +++ /dev/null @@ -1,60 +0,0 @@ -ifdef::env-github[] -:important-caption: :heavy_exclamation_mark: -endif::[] - -= Building for TLS Support - -If you want to include support for Transport Layer Security -(tls+tcp:// and wss:// URLs) you should follow these directions. - -At this time, TLS support depends on the https://tls.mbed.org/[Mbed TLS] -library. - -IMPORTANT: Mbed TLS is licensed under different terms than NNG. -You are responsible for reading those license terms, and ensuring -that your use conforms to them. - -On many distributions you may be able to install a pre-packaged version -of Mbed TLS. We recommend doing so if this is an option for you. -For example, Ubuntu users can install the `libmbedtls-dev` package. - -You can also build Mbed TLS from source; if you choose to do so, -please make sure you also *install* it somewhere (even a temporary -staging directory). - -== Configuring NNG with Mbed TLS - -TLS support is not enabled by default, but can be enabled by configuring -with the CMake option `NNG_ENABLE_TLS=ON`. - -By default NNG searches for an installed copy of Mbed TLS in `/usr/local`, -as well as the normal installation directories for libraries on your system. - -If you have installed Mbed TLS elsewhere, you can direct the NNG configuration -to it by setting the `MBEDTLS_ROOT_DIR` CMake variable. - -== Example - -The following example would work on either Linux or macOS, and assumes -that we have checked out github source trees into `$HOME/work`. -It also assumes that Mbed TLS is already installed in /usr/local or -a standard search path. - -[source, sh] ----- -$ export NNGDIR=$HOME/work/nng -$ mkdir build -$ cd build - -$ cmake -DNNG_ENABLE_TLS=ON .. - - ... (lots of lines of output from cmake...) - -$ make - - ... (lots of lines of output from make...) - -$ ./tests/tls -ok ./tests/tls 1.503s - ----- |