1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include "apr_strings.h"
19 #include "ap_config.h"
20 #include "ap_provider.h"
22 #include "http_config.h"
23 #include "http_core.h"
25 #include "http_protocol.h"
26 #include "http_request.h"
30 #include "ap_socache.h"
31 #include "util_mutex.h"
32 #include "apr_optional.h"
34 module AP_MODULE_DECLARE_DATA authn_socache_module;
36 typedef struct authn_cache_dircfg {
37 apr_interval_time_t timeout;
38 apr_array_header_t *providers;
43 * I think the cache and mutex should be global
45 static apr_global_mutex_t *authn_cache_mutex = NULL;
46 static ap_socache_provider_t *socache_provider = NULL;
47 static ap_socache_instance_t *socache_instance = NULL;
48 static const char *const authn_cache_id = "authn-socache";
49 static int configured;
51 static apr_status_t remove_lock(void *data)
53 if (authn_cache_mutex) {
54 apr_global_mutex_destroy(authn_cache_mutex);
55 authn_cache_mutex = NULL;
60 static apr_status_t destroy_cache(void *data)
62 if (socache_instance) {
63 socache_provider->destroy(socache_instance, (server_rec*)data);
64 socache_instance = NULL;
69 static int authn_cache_precfg(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptmp)
71 apr_status_t rv = ap_mutex_register(pconf, authn_cache_id,
72 NULL, APR_LOCK_DEFAULT, 0);
73 if (rv != APR_SUCCESS) {
74 ap_log_perror(APLOG_MARK, APLOG_CRIT, rv, plog, APLOGNO(01673)
75 "failed to register %s mutex", authn_cache_id);
76 return 500; /* An HTTP status would be a misnomer! */
78 socache_provider = ap_lookup_provider(AP_SOCACHE_PROVIDER_GROUP,
79 AP_SOCACHE_DEFAULT_PROVIDER,
80 AP_SOCACHE_PROVIDER_VERSION);
85 static int authn_cache_post_config(apr_pool_t *pconf, apr_pool_t *plog,
86 apr_pool_t *ptmp, server_rec *s)
89 static struct ap_socache_hints authn_cache_hints = {64, 32, 60000000};
93 return OK; /* don't waste the overhead of creating mutex & cache */
95 if (socache_provider == NULL) {
96 ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, plog, APLOGNO(01674)
97 "Please select a socache provider with AuthnCacheSOCache "
98 "(no default found on this platform). Maybe you need to "
99 "load mod_socache_shmcb or another socache module first");
100 return 500; /* An HTTP status would be a misnomer! */
103 /* We have socache_provider, but do not have socache_instance. This should
104 * happen only when using "default" socache_provider, so create default
105 * socache_instance in this case. */
106 if (socache_instance == NULL) {
107 errmsg = socache_provider->create(&socache_instance, NULL,
110 ap_log_perror(APLOG_MARK, APLOG_CRIT, 0, plog, APLOGNO(02612)
111 "failed to create mod_socache_shmcb socache "
112 "instance: %s", errmsg);
117 rv = ap_global_mutex_create(&authn_cache_mutex, NULL,
118 authn_cache_id, NULL, s, pconf, 0);
119 if (rv != APR_SUCCESS) {
120 ap_log_perror(APLOG_MARK, APLOG_CRIT, rv, plog, APLOGNO(01675)
121 "failed to create %s mutex", authn_cache_id);
122 return 500; /* An HTTP status would be a misnomer! */
124 apr_pool_cleanup_register(pconf, NULL, remove_lock, apr_pool_cleanup_null);
126 rv = socache_provider->init(socache_instance, authn_cache_id,
127 &authn_cache_hints, s, pconf);
128 if (rv != APR_SUCCESS) {
129 ap_log_perror(APLOG_MARK, APLOG_CRIT, rv, plog, APLOGNO(01677)
130 "failed to initialise %s cache", authn_cache_id);
131 return 500; /* An HTTP status would be a misnomer! */
133 apr_pool_cleanup_register(pconf, (void*)s, destroy_cache, apr_pool_cleanup_null);
137 static void authn_cache_child_init(apr_pool_t *p, server_rec *s)
142 return; /* don't waste the overhead of creating mutex & cache */
144 lock = apr_global_mutex_lockfile(authn_cache_mutex);
145 rv = apr_global_mutex_child_init(&authn_cache_mutex, lock, p);
146 if (rv != APR_SUCCESS) {
147 ap_log_error(APLOG_MARK, APLOG_CRIT, rv, s, APLOGNO(01678)
148 "failed to initialise mutex in child_init");
152 static const char *authn_cache_socache(cmd_parms *cmd, void *CFG,
155 const char *errmsg = ap_check_cmd_context(cmd, GLOBAL_ONLY);
156 const char *sep, *name;
161 /* Argument is of form 'name:args' or just 'name'. */
162 sep = ap_strchr_c(arg, ':');
164 name = apr_pstrmemdup(cmd->pool, arg, sep - arg);
171 socache_provider = ap_lookup_provider(AP_SOCACHE_PROVIDER_GROUP, name,
172 AP_SOCACHE_PROVIDER_VERSION);
173 if (socache_provider == NULL) {
174 errmsg = apr_psprintf(cmd->pool,
175 "Unknown socache provider '%s'. Maybe you need "
176 "to load the appropriate socache module "
177 "(mod_socache_%s?)", arg, arg);
180 errmsg = socache_provider->create(&socache_instance, sep,
181 cmd->temp_pool, cmd->pool);
185 errmsg = apr_psprintf(cmd->pool, "AuthnCacheSOCache: %s", errmsg);
190 static const char *authn_cache_enable(cmd_parms *cmd, void *CFG)
192 const char *errmsg = ap_check_cmd_context(cmd, GLOBAL_ONLY);
197 static const char *const directory = "directory";
198 static void* authn_cache_dircfg_create(apr_pool_t *pool, char *s)
200 authn_cache_dircfg *ret = apr_palloc(pool, sizeof(authn_cache_dircfg));
201 ret->timeout = apr_time_from_sec(300);
202 ret->providers = NULL;
203 ret->context = directory;
207 /* not sure we want this. Might be safer to document use-all-or-none */
208 static void* authn_cache_dircfg_merge(apr_pool_t *pool, void *BASE, void *ADD)
210 authn_cache_dircfg *base = BASE;
211 authn_cache_dircfg *add = ADD;
212 authn_cache_dircfg *ret = apr_pmemdup(pool, add, sizeof(authn_cache_dircfg));
213 /* preserve context and timeout if not defaults */
214 if (add->context == directory) {
215 ret->context = base->context;
217 if (add->timeout == apr_time_from_sec(300)) {
218 ret->timeout = base->timeout;
220 if (add->providers == NULL) {
221 ret->providers = base->providers;
226 static const char *authn_cache_setprovider(cmd_parms *cmd, void *CFG,
229 authn_cache_dircfg *cfg = CFG;
230 if (cfg->providers == NULL) {
231 cfg->providers = apr_array_make(cmd->pool, 4, sizeof(const char*));
233 APR_ARRAY_PUSH(cfg->providers, const char*) = arg;
238 static const char *authn_cache_timeout(cmd_parms *cmd, void *CFG,
241 authn_cache_dircfg *cfg = CFG;
242 int secs = atoi(arg);
243 cfg->timeout = apr_time_from_sec(secs);
247 static const command_rec authn_cache_cmds[] =
249 /* global stuff: cache and mutex */
250 AP_INIT_TAKE1("AuthnCacheSOCache", authn_cache_socache, NULL, RSRC_CONF,
251 "socache provider for authn cache"),
252 AP_INIT_NO_ARGS("AuthnCacheEnable", authn_cache_enable, NULL, RSRC_CONF,
253 "enable socache configuration in htaccess even if not enabled anywhere else"),
255 AP_INIT_ITERATE("AuthnCacheProvideFor", authn_cache_setprovider, NULL,
256 OR_AUTHCFG, "Determine what authn providers to cache for"),
257 AP_INIT_TAKE1("AuthnCacheTimeout", authn_cache_timeout, NULL,
258 OR_AUTHCFG, "Timeout (secs) for cached credentials"),
259 AP_INIT_TAKE1("AuthnCacheContext", ap_set_string_slot,
260 (void*)APR_OFFSETOF(authn_cache_dircfg, context),
261 ACCESS_CONF, "Context for authn cache"),
265 static const char *construct_key(request_rec *r, const char *context,
266 const char *user, const char *realm)
268 /* handle "special" context values */
269 if (!strcmp(context, directory)) {
270 /* FIXME: are we at risk of this blowing up? */
272 char *slash = strrchr(r->uri, '/');
273 new_context = apr_palloc(r->pool, slash - r->uri +
274 strlen(r->server->server_hostname) + 1);
275 strcpy(new_context, r->server->server_hostname);
276 strncat(new_context, r->uri, slash - r->uri);
277 context = new_context;
279 else if (!strcmp(context, "server")) {
280 context = r->server->server_hostname;
282 /* any other context value is literal */
284 if (realm == NULL) { /* basic auth */
285 return apr_pstrcat(r->pool, context, ":", user, NULL);
287 else { /* digest auth */
288 return apr_pstrcat(r->pool, context, ":", user, ":", realm, NULL);
292 static void ap_authn_cache_store(request_rec *r, const char *module,
293 const char *user, const char *realm,
297 authn_cache_dircfg *dcfg;
301 /* first check whether we're cacheing for this module */
302 dcfg = ap_get_module_config(r->per_dir_config, &authn_socache_module);
303 if (!configured || !dcfg->providers) {
306 if (!ap_array_str_contains(dcfg->providers, module)) {
310 /* OK, we're on. Grab mutex to do our business */
311 rv = apr_global_mutex_trylock(authn_cache_mutex);
312 if (APR_STATUS_IS_EBUSY(rv)) {
313 /* don't wait around; just abandon it */
314 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, rv, r, APLOGNO(01679)
315 "authn credentials for %s not cached (mutex busy)", user);
318 else if (rv != APR_SUCCESS) {
319 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01680)
320 "Failed to cache authn credentials for %s in %s",
321 module, dcfg->context);
325 /* We have the mutex, so go ahead */
326 /* first build our key and determine expiry time */
327 key = construct_key(r, dcfg->context, user, realm);
328 expiry = apr_time_now() + dcfg->timeout;
331 rv = socache_provider->store(socache_instance, r->server,
332 (unsigned char*)key, strlen(key), expiry,
333 (unsigned char*)data, strlen(data), r->pool);
334 if (rv == APR_SUCCESS) {
335 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01681)
336 "Cached authn credentials for %s in %s",
337 user, dcfg->context);
340 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01682)
341 "Failed to cache authn credentials for %s in %s",
342 module, dcfg->context);
345 /* We're done with the mutex */
346 rv = apr_global_mutex_unlock(authn_cache_mutex);
347 if (rv != APR_SUCCESS) {
348 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01683) "Failed to release mutex!");
352 #define MAX_VAL_LEN 256
353 static authn_status check_password(request_rec *r, const char *user,
354 const char *password)
358 * if found, test password
360 * mutexing here would be a big performance drag.
361 * It's definitely unnecessary with some backends (like ndbm or gdbm)
362 * Is there a risk in the general case? I guess the only risk we
363 * care about is a race condition that gets us a dangling pointer
364 * to no-longer-defined memory. Hmmm ...
368 authn_cache_dircfg *dcfg;
369 unsigned char val[MAX_VAL_LEN];
370 unsigned int vallen = MAX_VAL_LEN - 1;
371 dcfg = ap_get_module_config(r->per_dir_config, &authn_socache_module);
372 if (!configured || !dcfg->providers) {
373 return AUTH_USER_NOT_FOUND;
375 key = construct_key(r, dcfg->context, user, NULL);
376 rv = socache_provider->retrieve(socache_instance, r->server,
377 (unsigned char*)key, strlen(key),
378 val, &vallen, r->pool);
380 if (APR_STATUS_IS_NOTFOUND(rv)) {
381 /* not found - just return */
382 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01684)
383 "Authn cache: no credentials found for %s", user);
384 return AUTH_USER_NOT_FOUND;
386 else if (rv == APR_SUCCESS) {
387 /* OK, we got a value */
388 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01685)
389 "Authn cache: found credentials for %s", user);
393 /* error: give up and pass the buck */
394 /* FIXME: getting this for NOTFOUND - prolly a bug in mod_socache */
395 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01686)
396 "Error accessing authentication cache");
397 return AUTH_USER_NOT_FOUND;
400 rv = ap_password_validate(r, user, password, (char*) val);
401 if (rv != APR_SUCCESS) {
408 static authn_status get_realm_hash(request_rec *r, const char *user,
409 const char *realm, char **rethash)
413 authn_cache_dircfg *dcfg;
414 unsigned char val[MAX_VAL_LEN];
415 unsigned int vallen = MAX_VAL_LEN - 1;
416 dcfg = ap_get_module_config(r->per_dir_config, &authn_socache_module);
417 if (!configured || !dcfg->providers) {
418 return AUTH_USER_NOT_FOUND;
420 key = construct_key(r, dcfg->context, user, realm);
421 rv = socache_provider->retrieve(socache_instance, r->server,
422 (unsigned char*)key, strlen(key),
423 val, &vallen, r->pool);
425 if (APR_STATUS_IS_NOTFOUND(rv)) {
426 /* not found - just return */
427 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01687)
428 "Authn cache: no credentials found for %s", user);
429 return AUTH_USER_NOT_FOUND;
431 else if (rv == APR_SUCCESS) {
432 /* OK, we got a value */
433 ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, APLOGNO(01688)
434 "Authn cache: found credentials for %s", user);
437 /* error: give up and pass the buck */
438 /* FIXME: getting this for NOTFOUND - prolly a bug in mod_socache */
439 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r, APLOGNO(01689)
440 "Error accessing authentication cache");
441 return AUTH_USER_NOT_FOUND;
443 *rethash = apr_pstrmemdup(r->pool, (char *)val, vallen);
445 return AUTH_USER_FOUND;
448 static const authn_provider authn_cache_provider =
454 static void register_hooks(apr_pool_t *p)
456 ap_register_auth_provider(p, AUTHN_PROVIDER_GROUP, "socache",
457 AUTHN_PROVIDER_VERSION,
458 &authn_cache_provider, AP_AUTH_INTERNAL_PER_CONF);
459 APR_REGISTER_OPTIONAL_FN(ap_authn_cache_store);
460 ap_hook_pre_config(authn_cache_precfg, NULL, NULL, APR_HOOK_MIDDLE);
461 ap_hook_post_config(authn_cache_post_config, NULL, NULL, APR_HOOK_MIDDLE);
462 ap_hook_child_init(authn_cache_child_init, NULL, NULL, APR_HOOK_MIDDLE);
465 AP_DECLARE_MODULE(authn_socache) =
467 STANDARD20_MODULE_STUFF,
468 authn_cache_dircfg_create,
469 authn_cache_dircfg_merge,