xref: /freebsd/contrib/libevent/sample/openssl_hostname_validation.h (revision 6be3386466ab79a84b48429ae66244f21526d3df)
1 /* Obtained from: https://github.com/iSECPartners/ssl-conservatory */
2 
3 /*
4 Copyright (C) 2012, iSEC Partners.
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy of
7 this software and associated documentation files (the "Software"), to deal in
8 the Software without restriction, including without limitation the rights to
9 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10 of the Software, and to permit persons to whom the Software is furnished to do
11 so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23  */
24 
25 /*
26  * Helper functions to perform basic hostname validation using OpenSSL.
27  *
28  * Please read "everything-you-wanted-to-know-about-openssl.pdf" before
29  * attempting to use this code. This whitepaper describes how the code works,
30  * how it should be used, and what its limitations are.
31  *
32  * Author:  Alban Diquet
33  * License: See LICENSE
34  *
35  */
36 
37 typedef enum {
38         MatchFound,
39         MatchNotFound,
40         NoSANPresent,
41         MalformedCertificate,
42         Error
43 } HostnameValidationResult;
44 
45 /**
46 * Validates the server's identity by looking for the expected hostname in the
47 * server's certificate. As described in RFC 6125, it first tries to find a match
48 * in the Subject Alternative Name extension. If the extension is not present in
49 * the certificate, it checks the Common Name instead.
50 *
51 * Returns MatchFound if a match was found.
52 * Returns MatchNotFound if no matches were found.
53 * Returns MalformedCertificate if any of the hostnames had a NUL character embedded in it.
54 * Returns Error if there was an error.
55 */
56 HostnameValidationResult validate_hostname(const char *hostname, const X509 *server_cert);
57