diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-25 17:56:55 -0800 |
| commit | 87795b46f2bc732bd11067805709161bdc00d6b6 (patch) | |
| tree | 892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_tls_config_ca_chain.adoc | |
| parent | 545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff) | |
| download | nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.gz nng-87795b46f2bc732bd11067805709161bdc00d6b6.tar.bz2 nng-87795b46f2bc732bd11067805709161bdc00d6b6.zip | |
More man page reorganization.
Man pages need special handling, and we can have other kinds of documentation
like initial starting guides, etc., which would have different processing
applied. So lets move them off into their own directory.
Diffstat (limited to 'docs/nng_tls_config_ca_chain.adoc')
| -rw-r--r-- | docs/nng_tls_config_ca_chain.adoc | 62 |
1 files changed, 0 insertions, 62 deletions
diff --git a/docs/nng_tls_config_ca_chain.adoc b/docs/nng_tls_config_ca_chain.adoc deleted file mode 100644 index cac92b3c..00000000 --- a/docs/nng_tls_config_ca_chain.adoc +++ /dev/null @@ -1,62 +0,0 @@ -= nng_tls_config_ca_chain(3) -// -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> -// Copyright 2018 Capitar IT Group BV <info@capitar.com> -// -// This document 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_ca_chain - configure certificate authority certificate chain - -== SYNOPSIS - -[source, c] ------------ -#include <nng/nng.h> - -int nng_tls_config_ca_cert(nni_tls_config *cfg, const char *chain, - const char *crl); ------------ - -== DESCRIPTION - -The `nng_tls_config_ca_chain()` function configures a certificate or -certificate chain to be used when validating peers using the configuration -_cfg_. - -NOTE: Certificates *must* be configured when using the authentication mode -`NNG_TLS_AUTH_MODE_REQUIRED`. - -TIP: This function may be called multiple times, to add additional chains -to a configuration, without affecting those added previously. - -The certificates located in _chain_ must be a zero-terminated C string in -https://tools.ietf.org/html/rfc7468[PEM] format. Multiple certificates may -appear concatenated together, with the leaf certificate listed first. -together. - -The _crl_ may be `NULL`, or may also be a C string containing a PEM format -certificate revocation list for the associated authority. - -== 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`:: An invalid _chain_ or _crl_ was supplied. - -== SEE ALSO - -<<nng_strerror#,nng_strerror(3)>>, -<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>, -<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>, -<<nng_tls_config_ca_file#,nng_tls_config_ca_file(3)>>, -<<nng#,nng(7)>> |