aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tls_config_own_cert.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_own_cert.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_own_cert.adoc')
-rw-r--r--docs/man/nng_tls_config_own_cert.adoc63
1 files changed, 0 insertions, 63 deletions
diff --git a/docs/man/nng_tls_config_own_cert.adoc b/docs/man/nng_tls_config_own_cert.adoc
deleted file mode 100644
index 7d2a081e..00000000
--- a/docs/man/nng_tls_config_own_cert.adoc
+++ /dev/null
@@ -1,63 +0,0 @@
-= nng_tls_config_own_cert(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_own_cert - configure own certificate and key
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-#include <nng/supplemental/tls/tls.h>
-
-int nng_tls_config_own_cert(nni_tls_config *cfg, const char *cert,
- const char *key, const char *pass);
------------
-
-== DESCRIPTION
-
-The `nng_tls_config_own_cert()` function configures a certificate _cert_
-identifying the local side of a TLS connection used with _cfg_, along with an
-associated private or secret key _key_. The certificate may be
-a chain, with the leaf signer first and the root at the end. The
-self-signed certificate at the end can be omitted. (The client should already
-have it, and will have to in order to validate this certificate anyway).
-
-The _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.
-
-The certificate located in _cert_ and _key_ must be NUL (`\0`) terminated C
-strings containing
-https://tools.ietf.org/html/rfc7468[PEM] formatted material.
-
-== 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 _cert_ or _key_ was supplied.
-
-== SEE ALSO
-
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>,
-<<nng_tls_config_cert_key_file#,nng_tls_config_cert_key_file(3)>>,
-<<nng#,nng(7)>>