2 #include "AccessLogEntry.h"
3 #include "acl/FilledChecklist.h"
4 #include "adaptation/AccessCheck.h"
5 #include "adaptation/AccessRule.h"
6 #include "adaptation/Config.h"
7 #include "adaptation/Initiator.h"
8 #include "adaptation/Service.h"
9 #include "adaptation/ServiceGroups.h"
10 #include "base/AsyncJobCalls.h"
11 #include "base/TextException.h"
12 #include "ConfigParser.h"
14 #include "HttpReply.h"
15 #include "HttpRequest.h"
17 /** \cond AUTODOCS_IGNORE */
18 cbdata_type
Adaptation::AccessCheck::CBDATA_AccessCheck
= CBDATA_UNKNOWN
;
22 Adaptation::AccessCheck::Start(Method method
, VectPoint vp
,
23 HttpRequest
*req
, HttpReply
*rep
,
24 AccessLogEntry::Pointer
&al
, Adaptation::Initiator
*initiator
)
27 if (Config::Enabled
) {
28 // the new check will call the callback and delete self, eventually
29 AsyncJob::Start(new AccessCheck( // we do not store so not a CbcPointer
30 ServiceFilter(method
, vp
, req
, rep
, al
), initiator
));
34 debugs(83, 3, HERE
<< "adaptation off, skipping");
38 Adaptation::AccessCheck::AccessCheck(const ServiceFilter
&aFilter
,
39 Adaptation::Initiator
*initiator
):
40 AsyncJob("AccessCheck"), filter(aFilter
),
41 theInitiator(initiator
),
45 Adaptation::Icap::History::Pointer h
= filter
.request
->icapHistory();
50 debugs(93, 5, HERE
<< "AccessCheck constructed for " <<
51 methodStr(filter
.method
) << " " << vectPointStr(filter
.point
));
54 Adaptation::AccessCheck::~AccessCheck()
57 Adaptation::Icap::History::Pointer h
= filter
.request
->icapHistory();
64 Adaptation::AccessCheck::start()
68 if (!usedDynamicRules())
72 /// returns true if previous services configured dynamic chaining "rules"
74 Adaptation::AccessCheck::usedDynamicRules()
76 Adaptation::History::Pointer ah
= filter
.request
->adaptHistory();
78 return false; // dynamic rules not enabled or not triggered
80 DynamicGroupCfg services
;
81 if (!ah
->extractFutureServices(services
)) { // clears history
82 debugs(85,9, HERE
<< "no service-proposed rules stored");
83 return false; // earlier service did not plan for the future
86 debugs(85,3, HERE
<< "using stored service-proposed rules: " << services
);
88 ServiceGroupPointer g
= new DynamicServiceChain(services
, filter
);
94 /// Walk the access rules list to find rules with applicable service groups
96 Adaptation::AccessCheck::check()
98 debugs(93, 4, HERE
<< "start checking");
100 typedef AccessRules::iterator ARI
;
101 for (ARI i
= AllRules().begin(); i
!= AllRules().end(); ++i
) {
103 if (isCandidate(*r
)) {
104 debugs(93, 5, HERE
<< "check: rule '" << r
->id
<< "' is a candidate");
112 // XXX: Here and everywhere we call FindRule(topCandidate()):
113 // Once we identified the candidate, we should not just ignore it
114 // if reconfigure changes rules. We should either lock the rule to
115 // prevent reconfigure from stealing it or restart the check with
116 // new rules. Throwing an exception may also be appropriate.
118 Adaptation::AccessCheck::checkCandidates()
120 debugs(93, 4, HERE
<< "has " << candidates
.size() << " rules");
122 while (!candidates
.empty()) {
123 if (AccessRule
*r
= FindRule(topCandidate())) {
124 /* BUG 2526: what to do when r->acl is empty?? */
125 // XXX: we do not have access to conn->rfc931 here.
126 acl_checklist
= new ACLFilledChecklist(r
->acl
, filter
.request
, dash_str
);
127 if ((acl_checklist
->reply
= filter
.reply
))
128 HTTPMSGLOCK(acl_checklist
->reply
);
129 acl_checklist
->al
= filter
.al
;
130 acl_checklist
->nonBlockingCheck(AccessCheckCallbackWrapper
, this);
134 candidates
.shift(); // the rule apparently went away (reconfigure)
137 debugs(93, 4, HERE
<< "NO candidates left");
143 Adaptation::AccessCheck::AccessCheckCallbackWrapper(allow_t answer
, void *data
)
145 debugs(93, 8, HERE
<< "callback answer=" << answer
);
146 AccessCheck
*ac
= (AccessCheck
*)data
;
148 /** \todo AYJ 2008-06-12: If answer == ACCESS_AUTH_REQUIRED
149 * we should be kicking off an authentication before continuing
150 * with this request. see bug 2400 for details.
153 // convert to async call to get async call protections and features
154 typedef UnaryMemFunT
<AccessCheck
, allow_t
> MyDialer
;
155 AsyncCall::Pointer call
=
156 asyncCall(93,7, "Adaptation::AccessCheck::noteAnswer",
157 MyDialer(ac
, &Adaptation::AccessCheck::noteAnswer
, answer
));
158 ScheduleCallHere(call
);
162 /// process the results of the ACL check
164 Adaptation::AccessCheck::noteAnswer(allow_t answer
)
166 Must(!candidates
.empty()); // the candidate we were checking must be there
167 debugs(93,5, HERE
<< topCandidate() << " answer=" << answer
);
169 if (answer
== ACCESS_ALLOWED
) { // the rule matched
170 ServiceGroupPointer g
= topGroup();
171 if (g
!= NULL
) { // the corresponding group found
178 // no match or the group disappeared during reconfiguration
183 /// call back with a possibly nil group; the job ends here because all failures
184 /// at this point are fatal to the access check process
186 Adaptation::AccessCheck::callBack(const ServiceGroupPointer
&g
)
188 debugs(93,3, HERE
<< g
);
189 CallJobHere1(93, 5, theInitiator
, Adaptation::Initiator
,
190 noteAdaptationAclCheckDone
, g
);
191 mustStop("done"); // called back or will never be able to call back
194 Adaptation::ServiceGroupPointer
195 Adaptation::AccessCheck::topGroup() const
197 ServiceGroupPointer g
;
198 if (candidates
.size()) {
199 if (AccessRule
*r
= FindRule(topCandidate())) {
200 g
= FindGroup(r
->groupId
);
201 debugs(93,5, HERE
<< "top group for " << r
->id
<< " is " << g
);
203 debugs(93,5, HERE
<< "no rule for " << topCandidate());
206 debugs(93,5, HERE
<< "no candidates"); // should not happen
212 /** Returns true iff the rule's service group will be used after ACL matches.
213 Used to detect rules worth ACl-checking. */
215 Adaptation::AccessCheck::isCandidate(AccessRule
&r
)
217 debugs(93,7,HERE
<< "checking candidacy of " << r
.id
<< ", group " <<
220 ServiceGroupPointer g
= FindGroup(r
.groupId
);
223 debugs(93,7,HERE
<< "lost " << r
.groupId
<< " group in rule" << r
.id
);
227 const bool wants
= g
->wants(filter
);
228 debugs(93,7,HERE
<< r
.groupId
<< (wants
? " wants" : " ignores"));