diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/libnng.adoc | 23 | ||||
| -rw-r--r-- | docs/nng.adoc | 1 | ||||
| -rw-r--r-- | docs/nng_tls.adoc | 2 | ||||
| -rw-r--r-- | docs/nng_tls_config_alloc.adoc | 91 | ||||
| -rw-r--r-- | docs/nng_tls_config_free.adoc | 61 | ||||
| -rw-r--r-- | docs/nng_ws.adoc | 2 |
6 files changed, 178 insertions, 2 deletions
diff --git a/docs/libnng.adoc b/docs/libnng.adoc index c9ff2d5b..3c320bb1 100644 --- a/docs/libnng.adoc +++ b/docs/libnng.adoc @@ -148,9 +148,31 @@ The following functions are used to register a transport for use. | <<nng_inproc.adoc#,nng_inproc_register(3)>>|register inproc transport | <<nng_ipc.adoc#,nng_ipc_register(3)>>|register IPC transport | <<nng_tcp.adoc#,nng_tcp_register(3)>>|register TCP transport +| <<nng_tls.adoc#,nng_tls_register(3)>>|register TLS transport +| <<nng_ws.adoc#,nng_ws_register(3)>>|register WebSocket transport +| <<nng_wss.adoc#,nng_wss_register(3)>>|register WebSocket Secure transport | <<nng_zerotier.adoc#,nng_zerotier_register(3)>>|register ZeroTier transport |=== +TLS Configuration Objects +~~~~~~~~~~~~~~~~~~~~~~~~ + +The following functions are used to manipulate TLS configuration objects. + +[cols="1,4"] +|=== +| <<nng_tls_config_auth_alloc#nng_tls_config_alloc(3)>>|allocate TLS configuration +| <<nng_tls_config_auth_mode#nng_tls_config_auth_mode(3)>>|set authentication mode +| <<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>>|set certificate authority chain +| <<nng_tls_config_cert#nng_tls_config_cert(3)>>|set own certificate +| <<nng_tls_config_crl#nng_tls_config_crl(3)>>|set certificate revocation list +| <<nng_tls_config_free#,nng_tls_config_free(3)>>}free TLS configuration +| <<nng_tls_config_key#,nng_tls_config_key(3)>>|set private key +| <<nng_tls_config_pass#nng_tls_config_pass(3)>>|set private key password +| <<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>|set remote server name +|=== + + SEE ALSO -------- <<nng.adoc#,nng(7)>> @@ -160,6 +182,7 @@ COPYRIGHT --------- Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] + +Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV] This document is supplied under the terms of the diff --git a/docs/nng.adoc b/docs/nng.adoc index d0fc5ee3..6eadc2ce 100644 --- a/docs/nng.adoc +++ b/docs/nng.adoc @@ -125,6 +125,7 @@ The library API is documented at <<libnng.adoc#,libnng(3)>>. SEE ALSO -------- +<<libnng.adoc#,libnng(3)>> <<nng_compat.adoc#,nng_compat(3)>> COPYRIGHT diff --git a/docs/nng_tls.adoc b/docs/nng_tls.adoc index a6737d01..acf71d7b 100644 --- a/docs/nng_tls.adoc +++ b/docs/nng_tls.adoc @@ -243,7 +243,7 @@ if the `NNG_OPT_TLS_AUTH_MODE` option is set to SEE ALSO -------- <<nng.adoc#,nng(7)>> -<<nng_tls_init#,nng_tls_init(3)>> +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> COPYRIGHT --------- diff --git a/docs/nng_tls_config_alloc.adoc b/docs/nng_tls_config_alloc.adoc new file mode 100644 index 00000000..4b41258f --- /dev/null +++ b/docs/nng_tls_config_alloc.adoc @@ -0,0 +1,91 @@ +nng_tls_config_alloc(3) +======================= +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_alloc - allocate TLS configuration object + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +typedef enum nng_tls_mode { + NNG_TLS_MODE_CLIENT, + NNG_TLS_MODE_SERVER +} nng_tls_mode; + +int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_alloc()` function creates a newly initialized +TLS (Transport Layer Security, see +https://tools.ietf.org/html/rfc5246[RFC 5246]) +configuration object. + +This object is initialized for use when acting as either a +client (`NNG_TLS_MODE_CLIENT`) or as a server (`NNG_TLS_MODE_SERVER`). + +A TLS object can be further modified by functions that set the security +keys used, peeer certificates, protocol policies, and so forth. + +A single TLS configuration object can be used with multiple TLS streams +or services. The underlying system uses reference counting to ensure +that object is not inadvertently freed while in use. + +Also note that a TLS configuration object becomes "read-only" after it +is first used with a service. After this points, attempts to apply +further changes to the configuration will result in `NNG_EBUSY`. + + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available to allocate the object. + + +SEE ALSO +-------- + +<<nng_setopt#,nng_setopt(3)>> +<<nng_strerror#,nng_strerror(3)>> +<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>> +<<nng_tls_config_ca_cert#,nng_tls_config_ca_cert(3)>> +<<nng_tls_config_cert#,nng_tls_config_cert(3)>> +<<nng_tls_config_crl#,nng_tls_config_crl(3)>> +<<nng_tls_config_free#,nng_tls_config_free(3)>> +<<nng_tls_config_key#,nng_tls_config_key(3)>> +<<nng_tls_config_pass#,nng_tls_config_pass(3)>> +<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>> +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + +This document is supplied under the terms of the +https://opensource.org/licenses/LICENSE.txt[MIT License]. diff --git a/docs/nng_tls_config_free.adoc b/docs/nng_tls_config_free.adoc new file mode 100644 index 00000000..8e94e7f2 --- /dev/null +++ b/docs/nng_tls_config_free.adoc @@ -0,0 +1,61 @@ +nng_tls_config_alloc(3) +======================= +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2017 Staysail Systems, Inc. <info@staysail.tech> \ + This software is supplied under the terms of the MIT License, a \ + copy of which should be located in the distribution where this \ + file was obtained (LICENSE.txt). A copy of the license may also \ + be found online at https://opensource.org/licenses/MIT. + +NAME +---- +nng_tls_config_free - deallocate a TLS configuration object + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +void nng_tls_config_free(nni_tls_config *cfg); +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_free()` decrements the reference count on a +TLS configuration object, and if the resulting reference count is zero, +then deallocates the configuration object. + +RETURN VALUES +------------- + +None. + + +ERRORS +------ + +None. + + +SEE ALSO +-------- + +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2017 mailto:info@staysail.tech[Staysail Systems, Inc.] + +This document is supplied under the terms of the +https://opensource.org/licenses/LICENSE.txt[MIT License]. diff --git a/docs/nng_ws.adoc b/docs/nng_ws.adoc index b6185757..66bcff67 100644 --- a/docs/nng_ws.adoc +++ b/docs/nng_ws.adoc @@ -169,7 +169,7 @@ This object is only available for `wss://` endpoints. SEE ALSO -------- <<nng.adoc#,nng(7)>> -<<nng_tls_init#,nng_tls_init(3)>> +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>> COPYRIGHT --------- |