3 #include "ssl/ErrorDetail.h"
9 Ssl::ssl_error_t value
;
13 static const char *SslErrorDetailDefaultStr
= "SSL handshake error (%err_name)";
14 //Use std::map to optimize search
15 typedef std::map
<Ssl::ssl_error_t
, const SslErrorEntry
*> SslErrors
;
16 SslErrors TheSslErrors
;
18 static SslErrorEntry TheSslErrorArray
[] = {
19 {SQUID_X509_V_ERR_CERT_CHANGE
,
20 "SQUID_X509_V_ERR_CERT_CHANGE"},
21 {SQUID_ERR_SSL_HANDSHAKE
,
22 "SQUID_ERR_SSL_HANDSHAKE"},
23 {SQUID_X509_V_ERR_DOMAIN_MISMATCH
,
24 "SQUID_X509_V_ERR_DOMAIN_MISMATCH"},
25 {X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
,
26 "X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT"},
27 {X509_V_ERR_UNABLE_TO_GET_CRL
,
28 "X509_V_ERR_UNABLE_TO_GET_CRL"},
29 {X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE
,
30 "X509_V_ERR_UNABLE_TO_DECRYPT_CERT_SIGNATURE"},
31 {X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE
,
32 "X509_V_ERR_UNABLE_TO_DECRYPT_CRL_SIGNATURE"},
33 {X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY
,
34 "X509_V_ERR_UNABLE_TO_DECODE_ISSUER_PUBLIC_KEY"},
35 {X509_V_ERR_CERT_SIGNATURE_FAILURE
,
36 "X509_V_ERR_CERT_SIGNATURE_FAILURE"},
37 {X509_V_ERR_CRL_SIGNATURE_FAILURE
,
38 "X509_V_ERR_CRL_SIGNATURE_FAILURE"},
39 {X509_V_ERR_CERT_NOT_YET_VALID
,
40 "X509_V_ERR_CERT_NOT_YET_VALID"},
41 {X509_V_ERR_CERT_HAS_EXPIRED
,
42 "X509_V_ERR_CERT_HAS_EXPIRED"},
43 {X509_V_ERR_CRL_NOT_YET_VALID
,
44 "X509_V_ERR_CRL_NOT_YET_VALID"},
45 {X509_V_ERR_CRL_HAS_EXPIRED
,
46 "X509_V_ERR_CRL_HAS_EXPIRED"},
47 {X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD
,
48 "X509_V_ERR_ERROR_IN_CERT_NOT_BEFORE_FIELD"},
49 {X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD
,
50 "X509_V_ERR_ERROR_IN_CERT_NOT_AFTER_FIELD"},
51 {X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD
,
52 "X509_V_ERR_ERROR_IN_CRL_LAST_UPDATE_FIELD"},
53 {X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD
,
54 "X509_V_ERR_ERROR_IN_CRL_NEXT_UPDATE_FIELD"},
55 {X509_V_ERR_OUT_OF_MEM
,
56 "X509_V_ERR_OUT_OF_MEM"},
57 {X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
,
58 "X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT"},
59 {X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
,
60 "X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN"},
61 {X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
,
62 "X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY"},
63 {X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
,
64 "X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE"},
65 {X509_V_ERR_CERT_CHAIN_TOO_LONG
,
66 "X509_V_ERR_CERT_CHAIN_TOO_LONG"},
67 {X509_V_ERR_CERT_REVOKED
,
68 "X509_V_ERR_CERT_REVOKED"},
69 {X509_V_ERR_INVALID_CA
,
70 "X509_V_ERR_INVALID_CA"},
71 {X509_V_ERR_PATH_LENGTH_EXCEEDED
,
72 "X509_V_ERR_PATH_LENGTH_EXCEEDED"},
73 {X509_V_ERR_INVALID_PURPOSE
,
74 "X509_V_ERR_INVALID_PURPOSE"},
75 {X509_V_ERR_CERT_UNTRUSTED
,
76 "X509_V_ERR_CERT_UNTRUSTED"},
77 {X509_V_ERR_CERT_REJECTED
,
78 "X509_V_ERR_CERT_REJECTED"},
79 {X509_V_ERR_SUBJECT_ISSUER_MISMATCH
,
80 "X509_V_ERR_SUBJECT_ISSUER_MISMATCH"},
81 {X509_V_ERR_AKID_SKID_MISMATCH
,
82 "X509_V_ERR_AKID_SKID_MISMATCH"},
83 {X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH
,
84 "X509_V_ERR_AKID_ISSUER_SERIAL_MISMATCH"},
85 {X509_V_ERR_KEYUSAGE_NO_CERTSIGN
,
86 "X509_V_ERR_KEYUSAGE_NO_CERTSIGN"},
87 {X509_V_ERR_APPLICATION_VERIFICATION
,
88 "X509_V_ERR_APPLICATION_VERIFICATION"},
89 { SSL_ERROR_NONE
, "SSL_ERROR_NONE"},
90 {SSL_ERROR_NONE
, NULL
}
93 struct SslErrorAlias
{
95 const Ssl::ssl_error_t
*errors
;
98 static const Ssl::ssl_error_t hasExpired
[] = {X509_V_ERR_CERT_HAS_EXPIRED
, SSL_ERROR_NONE
};
99 static const Ssl::ssl_error_t notYetValid
[] = {X509_V_ERR_CERT_NOT_YET_VALID
, SSL_ERROR_NONE
};
100 static const Ssl::ssl_error_t domainMismatch
[] = {SQUID_X509_V_ERR_DOMAIN_MISMATCH
, SSL_ERROR_NONE
};
101 static const Ssl::ssl_error_t certUntrusted
[] = {X509_V_ERR_INVALID_CA
,
102 X509_V_ERR_SELF_SIGNED_CERT_IN_CHAIN
,
103 X509_V_ERR_UNABLE_TO_VERIFY_LEAF_SIGNATURE
,
104 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT
,
105 X509_V_ERR_UNABLE_TO_GET_ISSUER_CERT_LOCALLY
,
106 X509_V_ERR_CERT_UNTRUSTED
, SSL_ERROR_NONE
};
107 static const Ssl::ssl_error_t certSelfSigned
[] = {X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT
, SSL_ERROR_NONE
};
109 // The list of error name shortcuts for use with ssl_error acls.
110 // The keys without the "ssl::" scope prefix allow shorter error
111 // names within the SSL options scope. This is easier than
112 // carefully stripping the scope prefix in Ssl::ParseErrorString()
113 static SslErrorAlias TheSslErrorShortcutsArray
[] = {
114 {"ssl::certHasExpired", hasExpired
},
115 {"certHasExpired", hasExpired
},
116 {"ssl::certNotYetValid", notYetValid
},
117 {"certNotYetValid", notYetValid
},
118 {"ssl::certDomainMismatch", domainMismatch
},
119 {"certDomainMismatch", domainMismatch
},
120 {"ssl::certUntrusted", certUntrusted
},
121 {"certUntrusted", certUntrusted
},
122 {"ssl::certSelfSigned", certSelfSigned
},
123 {"certSelfSigned", certSelfSigned
},
127 //Use std::map to optimize search
128 typedef std::map
<std::string
, const Ssl::ssl_error_t
*> SslErrorShortcuts
;
129 SslErrorShortcuts TheSslErrorShortcuts
;
131 static void loadSslErrorMap()
133 assert(TheSslErrors
.empty());
134 for (int i
= 0; TheSslErrorArray
[i
].name
; ++i
) {
135 TheSslErrors
[TheSslErrorArray
[i
].value
] = &TheSslErrorArray
[i
];
139 static void loadSslErrorShortcutsMap()
141 assert(TheSslErrorShortcuts
.empty());
142 for (int i
= 0; TheSslErrorShortcutsArray
[i
].name
; i
++)
143 TheSslErrorShortcuts
[TheSslErrorShortcutsArray
[i
].name
] = TheSslErrorShortcutsArray
[i
].errors
;
146 Ssl::ssl_error_t
Ssl::GetErrorCode(const char *name
)
148 for (int i
= 0; TheSslErrorArray
[i
].name
!= NULL
; i
++) {
149 if (strcmp(name
, TheSslErrorArray
[i
].name
) == 0)
150 return TheSslErrorArray
[i
].value
;
152 return SSL_ERROR_NONE
;
156 Ssl::ParseErrorString(const char *name
)
160 const Ssl::ssl_error_t ssl_error
= GetErrorCode(name
);
161 if (ssl_error
!= SSL_ERROR_NONE
)
162 return new Ssl::Errors(ssl_error
);
164 if (xisdigit(*name
)) {
165 const long int value
= strtol(name
, NULL
, 0);
166 if (SQUID_SSL_ERROR_MIN
<= value
&& value
<= SQUID_SSL_ERROR_MAX
)
167 return new Ssl::Errors(value
);
168 fatalf("Too small or too bug SSL error code '%s'", name
);
171 if (TheSslErrorShortcuts
.empty())
172 loadSslErrorShortcutsMap();
174 const SslErrorShortcuts::const_iterator it
= TheSslErrorShortcuts
.find(name
);
175 if (it
!= TheSslErrorShortcuts
.end()) {
176 // Should not be empty...
177 assert(it
->second
[0] != SSL_ERROR_NONE
);
178 Ssl::Errors
*errors
= new Ssl::Errors(it
->second
[0]);
179 for (int i
=1; it
->second
[i
] != SSL_ERROR_NONE
; i
++) {
180 errors
->push_back_unique(it
->second
[i
]);
185 fatalf("Unknown SSL error name '%s'", name
);
186 return NULL
; // not reached
189 const char *Ssl::GetErrorName(Ssl::ssl_error_t value
)
191 if (TheSslErrors
.empty())
194 const SslErrors::const_iterator it
= TheSslErrors
.find(value
);
195 if (it
!= TheSslErrors
.end())
196 return it
->second
->name
;
202 Ssl::GetErrorDescr(Ssl::ssl_error_t value
)
204 return ErrorDetailsManager::GetInstance().getDefaultErrorDescr(value
);
207 Ssl::ErrorDetail::err_frm_code
Ssl::ErrorDetail::ErrorFormatingCodes
[] = {
208 {"ssl_subject", &Ssl::ErrorDetail::subject
},
209 {"ssl_ca_name", &Ssl::ErrorDetail::ca_name
},
210 {"ssl_cn", &Ssl::ErrorDetail::cn
},
211 {"ssl_notbefore", &Ssl::ErrorDetail::notbefore
},
212 {"ssl_notafter", &Ssl::ErrorDetail::notafter
},
213 {"err_name", &Ssl::ErrorDetail::err_code
},
214 {"ssl_error_descr", &Ssl::ErrorDetail::err_descr
},
215 {"ssl_lib_error", &Ssl::ErrorDetail::err_lib_error
},
220 * The subject of the current certification in text form
222 const char *Ssl::ErrorDetail::subject() const
225 return "[Not available]";
227 static char tmpBuffer
[256]; // A temporary buffer
228 X509_NAME_oneline(X509_get_subject_name(broken_cert
.get()), tmpBuffer
,
233 // helper function to be used with Ssl::matchX509CommonNames
234 static int copy_cn(void *check_data
, ASN1_STRING
*cn_data
)
236 String
*str
= (String
*)check_data
;
237 if (!str
) // no data? abort
241 str
->append((const char *)cn_data
->data
, cn_data
->length
);
246 * The list with certificates cn and alternate names
248 const char *Ssl::ErrorDetail::cn() const
251 return "[Not available]";
253 static String tmpStr
; ///< A temporary string buffer
255 Ssl::matchX509CommonNames(broken_cert
.get(), &tmpStr
, copy_cn
);
256 return tmpStr
.termedBuf();
262 const char *Ssl::ErrorDetail::ca_name() const
265 return "[Not available]";
267 static char tmpBuffer
[256]; // A temporary buffer
268 X509_NAME_oneline(X509_get_issuer_name(broken_cert
.get()), tmpBuffer
, sizeof(tmpBuffer
));
273 * The certificate "not before" field
275 const char *Ssl::ErrorDetail::notbefore() const
278 return "[Not available]";
280 static char tmpBuffer
[256]; // A temporary buffer
281 ASN1_UTCTIME
* tm
= X509_get_notBefore(broken_cert
.get());
282 Ssl::asn1timeToString(tm
, tmpBuffer
, sizeof(tmpBuffer
));
287 * The certificate "not after" field
289 const char *Ssl::ErrorDetail::notafter() const
292 return "[Not available]";
294 static char tmpBuffer
[256]; // A temporary buffer
295 ASN1_UTCTIME
* tm
= X509_get_notAfter(broken_cert
.get());
296 Ssl::asn1timeToString(tm
, tmpBuffer
, sizeof(tmpBuffer
));
301 * The string representation of the error_no
303 const char *Ssl::ErrorDetail::err_code() const
305 static char tmpBuffer
[64];
306 // We can use the GetErrorName but using the detailEntry is faster,
308 const char *err
= detailEntry
.name
.termedBuf();
310 // error details not loaded yet or not defined in error_details.txt,
311 // try the GetErrorName...
313 err
= GetErrorName(error_no
);
316 snprintf(tmpBuffer
, 64, "%d", (int)error_no
);
323 * A short description of the error_no
325 const char *Ssl::ErrorDetail::err_descr() const
327 if (error_no
== SSL_ERROR_NONE
)
329 if (const char *err
= detailEntry
.descr
.termedBuf())
331 return "[Not available]";
334 const char *Ssl::ErrorDetail::err_lib_error() const
336 if (lib_error_no
!= SSL_ERROR_NONE
)
337 return ERR_error_string(lib_error_no
, NULL
);
343 * It converts the code to a string value. Supported formating codes are:
345 * Error meta information:
346 * %err_name: The name of a high-level SSL error (e.g., X509_V_ERR_*)
347 * %ssl_error_descr: A short description of the SSL error
348 * %ssl_lib_error: human-readable low-level error string by ERR_error_string(3SSL)
350 * Certificate information extracted from broken (not necessarily peer!) cert
351 * %ssl_cn: The comma-separated list of common and alternate names
352 * %ssl_subject: The certificate subject
353 * %ssl_ca_name: The certificate issuer name
354 * %ssl_notbefore: The certificate "not before" field
355 * %ssl_notafter: The certificate "not after" field
357 \retval the length of the code (the number of characters will be replaced by value)
359 int Ssl::ErrorDetail::convert(const char *code
, const char **value
) const
362 for (int i
=0; ErrorFormatingCodes
[i
].code
!=NULL
; i
++) {
363 const int len
= strlen(ErrorFormatingCodes
[i
].code
);
364 if (strncmp(code
,ErrorFormatingCodes
[i
].code
, len
)==0) {
365 ErrorDetail::fmt_action_t action
= ErrorFormatingCodes
[i
].fmt_action
;
366 *value
= (this->*action
)();
374 * It uses the convert method to build the string errDetailStr using
375 * a template message for the current SSL error. The template messages
376 * can also contain normal error pages formating codes.
377 * Currently the error template messages are hard-coded
379 void Ssl::ErrorDetail::buildDetail() const
381 char const *s
= NULL
;
386 if (ErrorDetailsManager::GetInstance().getErrorDetail(error_no
, request
.raw(), detailEntry
))
387 s
= detailEntry
.detail
.termedBuf();
390 s
= SslErrorDetailDefaultStr
;
393 while ((p
= strchr(s
, '%'))) {
394 errDetailStr
.append(s
, p
- s
);
395 code_len
= convert(++p
, &t
);
397 errDetailStr
.append(t
);
399 errDetailStr
.append("%");
402 errDetailStr
.append(s
, strlen(s
));
405 const String
&Ssl::ErrorDetail::toString() const
407 if (!errDetailStr
.defined())
412 Ssl::ErrorDetail::ErrorDetail( Ssl::ssl_error_t err_no
, X509
*cert
, X509
*broken
): error_no (err_no
), lib_error_no(SSL_ERROR_NONE
)
415 peer_cert
.resetAndLock(cert
);
418 broken_cert
.resetAndLock(broken
);
420 broken_cert
.resetAndLock(cert
);
422 detailEntry
.error_no
= SSL_ERROR_NONE
;
425 Ssl::ErrorDetail::ErrorDetail(Ssl::ErrorDetail
const &anErrDetail
)
427 error_no
= anErrDetail
.error_no
;
428 request
= anErrDetail
.request
;
430 if (anErrDetail
.peer_cert
.get()) {
431 peer_cert
.resetAndLock(anErrDetail
.peer_cert
.get());
434 if (anErrDetail
.broken_cert
.get()) {
435 broken_cert
.resetAndLock(anErrDetail
.broken_cert
.get());
438 detailEntry
= anErrDetail
.detailEntry
;
440 lib_error_no
= anErrDetail
.lib_error_no
;