]>
Commit | Line | Data |
---|---|---|
bbc27441 | 1 | /* |
f70aedc4 | 2 | * Copyright (C) 1996-2021 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" |
d4806c91 | 10 | #include "AccessLogEntry.h" |
fde785ee | 11 | #include "auth/CredentialsCache.h" |
12daeef6 | 12 | #include "auth/ntlm/Config.h" |
33e622d7 | 13 | #include "auth/ntlm/User.h" |
616cfc4c | 14 | #include "auth/ntlm/UserRequest.h" |
d232141d | 15 | #include "auth/State.h" |
928f3421 | 16 | #include "cbdata.h" |
582c2af2 | 17 | #include "client_side.h" |
ed6e9fb9 | 18 | #include "fatal.h" |
86c63190 | 19 | #include "format/Format.h" |
582c2af2 | 20 | #include "globals.h" |
24438ec5 AJ |
21 | #include "helper.h" |
22 | #include "helper/Reply.h" | |
d3dddfb5 | 23 | #include "http/Stream.h" |
928f3421 | 24 | #include "HttpRequest.h" |
d4806c91 | 25 | #include "MemBuf.h" |
928f3421 AJ |
26 | #include "SquidTime.h" |
27 | ||
d59e4742 | 28 | Auth::Ntlm::UserRequest::UserRequest() : |
d59e4742 FC |
29 | server_blob(nullptr), |
30 | client_blob(nullptr), | |
31 | waiting(0), | |
32 | request(nullptr) | |
33 | {} | |
928f3421 | 34 | |
c7baff40 | 35 | Auth::Ntlm::UserRequest::~UserRequest() |
928f3421 | 36 | { |
8bf217bd | 37 | assert(LockCount()==0); |
928f3421 AJ |
38 | safe_free(server_blob); |
39 | safe_free(client_blob); | |
40 | ||
41 | releaseAuthServer(); | |
42 | ||
43 | if (request) { | |
44 | HTTPMSGUNLOCK(request); | |
45 | request = NULL; | |
46 | } | |
47 | } | |
48 | ||
49 | const char * | |
c7baff40 | 50 | Auth::Ntlm::UserRequest::connLastHeader() |
928f3421 AJ |
51 | { |
52 | return NULL; | |
53 | } | |
54 | ||
7afc3bf2 | 55 | int |
c7baff40 | 56 | Auth::Ntlm::UserRequest::authenticated() const |
7afc3bf2 AJ |
57 | { |
58 | if (user() != NULL && user()->credentials() == Auth::Ok) { | |
59 | debugs(29, 9, HERE << "user authenticated."); | |
60 | return 1; | |
61 | } | |
62 | ||
63 | debugs(29, 9, HERE << "user not fully authenticated."); | |
64 | return 0; | |
65 | } | |
66 | ||
d4806c91 CT |
67 | const char * |
68 | Auth::Ntlm::UserRequest::credentialsStr() | |
69 | { | |
70 | static char buf[MAX_AUTHTOKEN_LEN]; | |
d0873e0c | 71 | int printResult; |
d4806c91 | 72 | if (user()->credentials() == Auth::Pending) { |
d0873e0c | 73 | printResult = snprintf(buf, sizeof(buf), "YR %s\n", client_blob); |
d4806c91 | 74 | } else { |
d0873e0c | 75 | printResult = snprintf(buf, sizeof(buf), "KK %s\n", client_blob); |
d4806c91 | 76 | } |
d0873e0c CT |
77 | |
78 | // truncation is OK because we are used only for logging | |
79 | if (printResult < 0) { | |
80 | debugs(29, 2, "Can not build ntlm authentication credentials."); | |
81 | buf[0] = '\0'; | |
82 | } else if (printResult >= (int)sizeof(buf)) | |
83 | debugs(29, 2, "Ntlm authentication credentials truncated."); | |
84 | ||
d4806c91 CT |
85 | return buf; |
86 | } | |
87 | ||
51a3dd58 | 88 | Auth::Direction |
c7baff40 | 89 | Auth::Ntlm::UserRequest::module_direction() |
928f3421 | 90 | { |
c7baff40 | 91 | /* null auth_user is checked for by Auth::UserRequest::direction() */ |
928f3421 AJ |
92 | |
93 | if (waiting || client_blob) | |
51a3dd58 | 94 | return Auth::CRED_LOOKUP; /* need helper response to continue */ |
928f3421 | 95 | |
616cfc4c | 96 | if (user()->auth_type != Auth::AUTH_NTLM) |
51a3dd58 | 97 | return Auth::CRED_ERROR; |
928f3421 | 98 | |
d232141d | 99 | switch (user()->credentials()) { |
928f3421 | 100 | |
d87154ee | 101 | case Auth::Handshake: |
928f3421 | 102 | assert(server_blob); |
7afc3bf2 | 103 | return Auth::CRED_CHALLENGE; |
928f3421 | 104 | |
d87154ee | 105 | case Auth::Ok: |
51a3dd58 | 106 | return Auth::CRED_VALID; |
928f3421 | 107 | |
d87154ee | 108 | case Auth::Failed: |
7afc3bf2 | 109 | return Auth::CRED_ERROR; // XXX: really? not VALID or CHALLENGE? |
928f3421 | 110 | |
d232141d AJ |
111 | default: |
112 | debugs(29, DBG_IMPORTANT, "WARNING: NTLM Authentication in unexpected state: " << user()->credentials()); | |
51a3dd58 | 113 | return Auth::CRED_ERROR; |
d232141d | 114 | } |
928f3421 AJ |
115 | } |
116 | ||
928f3421 | 117 | void |
ced8def3 | 118 | Auth::Ntlm::UserRequest::startHelperLookup(HttpRequest *, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) |
928f3421 | 119 | { |
7afc3bf2 | 120 | static char buf[MAX_AUTHTOKEN_LEN]; |
928f3421 AJ |
121 | |
122 | assert(data); | |
123 | assert(handler); | |
928f3421 | 124 | |
dc79fed8 | 125 | if (static_cast<Auth::Ntlm::Config*>(Auth::SchemeConfig::Find("ntlm"))->authenticateProgram == NULL) { |
d232141d | 126 | debugs(29, DBG_CRITICAL, "ERROR: NTLM Start: no NTLM program configured."); |
4c535e87 | 127 | handler(data); |
ec5858ff | 128 | return; |
928f3421 AJ |
129 | } |
130 | ||
7afc3bf2 AJ |
131 | debugs(29, 8, HERE << "credentials state is '" << user()->credentials() << "'"); |
132 | ||
d4806c91 | 133 | const char *keyExtras = helperRequestKeyExtras(request, al); |
d0873e0c | 134 | int printResult = 0; |
d87154ee | 135 | if (user()->credentials() == Auth::Pending) { |
d4806c91 | 136 | if (keyExtras) |
d0873e0c | 137 | printResult = snprintf(buf, sizeof(buf), "YR %s %s\n", client_blob, keyExtras); |
d4806c91 | 138 | else |
d0873e0c | 139 | printResult = snprintf(buf, sizeof(buf), "YR %s\n", client_blob); //CHECKME: can ever client_blob be 0 here? |
928f3421 | 140 | } else { |
d4806c91 | 141 | if (keyExtras) |
d0873e0c | 142 | printResult = snprintf(buf, sizeof(buf), "KK %s %s\n", client_blob, keyExtras); |
d4806c91 | 143 | else |
d0873e0c | 144 | printResult = snprintf(buf, sizeof(buf), "KK %s\n", client_blob); |
928f3421 | 145 | } |
928f3421 AJ |
146 | waiting = 1; |
147 | ||
d0873e0c CT |
148 | if (printResult < 0 || printResult >= (int)sizeof(buf)) { |
149 | if (printResult < 0) | |
150 | debugs(29, DBG_CRITICAL, "ERROR: Can not build ntlm authentication helper request"); | |
151 | else | |
152 | debugs(29, DBG_CRITICAL, "ERROR: Ntlm authentication helper request too big for the " << sizeof(buf) << "-byte buffer."); | |
153 | handler(data); | |
154 | return; | |
155 | } | |
156 | ||
928f3421 | 157 | safe_free(client_blob); |
c7baff40 | 158 | helperStatefulSubmit(ntlmauthenticators, buf, Auth::Ntlm::UserRequest::HandleReply, |
a56fcf0b | 159 | new Auth::StateData(this, handler, data), reservationId); |
928f3421 AJ |
160 | } |
161 | ||
162 | /** | |
163 | * Atomic action: properly release the NTLM auth helpers which may have been reserved | |
164 | * for this request connections use. | |
165 | */ | |
166 | void | |
c7baff40 | 167 | Auth::Ntlm::UserRequest::releaseAuthServer() |
928f3421 | 168 | { |
a56fcf0b CT |
169 | if (reservationId) { |
170 | debugs(29, 6, reservationId); | |
171 | ntlmauthenticators->cancelReservation(reservationId); | |
172 | reservationId.clear(); | |
928f3421 AJ |
173 | } else |
174 | debugs(29, 6, HERE << "No NTLM auth server to release."); | |
175 | } | |
176 | ||
928f3421 | 177 | void |
789217a2 | 178 | Auth::Ntlm::UserRequest::authenticate(HttpRequest * aRequest, ConnStateData * conn, Http::HdrType type) |
928f3421 | 179 | { |
928f3421 AJ |
180 | /* Check that we are in the client side, where we can generate |
181 | * auth challenges */ | |
182 | ||
183 | if (conn == NULL || !cbdataReferenceValid(conn)) { | |
d87154ee | 184 | user()->credentials(Auth::Failed); |
7afc3bf2 | 185 | debugs(29, DBG_IMPORTANT, "WARNING: NTLM Authentication attempt to perform authentication without a connection!"); |
928f3421 AJ |
186 | return; |
187 | } | |
188 | ||
189 | if (waiting) { | |
7afc3bf2 | 190 | debugs(29, DBG_IMPORTANT, "WARNING: NTLM Authentication waiting for helper reply!"); |
928f3421 AJ |
191 | return; |
192 | } | |
193 | ||
194 | if (server_blob) { | |
7afc3bf2 | 195 | debugs(29, 2, HERE << "need to challenge client '" << server_blob << "'!"); |
928f3421 AJ |
196 | return; |
197 | } | |
198 | ||
199 | /* get header */ | |
7afc3bf2 | 200 | const char *proxy_auth = aRequest->header.getStr(type); |
928f3421 AJ |
201 | |
202 | /* locate second word */ | |
7afc3bf2 | 203 | const char *blob = proxy_auth; |
928f3421 AJ |
204 | |
205 | /* if proxy_auth is actually NULL, we'd better not manipulate it. */ | |
206 | if (blob) { | |
207 | while (xisspace(*blob) && *blob) | |
742a021b | 208 | ++blob; |
928f3421 AJ |
209 | |
210 | while (!xisspace(*blob) && *blob) | |
742a021b | 211 | ++blob; |
928f3421 AJ |
212 | |
213 | while (xisspace(*blob) && *blob) | |
742a021b | 214 | ++blob; |
928f3421 AJ |
215 | } |
216 | ||
d232141d | 217 | switch (user()->credentials()) { |
928f3421 | 218 | |
d87154ee | 219 | case Auth::Unchecked: |
928f3421 | 220 | /* we've received a ntlm request. pass to a helper */ |
7afc3bf2 | 221 | debugs(29, 9, HERE << "auth state ntlm none. Received blob: '" << proxy_auth << "'"); |
d87154ee | 222 | user()->credentials(Auth::Pending); |
928f3421 AJ |
223 | safe_free(client_blob); |
224 | client_blob=xstrdup(blob); | |
cc1e110a AJ |
225 | assert(conn->getAuth() == NULL); |
226 | conn->setAuth(this, "new NTLM handshake request"); | |
928f3421 AJ |
227 | request = aRequest; |
228 | HTTPMSGLOCK(request); | |
229 | break; | |
230 | ||
d87154ee | 231 | case Auth::Pending: |
e0236918 | 232 | debugs(29, DBG_IMPORTANT, HERE << "need to ask helper"); |
928f3421 AJ |
233 | break; |
234 | ||
d87154ee | 235 | case Auth::Handshake: |
928f3421 AJ |
236 | /* we should have received a blob from the client. Hand it off to |
237 | * some helper */ | |
238 | safe_free(client_blob); | |
7afc3bf2 | 239 | client_blob = xstrdup(blob); |
928f3421 AJ |
240 | if (request) |
241 | HTTPMSGUNLOCK(request); | |
242 | request = aRequest; | |
243 | HTTPMSGLOCK(request); | |
244 | break; | |
245 | ||
d87154ee | 246 | case Auth::Ok: |
2f8abb64 | 247 | fatal("Auth::Ntlm::UserRequest::authenticate: unexpected auth state DONE! Report a bug to the squid developers.\n"); |
928f3421 AJ |
248 | break; |
249 | ||
d87154ee | 250 | case Auth::Failed: |
928f3421 | 251 | /* we've failed somewhere in authentication */ |
7afc3bf2 | 252 | debugs(29, 9, HERE << "auth state ntlm failed. " << proxy_auth); |
928f3421 AJ |
253 | break; |
254 | } | |
255 | } | |
256 | ||
257 | void | |
24438ec5 | 258 | Auth::Ntlm::UserRequest::HandleReply(void *data, const Helper::Reply &reply) |
928f3421 | 259 | { |
1c756645 | 260 | Auth::StateData *r = static_cast<Auth::StateData *>(data); |
928f3421 | 261 | |
a56fcf0b | 262 | debugs(29, 8, reply.reservationId << " got reply=" << reply); |
928f3421 | 263 | |
1c756645 | 264 | if (!cbdataReferenceValid(r->data)) { |
a56fcf0b | 265 | debugs(29, DBG_IMPORTANT, "ERROR: NTLM Authentication invalid callback data(" << reply.reservationId <<")"); |
1c756645 | 266 | delete r; |
928f3421 AJ |
267 | return; |
268 | } | |
269 | ||
c7baff40 | 270 | Auth::UserRequest::Pointer auth_user_request = r->auth_user_request; |
928f3421 AJ |
271 | assert(auth_user_request != NULL); |
272 | ||
71e7400c AJ |
273 | // add new helper kv-pair notes to the credentials object |
274 | // so that any transaction using those credentials can access them | |
d665de37 A |
275 | static const NotePairs::Names appendables = { SBuf("group"), SBuf("tag") }; |
276 | auth_user_request->user()->notes.replaceOrAddOrAppend(&reply.notes, appendables); | |
c10ebce8 AJ |
277 | // remove any private credentials detail which got added. |
278 | auth_user_request->user()->notes.remove("token"); | |
71e7400c | 279 | |
c7baff40 | 280 | Auth::Ntlm::UserRequest *lm_request = dynamic_cast<Auth::Ntlm::UserRequest *>(auth_user_request.getRaw()); |
7afc3bf2 AJ |
281 | assert(lm_request != NULL); |
282 | assert(lm_request->waiting); | |
56a49fda | 283 | |
7afc3bf2 AJ |
284 | lm_request->waiting = 0; |
285 | safe_free(lm_request->client_blob); | |
928f3421 | 286 | |
7afc3bf2 AJ |
287 | assert(auth_user_request->user() != NULL); |
288 | assert(auth_user_request->user()->auth_type == Auth::AUTH_NTLM); | |
289 | ||
a56fcf0b CT |
290 | if (!lm_request->reservationId) |
291 | lm_request->reservationId = reply.reservationId; | |
928f3421 | 292 | else |
a56fcf0b | 293 | assert(lm_request->reservationId == reply.reservationId); |
928f3421 | 294 | |
dacb64b9 | 295 | switch (reply.result) { |
2428ce02 | 296 | case Helper::TT: |
928f3421 | 297 | /* we have been given a blob to send to the client */ |
7afc3bf2 | 298 | safe_free(lm_request->server_blob); |
e857372a | 299 | lm_request->request->flags.mustKeepalive = true; |
450fe1cb | 300 | if (lm_request->request->flags.proxyKeepalive) { |
cf9f0261 CT |
301 | const char *serverBlob = reply.notes.findFirst("token"); |
302 | lm_request->server_blob = xstrdup(serverBlob); | |
7afc3bf2 | 303 | auth_user_request->user()->credentials(Auth::Handshake); |
6f9a30f8 | 304 | auth_user_request->setDenyMessage("Authentication in progress"); |
cf9f0261 | 305 | debugs(29, 4, HERE << "Need to challenge the client with a server token: '" << serverBlob << "'"); |
928f3421 | 306 | } else { |
7afc3bf2 | 307 | auth_user_request->user()->credentials(Auth::Failed); |
6f9a30f8 | 308 | auth_user_request->setDenyMessage("NTLM authentication requires a persistent connection"); |
928f3421 | 309 | } |
0272dd08 AJ |
310 | break; |
311 | ||
2428ce02 | 312 | case Helper::Okay: { |
928f3421 | 313 | /* we're finished, release the helper */ |
cf9f0261 | 314 | const char *userLabel = reply.notes.findFirst("user"); |
10f8979e AJ |
315 | if (!userLabel) { |
316 | auth_user_request->user()->credentials(Auth::Failed); | |
317 | safe_free(lm_request->server_blob); | |
318 | lm_request->releaseAuthServer(); | |
319 | debugs(29, DBG_CRITICAL, "ERROR: NTLM Authentication helper returned no username. Result: " << reply); | |
320 | break; | |
321 | } | |
cf9f0261 | 322 | auth_user_request->user()->username(userLabel); |
6f9a30f8 | 323 | auth_user_request->setDenyMessage("Login successful"); |
7afc3bf2 AJ |
324 | safe_free(lm_request->server_blob); |
325 | lm_request->releaseAuthServer(); | |
928f3421 | 326 | |
cf9f0261 | 327 | debugs(29, 4, HERE << "Successfully validated user via NTLM. Username '" << userLabel << "'"); |
928f3421 | 328 | /* connection is authenticated */ |
7afc3bf2 | 329 | debugs(29, 4, HERE << "authenticated user " << auth_user_request->user()->username()); |
c10ebce8 | 330 | /* see if this is an existing user */ |
33e622d7 | 331 | auto local_auth_user = lm_request->user(); |
02aeb7ef | 332 | auto cached_user = Auth::Ntlm::User::Cache()->lookup(auth_user_request->user()->userKey()); |
33e622d7 FC |
333 | if (!cached_user) { |
334 | local_auth_user->addToNameCache(); | |
335 | } else { | |
928f3421 AJ |
336 | /* we can't seamlessly recheck the username due to the |
337 | * challenge-response nature of the protocol. | |
58e94342 AJ |
338 | * Just free the temporary auth_user after merging as |
339 | * much of it new state into the existing one as possible */ | |
33e622d7 | 340 | cached_user->absorb(local_auth_user); |
7afc3bf2 | 341 | /* from here on we are working with the original cached credentials. */ |
33e622d7 | 342 | local_auth_user = cached_user; |
58e94342 | 343 | auth_user_request->user(local_auth_user); |
928f3421 AJ |
344 | } |
345 | /* set these to now because this is either a new login from an | |
346 | * existing user or a new user */ | |
347 | local_auth_user->expiretime = current_time.tv_sec; | |
7afc3bf2 | 348 | auth_user_request->user()->credentials(Auth::Ok); |
7bbefa01 | 349 | debugs(29, 4, HERE << "Successfully validated user via NTLM. Username '" << auth_user_request->user()->username() << "'"); |
0272dd08 | 350 | } |
dacb64b9 | 351 | break; |
7afc3bf2 | 352 | |
0fc383ff | 353 | case Helper::Error: |
928f3421 | 354 | /* authentication failure (wrong password, etc.) */ |
6f9a30f8 | 355 | auth_user_request->denyMessageFromHelper("NTLM", reply); |
7afc3bf2 AJ |
356 | auth_user_request->user()->credentials(Auth::Failed); |
357 | safe_free(lm_request->server_blob); | |
358 | lm_request->releaseAuthServer(); | |
87a122b0 | 359 | debugs(29, 4, "Failed validating user via NTLM. Result: " << reply); |
0fc383ff | 360 | break; |
0272dd08 | 361 | |
2428ce02 | 362 | case Helper::Unknown: |
a56fcf0b | 363 | debugs(29, DBG_IMPORTANT, "ERROR: NTLM Authentication Helper crashed (" << reply.reservationId << ")"); |
f53969cc | 364 | /* continue to the next case */ |
0272dd08 | 365 | |
32fd6d8a | 366 | case Helper::TimedOut: |
0fc383ff | 367 | case Helper::BrokenHelper: |
928f3421 AJ |
368 | /* TODO kick off a refresh process. This can occur after a YR or after |
369 | * a KK. If after a YR release the helper and resubmit the request via | |
370 | * Authenticate NTLM start. | |
371 | * If after a KK deny the user's request w/ 407 and mark the helper as | |
372 | * Needing YR. */ | |
2428ce02 | 373 | if (reply.result == Helper::Unknown) |
6f9a30f8 | 374 | auth_user_request->setDenyMessage("Internal Error"); |
7bbefa01 | 375 | else |
6f9a30f8 | 376 | auth_user_request->denyMessageFromHelper("NTLM", reply); |
d87154ee | 377 | auth_user_request->user()->credentials(Auth::Failed); |
7afc3bf2 AJ |
378 | safe_free(lm_request->server_blob); |
379 | lm_request->releaseAuthServer(); | |
87a122b0 | 380 | debugs(29, DBG_IMPORTANT, "ERROR: NTLM Authentication validating user. Result: " << reply); |
0fc383ff | 381 | break; |
928f3421 AJ |
382 | } |
383 | ||
7afc3bf2 AJ |
384 | if (lm_request->request) { |
385 | HTTPMSGUNLOCK(lm_request->request); | |
386 | lm_request->request = NULL; | |
928f3421 | 387 | } |
4c535e87 | 388 | r->handler(r->data); |
1c756645 | 389 | delete r; |
928f3421 | 390 | } |
f53969cc | 391 |