From: Amos Jeffries Date: Thu, 22 May 2014 09:12:48 +0000 (-0700) Subject: Cleanup: document and rename Auth::UserRequest::module_start to startHelperLookup X-Git-Tag: SQUID_3_5_0_1~225 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=30c3f584b8a02773dfebcc259fc9a0c85d619f8c;p=thirdparty%2Fsquid.git Cleanup: document and rename Auth::UserRequest::module_start to startHelperLookup --- diff --git a/src/auth/UserRequest.cc b/src/auth/UserRequest.cc index 07172fb549..5794be1419 100644 --- a/src/auth/UserRequest.cc +++ b/src/auth/UserRequest.cc @@ -65,8 +65,8 @@ Auth::UserRequest::start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTH { assert(handler); assert(data); - debugs(29, 9, HERE << "auth_user_request '" << this << "'"); - module_start(request, al, handler, data); + debugs(29, 9, this); + startHelperLookup(request, al, handler, data); } bool diff --git a/src/auth/UserRequest.h b/src/auth/UserRequest.h index 7ca884e24c..b5e65c3d1d 100644 --- a/src/auth/UserRequest.h +++ b/src/auth/UserRequest.h @@ -158,15 +158,6 @@ public: virtual void releaseAuthServer(); - /** - * Called when squid is ready to put the request on hold and wait for a callback from the auth module - * when the auth module has performed it's external activities. - * - * \param handler Handler to process the callback when its run - * \param data CBDATA for handler - */ - virtual void module_start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *handler, void *data) = 0; - // User credentials object this UserRequest is managing virtual User::Pointer user() {return _auth_user;} virtual const User::Pointer user() const {return _auth_user;} @@ -195,7 +186,18 @@ public: /// Add the appropriate [Proxy-]Authenticate header to the given reply static void addReplyAuthHeader(HttpReply * rep, UserRequest::Pointer auth_user_request, HttpRequest * request, int accelerated, int internal); + /** Start an asynchronous helper lookup to verify the user credentials + * + * Uses startHelperLookup() for scheme-specific actions. + * + * The given callback will be called when the auth module has performed + * it's external activities. + * + * \param handler Handler to process the callback when its run + * \param data CBDATA for handler + */ void start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *handler, void *data); + char const * denyMessage(char const * const default_message = NULL); /** Possibly overrideable in future */ @@ -224,6 +226,15 @@ public: virtual const char *credentialsStr() = 0; const char *helperRequestKeyExtras(HttpRequest *, AccessLogEntry::Pointer &al); + +protected: + /** + * The scheme-specific actions to be performed when sending helper lookup. + * + * \see void start(HttpRequest *, AccessLogEntry::Pointer &, AUTHCB *, void *); + */ + virtual void startHelperLookup(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *handler, void *data) = 0; + private: static AuthAclState authenticate(UserRequest::Pointer * auth_user_request, http_hdr_type headertype, HttpRequest * request, ConnStateData * conn, Ip::Address &src_addr, AccessLogEntry::Pointer &al); diff --git a/src/auth/basic/UserRequest.cc b/src/auth/basic/UserRequest.cc index aaebbd5de2..fc1dee1ffa 100644 --- a/src/auth/basic/UserRequest.cc +++ b/src/auth/basic/UserRequest.cc @@ -93,7 +93,7 @@ Auth::Basic::UserRequest::module_direction() /* send the initial data to a basic authenticator module */ void -Auth::Basic::UserRequest::module_start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) +Auth::Basic::UserRequest::startHelperLookup(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) { assert(user()->auth_type == Auth::AUTH_BASIC); Auth::Basic::User *basic_auth = dynamic_cast(user().getRaw()); diff --git a/src/auth/basic/UserRequest.h b/src/auth/basic/UserRequest.h index 7fad9169c7..85885dd129 100644 --- a/src/auth/basic/UserRequest.h +++ b/src/auth/basic/UserRequest.h @@ -26,7 +26,7 @@ public: virtual int authenticated() const; virtual void authenticate(HttpRequest * request, ConnStateData *conn, http_hdr_type type); virtual Auth::Direction module_direction(); - virtual void module_start(HttpRequest * request, AccessLogEntry::Pointer &al, AUTHCB *, void *); + virtual void startHelperLookup(HttpRequest * request, AccessLogEntry::Pointer &al, AUTHCB *, void *); virtual const char *credentialsStr(); private: diff --git a/src/auth/digest/UserRequest.cc b/src/auth/digest/UserRequest.cc index 76cc980235..3f02a5b718 100644 --- a/src/auth/digest/UserRequest.cc +++ b/src/auth/digest/UserRequest.cc @@ -272,7 +272,7 @@ Auth::Digest::UserRequest::addAuthenticationInfoTrailer(HttpReply * rep, int acc /* send the initial data to a digest authenticator module */ void -Auth::Digest::UserRequest::module_start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) +Auth::Digest::UserRequest::startHelperLookup(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) { char buf[8192]; diff --git a/src/auth/digest/UserRequest.h b/src/auth/digest/UserRequest.h index 85415d1801..a4d006815c 100644 --- a/src/auth/digest/UserRequest.h +++ b/src/auth/digest/UserRequest.h @@ -34,7 +34,7 @@ public: virtual void addAuthenticationInfoTrailer(HttpReply * rep, int accel); #endif - virtual void module_start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *, void *); + virtual void startHelperLookup(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *, void *); virtual const char *credentialsStr(); char *nonceb64; /* "dcd98b7102dd2f0e8b11d0f600bfb0c093" */ diff --git a/src/auth/negotiate/UserRequest.cc b/src/auth/negotiate/UserRequest.cc index ee33419bfa..808aacab98 100644 --- a/src/auth/negotiate/UserRequest.cc +++ b/src/auth/negotiate/UserRequest.cc @@ -97,7 +97,7 @@ Auth::Negotiate::UserRequest::module_direction() } void -Auth::Negotiate::UserRequest::module_start(HttpRequest *req, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) +Auth::Negotiate::UserRequest::startHelperLookup(HttpRequest *req, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) { static char buf[MAX_AUTHTOKEN_LEN]; diff --git a/src/auth/negotiate/UserRequest.h b/src/auth/negotiate/UserRequest.h index b7af9311ec..ad55fb71f7 100644 --- a/src/auth/negotiate/UserRequest.h +++ b/src/auth/negotiate/UserRequest.h @@ -26,7 +26,7 @@ public: virtual int authenticated() const; virtual void authenticate(HttpRequest * request, ConnStateData * conn, http_hdr_type type); virtual Direction module_direction(); - virtual void module_start(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *, void *); + virtual void startHelperLookup(HttpRequest *request, AccessLogEntry::Pointer &al, AUTHCB *, void *); virtual const char *credentialsStr(); virtual void addAuthenticationInfoHeader(HttpReply * rep, int accel); diff --git a/src/auth/ntlm/UserRequest.cc b/src/auth/ntlm/UserRequest.cc index 0f79d5b98f..605c4c7b51 100644 --- a/src/auth/ntlm/UserRequest.cc +++ b/src/auth/ntlm/UserRequest.cc @@ -95,7 +95,7 @@ Auth::Ntlm::UserRequest::module_direction() } void -Auth::Ntlm::UserRequest::module_start(HttpRequest *req, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) +Auth::Ntlm::UserRequest::startHelperLookup(HttpRequest *req, AccessLogEntry::Pointer &al, AUTHCB * handler, void *data) { static char buf[MAX_AUTHTOKEN_LEN]; diff --git a/src/auth/ntlm/UserRequest.h b/src/auth/ntlm/UserRequest.h index 7bed6b1279..7b398210da 100644 --- a/src/auth/ntlm/UserRequest.h +++ b/src/auth/ntlm/UserRequest.h @@ -26,7 +26,7 @@ public: virtual int authenticated() const; virtual void authenticate(HttpRequest * request, ConnStateData * conn, http_hdr_type type); virtual Auth::Direction module_direction(); - virtual void module_start(HttpRequest *req, AccessLogEntry::Pointer &al, AUTHCB *, void *); + virtual void startHelperLookup(HttpRequest *req, AccessLogEntry::Pointer &al, AUTHCB *, void *); virtual const char *credentialsStr(); virtual const char * connLastHeader();