aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_tls_config_pass.adoc
blob: ca6a17e20deb8cc6c55fbbc0c34c3781df91c5ba (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
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].