doc/crypto/X509_check_host.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_check_host, X509_check_email, X509_check_ip, X509_check_ip_asc - X.509 certificate matching
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/x509.h>
  10
  11  int X509_check_host(X509 *, const unsigned char *name,
  12                      size_t namelen, unsigned int flags);
  13  int X509_check_email(X509 *, const unsigned char *address,
  14                      size_t addresslen, unsigned int flags);
  15  int X509_check_ip(X509 *, const unsigned char *address,
  16                    size_t addresslen, unsigned int flags);
  17  int X509_check_ip_asc(X509 *, const char *address, unsigned int flags);
  18
  19 =head1 DESCRIPTION
  20
  21 The certificate matching functions are intended to be called to check
  22 if a certificate matches a given host name, email address, or IP
  23 address.  The validity of the certificate and its trust level has to
  24 be checked by other means.
  25
  26 X509_check_host() checks if the certificate matches the specified
  27 host name, which must be encoded in the preferred name syntax
  28 described in section 3.5 of RFC 1034. The B<namelen> argument must be
  29 the number of characters in the name string or zero in which case the
  30 length is calculated with strlen(name).  When B<name> starts with
  31 a dot (e.g ".example.com"), it will be matched by a certificate
  32 valid for any sub-domain of B<name>, (see also
  33 B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS> below).
  34
  35 X509_check_email() checks if the certificate matches the specified
  36 email address.  Only the mailbox syntax of RFC 822 is supported,
  37 comments are not allowed, and no attempt is made to normalize quoted
  38 characters.  The B<addresslen> argument must be the number of
  39 characters in the address string. The B<namelen> argument must be
  40 the number of characters in the name string or zero in which case the
  41 length is calculated with strlen(name).
  42
  43 X509_check_ip() checks if the certificate matches a specified IPv4 or
  44 IPv6 address.  The B<address> array is in binary format, in network
  45 byte order.  The length is either 4 (IPv4) or 16 (IPv6).  Only
  46 explicitly marked addresses in the certificates are considered; IP
  47 addresses stored in DNS names and Common Names are ignored.
  48
  49 X509_check_ip_asc() is similar, except that the NUL-terminated
  50 string B<address> is first converted to the internal representation.
  51
  52 The B<flags> argument is usually 0.  It can be the bitwise OR of the
  53 flags:
  54
  55 =over 4
  56
  57 =item B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT>,
  58
  59 =item B<X509_CHECK_FLAG_NO_WILDCARDS>,
  60
  61 =item B<X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS>,
  62
  63 =item B<X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS>.
  64
  65 =item B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS>.
  66
  67 =back
  68
  69 The B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT> flag causes the function
  70 to consider the subject DN even if the certificate contains at least
  71 one subject alternative name of the right type (DNS name or email
  72 address as appropriate); the default is to ignore the subject DN
  73 when at least one corresponding subject alternative names is present.
  74
  75 If set, B<X509_CHECK_FLAG_NO_WILDCARDS> disables wildcard
  76 expansion; this only applies to B<X509_check_host>.
  77
  78 If set, B<X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS> suppresses support
  79 for "*" as wildcard pattern in labels that have a prefix or suffix,
  80 such as: "www*" or "*www"; this only aplies to B<X509_check_host>.
  81
  82 If set, B<X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS> allows a "*" that
  83 constitutes the complete label of a DNS name (e.g. "*.example.com")
  84 to match more than one label in B<name>; this flag only applies
  85 to B<X509_check_host>.
  86
  87 If set, B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS> restricts B<name>
  88 values which start with ".", that would otherwise match any sub-domain
  89 in the peer certificate, to only match direct child sub-domains.
  90 Thus, for instance, with this flag set a B<name> of ".example.com"
  91 would match a peer certificate with a DNS name of "www.example.com",
  92 but would not match a peer certificate with a DNS name of
  93 "www.sub.example.com"; this flag only applies to B<X509_check_host>.
  94
  95 =head1 RETURN VALUES
  96
  97 The functions return 1 for a successful match, 0 for a failed match
  98 and -1 for an internal error: typically a memory allocation failure.
  99
 100 X509_check_ip_asc() can also return -2 if the IP address string is malformed.
 101
 102 =head1 SEE ALSO
 103
 104 L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>
 105
 106 =head1 HISTORY
 107
 108 These functions were added in OpenSSL 1.1.0.
 109
 110 =cut