diff options
| author | Garrett D'Amore <garrett@damore.org> | 2024-10-27 22:51:29 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2024-10-28 07:06:29 -0700 |
| commit | cbd8c5573ef6816d585d00d63568cf98aa6a97b8 (patch) | |
| tree | 52c2242be427f63dd862394de644394a4bc8c352 /docs/man/nng_tls_options.5.adoc | |
| parent | ef1cf275eded10ccfe24c44089eb044dd5cd48b4 (diff) | |
| download | nng-cbd8c5573ef6816d585d00d63568cf98aa6a97b8.tar.gz nng-cbd8c5573ef6816d585d00d63568cf98aa6a97b8.tar.bz2 nng-cbd8c5573ef6816d585d00d63568cf98aa6a97b8.zip | |
tls: Remove the individual TLS configuration options
This is a breaking change.
TLS configuration changes are to be made using TLS configuration
objects, and then set on a listener or dialer with NNG_OPT_TLS_CONFIG.
This should be a bit less racy, and allows for simpler code.
Diffstat (limited to 'docs/man/nng_tls_options.5.adoc')
| -rw-r--r-- | docs/man/nng_tls_options.5.adoc | 31 |
1 files changed, 0 insertions, 31 deletions
diff --git a/docs/man/nng_tls_options.5.adoc b/docs/man/nng_tls_options.5.adoc index a06a600f..cf2a99cf 100644 --- a/docs/man/nng_tls_options.5.adoc +++ b/docs/man/nng_tls_options.5.adoc @@ -20,11 +20,7 @@ nng_tls_options - TLS-specific options ---- #include <nng/nng.h> -#define NNG_OPT_TLS_AUTH_MODE "tls-authmode" -#define NNG_OPT_TLS_CA_FILE "tls-ca-file" -#define NNG_OPT_TLS_CERT_KEY_FILE "tls-cert-key-file" #define NNG_OPT_TLS_CONFIG "tls-config" -#define NNG_OPT_TLS_SERVER_NAME "tls-server-name" #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" @@ -47,25 +43,6 @@ description of the option. === TLS Options -[[NNG_OPT_TLS_AUTH_MODE]]((`NNG_OPT_TLS_AUTH_MODE`)):: -(`int`) -Write-only option used to configure the authentication mode used. -See xref:nng_tls_config_auth_mode.3tls.adoc[`nng_tls_config_auth_mode()`] for -more details. - -[[NNG_OPT_TLS_CA_FILE]]((`NNG_OPT_TLS_CA_FILE`)):: -(string) Write-only option naming a file containing certificates to -use for peer validation. -See xref:nng_tls_config_ca_file.3tls.adoc[`nng_tls_config_ca_file()`] for more -information. - -[[NNG_OPT_TLS_CERT_KEY_FILE]]((`NNG_OPT_TLS_CERT_KEY_FILE`)):: -(string) Write-only option naming a file containing the local certificate and -associated private key. -The private key used must be unencrypted. -See xref:nng_tls_config_own_cert.3tls.adoc[`nng_tls_config_own_cert()`] for more -information. - [[NNG_OPT_TLS_CONFIG]]((`NNG_OPT_TLS_CONFIG`)):: (`nng_tls_config *`) This option references the underlying @@ -79,14 +56,6 @@ longer needs the TLS configuration object. + TIP: Use this option when more advanced TLS configuration is required. -[[NNG_OPT_TLS_SERVER_NAME]]((`NNG_OPT_TLS_SERVER_NAME`)):: -(string) -This write-only option is used to specify the name of the server. -When used with a dialer, this potentially configures SNI (server name -indication, which is used as a hint by a multihosting server to choose the -appropriate certificate to provide) and also is used to validate the -name presented in the server's x509 certificate. - [[NNG_OPT_TLS_VERIFIED]]((`NNG_OPT_TLS_VERIFIED`)):: (`bool`) This read-only option indicates whether the remote peer has been properly verified using TLS |