summaryrefslogtreecommitdiff
path: root/docs/nng_tls_config_auth_mode.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-25 17:56:55 -0800
commit87795b46f2bc732bd11067805709161bdc00d6b6 (patch)
tree892f3bcea1a14df5dde8dba413d394f5ccb0a0e0 /docs/nng_tls_config_auth_mode.adoc
parent545942f7ace7cde8a1b8a6a5289cecc185b08fbc (diff)
downloadnng-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_auth_mode.adoc')
-rw-r--r--docs/nng_tls_config_auth_mode.adoc70
1 files changed, 0 insertions, 70 deletions
diff --git a/docs/nng_tls_config_auth_mode.adoc b/docs/nng_tls_config_auth_mode.adoc
deleted file mode 100644
index 1c0f70ec..00000000
--- a/docs/nng_tls_config_auth_mode.adoc
+++ /dev/null
@@ -1,70 +0,0 @@
-= nng_tls_config_auth_mode(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_auth_mode - configure authentication mode
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-
-typedef enum nng_tls_auth_mode {
- NNG_TLS_AUTH_MODE_NONE,
- NNG_TLS_AUTH_MODE_OPTIONAL,
- NNG_TLS_AUTH_MODE_REQUIRED
-} nng_tls_auth_mode;
-
-int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode);
------------
-
-== DESCRIPTION
-
-The `nng_tls_config_auth_mode()` function configures the authentication mode
-to be used for TLS sessions using this configuration object.
-
-The possible modes are:
-
-`NNG_TLS_AUTH_MODE_NONE`::
-No authentication of the TLS peer is performed. This is the default for
-TLS servers, which most typically do not authenticate their clients.
-
-`NNG_TLS_AUTH_MODE_OPTIONAL`::
-If a certificate is presented by the peer, then it is validated. However,
-if the peer does not present a valid certificate, then the sesssion is allowed
-to proceed without authentication.
-
-`NNG_TLS_AUTH_MODE_REQUIRED`::
-A check is made to ensure that the peer has presented a valid certificate
-used for the session. If the peer's certificate is invalid or missing, then
-the session is refused. This is the default for clients.
-
-== RETURN VALUES
-
-This function returns 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-`NNG_ENOMEM`:: Insufficient memory is available.
-`NNG_EINVAL`:: An invalid _mode_ was specified.
-`NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified.
-
-
-== SEE ALSO
-
-<<nng_strerror#,nng_strerror(3)>>,
-<<nng_tls_config_alloc#,nng_tls_config_alloc(3)>>,
-<<nng_tls_config_ca_chain#,nng_tls_config_ca_chain(3)>>,
-<<nng_tls_config_ca_file#,nng_tls_config_ca_file(3)>>,
-<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>,
-<<nng#,nng(7)>>