From 7e83c78ad2c98a7c32a1b9557deaa13723e75b02 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Mon, 1 Jan 2018 18:11:17 -0800 Subject: Add TLS configuration manipulation documentation. While here, also fixup the markup on many of the pages, to use commas in SEE ALSO, avoid adding the .adoc extension to cross-references, and correct the link to the MIT license text. --- docs/nng_tls_config_server_name.adoc | 69 ++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/nng_tls_config_server_name.adoc (limited to 'docs/nng_tls_config_server_name.adoc') diff --git a/docs/nng_tls_config_server_name.adoc b/docs/nng_tls_config_server_name.adoc new file mode 100644 index 00000000..e31d0660 --- /dev/null +++ b/docs/nng_tls_config_server_name.adoc @@ -0,0 +1,69 @@ +nng_tls_config_server_name(3) +============================= +:doctype: manpage +:manmanual: nng +:mansource: nng +:manvolnum: 3 +:icons: font +:source-highlighter: pygments +:copyright: Copyright 2018 Staysail Systems, Inc. \ + Copyright 2018 Capitar IT Group BV \ + This software 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_server_name - configure remote server name + +SYNOPSIS +-------- + +[source, c] +----------- +#include + +int nng_tls_config_server_name(nni_tls_config *cfg, const char *name); +----------- + +DESCRIPTION +----------- + +The `nng_tls_config_server_name()` function configures the remote server name +to be used by a client when connection to a server. The supplied 'name' +is used when comparing the identity in the server's certificate. Furthermore, +when Server Name Indication (SNI) is used, the 'name' may be sent to the server +as a hint to tell it which of several possible certificates should be used. + +TIP: This function is only useful in configuring client behavior. + +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. + + +SEE ALSO +-------- + +<>, +<>, +<>, +<> + + +COPYRIGHT +--------- + +Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + +Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + +This document is supplied under the terms of the +https://opensource.org/licenses/MIT[MIT License]. -- cgit v1.2.3-70-g09d2