1 /* AFS security handling
3 * Copyright (C) 2007, 2017 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #include <linux/init.h>
13 #include <linux/slab.h>
15 #include <linux/ctype.h>
16 #include <linux/sched.h>
17 #include <linux/hashtable.h>
18 #include <keys/rxrpc-type.h>
21 static DEFINE_HASHTABLE(afs_permits_cache, 10);
22 static DEFINE_SPINLOCK(afs_permits_lock);
27 struct key *afs_request_key(struct afs_cell *cell)
31 _enter("{%x}", key_serial(cell->anonymous_key));
33 _debug("key %s", cell->anonymous_key->description);
34 key = request_key(&key_type_rxrpc, cell->anonymous_key->description,
37 if (PTR_ERR(key) != -ENOKEY) {
38 _leave(" = %ld", PTR_ERR(key));
42 /* act as anonymous user */
43 _leave(" = {%x} [anon]", key_serial(cell->anonymous_key));
44 return key_get(cell->anonymous_key);
46 /* act as authorised user */
47 _leave(" = {%x} [auth]", key_serial(key));
53 * Dispose of a list of permits.
55 static void afs_permits_rcu(struct rcu_head *rcu)
57 struct afs_permits *permits =
58 container_of(rcu, struct afs_permits, rcu);
61 for (i = 0; i < permits->nr_permits; i++)
62 key_put(permits->permits[i].key);
67 * Discard a permission cache.
69 void afs_put_permits(struct afs_permits *permits)
71 if (permits && refcount_dec_and_test(&permits->usage)) {
72 spin_lock(&afs_permits_lock);
73 hash_del_rcu(&permits->hash_node);
74 spin_unlock(&afs_permits_lock);
75 call_rcu(&permits->rcu, afs_permits_rcu);
80 * Clear a permit cache on callback break.
82 void afs_clear_permits(struct afs_vnode *vnode)
84 struct afs_permits *permits;
86 spin_lock(&vnode->lock);
87 permits = rcu_dereference_protected(vnode->permit_cache,
88 lockdep_is_held(&vnode->lock));
89 RCU_INIT_POINTER(vnode->permit_cache, NULL);
90 spin_unlock(&vnode->lock);
92 afs_put_permits(permits);
96 * Hash a list of permits. Use simple addition to make it easy to add an extra
97 * one at an as-yet indeterminate position in the list.
99 static void afs_hash_permits(struct afs_permits *permits)
101 unsigned long h = permits->nr_permits;
104 for (i = 0; i < permits->nr_permits; i++) {
105 h += (unsigned long)permits->permits[i].key / sizeof(void *);
106 h += permits->permits[i].access;
113 * Cache the CallerAccess result obtained from doing a fileserver operation
114 * that returned a vnode status for a particular key. If a callback break
115 * occurs whilst the operation was in progress then we have to ditch the cache
116 * as the ACL *may* have changed.
118 void afs_cache_permit(struct afs_vnode *vnode, struct key *key,
119 unsigned int cb_break)
121 struct afs_permits *permits, *xpermits, *replacement, *zap, *new = NULL;
122 afs_access_t caller_access = READ_ONCE(vnode->status.caller_access);
124 bool changed = false;
127 _enter("{%x:%u},%x,%x",
128 vnode->fid.vid, vnode->fid.vnode, key_serial(key), caller_access);
132 /* Check for the common case first: We got back the same access as last
133 * time we tried and already have it recorded.
135 permits = rcu_dereference(vnode->permit_cache);
137 if (!permits->invalidated) {
138 for (i = 0; i < permits->nr_permits; i++) {
139 if (permits->permits[i].key < key)
141 if (permits->permits[i].key > key)
143 if (permits->permits[i].access != caller_access) {
148 if (cb_break != afs_cb_break_sum(vnode, vnode->cb_interest)) {
153 /* The cache is still good. */
159 changed |= permits->invalidated;
160 size = permits->nr_permits;
162 /* If this set of permits is now wrong, clear the permits
163 * pointer so that no one tries to use the stale information.
166 spin_lock(&vnode->lock);
167 if (permits != rcu_access_pointer(vnode->permit_cache))
168 goto someone_else_changed_it_unlock;
169 RCU_INIT_POINTER(vnode->permit_cache, NULL);
170 spin_unlock(&vnode->lock);
172 afs_put_permits(permits);
178 if (cb_break != afs_cb_break_sum(vnode, vnode->cb_interest))
179 goto someone_else_changed_it;
181 /* We need a ref on any permits list we want to copy as we'll have to
182 * drop the lock to do memory allocation.
184 if (permits && !refcount_inc_not_zero(&permits->usage))
185 goto someone_else_changed_it;
189 /* Speculatively create a new list with the revised permission set. We
190 * discard this if we find an extant match already in the hash, but
191 * it's easier to compare with memcmp this way.
193 * We fill in the key pointers at this time, but we don't get the refs
197 new = kzalloc(sizeof(struct afs_permits) +
198 sizeof(struct afs_permit) * size, GFP_NOFS);
202 refcount_set(&new->usage, 1);
203 new->nr_permits = size;
206 for (i = 0; i < permits->nr_permits; i++) {
207 if (j == i && permits->permits[i].key > key) {
208 new->permits[j].key = key;
209 new->permits[j].access = caller_access;
212 new->permits[j].key = permits->permits[i].key;
213 new->permits[j].access = permits->permits[i].access;
219 new->permits[j].key = key;
220 new->permits[j].access = caller_access;
223 afs_hash_permits(new);
225 /* Now see if the permit list we want is actually already available */
226 spin_lock(&afs_permits_lock);
228 hash_for_each_possible(afs_permits_cache, xpermits, hash_node, new->h) {
229 if (xpermits->h != new->h ||
230 xpermits->invalidated ||
231 xpermits->nr_permits != new->nr_permits ||
232 memcmp(xpermits->permits, new->permits,
233 new->nr_permits * sizeof(struct afs_permit)) != 0)
236 if (refcount_inc_not_zero(&xpermits->usage)) {
237 replacement = xpermits;
244 for (i = 0; i < new->nr_permits; i++)
245 key_get(new->permits[i].key);
246 hash_add_rcu(afs_permits_cache, &new->hash_node, new->h);
251 spin_unlock(&afs_permits_lock);
255 spin_lock(&vnode->lock);
256 zap = rcu_access_pointer(vnode->permit_cache);
257 if (cb_break == afs_cb_break_sum(vnode, vnode->cb_interest) &&
259 rcu_assign_pointer(vnode->permit_cache, replacement);
262 spin_unlock(&vnode->lock);
263 afs_put_permits(zap);
265 afs_put_permits(permits);
268 someone_else_changed_it_unlock:
269 spin_unlock(&vnode->lock);
270 someone_else_changed_it:
271 /* Someone else changed the cache under us - don't recheck at this
279 * check with the fileserver to see if the directory or parent directory is
280 * permitted to be accessed with this authorisation, and if so, what access it
283 int afs_check_permit(struct afs_vnode *vnode, struct key *key,
284 afs_access_t *_access)
286 struct afs_permits *permits;
291 vnode->fid.vid, vnode->fid.vnode, key_serial(key));
293 /* check the permits to see if we've got one yet */
294 if (key == vnode->volume->cell->anonymous_key) {
296 *_access = vnode->status.anon_access;
300 permits = rcu_dereference(vnode->permit_cache);
302 for (i = 0; i < permits->nr_permits; i++) {
303 if (permits->permits[i].key < key)
305 if (permits->permits[i].key > key)
308 *_access = permits->permits[i].access;
309 valid = !permits->invalidated;
317 /* Check the status on the file we're actually interested in
318 * (the post-processing will cache the result).
320 _debug("no valid permit");
322 ret = afs_fetch_status(vnode, key, false);
325 _leave(" = %d", ret);
328 *_access = vnode->status.caller_access;
331 _leave(" = 0 [access %x]", *_access);
336 * check the permissions on an AFS file
337 * - AFS ACLs are attached to directories only, and a file is controlled by its
338 * parent directory's ACL
340 int afs_permission(struct inode *inode, int mask)
342 struct afs_vnode *vnode = AFS_FS_I(inode);
343 afs_access_t uninitialized_var(access);
347 if (mask & MAY_NOT_BLOCK)
350 _enter("{{%x:%u},%lx},%x,",
351 vnode->fid.vid, vnode->fid.vnode, vnode->flags, mask);
353 key = afs_request_key(vnode->volume->cell);
355 _leave(" = %ld [key]", PTR_ERR(key));
359 ret = afs_validate(vnode, key);
363 /* check the permits to see if we've got one yet */
364 ret = afs_check_permit(vnode, key, &access);
368 /* interpret the access mask */
369 _debug("REQ %x ACC %x on %s",
370 mask, access, S_ISDIR(inode->i_mode) ? "dir" : "file");
372 if (S_ISDIR(inode->i_mode)) {
373 if (mask & (MAY_EXEC | MAY_READ | MAY_CHDIR)) {
374 if (!(access & AFS_ACE_LOOKUP))
375 goto permission_denied;
377 if (mask & MAY_WRITE) {
378 if (!(access & (AFS_ACE_DELETE | /* rmdir, unlink, rename from */
379 AFS_ACE_INSERT))) /* create, mkdir, symlink, rename to */
380 goto permission_denied;
383 if (!(access & AFS_ACE_LOOKUP))
384 goto permission_denied;
385 if ((mask & MAY_EXEC) && !(inode->i_mode & S_IXUSR))
386 goto permission_denied;
387 if (mask & (MAY_EXEC | MAY_READ)) {
388 if (!(access & AFS_ACE_READ))
389 goto permission_denied;
390 if (!(inode->i_mode & S_IRUSR))
391 goto permission_denied;
392 } else if (mask & MAY_WRITE) {
393 if (!(access & AFS_ACE_WRITE))
394 goto permission_denied;
395 if (!(inode->i_mode & S_IWUSR))
396 goto permission_denied;
401 _leave(" = %d", ret);
408 _leave(" = %d", ret);
412 void __exit afs_clean_up_permit_cache(void)
416 for (i = 0; i < HASH_SIZE(afs_permits_cache); i++)
417 WARN_ON_ONCE(!hlist_empty(&afs_permits_cache[i]));