[Curl] Add TLS debugging feature to log encryption keys
[WebKit.git] / Source / WebCore / platform / network / curl / CurlSSLVerifier.cpp
1 /*
2  * Copyright (C) 2013 University of Szeged
3  * Copyright (C) 2020 Sony Interactive Entertainment Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY UNIVERSITY OF SZEGED ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "CurlSSLVerifier.h"
29
30 #if USE(CURL)
31 #include "CurlContext.h"
32 #include "CurlSSLHandle.h"
33
34 namespace WebCore {
35
36 static CurlSSLVerifier::SSLCertificateFlags convertToSSLCertificateFlags(unsigned);
37
38 CurlSSLVerifier::CurlSSLVerifier(void* sslCtx)
39 {
40     auto* ctx = static_cast<SSL_CTX*>(sslCtx);
41     const auto& sslHandle = CurlContext::singleton().sslHandle();
42
43     SSL_CTX_set_app_data(ctx, this);
44     SSL_CTX_set_verify(ctx, SSL_CTX_get_verify_mode(ctx), verifyCallback);
45
46 #if defined(LIBRESSL_VERSION_NUMBER)
47     if (auto data = WTF::get_if<CertificateInfo::Certificate>(sslHandle.getCACertInfo()))
48         SSL_CTX_load_verify_mem(ctx, static_cast<void*>(const_cast<uint8_t*>(data->data())), data->size());
49 #endif
50
51 #if (!defined(LIBRESSL_VERSION_NUMBER))
52     const auto& signatureAlgorithmsList = sslHandle.getSignatureAlgorithmsList();
53     if (!signatureAlgorithmsList.isEmpty())
54         SSL_CTX_set1_sigalgs_list(ctx, signatureAlgorithmsList->utf8().data());
55 #endif
56
57     const auto& curvesList = sslHandle.getCurvesList();
58     if (!curvesList.isEmpty())
59         SSL_CTX_set1_curves_list(ctx, curvesList.utf8().data());
60
61 #if ENABLE(TLS_DEBUG)
62     SSL_CTX_set_info_callback(ctx, infoCallback);
63 #endif
64 }
65
66 void CurlSSLVerifier::collectInfo(X509_STORE_CTX* ctx)
67 {
68     if (auto certificateInfo = OpenSSL::createCertificateInfo(ctx))
69         m_certificateInfo = WTFMove(*certificateInfo);
70
71     if (auto error = m_certificateInfo.verificationError())
72         m_sslErrors = static_cast<int>(convertToSSLCertificateFlags(error));
73 }
74
75 int CurlSSLVerifier::verifyCallback(int preverified, X509_STORE_CTX* ctx)
76 {
77     auto ssl = static_cast<SSL*>(X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
78     auto sslCtx = SSL_get_SSL_CTX(ssl);
79     auto verifier = static_cast<CurlSSLVerifier*>(SSL_CTX_get_app_data(sslCtx));
80
81     verifier->collectInfo(ctx);
82     // whether the verification of the certificate in question was passed (preverified=1) or not (preverified=0)
83     return preverified;
84 }
85
86 #if ENABLE(TLS_DEBUG)
87
88 void CurlSSLVerifier::infoCallback(const SSL* ssl, int where, int)
89 {
90     auto sslCtx = SSL_get_SSL_CTX(ssl);
91     auto verifier = static_cast<CurlSSLVerifier*>(SSL_CTX_get_app_data(sslCtx));
92
93     if (where & SSL_CB_HANDSHAKE_DONE)
94         verifier->logTLSKey(ssl);
95 }
96
97 void CurlSSLVerifier::logTLSKey(const SSL* ssl)
98 {
99     // See https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format
100
101     if (!CurlContext::singleton().shouldLogTLSKey())
102         return;
103
104     auto* session = SSL_get_session(ssl);
105     if (!session)
106         return;
107
108     auto& version = session->ssl_version;
109     if (version != TLS1_VERSION && version != TLS1_1_VERSION && version != TLS1_2_VERSION)
110         return;
111
112     auto requiredSize = SSL_get_client_random(ssl, nullptr, 0);
113     Vector<uint8_t> clientRandom(requiredSize);
114     if (SSL_get_client_random(ssl, clientRandom.data(), clientRandom.size()) != clientRandom.size())
115         return;
116
117     requiredSize = SSL_SESSION_get_master_key(session, nullptr, 0);
118     Vector<uint8_t> masterKey(requiredSize);
119     if (SSL_SESSION_get_master_key(session, masterKey.data(), masterKey.size()) != masterKey.size())
120         return;
121
122     auto fp = fopen(CurlContext::singleton().tlsKeyLogFilePath().utf8().data(), "a");
123     if (!fp)
124         return;
125
126     fprintf(fp, "CLIENT_RANDOM ");
127
128     for (size_t i = 0; i < clientRandom.size(); i++)
129         fprintf(fp, "%02X", clientRandom[i]);
130
131     fprintf(fp, " ");
132
133     for (size_t i = 0; i < masterKey.size(); i++)
134         fprintf(fp, "%02X", masterKey[i]);
135
136     fprintf(fp, "\n");
137     fclose(fp);
138 }
139
140 #endif
141
142 static CurlSSLVerifier::SSLCertificateFlags convertToSSLCertificateFlags(unsigned sslError)
143 {
144     switch (sslError) {
145     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT : // the issuer certificate could not be found: this occurs if the issuer certificate of an untrusted certificate cannot be found.
146     case X509_V_ERR_UNABLE_TO_GET_CRL : // the CRL of a certificate could not be found.
147     case X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY : // the issuer certificate of a locally looked up certificate could not be found. This normally means the list of trusted certificates is not complete.
148         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_UNKNOWN_CA;
149     case X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE : // the certificate signature could not be decrypted. This means that the actual signature value could not be determined rather than it not matching the expected value, this is only meaningful for RSA keys.
150     case X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE : // the CRL signature could not be decrypted: this means that the actual signature value could not be determined rather than it not matching the expected value. Unused.
151     case X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY : // the public key in the certificate SubjectPublicKeyInfo could not be read.
152     case X509_V_ERR_CERT_SIGNATURE_FAILURE : // the signature of the certificate is invalid.
153     case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT : // the passed certificate is self signed and the same certificate cannot be found in the list of trusted certificates.
154     case X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN : // the certificate chain could be built up using the untrusted certificates but the root could not be found locally.
155     case X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE : // no signatures could be verified because the chain contains only one certificate and it is not self signed.
156     case X509_V_ERR_INVALID_PURPOSE : // the supplied certificate cannot be used for the specified purpose.
157     case X509_V_ERR_CERT_UNTRUSTED : // the root CA is not marked as trusted for the specified purpose.
158     case X509_V_ERR_CERT_REJECTED : // the root CA is marked to reject the specified purpose.
159     case X509_V_ERR_NO_EXPLICIT_POLICY : // the verification flags were set to require and explicit policy but none was present.
160     case X509_V_ERR_DIFFERENT_CRL_SCOPE : // the only CRLs that could be found did not match the scope of the certificate.
161         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_INSECURE;
162     case X509_V_ERR_CERT_NOT_YET_VALID : // the certificate is not yet valid: the notBefore date is after the current time.
163     case X509_V_ERR_CRL_NOT_YET_VALID : // the CRL is not yet valid.
164         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_NOT_ACTIVATED;
165     case X509_V_ERR_CERT_HAS_EXPIRED : // the certificate has expired: that is the notAfter date is before the current time.
166     case X509_V_ERR_CRL_HAS_EXPIRED : // the CRL has expired.
167         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_EXPIRED;
168     case X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD : // the certificate notBefore field contains an invalid time.
169     case X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD : // the certificate notAfter field contains an invalid time.
170     case X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD : // the CRL lastUpdate field contains an invalid time.
171     case X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD : // the CRL nextUpdate field contains an invalid time.
172     case X509_V_ERR_OUT_OF_MEM : // an error occurred trying to allocate memory. This should never happen.
173     case X509_V_ERR_CERT_CHAIN_TOO_LONG : // the certificate chain length is greater than the supplied maximum depth. Unused.
174     case X509_V_ERR_PATH_LENGTH_EXCEEDED : // the basicConstraints pathlength parameter has been exceeded.
175     case X509_V_ERR_INVALID_EXTENSION : // a certificate extension had an invalid value (for example an incorrect encoding) or some value inconsistent with other extensions.
176     case X509_V_ERR_INVALID_POLICY_EXTENSION : // a certificate policies extension had an invalid value (for example an incorrect encoding) or some value inconsistent with other extensions. This error only occurs if policy processing is enabled.
177     case X509_V_ERR_UNSUPPORTED_EXTENSION_FEATURE : // some feature of a certificate extension is not supported. Unused.
178     case X509_V_ERR_PERMITTED_VIOLATION : // a name constraint violation occured in the permitted subtrees.
179     case X509_V_ERR_EXCLUDED_VIOLATION : // a name constraint violation occured in the excluded subtrees.
180     case X509_V_ERR_SUBTREE_MINMAX : // a certificate name constraints extension included a minimum or maximum field: this is not supported.
181     case X509_V_ERR_UNSUPPORTED_CONSTRAINT_TYPE : // an unsupported name constraint type was encountered. OpenSSL currently only supports directory name, DNS name, email and URI types.
182     case X509_V_ERR_UNSUPPORTED_CONSTRAINT_SYNTAX : // the format of the name constraint is not recognised: for example an email address format of a form not mentioned in RFC3280. This could be caused by a garbage extension or some new feature not currently supported.
183     case X509_V_ERR_CRL_PATH_VALIDATION_ERROR : // an error occured when attempting to verify the CRL path. This error can only happen if extended CRL checking is enabled.
184     case X509_V_ERR_APPLICATION_VERIFICATION : // an application specific error. This will never be returned unless explicitly set by an application.
185         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_GENERIC_ERROR;
186     case X509_V_ERR_CERT_REVOKED : // the certificate has been revoked.
187         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_REVOKED;
188     case X509_V_ERR_INVALID_CA : // a CA certificate is invalid. Either it is not a CA or its extensions are not consistent with the supplied purpose.
189     case X509_V_ERR_SUBJECT_ISSUER_MISMATCH : // the current candidate issuer certificate was rejected because its subject name did not match the issuer name of the current certificate. This is only set if issuer check debugging is enabled it is used for status notification and is not in itself an error.
190     case X509_V_ERR_AKID_SKID_MISMATCH : // the current candidate issuer certificate was rejected because its subject key identifier was present and did not match the authority key identifier current certificate. This is only set if issuer check debugging is enabled it is used for status notification and is not in itself an error.
191     case X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH : // the current candidate issuer certificate was rejected because its issuer name and serial number was present and did not match the authority key identifier of the current certificate. This is only set if issuer check debugging is enabled it is used for status notification and is not in itself an error.
192     case X509_V_ERR_KEYUSAGE_NO_CERTSIGN : // the current candidate issuer certificate was rejected because its keyUsage extension does not permit certificate signing. This is only set if issuer check debugging is enabled it is used for status notification and is not in itself an error.
193         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_BAD_IDENTITY;
194     default :
195         return CurlSSLVerifier::SSLCertificateFlags::SSL_CERTIFICATE_GENERIC_ERROR;
196     }
197 }
198
199 }
200
201 #endif