More complete X509_check_host documentation.
[openssl.git] / 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. Per section 6.4.2 of RFC 6125,
29 B<name> values representing international domain names must be given
30 in A-label form.  The B<namelen> argument must be the number of
31 characters in the name string or zero in which case the length is
32 calculated with strlen(name).  When B<name> starts with a dot (e.g
33 ".example.com"), it will be matched by a certificate valid for any
34 sub-domain of B<name>, (see also B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS>
35 below).  Applications are strongly advised to use
36 X509_VERIFY_PARAM_set1_host() in preference to explicitly calling
37 L<X509_check_host(3)>, hostname checks are out of scope with the
38 DANE-EE(3) certificate usage, and the internal check will be
39 suppressed as appropriate when DANE support is added to OpenSSL.
40
41 X509_check_email() checks if the certificate matches the specified
42 email address.  Only the mailbox syntax of RFC 822 is supported,
43 comments are not allowed, and no attempt is made to normalize quoted
44 characters.  The B<addresslen> argument must be the number of
45 characters in the address string. The B<namelen> argument must be
46 the number of characters in the name string or zero in which case the
47 length is calculated with strlen(name).
48
49 X509_check_ip() checks if the certificate matches a specified IPv4 or
50 IPv6 address.  The B<address> array is in binary format, in network
51 byte order.  The length is either 4 (IPv4) or 16 (IPv6).  Only
52 explicitly marked addresses in the certificates are considered; IP
53 addresses stored in DNS names and Common Names are ignored.
54
55 X509_check_ip_asc() is similar, except that the NUL-terminated
56 string B<address> is first converted to the internal representation.
57
58 The B<flags> argument is usually 0.  It can be the bitwise OR of the
59 flags:
60
61 =over 4
62
63 =item B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT>,
64
65 =item B<X509_CHECK_FLAG_NO_WILDCARDS>,
66
67 =item B<X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS>,
68
69 =item B<X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS>.
70
71 =item B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS>.
72
73 =back
74
75 The B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT> flag causes the function
76 to consider the subject DN even if the certificate contains at least
77 one subject alternative name of the right type (DNS name or email
78 address as appropriate); the default is to ignore the subject DN
79 when at least one corresponding subject alternative names is present.
80
81 If set, B<X509_CHECK_FLAG_NO_WILDCARDS> disables wildcard
82 expansion; this only applies to B<X509_check_host>.
83
84 If set, B<X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS> suppresses support
85 for "*" as wildcard pattern in labels that have a prefix or suffix,
86 such as: "www*" or "*www"; this only aplies to B<X509_check_host>.
87
88 If set, B<X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS> allows a "*" that
89 constitutes the complete label of a DNS name (e.g. "*.example.com")
90 to match more than one label in B<name>; this flag only applies
91 to B<X509_check_host>.
92
93 If set, B<X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS> restricts B<name>
94 values which start with ".", that would otherwise match any sub-domain
95 in the peer certificate, to only match direct child sub-domains.
96 Thus, for instance, with this flag set a B<name> of ".example.com"
97 would match a peer certificate with a DNS name of "www.example.com",
98 but would not match a peer certificate with a DNS name of
99 "www.sub.example.com"; this flag only applies to B<X509_check_host>.
100
101 =head1 RETURN VALUES
102
103 The functions return 1 for a successful match, 0 for a failed match
104 and -1 for an internal error: typically a memory allocation failure.
105
106 X509_check_ip_asc() can also return -2 if the IP address string is malformed.
107
108 =head1 SEE ALSO
109
110 L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>,
111 L<X509_VERIFY_PARAM_set1_host(3)|X509_VERIFY_PARAM_set1_host(3)>,
112 L<X509_VERIFY_PARAM_set1_email(3)|X509_VERIFY_PARAM_set1_email(3)>,
113 L<X509_VERIFY_PARAM_set1_ip(3)|X509_VERIFY_PARAM_set1_ip(3)>,
114 L<X509_VERIFY_PARAM_set1_ipasc(3)|X509_VERIFY_PARAM_set1_ipasc(3)>
115
116 =head1 HISTORY
117
118 These functions were added in OpenSSL 1.1.0.
119
120 =cut