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 /* This module is triggered by an
19 * AuthGroupFile standard /path/to/file
21 * and the presense of a
23 * require group <list-of-groups>
25 * In an applicable limit/directory block for that method.
27 * If there are no AuthGroupFile directives valid for
28 * the request; we DECLINED.
30 * If the AuthGroupFile is defined; but somehow not
31 * accessible: we SERVER_ERROR (was DECLINED).
33 * If there are no 'require ' directives defined for
34 * this request then we DECLINED (was OK).
36 * If there are no 'require ' directives valid for
37 * this request method then we DECLINED. (was OK)
39 * If there are any 'require group' blocks and we
40 * are not in any group - we HTTP_UNAUTHORIZE
44 #include "apr_strings.h"
45 #include "apr_lib.h" /* apr_isspace */
47 #include "ap_config.h"
48 #include "ap_provider.h"
50 #include "http_config.h"
51 #include "http_core.h"
53 #include "http_protocol.h"
54 #include "http_request.h"
60 } authz_groupfile_config_rec;
62 APR_DECLARE_OPTIONAL_FN(char*, authz_owner_get_file_group, (request_rec *r));
64 static void *create_authz_groupfile_dir_config(apr_pool_t *p, char *d)
66 authz_groupfile_config_rec *conf = apr_palloc(p, sizeof(*conf));
68 conf->groupfile = NULL;
72 static const char *set_authz_groupfile_slot(cmd_parms *cmd, void *offset, const char *f,
75 if (t && strcmp(t, "standard")) {
76 return apr_pstrcat(cmd->pool, "Invalid auth file type: ", t, NULL);
79 return ap_set_file_slot(cmd, offset, f);
82 static const command_rec authz_groupfile_cmds[] =
84 AP_INIT_TAKE12("AuthGroupFile", set_authz_groupfile_slot,
85 (void *)APR_OFFSETOF(authz_groupfile_config_rec, groupfile),
87 "text file containing group names and member user IDs"),
91 module AP_MODULE_DECLARE_DATA authz_groupfile_module;
93 static apr_status_t groups_for_user(apr_pool_t *p, char *user, char *grpfile,
97 apr_table_t *grps = apr_table_make(p, 15);
99 char l[MAX_STRING_LEN];
100 const char *group_name, *ll, *w;
102 apr_size_t group_len;
104 if ((status = ap_pcfg_openfile(&f, p, grpfile)) != APR_SUCCESS) {
108 apr_pool_create(&sp, p);
110 while (!(ap_cfg_getline(l, MAX_STRING_LEN, f))) {
111 if ((l[0] == '#') || (!l[0])) {
117 group_name = ap_getword(sp, &ll, ':');
118 group_len = strlen(group_name);
120 while (group_len && apr_isspace(*(group_name + group_len - 1))) {
125 w = ap_getword_conf(sp, &ll);
126 if (!strcmp(w, user)) {
127 apr_table_setn(grps, apr_pstrmemdup(p, group_name, group_len),
134 apr_pool_destroy(sp);
140 static authz_status group_check_authorization(request_rec *r,
141 const char *require_args)
143 authz_groupfile_config_rec *conf = ap_get_module_config(r->per_dir_config,
144 &authz_groupfile_module);
145 char *user = r->user;
147 apr_table_t *grpstatus = NULL;
150 /* If there is no group file - then we are not
151 * configured. So decline.
153 if (!(conf->groupfile)) {
154 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
155 "No group file was specified in the configuration");
159 status = groups_for_user(r->pool, user, conf->groupfile,
162 if (status != APR_SUCCESS) {
163 ap_log_rerror(APLOG_MARK, APLOG_ERR, status, r,
164 "Could not open group file: %s",
169 if (apr_table_elts(grpstatus)->nelts == 0) {
170 /* no groups available, so exit immediately */
171 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
172 "Authorization of user %s to access %s failed, reason: "
173 "user doesn't appear in group file (%s).",
174 r->user, r->uri, conf->groupfile);
179 while ((w = ap_getword_conf(r->pool, &t)) && w[0]) {
180 if (apr_table_get(grpstatus, w)) {
181 return AUTHZ_GRANTED;
185 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
186 "Authorization of user %s to access %s failed, reason: "
187 "user is not part of the 'require'ed group(s).",
193 APR_OPTIONAL_FN_TYPE(authz_owner_get_file_group) *authz_owner_get_file_group;
195 static authz_status filegroup_check_authorization(request_rec *r,
196 const char *require_args)
198 authz_groupfile_config_rec *conf = ap_get_module_config(r->per_dir_config,
199 &authz_groupfile_module);
200 char *user = r->user;
201 apr_table_t *grpstatus = NULL;
203 const char *filegroup = NULL;
205 /* If there is no group file - then we are not
206 * configured. So decline.
208 if (!(conf->groupfile)) {
209 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
210 "No group file was specified in the configuration");
214 status = groups_for_user(r->pool, user, conf->groupfile,
216 if (status != APR_SUCCESS) {
217 ap_log_rerror(APLOG_MARK, APLOG_ERR, status, r,
218 "Could not open group file: %s",
223 if (apr_table_elts(grpstatus)->nelts == 0) {
224 /* no groups available, so exit immediately */
225 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
226 "Authorization of user %s to access %s failed, reason: "
227 "user doesn't appear in group file (%s).",
228 r->user, r->uri, conf->groupfile);
232 filegroup = authz_owner_get_file_group(r);
235 if (apr_table_get(grpstatus, filegroup)) {
236 return AUTHZ_GRANTED;
240 /* No need to emit a error log entry because the call
241 to authz_owner_get_file_group already did it
247 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
248 "Authorization of user %s to access %s failed, reason: "
249 "user is not part of the 'require'ed file group.",
255 static const authz_provider authz_group_provider =
257 &group_check_authorization,
260 static const authz_provider authz_filegroup_provider =
262 &filegroup_check_authorization,
265 static void register_hooks(apr_pool_t *p)
267 authz_owner_get_file_group = APR_RETRIEVE_OPTIONAL_FN(authz_owner_get_file_group);
269 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "group", "0",
270 &authz_group_provider,
271 AP_AUTH_INTERNAL_PER_CONF);
272 ap_register_auth_provider(p, AUTHZ_PROVIDER_GROUP, "file-group", "0",
273 &authz_filegroup_provider,
274 AP_AUTH_INTERNAL_PER_CONF);
277 module AP_MODULE_DECLARE_DATA authz_groupfile_module =
279 STANDARD20_MODULE_STUFF,
280 create_authz_groupfile_dir_config,/* dir config creater */
281 NULL, /* dir merger -- default is to override */
282 NULL, /* server config */
283 NULL, /* merge server config */
284 authz_groupfile_cmds, /* command apr_table_t */
285 register_hooks /* register hooks */