]>
Commit | Line | Data |
---|---|---|
22f3fd98 | 1 | |
2 | /* | |
262a0e14 | 3 | * $Id$ |
22f3fd98 | 4 | * |
5 | * DEBUG: section 16 Cache Manager Objects | |
6 | * AUTHOR: Duane Wessels | |
7 | * | |
2b6662ba | 8 | * SQUID Web Proxy Cache http://www.squid-cache.org/ |
e25c139f | 9 | * ---------------------------------------------------------- |
22f3fd98 | 10 | * |
2b6662ba | 11 | * Squid is the result of efforts by numerous individuals from |
12 | * the Internet community; see the CONTRIBUTORS file for full | |
13 | * details. Many organizations have provided support for Squid's | |
14 | * development; see the SPONSORS file for full details. Squid is | |
15 | * Copyrighted (C) 2001 by the Regents of the University of | |
16 | * California; see the COPYRIGHT file for full details. Squid | |
17 | * incorporates software developed and/or copyrighted by other | |
18 | * sources; see the CREDITS file for full details. | |
22f3fd98 | 19 | * |
20 | * This program is free software; you can redistribute it and/or modify | |
21 | * it under the terms of the GNU General Public License as published by | |
22 | * the Free Software Foundation; either version 2 of the License, or | |
23 | * (at your option) any later version. | |
26ac0430 | 24 | * |
22f3fd98 | 25 | * This program is distributed in the hope that it will be useful, |
26 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
27 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
28 | * GNU General Public License for more details. | |
26ac0430 | 29 | * |
22f3fd98 | 30 | * You should have received a copy of the GNU General Public License |
31 | * along with this program; if not, write to the Free Software | |
cbdec147 | 32 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. |
e25c139f | 33 | * |
22f3fd98 | 34 | */ |
35 | ||
5c336a3b | 36 | #include "config.h" |
8822ebee | 37 | #include "base/TextException.h" |
62ee09ca | 38 | #include "CacheManager.h" |
5c336a3b | 39 | #include "comm/Connection.h" |
8822ebee | 40 | #include "Debug.h" |
aa839030 | 41 | #include "errorpage.h" |
8822ebee | 42 | #include "fde.h" |
528b2c61 | 43 | #include "HttpReply.h" |
44 | #include "HttpRequest.h" | |
8822ebee AR |
45 | #include "mgr/ActionCreator.h" |
46 | #include "mgr/Action.h" | |
47 | #include "mgr/ActionProfile.h" | |
48 | #include "mgr/BasicActions.h" | |
49 | #include "mgr/Command.h" | |
50 | #include "mgr/Forwarder.h" | |
51 | #include "mgr/FunAction.h" | |
a750e510 AJ |
52 | /* for rotate_logs() */ |
53 | #include "protos.h" | |
985c86bc | 54 | #include "SquidTime.h" |
8822ebee | 55 | #include "Store.h" |
d295d770 | 56 | #include "wordlist.h" |
8822ebee | 57 | #include <algorithm> |
22f3fd98 | 58 | |
74990ce1 | 59 | |
63be0a78 | 60 | /// \ingroup CacheManagerInternal |
22f3fd98 | 61 | #define MGR_PASSWD_SZ 128 |
62 | ||
8822ebee AR |
63 | /// creates Action using supplied Action::Create method and command |
64 | class ClassActionCreator: public Mgr::ActionCreator | |
65 | { | |
66 | public: | |
67 | typedef Mgr::Action::Pointer Handler(const Mgr::Command::Pointer &cmd); | |
c83f0bd5 | 68 | |
8822ebee AR |
69 | public: |
70 | ClassActionCreator(Handler *aHandler): handler(aHandler) {} | |
71 | ||
d9fc6862 | 72 | virtual Mgr::Action::Pointer create(const Mgr::Command::Pointer &cmd) const { |
8822ebee AR |
73 | return handler(cmd); |
74 | } | |
75 | ||
76 | private: | |
77 | Handler *handler; | |
78 | }; | |
79 | ||
80 | ||
81 | /// Registers new profiles, ignoring attempts to register a duplicate | |
82 | void | |
83 | CacheManager::registerProfile(const Mgr::ActionProfile::Pointer &profile) | |
62ee09ca | 84 | { |
8822ebee | 85 | Must(profile != NULL); |
ef890f9d | 86 | if (std::find(menu_.begin(), menu_.end(), profile) == menu_.end()) { |
8822ebee AR |
87 | menu_.push_back(profile); |
88 | debugs(16, 3, HERE << "registered profile: " << *profile); | |
89 | } else { | |
90 | debugs(16, 2, HERE << "skipped duplicate profile: " << *profile); | |
91 | } | |
62ee09ca | 92 | } |
22f3fd98 | 93 | |
d154d3ec FC |
94 | /** |
95 | \ingroup CacheManagerAPI | |
96 | * Registers a C-style action, which is implemented as a pointer to a function | |
97 | * taking as argument a pointer to a StoreEntry and returning void. | |
98 | * Implemented via CacheManagerActionLegacy. | |
99 | */ | |
22f3fd98 | 100 | void |
8822ebee | 101 | CacheManager::registerProfile(char const * action, char const * desc, OBJH * handler, int pw_req_flag, int atomic) |
22f3fd98 | 102 | { |
8822ebee AR |
103 | debugs(16, 3, HERE << "registering legacy " << action); |
104 | const Mgr::ActionProfile::Pointer profile = new Mgr::ActionProfile(action, | |
d9fc6862 | 105 | desc, pw_req_flag, atomic, new Mgr::FunActionCreator(handler)); |
8822ebee | 106 | registerProfile(profile); |
1d8395bd | 107 | } |
62e76326 | 108 | |
d154d3ec | 109 | /** |
e0d28505 | 110 | * \ingroup CacheManagerAPI |
a750e510 | 111 | * Registers a C++-style action, via a pointer to a subclass of |
d154d3ec FC |
112 | * a CacheManagerAction object, whose run() method will be invoked when |
113 | * CacheManager identifies that the user has requested the action. | |
114 | */ | |
1d8395bd | 115 | void |
8822ebee | 116 | CacheManager::registerProfile(char const * action, char const * desc, |
d9fc6862 A |
117 | ClassActionCreator::Handler *handler, |
118 | int pw_req_flag, int atomic) | |
1d8395bd | 119 | { |
8822ebee | 120 | const Mgr::ActionProfile::Pointer profile = new Mgr::ActionProfile(action, |
d9fc6862 | 121 | desc, pw_req_flag, atomic, new ClassActionCreator(handler)); |
8822ebee | 122 | registerProfile(profile); |
62ee09ca | 123 | } |
124 | ||
d154d3ec FC |
125 | /** |
126 | \ingroup CacheManagerInternal | |
127 | * Locates an action in the actions registry ActionsList. | |
128 | \retval NULL if Action not found | |
129 | \retval CacheManagerAction* if the action was found | |
130 | */ | |
8822ebee AR |
131 | Mgr::ActionProfile::Pointer |
132 | CacheManager::findAction(char const * action) const | |
22f3fd98 | 133 | { |
8822ebee AR |
134 | Must(action != NULL); |
135 | Menu::const_iterator a; | |
03c4599f K |
136 | |
137 | debugs(16, 5, "CacheManager::findAction: looking for action " << action); | |
8822ebee AR |
138 | for (a = menu_.begin(); a != menu_.end(); ++a) { |
139 | if (0 == strcmp((*a)->name, action)) { | |
03c4599f K |
140 | debugs(16, 6, " found"); |
141 | return *a; | |
142 | } | |
22f3fd98 | 143 | } |
62e76326 | 144 | |
03c4599f | 145 | debugs(16, 6, "Action not found."); |
8822ebee AR |
146 | return Mgr::ActionProfilePointer(); |
147 | } | |
148 | ||
149 | Mgr::Action::Pointer | |
150 | CacheManager::createNamedAction(const char *actionName) | |
151 | { | |
152 | Must(actionName); | |
153 | ||
154 | Mgr::Command::Pointer cmd = new Mgr::Command; | |
155 | cmd->profile = findAction(actionName); | |
156 | cmd->params.actionName = actionName; | |
157 | ||
158 | Must(cmd->profile != NULL); | |
159 | return cmd->profile->creator->create(cmd); | |
160 | } | |
161 | ||
162 | Mgr::Action::Pointer | |
163 | CacheManager::createRequestedAction(const Mgr::ActionParams ¶ms) | |
164 | { | |
165 | Mgr::Command::Pointer cmd = new Mgr::Command; | |
166 | cmd->params = params; | |
167 | cmd->profile = findAction(params.actionName.termedBuf()); | |
168 | Must(cmd->profile != NULL); | |
169 | return cmd->profile->creator->create(cmd); | |
22f3fd98 | 170 | } |
171 | ||
832c08ab FC |
172 | /** |
173 | \ingroup CacheManagerInternal | |
174 | * define whether the URL is a cache-manager URL and parse the action | |
175 | * requested by the user. Checks via CacheManager::ActionProtection() that the | |
176 | * item is accessible by the user. | |
177 | \retval CacheManager::cachemgrStateData state object for the following handling | |
178 | \retval NULL if the action can't be found or can't be accessed by the user | |
179 | */ | |
8822ebee | 180 | Mgr::Command::Pointer |
c83f0bd5 | 181 | CacheManager::ParseUrl(const char *url) |
22f3fd98 | 182 | { |
183 | int t; | |
184 | LOCAL_ARRAY(char, host, MAX_URL); | |
185 | LOCAL_ARRAY(char, request, MAX_URL); | |
186 | LOCAL_ARRAY(char, password, MAX_URL); | |
22f3fd98 | 187 | t = sscanf(url, "cache_object://%[^/]/%[^@]@%s", host, request, password); |
62e76326 | 188 | |
8822ebee | 189 | if (t < 2) |
62e76326 | 190 | xstrncpy(request, "menu", MAX_URL); |
8822ebee | 191 | |
cd377065 | 192 | #ifdef _SQUID_OS2_ |
8822ebee | 193 | if (t == 2 && request[0] == '\0') { |
62e76326 | 194 | /* |
195 | * emx's sscanf insists of returning 2 because it sets request | |
196 | * to null | |
197 | */ | |
62e76326 | 198 | xstrncpy(request, "menu", MAX_URL); |
8822ebee | 199 | } |
cd377065 | 200 | #endif |
62e76326 | 201 | |
8822ebee AR |
202 | Mgr::ActionProfile::Pointer profile = findAction(request); |
203 | if (!profile) { | |
3e1da049 | 204 | debugs(16, DBG_IMPORTANT, "CacheManager::ParseUrl: action '" << request << "' not found"); |
62e76326 | 205 | return NULL; |
22f3fd98 | 206 | } |
62e76326 | 207 | |
8822ebee AR |
208 | const char *prot = ActionProtection(profile); |
209 | if (!strcmp(prot, "disabled") || !strcmp(prot, "hidden")) { | |
210 | debugs(16, DBG_IMPORTANT, "CacheManager::ParseUrl: action '" << request << "' is " << prot); | |
211 | return NULL; | |
212 | } | |
62e76326 | 213 | |
8822ebee AR |
214 | Mgr::Command::Pointer cmd = new Mgr::Command; |
215 | cmd->profile = profile; | |
216 | cmd->params.httpUri = url; | |
217 | cmd->params.userName = String(); | |
218 | cmd->params.password = t == 3 ? String(password) : String(); | |
219 | cmd->params.actionName = request; | |
220 | return cmd; | |
22f3fd98 | 221 | } |
222 | ||
63be0a78 | 223 | /// \ingroup CacheManagerInternal |
832c08ab FC |
224 | /* |
225 | \ingroup CacheManagerInternal | |
226 | * Decodes the headers needed to perform user authentication and fills | |
227 | * the details into the cachemgrStateData argument | |
228 | */ | |
c83f0bd5 | 229 | void |
8822ebee | 230 | CacheManager::ParseHeaders(const HttpRequest * request, Mgr::ActionParams ¶ms) |
63259c34 | 231 | { |
8822ebee AR |
232 | assert(request); |
233 | ||
234 | params.httpMethod = request->method.id(); | |
235 | params.httpFlags = request->flags; | |
236 | ||
9da6b594 AJ |
237 | #if HAVE_AUTH_MODULE_BASIC |
238 | // TODO: use the authentication system decode to retrieve these details properly. | |
239 | ||
240 | /* base 64 _decoded_ user:passwd pair */ | |
241 | const char *basic_cookie = request->header.getAuth(HDR_AUTHORIZATION, "Basic"); | |
62e76326 | 242 | |
99edd1c3 | 243 | if (!basic_cookie) |
62e76326 | 244 | return; |
245 | ||
9da6b594 | 246 | const char *passwd_del; |
63259c34 | 247 | if (!(passwd_del = strchr(basic_cookie, ':'))) { |
3e1da049 | 248 | debugs(16, DBG_IMPORTANT, "CacheManager::ParseHeaders: unknown basic_cookie format '" << basic_cookie << "'"); |
62e76326 | 249 | return; |
63259c34 | 250 | } |
62e76326 | 251 | |
63259c34 | 252 | /* found user:password pair, reset old values */ |
8822ebee AR |
253 | params.userName.limitInit(basic_cookie, passwd_del - basic_cookie); |
254 | params.password = passwd_del + 1; | |
62e76326 | 255 | |
9da6b594 | 256 | /* warning: this prints decoded password which maybe not be what you want to do @?@ @?@ */ |
8822ebee | 257 | debugs(16, 9, "CacheManager::ParseHeaders: got user: '" << |
d9fc6862 | 258 | params.userName << "' passwd: '" << params.password << "'"); |
9da6b594 | 259 | #endif |
63259c34 | 260 | } |
261 | ||
63be0a78 | 262 | /** |
263 | \ingroup CacheManagerInternal | |
264 | * | |
265 | \retval 0 if mgr->password is good or "none" | |
266 | \retval 1 if mgr->password is "disable" | |
267 | \retval !0 if mgr->password does not match configured password | |
22f3fd98 | 268 | */ |
c83f0bd5 | 269 | int |
8822ebee | 270 | CacheManager::CheckPassword(const Mgr::Command &cmd) |
22f3fd98 | 271 | { |
8822ebee AR |
272 | assert(cmd.profile != NULL); |
273 | const char *action = cmd.profile->name; | |
274 | char *pwd = PasswdGet(Config.passwd_list, action); | |
03c4599f | 275 | |
8822ebee | 276 | debugs(16, 4, "CacheManager::CheckPassword for action " << action); |
62e76326 | 277 | |
22f3fd98 | 278 | if (pwd == NULL) |
8822ebee | 279 | return cmd.profile->isPwReq; |
62e76326 | 280 | |
22f3fd98 | 281 | if (strcmp(pwd, "disable") == 0) |
62e76326 | 282 | return 1; |
283 | ||
22f3fd98 | 284 | if (strcmp(pwd, "none") == 0) |
62e76326 | 285 | return 0; |
286 | ||
8822ebee | 287 | if (!cmd.params.password.size()) |
62e76326 | 288 | return 1; |
289 | ||
8822ebee | 290 | return cmd.params.password != pwd; |
22f3fd98 | 291 | } |
292 | ||
832c08ab FC |
293 | /** |
294 | \ingroup CacheManagerAPI | |
295 | * Main entry point in the Cache Manager's activity. Gets called as part | |
296 | * of the forward chain if the right URL is detected there. Initiates | |
297 | * all needed internal work and renders the response. | |
298 | */ | |
22f3fd98 | 299 | void |
5c336a3b | 300 | CacheManager::Start(const Comm::ConnectionPointer &client, HttpRequest * request, StoreEntry * entry) |
22f3fd98 | 301 | { |
22f3fd98 | 302 | ErrorState *err = NULL; |
832c08ab | 303 | debugs(16, 3, "CacheManager::Start: '" << entry->url() << "'" ); |
62e76326 | 304 | |
8822ebee AR |
305 | Mgr::Command::Pointer cmd = ParseUrl(entry->url()); |
306 | if (!cmd) { | |
2cc81f1f | 307 | err = errorCon(ERR_INVALID_URL, HTTP_NOT_FOUND, request); |
3900307b | 308 | err->url = xstrdup(entry->url()); |
62e76326 | 309 | errorAppendEntry(entry, err); |
310 | entry->expires = squid_curtime; | |
311 | return; | |
22f3fd98 | 312 | } |
62e76326 | 313 | |
8822ebee | 314 | const char *actionName = cmd->profile->name; |
34266cde | 315 | |
22f3fd98 | 316 | entry->expires = squid_curtime; |
34266cde | 317 | |
a750e510 | 318 | debugs(16, 5, "CacheManager: " << client << " requesting '" << actionName << "'"); |
34266cde | 319 | |
63259c34 | 320 | /* get additional info from request headers */ |
8822ebee AR |
321 | ParseHeaders(request, cmd->params); |
322 | ||
323 | const char *userName = cmd->params.userName.size() ? | |
d9fc6862 | 324 | cmd->params.userName.termedBuf() : "unknown"; |
34266cde | 325 | |
22f3fd98 | 326 | /* Check password */ |
62e76326 | 327 | |
8822ebee | 328 | if (CheckPassword(*cmd) != 0) { |
62e76326 | 329 | /* build error message */ |
076df709 | 330 | ErrorState *errState; |
62e76326 | 331 | HttpReply *rep; |
076df709 | 332 | errState = errorCon(ERR_CACHE_MGR_ACCESS_DENIED, HTTP_UNAUTHORIZED, request); |
62e76326 | 333 | /* warn if user specified incorrect password */ |
334 | ||
8822ebee | 335 | if (cmd->params.password.size()) { |
26ac0430 | 336 | debugs(16, DBG_IMPORTANT, "CacheManager: " << |
8822ebee | 337 | userName << "@" << |
5c336a3b | 338 | client << ": incorrect password for '" << |
8822ebee AR |
339 | actionName << "'" ); |
340 | } else { | |
26ac0430 | 341 | debugs(16, DBG_IMPORTANT, "CacheManager: " << |
8822ebee | 342 | userName << "@" << |
5c336a3b | 343 | client << ": password needed for '" << |
8822ebee AR |
344 | actionName << "'" ); |
345 | } | |
62e76326 | 346 | |
076df709 | 347 | rep = errState->BuildHttpReply(); |
62e76326 | 348 | |
076df709 | 349 | errorStateFree(errState); |
62e76326 | 350 | |
9da6b594 | 351 | #if HAVE_AUTH_MODULE_BASIC |
62e76326 | 352 | /* |
8822ebee AR |
353 | * add Authenticate header using action name as a realm because |
354 | * password depends on the action | |
62e76326 | 355 | */ |
8822ebee | 356 | rep->header.putAuth("Basic", actionName); |
9da6b594 | 357 | #endif |
62e76326 | 358 | |
359 | /* store the reply */ | |
db237875 | 360 | entry->replaceHttpReply(rep); |
62e76326 | 361 | |
362 | entry->expires = squid_curtime; | |
363 | ||
364 | entry->complete(); | |
365 | ||
62e76326 | 366 | return; |
22f3fd98 | 367 | } |
62e76326 | 368 | |
0be039f4 | 369 | debugs(16, 2, "CacheManager: " << |
8822ebee | 370 | userName << "@" << |
5c336a3b | 371 | client << " requesting '" << |
8822ebee | 372 | actionName << "'" ); |
62e76326 | 373 | |
8822ebee | 374 | if (UsingSmp() && IamWorkerProcess()) { |
25b481e6 | 375 | AsyncJob::Start(new Mgr::Forwarder(client, cmd->params, request, entry)); |
8822ebee | 376 | return; |
cb69b4c7 | 377 | } |
62e76326 | 378 | |
8822ebee AR |
379 | Mgr::Action::Pointer action = cmd->profile->creator->create(cmd); |
380 | Must(action != NULL); | |
381 | action->run(entry, true); | |
22f3fd98 | 382 | } |
383 | ||
832c08ab FC |
384 | /* |
385 | \ingroup CacheManagerInternal | |
386 | * Renders the protection level text for an action. | |
387 | * Also doubles as a check for the protection level. | |
832c08ab | 388 | */ |
c83f0bd5 | 389 | const char * |
8822ebee | 390 | CacheManager::ActionProtection(const Mgr::ActionProfile::Pointer &profile) |
7395afb8 | 391 | { |
8822ebee AR |
392 | assert(profile != NULL); |
393 | const char *pwd = PasswdGet(Config.passwd_list, profile->name); | |
62e76326 | 394 | |
7395afb8 | 395 | if (!pwd) |
8822ebee | 396 | return profile->isPwReq ? "hidden" : "public"; |
62e76326 | 397 | |
7395afb8 | 398 | if (!strcmp(pwd, "disable")) |
62e76326 | 399 | return "disabled"; |
400 | ||
7395afb8 | 401 | if (strcmp(pwd, "none") == 0) |
62e76326 | 402 | return "public"; |
403 | ||
7395afb8 | 404 | return "protected"; |
405 | } | |
406 | ||
832c08ab FC |
407 | /* |
408 | \ingroup CacheManagerInternal | |
409 | * gets from the global Config the password the user would need to supply | |
410 | * for the action she queried | |
411 | */ | |
c83f0bd5 K |
412 | char * |
413 | CacheManager::PasswdGet(cachemgr_passwd * a, const char *action) | |
22f3fd98 | 414 | { |
415 | wordlist *w; | |
62e76326 | 416 | |
22f3fd98 | 417 | while (a != NULL) { |
62e76326 | 418 | for (w = a->actions; w != NULL; w = w->next) { |
419 | if (0 == strcmp(w->key, action)) | |
420 | return a->passwd; | |
421 | ||
422 | if (0 == strcmp(w->key, "all")) | |
423 | return a->passwd; | |
424 | } | |
425 | ||
426 | a = a->next; | |
22f3fd98 | 427 | } |
62e76326 | 428 | |
22f3fd98 | 429 | return NULL; |
430 | } | |
c83f0bd5 K |
431 | |
432 | CacheManager* CacheManager::instance=0; | |
433 | ||
832c08ab FC |
434 | /** |
435 | \ingroup CacheManagerAPI | |
436 | * Singleton accessor method. | |
437 | */ | |
c83f0bd5 | 438 | CacheManager* |
26ac0430 AJ |
439 | CacheManager::GetInstance() |
440 | { | |
441 | if (instance == 0) { | |
442 | debugs(16, 6, "CacheManager::GetInstance: starting cachemanager up"); | |
443 | instance = new CacheManager; | |
8822ebee | 444 | Mgr::RegisterBasics(); |
26ac0430 AJ |
445 | } |
446 | return instance; | |
c83f0bd5 | 447 | } |