blob: 63ae634731ed08cd12bfe69f0d3e33566cb472d6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
# Building for TLS Support
If you want to include support for Transport Layer Security
(`tls+tcp://` and `wss://` URLs) you should follow these directions.
TLS support in NNG depends on either the [Mbed TLS](https://tls.mbed.org/)
or [WolfSSL](https://www.wolfssl.com/) library (your choice).
> [!IMPORTANT]
> These libraries are licensed under different terms than NNG.
> You are responsible for reading those license terms, and ensuring
> that your use conforms to them.
> [!TIP]
> This project receives no compensation or support in any other form
> from either ARM (owners of the Mbed TLS project) or WolfSSL.
> Thus, as a special request, if you're paying for commercial licenses for
> either Mbed TLS or WolfSSL for use with NNG, please consider also sponsoring
> this project or obtaining a commercial support contract from
> [Staysail Systems, Inc.](https://www.staysail.tech/)
> You can enquire about support contracts at info@staysail.tech.
> Sponsorship information is available on our
> [GitHub page](https://github.com/nanomsg/nng). Thank you!
On many distributions you may be able to install a pre-packaged version
of either library. 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 these from source; if you choose to do so,
please make sure you also _install_ it somewhere (even a temporary
staging directory).
## Configuring NNG with TLS
TLS support is not enabled by default, but can be enabled by configuring
with the CMake option `NNG_ENABLE_TLS=ON`.
You can select which library to use by using `NNG_TLS_ENGINE=mbed` or
`NNG_TLS_ENGINE=wolf`. If you specify neither, then Mbed TLS will be assumed
by default.
By default NNG searches for an installed components 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` or `WOLFSSL_ROOT_DIR` CMake variable
as appropriate.
## 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.
```
$ export NNGDIR=$HOME/work/nng
$ mkdir build
$ cd build
$ cmake -G Ninja -DNNG_ENABLE_TLS=ON ..
... (lots of lines of output from cmake...)
$ ninja build
... (lots of lines of output from ninja...)
$ ./src/supplemental/tls/tls_test -v
... (lots of lines of output from the test ...)
Summary:
Count of all unit tests: 9
Count of run unit tests: 9
Count of failed unit tests: 0
Count of skipped unit tests: 0
SUCCESS: All unit tests have passed.
```
|
