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 char *name, size_t namelen,
  12                      unsigned int flags, char **peername);
  13  int X509_check_email(X509 *, const char *address, size_t addresslen,
  14                       unsigned int flags);
  15  int X509_check_ip(X509 *, const unsigned char *address, size_t addresslen,
  16                    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 used to check whether a
  22 certificate matches a given host name, email address, or IP address.
  23 The validity of the certificate and its trust level has to be checked by
  24 other means.
  25
  26 X509_check_host() checks if the certificate Subject Alternative
  27 Name (SAN) or Subject CommonName (CN) matches the specified host
  28 name, which must be encoded in the preferred name syntax described
  29 in section 3.5 of RFC 1034.  By default, wildcards are supported
  30 and they match  only in the left-most label; but they may match
  31 part of that label with an explicit prefix or suffix.  For example,
  32 by default, the host B<name> "www.example.com" would match a
  33 certificate with a SAN or CN value of "*.example.com", "w*.example.com"
  34 or "*w.example.com".
  35
  36 Per section 6.4.2 of RFC 6125, B<name> values representing international
  37 domain names must be given in A-label form.  The B<namelen> argument
  38 must be the number of characters in the name string or zero in which
  39 case the length is calculated with strlen(B<name>).  When B<name> starts
  40 with a dot (e.g ".example.com"), it will be matched by a certificate
  41 valid for any sub-domain of B<name>, (see also
  42 B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS> below).
  43
  44 When the certificate is matched, and B<peername> is not NULL, a
  45 pointer to a copy of the matching SAN or CN from the peer certificate
  46 is stored at the address passed in B<peername>.  The application
  47 is responsible for freeing the peername via OPENSSL_free() when it
  48 is no longer needed.
  49
  50 X509_check_email() checks if the certificate matches the specified
  51 email B<address>.  Only the mailbox syntax of RFC 822 is supported,
  52 comments are not allowed, and no attempt is made to normalize quoted
  53 characters.  The B<addresslen> argument must be the number of
  54 characters in the address string or zero in which case the length
  55 is calculated with strlen(B<address>).
  56
  57 X509_check_ip() checks if the certificate matches a specified IPv4 or
  58 IPv6 address.  The B<address> array is in binary format, in network
  59 byte order.  The length is either 4 (IPv4) or 16 (IPv6).  Only
  60 explicitly marked addresses in the certificates are considered; IP
  61 addresses stored in DNS names and Common Names are ignored.
  62
  63 X509_check_ip_asc() is similar, except that the NUL-terminated
  64 string B<address> is first converted to the internal representation.
  65
  66 The B<flags> argument is usually 0.  It can be the bitwise OR of the
  67 flags:
  68
  69 =over 4
  70
  71 =item B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT>,
  72
  73 =item B<X509_CHECK_FLAG_NO_WILDCARDS>,
  74
  75 =item B<X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS>,
  76
  77 =item B<X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS>.
  78
  79 =item B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS>.
  80
  81 =back
  82
  83 The B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT> flag causes the function
  84 to consider the subject DN even if the certificate contains at least
  85 one subject alternative name of the right type (DNS name or email
  86 address as appropriate); the default is to ignore the subject DN
  87 when at least one corresponding subject alternative names is present.
  88
  89 If set, B<X509_CHECK_FLAG_NO_WILDCARDS> disables wildcard
  90 expansion; this only applies to B<X509_check_host>.
  91
  92 If set, B<X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS> suppresses support
  93 for "*" as wildcard pattern in labels that have a prefix or suffix,
  94 such as: "www*" or "*www"; this only applies to B<X509_check_host>.
  95
  96 If set, B<X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS> allows a "*" that
  97 constitutes the complete label of a DNS name (e.g. "*.example.com")
  98 to match more than one label in B<name>; this flag only applies
  99 to B<X509_check_host>.
 100
 101 If set, B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS> restricts B<name>
 102 values which start with ".", that would otherwise match any sub-domain
 103 in the peer certificate, to only match direct child sub-domains.
 104 Thus, for instance, with this flag set a B<name> of ".example.com"
 105 would match a peer certificate with a DNS name of "www.example.com",
 106 but would not match a peer certificate with a DNS name of
 107 "www.sub.example.com"; this flag only applies to B<X509_check_host>.
 108
 109 =head1 RETURN VALUES
 110
 111 The functions return 1 for a successful match, 0 for a failed match
 112 and -1 for an internal error: typically a memory allocation failure
 113 or an ASN.1 decoding error.
 114
 115 All functions can also return -2 if the input is malformed. For example,
 116 X509_check_host() returns -2 if the provided B<name> contains embedded
 117 NULs.
 118
 119 =head1 NOTES
 120
 121 Applications are encouraged to use X509_VERIFY_PARAM_set1_host()
 122 rather than explicitly calling L<X509_check_host(3)>. Host name
 123 checks are out of scope with the DANE-EE(3) certificate usage,
 124 and the internal checks will be suppressed as appropriate when
 125 DANE support is added to OpenSSL.
 126
 127 =head1 SEE ALSO
 128
 129 L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>,
 130 L<X509_VERIFY_PARAM_set1_host(3)|X509_VERIFY_PARAM_set1_host(3)>,
 131 L<X509_VERIFY_PARAM_add1_host(3)|X509_VERIFY_PARAM_add1_host(3)>,
 132 L<X509_VERIFY_PARAM_set1_email(3)|X509_VERIFY_PARAM_set1_email(3)>,
 133 L<X509_VERIFY_PARAM_set1_ip(3)|X509_VERIFY_PARAM_set1_ip(3)>,
 134 L<X509_VERIFY_PARAM_set1_ipasc(3)|X509_VERIFY_PARAM_set1_ipasc(3)>
 135
 136 =head1 HISTORY
 137
 138 These functions were added in OpenSSL 1.0.2.
 139
 140 =cut