PR: 2909
[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. 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).
31
32 X509_check_email() checks if the certificate matches the specified
33 email address.  Only the mailbox syntax of RFC 822 is supported,
34 comments are not allowed, and no attempt is made to normalize quoted
35 characters.  The B<addresslen> argument must be the number of
36 characters in the address string. The B<namelen> argument must be
37 the number of characters in the name string or zero in which case the
38 length is calculated with strlen(name).
39
40 X509_check_ip() checks if the certificate matches a specified IPv4 or
41 IPv6 address.  The B<address> array is in binary format, in network
42 byte order.  The length is either 4 (IPv4) or 16 (IPv6).  Only
43 explicitly marked addresses in the certificates are considered; IP
44 addresses stored in DNS names and Common Names are ignored.
45
46 X509_check_ip_asc() is similar, except that the NUL-terminated
47 string B<address> is first converted to the internal representation.
48
49 The B<flags> argument is usually 0.  It can be the bitwise OR of the
50 flags B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT>,
51 B<X509_CHECK_FLAG_NO_WILDCARDS>.
52
53 The B<X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT> flag causes the function
54 to check the subject DN even if the certificate contains a subject
55 alternative name extension is present; the default is to ignore the
56 subject DN in preference of the extension.
57
58 If present, B<X509_CHECK_FLAG_NO_WILDCARDS> disables wildcard
59 expansion; this only applies to B<X509_check_host>.
60
61 =head1 RETURN VALUES
62
63 The functions return 1 for a successful match, 0 for a failed match
64 and -1 for an internal error: typically a memory allocation failure.
65
66 X509_check_ip_asc() can also return -2 if the IP address string is malformed.
67
68 =head1 SEE ALSO
69
70 L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>
71
72 =head1 HISTORY
73
74 These functions were added in OpenSSL 1.1.0.
75
76 =cut