aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tls_config_cert_key_file.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-03-15 08:40:17 -0700
committerGarrett D'Amore <garrett@damore.org>2018-03-17 08:49:12 -0700
commit98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 (patch)
treee3cc06524b26fd0773d1742de82a00862f95c5f6 /docs/man/nng_tls_config_cert_key_file.adoc
parent91866ed9365ab89069c12da41c873c23d0ba1d19 (diff)
downloadnng-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_cert_key_file.adoc')
-rw-r--r--docs/man/nng_tls_config_cert_key_file.adoc64
1 files changed, 0 insertions, 64 deletions
diff --git a/docs/man/nng_tls_config_cert_key_file.adoc b/docs/man/nng_tls_config_cert_key_file.adoc
deleted file mode 100644
index c511c5b5..00000000
--- a/docs/man/nng_tls_config_cert_key_file.adoc
+++ /dev/null
@@ -1,64 +0,0 @@
-= nng_tls_config_cert_key_file(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_cert_key_file - load own certificate and key from file
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_config_cert_key_file(nni_tls_config *cfg, const char *path,
- const char *pass);
------------
-
-== DESCRIPTION
-
-The `nng_tls_config_cert_key_file()` function loads a certificate (or
-certificate chain) and a private key from the file named by _path_.
-
-The file must contain both the https://tools.ietf.org/html/rfc7468[PEM]
-encoded certificate and associated private key, which will be used when
-establishing TLS sessions using _cfg_. It may contain additional certificates
-leading to a validation chain, with the leaf certificate first.
-There is no need to include the self-signed root, as the peer
-will need to have that already in order to perform it's own validation.
-
-The private key may be encrypted with a password, in which can be supplied in
-_pass_. The value `NULL` should be supplied for _pass_ if the key is not
-encrypted.
-
-On servers, it is possible to call this function multiple times for the
-same configuration. This can be useful for specifying different parameters
-to be used for different cryptographic algorithms.
-
-== 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`:: The contents of _path_ are invalid.
-`NNG_ENOENT`:: The file named by _path_ does not exist.
-`NNG_EPERM`:: The file named by _path_ cannot be opened.
-
-== SEE ALSO
-
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>,
-<<nng_tls_config_own_cert#,nng_tls_config_own_cert(3)>>,
-<<nng#,nng(7)>>