]>
Commit | Line | Data |
---|---|---|
bbc27441 | 1 | /* |
b8ae064d | 2 | * Copyright (C) 1996-2023 The Squid Software Foundation and contributors |
bbc27441 AJ |
3 | * |
4 | * Squid software is distributed under GPLv2+ license and includes | |
5 | * contributions from numerous individuals and organizations. | |
6 | * Please see the COPYING and CONTRIBUTORS files for details. | |
7 | */ | |
8 | ||
f7f3304a | 9 | #include "squid.h" |
24438ec5 | 10 | #include "../helper.h" |
502bcc7b | 11 | #include "anyp/PortCfg.h" |
e5ddd4ce | 12 | #include "base/AsyncCallbacks.h" |
72247610 | 13 | #include "cache_cf.h" |
b3f7fd88 | 14 | #include "fs_io.h" |
24438ec5 | 15 | #include "helper/Reply.h" |
72247610 | 16 | #include "Parsing.h" |
70ac5b29 | 17 | #include "sbuf/Stream.h" |
602d9612 | 18 | #include "SquidConfig.h" |
14798e73 | 19 | #include "ssl/cert_validate_message.h" |
602d9612 A |
20 | #include "ssl/Config.h" |
21 | #include "ssl/helper.h" | |
fc54b8d2 | 22 | #include "wordlist.h" |
95d2589c | 23 | |
1f8b5f0e | 24 | #include <limits> |
25 | ||
72247610 | 26 | Ssl::CertValidationHelper::CacheType *Ssl::CertValidationHelper::HelperCache = nullptr; |
968b000d | 27 | |
58fa3f51 CT |
28 | #if USE_SSL_CRTD |
29 | ||
30 | namespace Ssl { | |
31 | ||
32 | /// Initiator of an Ssl::Helper query. | |
33 | class GeneratorRequestor { | |
34 | public: | |
35 | GeneratorRequestor(HLPCB *aCallback, void *aData): callback(aCallback), data(aData) {} | |
36 | HLPCB *callback; | |
37 | CallbackData data; | |
38 | }; | |
39 | ||
40 | /// A pending Ssl::Helper request, combining the original and collapsed queries. | |
41 | class GeneratorRequest { | |
42 | CBDATA_CLASS(GeneratorRequest); | |
43 | ||
44 | public: | |
45 | /// adds a GeneratorRequestor | |
46 | void emplace(HLPCB *callback, void *data) { requestors.emplace_back(callback, data); } | |
47 | ||
48 | SBuf query; ///< Ssl::Helper request message (GeneratorRequests key) | |
49 | ||
50 | /// Ssl::Helper request initiators waiting for the same answer (FIFO). | |
51 | typedef std::vector<GeneratorRequestor> GeneratorRequestors; | |
52 | GeneratorRequestors requestors; | |
53 | }; | |
54 | ||
55 | /// Ssl::Helper query:GeneratorRequest map | |
56 | typedef std::unordered_map<SBuf, GeneratorRequest*> GeneratorRequests; | |
57 | ||
58 | static void HandleGeneratorReply(void *data, const ::Helper::Reply &reply); | |
59 | ||
60 | } // namespace Ssl | |
61 | ||
62 | CBDATA_NAMESPACED_CLASS_INIT(Ssl, GeneratorRequest); | |
63 | ||
64 | /// prints Ssl::GeneratorRequest for debugging | |
65 | static std::ostream & | |
66 | operator <<(std::ostream &os, const Ssl::GeneratorRequest &gr) | |
67 | { | |
68 | return os << "crtGenRq" << gr.query.id.value << "/" << gr.requestors.size(); | |
69 | } | |
70 | ||
71 | /// pending Ssl::Helper requests (to all certificate generator helpers combined) | |
72 | static Ssl::GeneratorRequests TheGeneratorRequests; | |
73 | ||
e05a9d51 | 74 | Helper::Client::Pointer Ssl::Helper::ssl_crtd; |
95d2589c CT |
75 | |
76 | void Ssl::Helper::Init() | |
77 | { | |
aee3523a | 78 | assert(ssl_crtd == nullptr); |
586089cd | 79 | |
f0763147 AJ |
80 | // we need to start ssl_crtd only if some port(s) need to bump SSL *and* generate certificates |
81 | // TODO: generate host certificates for SNI enabled accel ports | |
24e6c8f1 | 82 | bool found = false; |
aee3523a | 83 | for (AnyP::PortCfgPointer s = HttpPortList; !found && s != nullptr; s = s->next) |
cf487124 | 84 | found = s->flags.tunnelSslBumping && s->secure.generateHostCertificates; |
24e6c8f1 | 85 | if (!found) |
586089cd CT |
86 | return; |
87 | ||
e05a9d51 | 88 | ssl_crtd = ::Helper::Client::Make("sslcrtd_program"); |
1af735c7 | 89 | ssl_crtd->childs.updateLimits(Ssl::TheConfig.ssl_crtdChildren); |
95d2589c | 90 | ssl_crtd->ipc_type = IPC_STREAM; |
0af9303a CT |
91 | // The crtd messages may contain the eol ('\n') character. We are |
92 | // going to use the '\1' char as the end-of-message mark. | |
93 | ssl_crtd->eom = '\1'; | |
aee3523a | 94 | assert(ssl_crtd->cmdline == nullptr); |
95d2589c CT |
95 | { |
96 | char *tmp = xstrdup(Ssl::TheConfig.ssl_crtd); | |
97 | char *tmp_begin = tmp; | |
aee3523a AR |
98 | char *token = nullptr; |
99 | while ((token = strwordtok(nullptr, &tmp))) { | |
95d2589c | 100 | wordlistAdd(&ssl_crtd->cmdline, token); |
95d2589c CT |
101 | } |
102 | safe_free(tmp_begin); | |
103 | } | |
bd71920d | 104 | ssl_crtd->openSessions(); |
95d2589c CT |
105 | } |
106 | ||
107 | void Ssl::Helper::Shutdown() | |
108 | { | |
109 | if (!ssl_crtd) | |
110 | return; | |
111 | helperShutdown(ssl_crtd); | |
112 | wordlistDestroy(&ssl_crtd->cmdline); | |
aee3523a | 113 | ssl_crtd = nullptr; |
95d2589c CT |
114 | } |
115 | ||
23da195f CT |
116 | void |
117 | Ssl::Helper::Reconfigure() | |
95d2589c | 118 | { |
23da195f CT |
119 | Shutdown(); |
120 | Init(); | |
121 | } | |
95d2589c | 122 | |
23da195f CT |
123 | void Ssl::Helper::Submit(CrtdMessage const & message, HLPCB * callback, void * data) |
124 | { | |
58fa3f51 CT |
125 | SBuf rawMessage(message.compose().c_str()); // XXX: helpers cannot use SBuf |
126 | rawMessage.append("\n", 1); | |
127 | ||
128 | const auto pending = TheGeneratorRequests.find(rawMessage); | |
129 | if (pending != TheGeneratorRequests.end()) { | |
130 | pending->second->emplace(callback, data); | |
131 | debugs(83, 5, "collapsed request from " << data << " onto " << *pending->second); | |
132 | return; | |
133 | } | |
134 | ||
135 | GeneratorRequest *request = new GeneratorRequest; | |
136 | request->query = rawMessage; | |
137 | request->emplace(callback, data); | |
138 | TheGeneratorRequests.emplace(request->query, request); | |
139 | debugs(83, 5, "request from " << data << " as " << *request); | |
23da195f CT |
140 | // ssl_crtd becomes nil if Squid is reconfigured without SslBump or |
141 | // certificate generation disabled in the new configuration | |
142 | if (ssl_crtd && ssl_crtd->trySubmit(request->query.c_str(), HandleGeneratorReply, request)) | |
95d2589c | 143 | return; |
58fa3f51 CT |
144 | |
145 | ::Helper::Reply failReply(::Helper::BrokenHelper); | |
146 | failReply.notes.add("message", "error 45 Temporary network problem, please retry later"); | |
147 | HandleGeneratorReply(request, failReply); | |
148 | } | |
149 | ||
150 | /// receives helper response | |
151 | static void | |
152 | Ssl::HandleGeneratorReply(void *data, const ::Helper::Reply &reply) | |
153 | { | |
154 | const std::unique_ptr<Ssl::GeneratorRequest> request(static_cast<Ssl::GeneratorRequest*>(data)); | |
155 | assert(request); | |
156 | const auto erased = TheGeneratorRequests.erase(request->query); | |
157 | assert(erased); | |
158 | ||
159 | for (auto &requestor: request->requestors) { | |
160 | if (void *cbdata = requestor.data.validDone()) { | |
161 | debugs(83, 5, "to " << cbdata << " in " << *request); | |
162 | requestor.callback(cbdata, reply); | |
163 | } | |
95d2589c | 164 | } |
95d2589c | 165 | } |
4a77bb4e | 166 | #endif //USE_SSL_CRTD |
2cef0ca6 | 167 | |
e05a9d51 | 168 | Helper::Client::Pointer Ssl::CertValidationHelper::ssl_crt_validator; |
2cef0ca6 AR |
169 | |
170 | void Ssl::CertValidationHelper::Init() | |
171 | { | |
23da195f CT |
172 | if (!Ssl::TheConfig.ssl_crt_validator) |
173 | return; | |
174 | ||
aee3523a | 175 | assert(ssl_crt_validator == nullptr); |
2cef0ca6 AR |
176 | |
177 | // we need to start ssl_crtd only if some port(s) need to bump SSL | |
178 | bool found = false; | |
aee3523a | 179 | for (AnyP::PortCfgPointer s = HttpPortList; !found && s != nullptr; s = s->next) |
6a25a046 | 180 | found = s->flags.tunnelSslBumping; |
2cef0ca6 AR |
181 | if (!found) |
182 | return; | |
183 | ||
e05a9d51 | 184 | ssl_crt_validator = ::Helper::Client::Make("ssl_crt_validator"); |
2cef0ca6 AR |
185 | ssl_crt_validator->childs.updateLimits(Ssl::TheConfig.ssl_crt_validator_Children); |
186 | ssl_crt_validator->ipc_type = IPC_STREAM; | |
187 | // The crtd messages may contain the eol ('\n') character. We are | |
188 | // going to use the '\1' char as the end-of-message mark. | |
189 | ssl_crt_validator->eom = '\1'; | |
aee3523a | 190 | assert(ssl_crt_validator->cmdline == nullptr); |
14798e73 | 191 | |
72247610 AJ |
192 | /* defaults */ |
193 | int ttl = 3600; // 1 hour | |
194 | size_t cache = 64*1024*1024; // 64 MB | |
2cef0ca6 | 195 | { |
72247610 | 196 | // TODO: Do this during parseConfigFile() for proper parsing, error handling |
2cef0ca6 AR |
197 | char *tmp = xstrdup(Ssl::TheConfig.ssl_crt_validator); |
198 | char *tmp_begin = tmp; | |
aee3523a | 199 | char * token = nullptr; |
14798e73 | 200 | bool parseParams = true; |
aee3523a | 201 | while ((token = strwordtok(nullptr, &tmp))) { |
14798e73 | 202 | if (parseParams) { |
72247610 AJ |
203 | if (strcmp(token, "ttl=infinity") == 0) { |
204 | ttl = std::numeric_limits<CacheType::Ttl>::max(); | |
205 | continue; | |
206 | } else if (strncmp(token, "ttl=", 4) == 0) { | |
207 | ttl = xatoi(token + 4); | |
208 | if (ttl < 0) { | |
209 | throw TextException(ToSBuf("Negative TTL in sslcrtvalidator_program ", Ssl::TheConfig.ssl_crt_validator, | |
70ac5b29 | 210 | Debug::Extra, "For unlimited TTL, use ttl=infinity"), |
211 | Here()); | |
72247610 | 212 | } |
14798e73 CT |
213 | continue; |
214 | } else if (strncmp(token, "cache=", 6) == 0) { | |
72247610 | 215 | cache = xatoi(token + 6); |
14798e73 CT |
216 | continue; |
217 | } else | |
218 | parseParams = false; | |
219 | } | |
2cef0ca6 AR |
220 | wordlistAdd(&ssl_crt_validator->cmdline, token); |
221 | } | |
4a77bb4e | 222 | xfree(tmp_begin); |
2cef0ca6 | 223 | } |
bd71920d | 224 | ssl_crt_validator->openSessions(); |
14798e73 CT |
225 | |
226 | //WARNING: initializing static member in an object initialization method | |
aee3523a | 227 | assert(HelperCache == nullptr); |
72247610 | 228 | HelperCache = new CacheType(cache, ttl); |
2cef0ca6 AR |
229 | } |
230 | ||
231 | void Ssl::CertValidationHelper::Shutdown() | |
232 | { | |
233 | if (!ssl_crt_validator) | |
234 | return; | |
235 | helperShutdown(ssl_crt_validator); | |
236 | wordlistDestroy(&ssl_crt_validator->cmdline); | |
aee3523a | 237 | ssl_crt_validator = nullptr; |
4c304fb9 | 238 | |
14798e73 | 239 | // CertValidationHelper::HelperCache is a static member, it is not good policy to |
4c304fb9 | 240 | // reset it here. Will work because the current Ssl::CertValidationHelper is |
14798e73 CT |
241 | // always the same static object. |
242 | delete HelperCache; | |
aee3523a | 243 | HelperCache = nullptr; |
14798e73 CT |
244 | } |
245 | ||
23da195f CT |
246 | void |
247 | Ssl::CertValidationHelper::Reconfigure() | |
248 | { | |
249 | Shutdown(); | |
250 | Init(); | |
251 | } | |
252 | ||
5c2f68b7 AJ |
253 | class submitData |
254 | { | |
255 | CBDATA_CLASS(submitData); | |
256 | ||
257 | public: | |
5107d2c4 | 258 | SBuf query; |
e5ddd4ce | 259 | Ssl::CertValidationHelper::Callback callback; |
e601ca5d | 260 | Security::SessionPointer ssl; |
14798e73 CT |
261 | }; |
262 | CBDATA_CLASS_INIT(submitData); | |
263 | ||
264 | static void | |
24438ec5 | 265 | sslCrtvdHandleReplyWrapper(void *data, const ::Helper::Reply &reply) |
14798e73 CT |
266 | { |
267 | Ssl::CertValidationMsg replyMsg(Ssl::CrtdMessage::REPLY); | |
14798e73 CT |
268 | |
269 | submitData *crtdvdData = static_cast<submitData *>(data); | |
8fe1a85a CT |
270 | assert(crtdvdData->ssl.get()); |
271 | Ssl::CertValidationResponse::Pointer validationResponse = new Ssl::CertValidationResponse(crtdvdData->ssl); | |
2428ce02 | 272 | if (reply.result == ::Helper::BrokenHelper) { |
d816f28d | 273 | debugs(83, DBG_IMPORTANT, "ERROR: \"ssl_crtvd\" helper error response: " << reply.other().content()); |
2428ce02 | 274 | validationResponse->resultCode = ::Helper::BrokenHelper; |
ddc77a2e CT |
275 | } else if (!reply.other().hasContent()) { |
276 | debugs(83, DBG_IMPORTANT, "\"ssl_crtvd\" helper returned NULL response"); | |
277 | validationResponse->resultCode = ::Helper::BrokenHelper; | |
14798e73 | 278 | } else if (replyMsg.parse(reply.other().content(), reply.other().contentSize()) != Ssl::CrtdMessage::OK || |
8b082ed9 | 279 | !replyMsg.parseResponse(*validationResponse) ) { |
14798e73 | 280 | debugs(83, DBG_IMPORTANT, "WARNING: Reply from ssl_crtvd for " << " is incorrect"); |
d816f28d | 281 | debugs(83, DBG_IMPORTANT, "ERROR: Certificate cannot be validated. ssl_crtvd response: " << replyMsg.getBody()); |
2428ce02 | 282 | validationResponse->resultCode = ::Helper::BrokenHelper; |
4c304fb9 | 283 | } else |
14798e73 CT |
284 | validationResponse->resultCode = reply.result; |
285 | ||
e5ddd4ce AR |
286 | crtdvdData->callback.answer() = validationResponse; |
287 | ScheduleCallHere(crtdvdData->callback.release()); | |
14798e73 CT |
288 | |
289 | if (Ssl::CertValidationHelper::HelperCache && | |
2428ce02 | 290 | (validationResponse->resultCode == ::Helper::Okay || validationResponse->resultCode == ::Helper::Error)) { |
72247610 | 291 | (void)Ssl::CertValidationHelper::HelperCache->add(crtdvdData->query, validationResponse); |
0e208dad | 292 | } |
14798e73 | 293 | |
14798e73 | 294 | delete crtdvdData; |
2cef0ca6 AR |
295 | } |
296 | ||
e5ddd4ce AR |
297 | void |
298 | Ssl::CertValidationHelper::Submit(const Ssl::CertValidationRequest &request, const Callback &callback) | |
2cef0ca6 | 299 | { |
14798e73 CT |
300 | Ssl::CertValidationMsg message(Ssl::CrtdMessage::REQUEST); |
301 | message.setCode(Ssl::CertValidationMsg::code_cert_validate); | |
302 | message.composeRequest(request); | |
303 | debugs(83, 5, "SSL crtvd request: " << message.compose().c_str()); | |
304 | ||
305 | submitData *crtdvdData = new submitData; | |
5107d2c4 CT |
306 | crtdvdData->query.assign(message.compose().c_str()); |
307 | crtdvdData->query.append('\n'); | |
14798e73 | 308 | crtdvdData->callback = callback; |
0b168d25 | 309 | crtdvdData->ssl = request.ssl; |
0e208dad | 310 | Ssl::CertValidationResponse::Pointer const*validationResponse; |
14798e73 CT |
311 | |
312 | if (CertValidationHelper::HelperCache && | |
5107d2c4 | 313 | (validationResponse = CertValidationHelper::HelperCache->get(crtdvdData->query))) { |
0e208dad | 314 | |
e5ddd4ce AR |
315 | crtdvdData->callback.answer() = *validationResponse; |
316 | ScheduleCallHere(crtdvdData->callback.release()); | |
14798e73 CT |
317 | delete crtdvdData; |
318 | return; | |
319 | } | |
6825b101 | 320 | |
23da195f CT |
321 | // ssl_crt_validator becomes nil if Squid is reconfigured with cert |
322 | // validator disabled in the new configuration | |
323 | if (ssl_crt_validator && ssl_crt_validator->trySubmit(crtdvdData->query.c_str(), sslCrtvdHandleReplyWrapper, crtdvdData)) | |
6825b101 | 324 | return; |
23da195f CT |
325 | |
326 | Ssl::CertValidationResponse::Pointer resp = new Ssl::CertValidationResponse(crtdvdData->ssl); | |
327 | resp->resultCode = ::Helper::BrokenHelper; | |
e5ddd4ce AR |
328 | crtdvdData->callback.answer() = resp; |
329 | ScheduleCallHere(crtdvdData->callback.release()); | |
23da195f CT |
330 | delete crtdvdData; |
331 | return; | |
2cef0ca6 | 332 | } |
f53969cc | 333 |