diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-15 08:40:17 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-17 08:49:12 -0700 |
| commit | 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch) | |
| tree | e3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_tls_config_ca_chain.adoc | |
| parent | 91866ed9365ab89069c12da41c873c23d0ba1d19 (diff) | |
| download | nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.gz nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.tar.bz2 nng-98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86.zip | |
fixes #286 nng_pair0_open (and all others) need man page
fixes #279 consider restructuring man sections
This represents a rather significant rework, and major editing
effort, for the entire set of manual pages.
All of the pages now have a section number in their filename;
this assists in some other tooling, particularly ebook generation
as every link needs to be programmatically modified when combined
into an ebook.
Section 5 is introduced, and populated with pages for the main
types, and all options are now documented.
Numerous errors have been corrected, including rewriting certain
portions such as the header section of the surveyor protocol.
Much work has been done to facilitate index generation, although
certainly more work remains here.
Every internal link within these pages now resolves; there are no
more dead links. (This is required to generate Kindle format books.)
Diffstat (limited to 'docs/man/nng_tls_config_ca_chain.adoc')
| -rw-r--r-- | docs/man/nng_tls_config_ca_chain.adoc | 63 |
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/man/nng_tls_config_ca_chain.adoc b/docs/man/nng_tls_config_ca_chain.adoc deleted file mode 100644 index 44258998..00000000 --- a/docs/man/nng_tls_config_ca_chain.adoc +++ /dev/null @@ -1,63 +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> -#include <nng/supplemental/tls/tls.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)>> |
