4 * DEBUG: section 29 Authenticator
5 * AUTHOR: Robert Collins
7 * SQUID Internet Object Cache http://squid.nlanr.net/Squid/
8 * ----------------------------------------------------------
10 * Squid is the result of efforts by numerous individuals from the
11 * Internet community. Development is led by Duane Wessels of the
12 * National Laboratory for Applied Network Research and funded by the
13 * National Science Foundation. Squid is Copyrighted (C) 1998 by
14 * the Regents of the University of California. Please see the
15 * COPYRIGHT file for full details. Squid incorporates software
16 * developed and/or copyrighted by other sources. Please see the
17 * CREDITS file for full details.
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
35 /* The functions in this file handle authentication.
36 * They DO NOT perform access control or auditing.
37 * See acl.c for access control and client_side.c for auditing */
42 #include "auth/digest/auth_digest.h"
43 #include "auth/Gadgets.h"
45 #include "CacheManager.h"
47 #include "HttpRequest.h"
48 #include "HttpReply.h"
50 #include "SquidTime.h"
51 /* TODO don't include this */
52 #include "auth/digest/digestScheme.h"
53 #include "auth/digest/digestUserRequest.h"
57 static AUTHSSTATS authenticateDigestStats
;
59 helper
*digestauthenticators
= NULL
;
61 static hash_table
*digest_nonce_cache
;
63 static int authdigest_initialised
= 0;
64 static MemAllocator
*digest_nonce_pool
= NULL
;
66 // CBDATA_TYPE(DigestAuthenticateStateData);
68 enum http_digest_attr_type
{
81 static const HttpHeaderFieldAttrs DigestAttrs
[DIGEST_ENUM_END
] = {
82 {"username", (http_hdr_type
)DIGEST_USERNAME
},
83 {"realm", (http_hdr_type
)DIGEST_REALM
},
84 {"qop", (http_hdr_type
)DIGEST_QOP
},
85 {"algorithm", (http_hdr_type
)DIGEST_ALGORITHM
},
86 {"uri", (http_hdr_type
)DIGEST_URI
},
87 {"nonce", (http_hdr_type
)DIGEST_NONCE
},
88 {"nc", (http_hdr_type
)DIGEST_NC
},
89 {"cnonce", (http_hdr_type
)DIGEST_CNONCE
},
90 {"response", (http_hdr_type
)DIGEST_RESPONSE
},
93 static HttpHeaderFieldInfo
*DigestFieldsInfo
= NULL
;
101 static void authenticateDigestNonceCacheCleanup(void *data
);
102 static digest_nonce_h
*authenticateDigestNonceFindNonce(const char *nonceb64
);
103 static digest_nonce_h
*authenticateDigestNonceNew(void);
104 static void authenticateDigestNonceDelete(digest_nonce_h
* nonce
);
105 static void authenticateDigestNonceSetup(void);
106 static void authenticateDigestNonceShutdown(void);
107 static void authenticateDigestNonceReconfigure(void);
108 static int authDigestNonceIsStale(digest_nonce_h
* nonce
);
109 static void authDigestNonceEncode(digest_nonce_h
* nonce
);
110 static void authDigestNonceLink(digest_nonce_h
* nonce
);
112 static int authDigestNonceLinks(digest_nonce_h
* nonce
);
114 static void authDigestNonceUserUnlink(digest_nonce_h
* nonce
);
115 static void authDigestNoncePurge(digest_nonce_h
* nonce
);
118 authDigestNonceEncode(digest_nonce_h
* nonce
)
126 nonce
->key
= xstrdup(base64_encode_bin((char *) &(nonce
->noncedata
), sizeof(digest_nonce_data
)));
129 static digest_nonce_h
*
130 authenticateDigestNonceNew(void)
132 digest_nonce_h
*newnonce
= static_cast < digest_nonce_h
* >(digest_nonce_pool
->alloc());
133 digest_nonce_h
*temp
;
135 /* NONCE CREATION - NOTES AND REASONING. RBC 20010108
136 * === EXCERPT FROM RFC 2617 ===
137 * The contents of the nonce are implementation dependent. The quality
138 * of the implementation depends on a good choice. A nonce might, for
139 * example, be constructed as the base 64 encoding of
141 * time-stamp H(time-stamp ":" ETag ":" private-key)
143 * where time-stamp is a server-generated time or other non-repeating
144 * value, ETag is the value of the HTTP ETag header associated with
145 * the requested entity, and private-key is data known only to the
146 * server. With a nonce of this form a server would recalculate the
147 * hash portion after receiving the client authentication header and
148 * reject the request if it did not match the nonce from that header
149 * or if the time-stamp value is not recent enough. In this way the
150 * server can limit the time of the nonce's validity. The inclusion of
151 * the ETag prevents a replay request for an updated version of the
152 * resource. (Note: including the IP address of the client in the
153 * nonce would appear to offer the server the ability to limit the
154 * reuse of the nonce to the same client that originally got it.
155 * However, that would break proxy farms, where requests from a single
156 * user often go through different proxies in the farm. Also, IP
157 * address spoofing is not that hard.)
160 * Now for my reasoning:
161 * We will not accept a unrecognised nonce->we have all recognisable
162 * nonces stored. If we send out unique base64 encodings we guarantee
163 * that a given nonce applies to only one user (barring attacks or
164 * really bad timing with expiry and creation). Using a random
165 * component in the nonce allows us to loop to find a unique nonce.
166 * We use H(nonce_data) so the nonce is meaningless to the reciever.
167 * So our nonce looks like base64(H(timestamp,pointertohash,randomdata))
168 * And even if our randomness is not very random (probably due to
169 * bad coding on my part) we don't really care - the timestamp and
170 * memory pointer also guarantee local uniqueness in the input to the hash
174 /* create a new nonce */
176 newnonce
->flags
.valid
= 1;
177 newnonce
->noncedata
.self
= newnonce
;
178 newnonce
->noncedata
.creationtime
= current_time
.tv_sec
;
179 newnonce
->noncedata
.randomdata
= squid_random();
181 authDigestNonceEncode(newnonce
);
183 * loop until we get a unique nonce. The nonce creation must
184 * have a random factor
187 while ((temp
= authenticateDigestNonceFindNonce((char const *) (newnonce
->key
)))) {
188 /* create a new nonce */
189 newnonce
->noncedata
.randomdata
= squid_random();
190 authDigestNonceEncode(newnonce
);
193 hash_join(digest_nonce_cache
, newnonce
);
194 /* the cache's link */
195 authDigestNonceLink(newnonce
);
196 newnonce
->flags
.incache
= 1;
197 debugs(29, 5, "authenticateDigestNonceNew: created nonce " << newnonce
<< " at " << newnonce
->noncedata
.creationtime
);
202 authenticateDigestNonceDelete(digest_nonce_h
* nonce
)
205 assert(nonce
->references
== 0);
208 if (nonce
->flags
.incache
)
209 hash_remove_link(digest_nonce_cache
, nonce
);
213 assert(nonce
->flags
.incache
== 0);
215 safe_free(nonce
->key
);
217 digest_nonce_pool
->freeOne(nonce
);
222 authenticateDigestNonceSetup(void)
224 if (!digest_nonce_pool
)
225 digest_nonce_pool
= memPoolCreate("Digest Scheme nonce's", sizeof(digest_nonce_h
));
227 if (!digest_nonce_cache
) {
228 digest_nonce_cache
= hash_create((HASHCMP
*) strcmp
, 7921, hash_string
);
229 assert(digest_nonce_cache
);
230 eventAdd("Digest none cache maintenance", authenticateDigestNonceCacheCleanup
, NULL
, static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->nonceGCInterval
, 1);
235 authenticateDigestNonceShutdown(void)
238 * We empty the cache of any nonces left in there.
240 digest_nonce_h
*nonce
;
242 if (digest_nonce_cache
) {
243 debugs(29, 2, "authenticateDigestNonceShutdown: Shutting down nonce cache ");
244 hash_first(digest_nonce_cache
);
246 while ((nonce
= ((digest_nonce_h
*) hash_next(digest_nonce_cache
)))) {
247 assert(nonce
->flags
.incache
);
248 authDigestNoncePurge(nonce
);
253 if (digest_nonce_pool
) {
254 delete digest_nonce_pool
;
255 digest_nonce_pool
= NULL
;
259 debugs(29, 2, "authenticateDigestNonceShutdown: Nonce cache shutdown");
263 authenticateDigestNonceReconfigure(void)
267 authenticateDigestNonceCacheCleanup(void *data
)
270 * We walk the hash by nonceb64 as that is the unique key we
271 * use. For big hash tables we could consider stepping through
272 * the cache, 100/200 entries at a time. Lets see how it flies
275 digest_nonce_h
*nonce
;
276 debugs(29, 3, "authenticateDigestNonceCacheCleanup: Cleaning the nonce cache now");
277 debugs(29, 3, "authenticateDigestNonceCacheCleanup: Current time: " << current_time
.tv_sec
);
278 hash_first(digest_nonce_cache
);
280 while ((nonce
= ((digest_nonce_h
*) hash_next(digest_nonce_cache
)))) {
281 debugs(29, 3, "authenticateDigestNonceCacheCleanup: nonce entry : " << nonce
<< " '" << (char *) nonce
->key
<< "'");
282 debugs(29, 4, "authenticateDigestNonceCacheCleanup: Creation time: " << nonce
->noncedata
.creationtime
);
284 if (authDigestNonceIsStale(nonce
)) {
285 debugs(29, 4, "authenticateDigestNonceCacheCleanup: Removing nonce " << (char *) nonce
->key
<< " from cache due to timeout.");
286 assert(nonce
->flags
.incache
);
287 /* invalidate nonce so future requests fail */
288 nonce
->flags
.valid
= 0;
289 /* if it is tied to a auth_user, remove the tie */
290 authDigestNonceUserUnlink(nonce
);
291 authDigestNoncePurge(nonce
);
295 debugs(29, 3, "authenticateDigestNonceCacheCleanup: Finished cleaning the nonce cache.");
297 if (static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->active())
298 eventAdd("Digest none cache maintenance", authenticateDigestNonceCacheCleanup
, NULL
, static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->nonceGCInterval
, 1);
302 authDigestNonceLink(digest_nonce_h
* nonce
)
304 assert(nonce
!= NULL
);
306 debugs(29, 9, "authDigestNonceLink: nonce '" << nonce
<< "' now at '" << nonce
->references
<< "'.");
311 authDigestNonceLinks(digest_nonce_h
* nonce
)
316 return nonce
->references
;
322 authDigestNonceUnlink(digest_nonce_h
* nonce
)
324 assert(nonce
!= NULL
);
326 if (nonce
->references
> 0) {
329 debugs(29, 1, "authDigestNonceUnlink; Attempt to lower nonce " << nonce
<< " refcount below 0!");
332 debugs(29, 9, "authDigestNonceUnlink: nonce '" << nonce
<< "' now at '" << nonce
->references
<< "'.");
334 if (nonce
->references
== 0)
335 authenticateDigestNonceDelete(nonce
);
339 authenticateDigestNonceNonceb64(const digest_nonce_h
* nonce
)
344 return (char const *) nonce
->key
;
347 static digest_nonce_h
*
348 authenticateDigestNonceFindNonce(const char *nonceb64
)
350 digest_nonce_h
*nonce
= NULL
;
352 if (nonceb64
== NULL
)
355 debugs(29, 9, "authDigestNonceFindNonce:looking for nonceb64 '" << nonceb64
<< "' in the nonce cache.");
357 nonce
= static_cast < digest_nonce_h
* >(hash_lookup(digest_nonce_cache
, nonceb64
));
359 if ((nonce
== NULL
) || (strcmp(authenticateDigestNonceNonceb64(nonce
), nonceb64
)))
362 debugs(29, 9, "authDigestNonceFindNonce: Found nonce '" << nonce
<< "'");
368 authDigestNonceIsValid(digest_nonce_h
* nonce
, char nc
[9])
371 /* do we have a nonce ? */
376 intnc
= strtol(nc
, NULL
, 16);
378 /* has it already been invalidated ? */
379 if (!nonce
->flags
.valid
) {
380 debugs(29, 4, "authDigestNonceIsValid: Nonce already invalidated");
384 /* is the nonce-count ok ? */
385 if (!static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->CheckNonceCount
) {
387 return -1; /* forced OK by configuration */
390 if ((static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->NonceStrictness
&& intnc
!= nonce
->nc
+ 1) ||
391 intnc
< nonce
->nc
+ 1) {
392 debugs(29, 4, "authDigestNonceIsValid: Nonce count doesn't match");
393 nonce
->flags
.valid
= 0;
398 /* increment the nonce count - we've already checked that intnc is a
399 * valid representation for us, so we don't need the test here.
407 authDigestNonceIsStale(digest_nonce_h
* nonce
)
409 /* do we have a nonce ? */
414 /* has it's max duration expired? */
415 if (nonce
->noncedata
.creationtime
+ static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->noncemaxduration
< current_time
.tv_sec
) {
416 debugs(29, 4, "authDigestNonceIsStale: Nonce is too old. " <<
417 nonce
->noncedata
.creationtime
<< " " <<
418 static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->noncemaxduration
<< " " <<
419 current_time
.tv_sec
);
421 nonce
->flags
.valid
= 0;
425 if (nonce
->nc
> 99999998) {
426 debugs(29, 4, "authDigestNonceIsStale: Nonce count overflow");
427 nonce
->flags
.valid
= 0;
431 if (nonce
->nc
> static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->noncemaxuses
) {
432 debugs(29, 4, "authDigestNoncelastRequest: Nonce count over user limit");
433 nonce
->flags
.valid
= 0;
442 * \retval 0 the digest is not stale yet
443 * \retval -1 the digest will be stale on the next request
446 authDigestNonceLastRequest(digest_nonce_h
* nonce
)
451 if (nonce
->nc
== 99999997) {
452 debugs(29, 4, "authDigestNoncelastRequest: Nonce count about to overflow");
456 if (nonce
->nc
>= static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->noncemaxuses
- 1) {
457 debugs(29, 4, "authDigestNoncelastRequest: Nonce count about to hit user limit");
461 /* and other tests are possible. */
466 authDigestNoncePurge(digest_nonce_h
* nonce
)
471 if (!nonce
->flags
.incache
)
474 hash_remove_link(digest_nonce_cache
, nonce
);
476 nonce
->flags
.incache
= 0;
478 /* the cache's link */
479 authDigestNonceUnlink(nonce
);
482 /* USER related functions */
483 static AuthUser::Pointer
484 authDigestUserFindUsername(const char *username
)
486 AuthUserHashPointer
*usernamehash
;
487 debugs(29, 9, HERE
<< "Looking for user '" << username
<< "'");
489 if (username
&& (usernamehash
= static_cast < auth_user_hash_pointer
* >(hash_lookup(proxy_auth_username_cache
, username
)))) {
490 while ((usernamehash
->user()->auth_type
!= AUTH_DIGEST
) && (usernamehash
->next
))
491 usernamehash
= static_cast<AuthUserHashPointer
*>(usernamehash
->next
);
493 if (usernamehash
->user()->auth_type
== AUTH_DIGEST
) {
494 return usernamehash
->user();
502 AuthDigestConfig::rotateHelpers()
504 /* schedule closure of existing helpers */
505 if (digestauthenticators
) {
506 helperShutdown(digestauthenticators
);
509 /* NP: dynamic helper restart will ensure they start up again as needed. */
513 /** delete the digest request structure. Does NOT delete related structures */
517 /** \todo this should be a Config call. */
519 if (digestauthenticators
)
520 helperShutdown(digestauthenticators
);
522 if (DigestFieldsInfo
) {
523 httpHeaderDestroyFieldsInfo(DigestFieldsInfo
, DIGEST_ENUM_END
);
524 DigestFieldsInfo
= NULL
;
527 authdigest_initialised
= 0;
529 if (!shutting_down
) {
530 authenticateDigestNonceReconfigure();
534 delete digestauthenticators
;
535 digestauthenticators
= NULL
;
537 PurgeCredentialsCache();
538 authenticateDigestNonceShutdown();
539 debugs(29, 2, "authenticateDigestDone: Digest authentication shut down.");
541 /* clear the global handle to this scheme. */
546 AuthDigestConfig::dump(StoreEntry
* entry
, const char *name
, AuthConfig
* scheme
)
548 wordlist
*list
= authenticate
;
549 debugs(29, 9, "authDigestCfgDump: Dumping configuration");
550 storeAppendPrintf(entry
, "%s %s", name
, "digest");
552 while (list
!= NULL
) {
553 storeAppendPrintf(entry
, " %s", list
->key
);
557 storeAppendPrintf(entry
, "\n%s %s realm %s\n%s %s children %d startup=%d idle=%d concurrency=%d\n%s %s nonce_max_count %d\n%s %s nonce_max_duration %d seconds\n%s %s nonce_garbage_interval %d seconds\n",
558 name
, "digest", digestAuthRealm
,
559 name
, "digest", authenticateChildren
.n_max
, authenticateChildren
.n_startup
, authenticateChildren
.n_idle
, authenticateChildren
.concurrency
,
560 name
, "digest", noncemaxuses
,
561 name
, "digest", (int) noncemaxduration
,
562 name
, "digest", (int) nonceGCInterval
);
566 AuthDigestConfig::active() const
568 return authdigest_initialised
== 1;
572 AuthDigestConfig::configured() const
574 if ((authenticate
!= NULL
) &&
575 (authenticateChildren
.n_max
!= 0) &&
576 (digestAuthRealm
!= NULL
) && (noncemaxduration
> -1))
582 /* add the [www-|Proxy-]authenticate header on a 407 or 401 reply */
584 AuthDigestConfig::fixHeader(AuthUserRequest::Pointer auth_user_request
, HttpReply
*rep
, http_hdr_type hdrType
, HttpRequest
* request
)
591 if (auth_user_request
!= NULL
) {
592 AuthDigestUserRequest
*digest_request
;
593 digest_request
= dynamic_cast<AuthDigestUserRequest
*>(auth_user_request
.getRaw());
594 assert (digest_request
!= NULL
);
596 stale
= !digest_request
->flags
.invalid_password
;
599 /* on a 407 or 401 we always use a new nonce */
600 digest_nonce_h
*nonce
= authenticateDigestNonceNew();
602 debugs(29, 9, "authenticateFixHeader: Sending type:" << hdrType
<<
603 " header: 'Digest realm=\"" << digestAuthRealm
<< "\", nonce=\"" <<
604 authenticateDigestNonceNonceb64(nonce
) << "\", qop=\"" << QOP_AUTH
<<
605 "\", stale=" << (stale
? "true" : "false"));
607 /* in the future, for WWW auth we may want to support the domain entry */
608 httpHeaderPutStrf(&rep
->header
, hdrType
, "Digest realm=\"%s\", nonce=\"%s\", qop=\"%s\", stale=%s", digestAuthRealm
, authenticateDigestNonceNonceb64(nonce
), QOP_AUTH
, stale
? "true" : "false");
611 DigestUser::~DigestUser()
613 dlink_node
*link
, *tmplink
;
619 dlinkDelete(tmplink
, &nonces
);
620 authDigestNoncePurge(static_cast < digest_nonce_h
* >(tmplink
->data
));
621 authDigestNonceUnlink(static_cast < digest_nonce_h
* >(tmplink
->data
));
622 dlinkNodeDelete(tmplink
);
627 DigestUser::ttl() const
629 int32_t global_ttl
= static_cast<int32_t>(expiretime
- squid_curtime
+ Config
.authenticateTTL
);
631 /* find the longest lasting nonce. */
632 int32_t latest_nonce
= -1;
633 dlink_node
*link
= nonces
.head
;
635 digest_nonce_h
*nonce
= static_cast<digest_nonce_h
*>(link
->data
);
636 if (nonce
->flags
.valid
&& nonce
->noncedata
.creationtime
> latest_nonce
)
637 latest_nonce
= nonce
->noncedata
.creationtime
;
641 if (latest_nonce
== -1)
642 return min(-1, global_ttl
);
644 int32_t nonce_ttl
= latest_nonce
- current_time
.tv_sec
+ static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest"))->noncemaxduration
;
646 return min(nonce_ttl
, global_ttl
);
650 /* Initialize helpers and the like for this auth scheme. Called AFTER parsing the
653 AuthDigestConfig::init(AuthConfig
* scheme
)
656 DigestFieldsInfo
= httpHeaderBuildFieldsInfo(DigestAttrs
, DIGEST_ENUM_END
);
657 authenticateDigestNonceSetup();
658 authdigest_initialised
= 1;
660 if (digestauthenticators
== NULL
)
661 digestauthenticators
= new helper("digestauthenticator");
663 digestauthenticators
->cmdline
= authenticate
;
665 digestauthenticators
->childs
= authenticateChildren
;
667 digestauthenticators
->ipc_type
= IPC_STREAM
;
669 helperOpenServers(digestauthenticators
);
671 CBDATA_INIT_TYPE(authenticateStateData
);
676 AuthDigestConfig::registerWithCacheManager(void)
678 CacheManager::GetInstance()->
679 registerAction("digestauthenticator",
680 "Digest User Authenticator Stats",
681 authenticateDigestStats
, 0, 1);
684 /* free any allocated configuration details */
686 AuthDigestConfig::done()
689 wordlistDestroy(&authenticate
);
691 safe_free(digestAuthRealm
);
694 AuthDigestConfig::AuthDigestConfig()
696 /* TODO: move into initialisation list */
698 nonceGCInterval
= 5 * 60;
700 noncemaxduration
= 30 * 60;
703 /* Not strict nonce count behaviour */
705 /* Verify nonce count */
710 AuthDigestConfig::parse(AuthConfig
* scheme
, int n_configured
, char *param_str
)
712 if (strcasecmp(param_str
, "program") == 0) {
714 wordlistDestroy(&authenticate
);
716 parse_wordlist(&authenticate
);
718 requirePathnameExists("auth_param digest program", authenticate
->key
);
719 } else if (strcasecmp(param_str
, "children") == 0) {
720 authenticateChildren
.parseConfig();
721 } else if (strcasecmp(param_str
, "realm") == 0) {
722 parse_eol(&digestAuthRealm
);
723 } else if (strcasecmp(param_str
, "nonce_garbage_interval") == 0) {
724 parse_time_t(&nonceGCInterval
);
725 } else if (strcasecmp(param_str
, "nonce_max_duration") == 0) {
726 parse_time_t(&noncemaxduration
);
727 } else if (strcasecmp(param_str
, "nonce_max_count") == 0) {
728 parse_int((int *) &noncemaxuses
);
729 } else if (strcasecmp(param_str
, "nonce_strictness") == 0) {
730 parse_onoff(&NonceStrictness
);
731 } else if (strcasecmp(param_str
, "check_nonce_count") == 0) {
732 parse_onoff(&CheckNonceCount
);
733 } else if (strcasecmp(param_str
, "post_workaround") == 0) {
734 parse_onoff(&PostWorkaround
);
735 } else if (strcasecmp(param_str
, "utf8") == 0) {
738 debugs(29, 0, "unrecognised digest auth scheme parameter '" << param_str
<< "'");
743 AuthDigestConfig::type() const
745 return digestScheme::GetInstance()->type();
750 authenticateDigestStats(StoreEntry
* sentry
)
752 helperStats(sentry
, digestauthenticators
, "Digest Authenticator Statistics");
755 /* NonceUserUnlink: remove the reference to auth_user and unlink the node from the list */
758 authDigestNonceUserUnlink(digest_nonce_h
* nonce
)
760 DigestUser
*digest_user
;
761 dlink_node
*link
, *tmplink
;
769 digest_user
= nonce
->user
;
771 /* unlink from the user list. Yes we're crossing structures but this is the only
772 * time this code is needed
774 link
= digest_user
->nonces
.head
;
780 if (tmplink
->data
== nonce
) {
781 dlinkDelete(tmplink
, &digest_user
->nonces
);
782 authDigestNonceUnlink(static_cast < digest_nonce_h
* >(tmplink
->data
));
783 dlinkNodeDelete(tmplink
);
788 /* this reference to user was not locked because freeeing the user frees
794 /* authDigestUserLinkNonce: add a nonce to a given user's struct */
797 authDigestUserLinkNonce(DigestUser
* user
, digest_nonce_h
* nonce
)
800 DigestUser
*digest_user
;
807 node
= digest_user
->nonces
.head
;
809 while (node
&& (node
->data
!= nonce
))
815 node
= dlinkNodeNew();
817 dlinkAddTail(nonce
, node
, &digest_user
->nonces
);
819 authDigestNonceLink(nonce
);
821 /* ping this nonce to this auth user */
822 assert((nonce
->user
== NULL
) || (nonce
->user
== user
));
824 /* we don't lock this reference because removing the user removes the
825 * hash too. Of course if that changes we're stuffed so read the code huh?
830 /* setup the necessary info to log the username */
831 static AuthUserRequest::Pointer
832 authDigestLogUsername(char *username
, AuthUserRequest::Pointer auth_user_request
)
834 assert(auth_user_request
!= NULL
);
836 /* log the username */
837 debugs(29, 9, "authDigestLogUsername: Creating new user for logging '" << username
<< "'");
838 AuthUser::Pointer digest_user
= new DigestUser(static_cast<AuthDigestConfig
*>(AuthConfig::Find("digest")));
839 /* save the credentials */
840 digest_user
->username(username
);
841 /* set the auth_user type */
842 digest_user
->auth_type
= AUTH_BROKEN
;
843 /* link the request to the user */
844 auth_user_request
->user(digest_user
);
845 return auth_user_request
;
849 * Decode a Digest [Proxy-]Auth string, placing the results in the passed
850 * Auth_user structure.
852 AuthUserRequest::Pointer
853 AuthDigestConfig::decode(char const *proxy_auth
)
857 const char *pos
= NULL
;
858 char *username
= NULL
;
859 digest_nonce_h
*nonce
;
862 debugs(29, 9, "authenticateDigestDecodeAuth: beginning");
864 AuthDigestUserRequest
*digest_request
= new AuthDigestUserRequest();
866 /* trim DIGEST from string */
868 while (xisgraph(*proxy_auth
))
871 /* Trim leading whitespace before decoding */
872 while (xisspace(*proxy_auth
))
875 String
temp(proxy_auth
);
877 while (strListGetItem(&temp
, ',', &item
, &ilen
, &pos
)) {
878 /* isolate directive name & value */
881 if ((p
= (const char *)memchr(item
, '=', ilen
)) && (p
- item
< ilen
)) {
883 vlen
= ilen
- (p
- item
);
889 /* parse value. auth-param = token "=" ( token | quoted-string ) */
893 if (!httpHeaderParseQuotedString(p
, &value
)) {
894 debugs(29, 9, "authDigestDecodeAuth: Failed to parse attribute '" << item
<< "' in '" << temp
<< "'");
898 value
.limitInit(p
, vlen
);
901 debugs(29, 9, "authDigestDecodeAuth: Failed to parse attribute '" << item
<< "' in '" << temp
<< "'");
906 http_digest_attr_type type
= (http_digest_attr_type
)httpHeaderIdByName(item
, nlen
, DigestFieldsInfo
, DIGEST_ENUM_END
);
909 case DIGEST_USERNAME
:
911 username
= xstrndup(value
.rawBuf(), value
.size() + 1);
912 debugs(29, 9, "authDigestDecodeAuth: Found Username '" << username
<< "'");
916 safe_free(digest_request
->realm
);
917 digest_request
->realm
= xstrndup(value
.rawBuf(), value
.size() + 1);
918 debugs(29, 9, "authDigestDecodeAuth: Found realm '" << digest_request
->realm
<< "'");
922 safe_free(digest_request
->qop
);
923 digest_request
->qop
= xstrndup(value
.rawBuf(), value
.size() + 1);
924 debugs(29, 9, "authDigestDecodeAuth: Found qop '" << digest_request
->qop
<< "'");
927 case DIGEST_ALGORITHM
:
928 safe_free(digest_request
->algorithm
);
929 digest_request
->algorithm
= xstrndup(value
.rawBuf(), value
.size() + 1);
930 debugs(29, 9, "authDigestDecodeAuth: Found algorithm '" << digest_request
->algorithm
<< "'");
934 safe_free(digest_request
->uri
);
935 digest_request
->uri
= xstrndup(value
.rawBuf(), value
.size() + 1);
936 debugs(29, 9, "authDigestDecodeAuth: Found uri '" << digest_request
->uri
<< "'");
940 safe_free(digest_request
->nonceb64
);
941 digest_request
->nonceb64
= xstrndup(value
.rawBuf(), value
.size() + 1);
942 debugs(29, 9, "authDigestDecodeAuth: Found nonce '" << digest_request
->nonceb64
<< "'");
946 if (value
.size() != 8) {
947 debugs(29, 9, "authDigestDecodeAuth: Invalid nc '" << value
<< "' in '" << temp
<< "'");
949 xstrncpy(digest_request
->nc
, value
.rawBuf(), value
.size() + 1);
950 debugs(29, 9, "authDigestDecodeAuth: Found noncecount '" << digest_request
->nc
<< "'");
954 safe_free(digest_request
->cnonce
);
955 digest_request
->cnonce
= xstrndup(value
.rawBuf(), value
.size() + 1);
956 debugs(29, 9, "authDigestDecodeAuth: Found cnonce '" << digest_request
->cnonce
<< "'");
959 case DIGEST_RESPONSE
:
960 safe_free(digest_request
->response
);
961 digest_request
->response
= xstrndup(value
.rawBuf(), value
.size() + 1);
962 debugs(29, 9, "authDigestDecodeAuth: Found response '" << digest_request
->response
<< "'");
966 debugs(29, 3, "authDigestDecodeAuth: Unknown attribute '" << item
<< "' in '" << temp
<< "'");
974 /* now we validate the data given to us */
977 * TODO: on invalid parameters we should return 400, not 407.
978 * Find some clean way of doing this. perhaps return a valid
979 * struct, and set the direction to clientwards combined with
980 * a change to the clientwards handling code (ie let the
981 * clientwards call set the error type (but limited to known
982 * correct values - 400/401/407
985 /* 2069 requirements */
987 /* do we have a username ? */
988 if (!username
|| username
[0] == '\0') {
989 debugs(29, 2, "authenticateDigestDecode: Empty or not present username");
990 return authDigestLogUsername(username
, digest_request
);
993 /* Sanity check of the username.
994 * " can not be allowed in usernames until * the digest helper protocol
997 if (strchr(username
, '"')) {
998 debugs(29, 2, "authenticateDigestDecode: Unacceptable username '" << username
<< "'");
999 return authDigestLogUsername(username
, digest_request
);
1002 /* do we have a realm ? */
1003 if (!digest_request
->realm
|| digest_request
->realm
[0] == '\0') {
1004 debugs(29, 2, "authenticateDigestDecode: Empty or not present realm");
1005 return authDigestLogUsername(username
, digest_request
);
1009 if (!digest_request
->nonceb64
|| digest_request
->nonceb64
[0] == '\0') {
1010 debugs(29, 2, "authenticateDigestDecode: Empty or not present nonce");
1011 return authDigestLogUsername(username
, digest_request
);
1014 /* we can't check the URI just yet. We'll check it in the
1015 * authenticate phase, but needs to be given */
1016 if (!digest_request
->uri
|| digest_request
->uri
[0] == '\0') {
1017 debugs(29, 2, "authenticateDigestDecode: Missing URI field");
1018 return authDigestLogUsername(username
, digest_request
);
1021 /* is the response the correct length? */
1022 if (!digest_request
->response
|| strlen(digest_request
->response
) != 32) {
1023 debugs(29, 2, "authenticateDigestDecode: Response length invalid");
1024 return authDigestLogUsername(username
, digest_request
);
1027 /* check the algorithm is present and supported */
1028 if (!digest_request
->algorithm
)
1029 digest_request
->algorithm
= xstrndup("MD5", 4);
1030 else if (strcmp(digest_request
->algorithm
, "MD5")
1031 && strcmp(digest_request
->algorithm
, "MD5-sess")) {
1032 debugs(29, 2, "authenticateDigestDecode: invalid algorithm specified!");
1033 return authDigestLogUsername(username
, digest_request
);
1036 /* 2617 requirements, indicated by qop */
1037 if (digest_request
->qop
) {
1039 /* check the qop is what we expected. */
1040 if (strcmp(digest_request
->qop
, QOP_AUTH
) != 0) {
1041 /* we received a qop option we didn't send */
1042 debugs(29, 2, "authenticateDigestDecode: Invalid qop option received");
1043 return authDigestLogUsername(username
, digest_request
);
1047 if (!digest_request
->cnonce
|| digest_request
->cnonce
[0] == '\0') {
1048 debugs(29, 2, "authenticateDigestDecode: Missing cnonce field");
1049 return authDigestLogUsername(username
, digest_request
);
1053 if (strlen(digest_request
->nc
) != 8 || strspn(digest_request
->nc
, "0123456789abcdefABCDEF") != 8) {
1054 debugs(29, 2, "authenticateDigestDecode: invalid nonce count");
1055 return authDigestLogUsername(username
, digest_request
);
1058 /* cnonce and nc both require qop */
1059 if (digest_request
->cnonce
|| digest_request
->nc
) {
1060 debugs(29, 2, "authenticateDigestDecode: missing qop!");
1061 return authDigestLogUsername(username
, digest_request
);
1065 /** below nonce state dependent **/
1068 nonce
= authenticateDigestNonceFindNonce(digest_request
->nonceb64
);
1070 /* we couldn't find a matching nonce! */
1071 debugs(29, 2, "authenticateDigestDecode: Unexpected or invalid nonce received");
1072 digest_request
->credentials(AuthDigestUserRequest::Failed
);
1073 return authDigestLogUsername(username
, digest_request
);
1076 digest_request
->nonce
= nonce
;
1077 authDigestNonceLink(nonce
);
1079 /* check that we're not being hacked / the username hasn't changed */
1080 if (nonce
->user
&& strcmp(username
, nonce
->user
->username())) {
1081 debugs(29, 2, "authenticateDigestDecode: Username for the nonce does not equal the username for the request");
1082 return authDigestLogUsername(username
, digest_request
);
1085 /* the method we'll check at the authenticate step as well */
1088 /* we don't send or parse opaques. Ok so we're flexable ... */
1091 DigestUser
*digest_user
;
1093 AuthUser::Pointer auth_user
;
1095 if ((auth_user
= authDigestUserFindUsername(username
)) == NULL
) {
1096 /* the user doesn't exist in the username cache yet */
1097 debugs(29, 9, "authDigestDecodeAuth: Creating new digest user '" << username
<< "'");
1098 digest_user
= new DigestUser(this);
1099 /* auth_user is a parent */
1100 auth_user
= digest_user
;
1101 /* save the username */
1102 digest_user
->username(username
);
1103 /* set the user type */
1104 digest_user
->auth_type
= AUTH_DIGEST
;
1105 /* this auth_user struct is the one to get added to the
1107 /* store user in hash's */
1108 digest_user
->addToNameCache();
1111 * Add the digest to the user so we can tell if a hacking
1112 * or spoofing attack is taking place. We do this by assuming
1113 * the user agent won't change user name without warning.
1115 authDigestUserLinkNonce(digest_user
, nonce
);
1117 debugs(29, 9, "authDigestDecodeAuth: Found user '" << username
<< "' in the user cache as '" << auth_user
<< "'");
1118 digest_user
= static_cast<DigestUser
*>(auth_user
.getRaw());
1122 /*link the request and the user */
1123 assert(digest_request
!= NULL
);
1125 digest_request
->user(digest_user
);
1126 debugs(29, 9, "username = '" << digest_user
->username() << "'\nrealm = '" <<
1127 digest_request
->realm
<< "'\nqop = '" << digest_request
->qop
<<
1128 "'\nalgorithm = '" << digest_request
->algorithm
<< "'\nuri = '" <<
1129 digest_request
->uri
<< "'\nnonce = '" << digest_request
->nonceb64
<<
1130 "'\nnc = '" << digest_request
->nc
<< "'\ncnonce = '" <<
1131 digest_request
->cnonce
<< "'\nresponse = '" <<
1132 digest_request
->response
<< "'\ndigestnonce = '" << nonce
<< "'");
1134 return digest_request
;
1137 DigestUser::DigestUser(AuthConfig
*aConfig
) : AuthUser(aConfig
), HA1created (0)