SSL_set1_host (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/SSL_set1_host.3ssl".)

NAME

SSL_set1_host, SSL_add1_host, SSL_set_hostflags, SSL_get0_peername - SSL server verification parameters

SYNOPSIS

 #include <openssl/ssl.h>

 int SSL_set1_host(SSL *s, const char *hostname);
 int SSL_add1_host(SSL *s, const char *hostname);
 void SSL_set_hostflags(SSL *s, unsigned int flags);
 const char *SSL_get0_peername(SSL *s);

DESCRIPTION

These functions configure server hostname checks in the client.

SSL_set1_host() sets the expected

hostname to name clearing any previously specified host name or names. If name is or the empty string the list of hostnames is cleared, and name checks are not performed on the peer certificate. When a non-empty name is specified, certificate verification automatically checks the peer hostname via X509_check_host(3) with flags as specified via SSL_set_hostflags(). Clients that enable authentication via SSL_dane_enable(3) should leave it to that function to set the primary reference identifier of the peer, and should not call SSL_set1_host().

SSL_add1_host() adds name as an additional reference identifier that can match the peer's certificate. Any previous names set via SSL_set1_host() or SSL_add1_host() are retained, no change is made if name is

or empty. When multiple names are configured, the peer is considered verified when any name matches. This function is required for in the presence of service name indirection via or records as specified in or

SSL_set_hostflags() sets the flags that will be passed to X509_check_host(3) when name checks are applicable, by default the flags value is 0. See X509_check_host(3) for the list of available flags and their meaning.

SSL_get0_peername() returns the

hostname or subject CommonName from the peer certificate that matched one of the reference identifiers. When wildcard matching is not disabled, the name matched in the peer certificate may be a wildcard name. When one of the reference identifiers configured via SSL_set1_host() or SSL_add1_host() starts with ``.'', which indicates a parent domain prefix rather than a fixed name, the matched peer name may be a sub-domain of the reference identifier. The returned string is allocated by the library and is no longer valid once the associated ssl handle is cleared or freed, or a renegotiation takes place. Applications must not free the return value.

clients are advised to use these functions in preference to explicitly calling X509_check_host(3). Hostname checks are out of scope with the (3) certificate usage, and the internal check will be suppressed as appropriate when is enabled.

RETURN VALUES

SSL_set1_host() and SSL_add1_host() return 1 for success and 0 for failure.

SSL_get0_peername() returns

if peername verification is not applicable (as with (3)), or no trusted peername was matched. Otherwise, it returns the matched peername. To determine whether verification succeeded call SSL_get_verify_result(3).

EXAMPLE

Suppose ``smtp.example.com'' is the host of the domain ``example.com''. The calls below will arrange to match either the hostname or the destination domain name in the server certificate. Wildcards are supported, but must match the entire label. The actual name matched in the certificate (which might be a wildcard) is retrieved, and must be copied by the application if it is to be retained beyond the lifetime of the connection.

  SSL_set_hostflags(ssl, X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
  if (!SSL_set1_host(ssl, "smtp.example.com")) {
    /* handle error */
  }
  if (!SSL_add1_host(ssl, "example.com")) {
    /* handle error */
  }

  /* XXX: Perform SSL_connect() handshake and handle errors here */

  if (SSL_get_verify_result(ssl) == X509_V_OK) {
      const char *peername = SSL_get0_peername(ssl);

      if (peername != NULL) {
          /* Name checks were in scope and matched the peername */
      }
  }

SEE ALSO

X509_check_host(3), SSL_get_verify_result(3). SSL_dane_enable(3).

HISTORY

These functions were first added to OpenSSL 1.1.0.

COPYRIGHT

Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the ``License''). You may not use this file except in compliance with the License. You can obtain a copy in the file

in the source distribution or at <www.openssl.org/source/license.html>.