src/auth/basic/UserRequest.cc

   1 /*
   2  * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
   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
   9 #include "squid.h"
  10 #include "auth/basic/Config.h"
  11 #include "auth/basic/User.h"
  12 #include "auth/basic/UserRequest.h"
  13 #include "auth/QueueNode.h"
  14 #include "auth/State.h"
  15 #include "charset.h"
  16 #include "Debug.h"
  17 #include "format/Format.h"
  18 #include "helper.h"
  19 #include "helper/Reply.h"
  20 #include "HttpMsg.h"
  21 #include "HttpRequest.h"
  22 #include "MemBuf.h"
  23 #include "rfc1738.h"
  24 #include "SquidTime.h"
  25
  26 #if !defined(HELPER_INPUT_BUFFER)
  27 #define HELPER_INPUT_BUFFER  8192
  28 #endif
  29
  30 int
  31 Auth::Basic::UserRequest::authenticated() const
  32 {
  33     Auth::Basic::User const *basic_auth = dynamic_cast<Auth::Basic::User const *>(user().getRaw());
  34
  35     if (basic_auth && basic_auth->authenticated())
  36         return 1;
  37
  38     return 0;
  39 }
  40
  41 const char *
  42 Auth::Basic::UserRequest::credentialsStr()
  43 {
  44     Auth::Basic::User const *basic_auth = dynamic_cast<Auth::Basic::User const *>(user().getRaw());
  45     if (basic_auth)
  46         return basic_auth->passwd;
  47     return NULL;
  48 }
  49
  50 /* log a basic user in
  51  */
  52 void
  53 Auth::Basic::UserRequest::authenticate(HttpRequest *, ConnStateData *, Http::HdrType)
  54 {
  55     assert(user() != NULL);
  56
  57     /* if the password is not ok, do an identity */
  58     if (!user() || user()->credentials() != Auth::Ok)
  59         return;
  60
  61     /* are we about to recheck the credentials externally? */
  62     if ((user()->expiretime + static_cast<Auth::Basic::Config*>(Auth::Config::Find("basic"))->credentialsTTL) <= squid_curtime) {
  63         debugs(29, 4, HERE << "credentials expired - rechecking");
  64         return;
  65     }
  66
  67     /* we have been through the external helper, and the credentials haven't expired */
  68     debugs(29, 9, HERE << "user '" << user()->username() << "' authenticated");
  69
  70     /* Decode now takes care of finding the AuthUser struct in the cache */
  71     /* after external auth occurs anyway */
  72     user()->expiretime = current_time.tv_sec;
  73 }
  74
  75 Auth::Direction
  76 Auth::Basic::UserRequest::module_direction()
  77 {
  78     /* null auth_user is checked for by Auth::UserRequest::direction() */
  79     if (user()->auth_type != Auth::AUTH_BASIC)
  80         return Auth::CRED_ERROR;
  81
  82     switch (user()->credentials()) {
  83
  84     case Auth::Unchecked:
  85     case Auth::Pending:
  86         return Auth::CRED_LOOKUP;
  87
  88     case Auth::Ok:
  89         if (user()->expiretime + static_cast<Auth::Basic::Config*>(Auth::Config::Find("basic"))->credentialsTTL <= squid_curtime)
  90             return Auth::CRED_LOOKUP;
  91         return Auth::CRED_VALID;
  92
  93     case Auth::Failed:
  94         return Auth::CRED_VALID;
  95
  96     default:
  97         return Auth::CRED_ERROR;
  98     }
  99 }
 100
 101 /* send the initial data to a basic authenticator module */
 102 void
 103 Auth::Basic::UserRequest::startHelperLookup(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data)
 104 {
 105     assert(user()->auth_type == Auth::AUTH_BASIC);
 106     Auth::Basic::User *basic_auth = dynamic_cast<Auth::Basic::User *>(user().getRaw());
 107     assert(basic_auth != NULL);
 108     debugs(29, 9, HERE << "'" << basic_auth->username() << ":" << basic_auth->passwd << "'");
 109
 110     if (static_cast<Auth::Basic::Config*>(Auth::Config::Find("basic"))->authenticateProgram == NULL) {
 111         debugs(29, DBG_CRITICAL, "ERROR: No Basic authentication program configured.");
 112         handler(data);
 113         return;
 114     }
 115
 116     /* check to see if the auth_user already has a request outstanding */
 117     if (user()->credentials() == Auth::Pending) {
 118         /* there is a request with the same credentials already being verified */
 119
 120         Auth::QueueNode *node = new Auth::QueueNode(this, handler, data);
 121
 122         /* queue this validation request to be infored of the pending lookup results */
 123         node->next = basic_auth->queue;
 124         basic_auth->queue = node;
 125         return;
 126     }
 127     // otherwise submit this request to the auth helper(s) for validation
 128
 129     /* mark this user as having verification in progress */
 130     user()->credentials(Auth::Pending);
 131     char buf[HELPER_INPUT_BUFFER];
 132     static char usern[HELPER_INPUT_BUFFER];
 133     static char pass[HELPER_INPUT_BUFFER];
 134     if (static_cast<Auth::Basic::Config*>(user()->config)->utf8) {
 135         latin1_to_utf8(usern, sizeof(usern), user()->username());
 136         latin1_to_utf8(pass, sizeof(pass), basic_auth->passwd);
 137         xstrncpy(usern, rfc1738_escape(usern), sizeof(usern));
 138         xstrncpy(pass, rfc1738_escape(pass), sizeof(pass));
 139     } else {
 140         xstrncpy(usern, rfc1738_escape(user()->username()), sizeof(usern));
 141         xstrncpy(pass, rfc1738_escape(basic_auth->passwd), sizeof(pass));
 142     }
 143     int sz = 0;
 144     if (const char *keyExtras = helperRequestKeyExtras(request, al))
 145         sz = snprintf(buf, sizeof(buf), "%s %s %s\n", usern, pass, keyExtras);
 146     else
 147         sz = snprintf(buf, sizeof(buf), "%s %s\n", usern, pass);
 148
 149     if (sz<=0) {
 150         debugs(9, DBG_CRITICAL, "ERROR: Basic Authentication Failure. Can not build helper validation request.");
 151         handler(data);
 152     } else if (static_cast<size_t>(sz) >= sizeof(buf)) {
 153         debugs(9, DBG_CRITICAL, "ERROR: Basic Authentication Failure. user:password exceeds " << sizeof(buf) << " bytes.");
 154         handler(data);
 155     } else
 156         helperSubmit(basicauthenticators, buf, Auth::Basic::UserRequest::HandleReply,
 157                      new Auth::StateData(this, handler, data));
 158 }
 159
 160 void
 161 Auth::Basic::UserRequest::HandleReply(void *data, const Helper::Reply &reply)
 162 {
 163     Auth::StateData *r = static_cast<Auth::StateData *>(data);
 164     void *cbdata;
 165     debugs(29, 5, HERE << "reply=" << reply);
 166
 167     assert(r->auth_user_request != NULL);
 168     assert(r->auth_user_request->user()->auth_type == Auth::AUTH_BASIC);
 169
 170     // add new helper kv-pair notes to the credentials object
 171     // so that any transaction using those credentials can access them
 172     r->auth_user_request->user()->notes.appendNewOnly(&reply.notes);
 173
 174     /* this is okay since we only play with the Auth::Basic::User child fields below
 175      * and dont pass the pointer itself anywhere */
 176     Auth::Basic::User *basic_auth = dynamic_cast<Auth::Basic::User *>(r->auth_user_request->user().getRaw());
 177
 178     assert(basic_auth != NULL);
 179
 180     if (reply.result == Helper::Okay)
 181         basic_auth->credentials(Auth::Ok);
 182     else {
 183         basic_auth->credentials(Auth::Failed);
 184
 185         if (reply.other().hasContent())
 186             r->auth_user_request->setDenyMessage(reply.other().content());
 187     }
 188
 189     basic_auth->expiretime = squid_curtime;
 190
 191     if (cbdataReferenceValidDone(r->data, &cbdata))
 192         r->handler(cbdata);
 193
 194     cbdataReferenceDone(r->data);
 195
 196     while (basic_auth->queue) {
 197         if (cbdataReferenceValidDone(basic_auth->queue->data, &cbdata))
 198             basic_auth->queue->handler(cbdata);
 199
 200         Auth::QueueNode *tmpnode = basic_auth->queue->next;
 201         basic_auth->queue->next = NULL;
 202         delete basic_auth->queue;
 203
 204         basic_auth->queue = tmpnode;
 205     }
 206
 207     delete r;
 208 }
 209