diff options
Diffstat (limited to 'docs/nng_tls_config_pass.adoc')
| -rw-r--r-- | docs/nng_tls_config_pass.adoc | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/nng_tls_config_pass.adoc b/docs/nng_tls_config_pass.adoc new file mode 100644 index 00000000..ca6a17e2 --- /dev/null +++ b/docs/nng_tls_config_pass.adoc @@ -0,0 +1,70 @@ +nng_tls_config_pass(3) +====================== +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \ + Copyright 2018 Capitar IT Group BV <info@capitar.com> \ + 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_pass - configure private key password + +SYNOPSIS +-------- + +[source, c] +----------- +#include <nng/nng.h> + +int nng_tls_config_pass(nni_tls_config *cfg, const char *password) +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_pass()` function configures 'password' used to decrypt +a private key previously configured on the configuration 'cfg' with +<<nng_tls_config_key#,nng_tls_config_key(3)>>. + +The 'password' is an ASCIIZ string. + +This function's affect is limited to decryption only the most recent +private key that was configured. + +RETURN VALUES +------------- + +This function returns 0 on success, and non-zero otherwise. + +ERRORS +------ + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration 'cfg' is already in use, and cannot be modified. +`NNG_EINVAL`:: No private key was configured. + +SEE ALSO +-------- + +<<nng_strerror#,nng_strerror(3)>>, +<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, +<<nng_tls_config_key#,nng_tls_config_key(3)>>, +<<nng#,nng(7)>> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. |