Skip to content

Latest commit

 

History

History
90 lines (70 loc) · 2.97 KB

nng_tls_options.5.adoc

File metadata and controls

90 lines (70 loc) · 2.97 KB

nng_tls_options(5)

NAME

nng_tls_options - TLS-specific options

SYNOPSIS

#include <nng/nng.h>

#define NNG_OPT_TLS_VERIFIED       "tls-verified"
#define NNG_OPT_TLS_PEER_CN        "tls-peer-cn"
#define NNG_OPT_TLS_PEER_ALT_NAMES "tls-peer-alt-names"

DESCRIPTION

This page documents the various standard options that can be set or retrieved on objects using TLS.

The option names should always be used by their symbolic definitions.

In the following list of options, the name of the option is supplied, along with the data type of the underlying value.

Some options are only meaningful or supported in certain contexts, or may have other access restrictions. An attempt has been made to include details about such restrictions in the description of the option.

TLS Options

NNG_OPT_TLS_VERIFIED

(bool) This read-only option indicates whether the remote peer has been properly verified using TLS authentication. May return incorrect results if peer authentication is disabled.

NNG_OPT_TLS_PEER_CN

(string) This read-only option returns the common name of the peer certificate. May return incorrect results if peer authentication is disabled.

NNG_OPT_TLS_PEER_ALT_NAMES

(string) This read-only option returns string list with the subject alternative names of the peer certificate. May return incorrect results if peer authentication is disabled.

Inherited Options

Generally, the following option values are also available for TLS objects, when appropriate for the context: