1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* AFS security handling
4 * Copyright (C) 2007, 2017 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #include <linux/init.h>
9 #include <linux/slab.h>
11 #include <linux/ctype.h>
12 #include <linux/sched.h>
13 #include <linux/hashtable.h>
14 #include <keys/rxrpc-type.h>
17 static DEFINE_HASHTABLE(afs_permits_cache
, 10);
18 static DEFINE_SPINLOCK(afs_permits_lock
);
23 struct key
*afs_request_key(struct afs_cell
*cell
)
27 _enter("{%x}", key_serial(cell
->anonymous_key
));
29 _debug("key %s", cell
->anonymous_key
->description
);
30 key
= request_key_net(&key_type_rxrpc
, cell
->anonymous_key
->description
,
31 cell
->net
->net
, NULL
);
33 if (PTR_ERR(key
) != -ENOKEY
) {
34 _leave(" = %ld", PTR_ERR(key
));
38 /* act as anonymous user */
39 _leave(" = {%x} [anon]", key_serial(cell
->anonymous_key
));
40 return key_get(cell
->anonymous_key
);
42 /* act as authorised user */
43 _leave(" = {%x} [auth]", key_serial(key
));
49 * Get a key when pathwalk is in rcuwalk mode.
51 struct key
*afs_request_key_rcu(struct afs_cell
*cell
)
55 _enter("{%x}", key_serial(cell
->anonymous_key
));
57 _debug("key %s", cell
->anonymous_key
->description
);
58 key
= request_key_net_rcu(&key_type_rxrpc
,
59 cell
->anonymous_key
->description
,
62 if (PTR_ERR(key
) != -ENOKEY
) {
63 _leave(" = %ld", PTR_ERR(key
));
67 /* act as anonymous user */
68 _leave(" = {%x} [anon]", key_serial(cell
->anonymous_key
));
69 return key_get(cell
->anonymous_key
);
71 /* act as authorised user */
72 _leave(" = {%x} [auth]", key_serial(key
));
78 * Dispose of a list of permits.
80 static void afs_permits_rcu(struct rcu_head
*rcu
)
82 struct afs_permits
*permits
=
83 container_of(rcu
, struct afs_permits
, rcu
);
86 for (i
= 0; i
< permits
->nr_permits
; i
++)
87 key_put(permits
->permits
[i
].key
);
92 * Discard a permission cache.
94 void afs_put_permits(struct afs_permits
*permits
)
96 if (permits
&& refcount_dec_and_test(&permits
->usage
)) {
97 spin_lock(&afs_permits_lock
);
98 hash_del_rcu(&permits
->hash_node
);
99 spin_unlock(&afs_permits_lock
);
100 call_rcu(&permits
->rcu
, afs_permits_rcu
);
105 * Clear a permit cache on callback break.
107 void afs_clear_permits(struct afs_vnode
*vnode
)
109 struct afs_permits
*permits
;
111 spin_lock(&vnode
->lock
);
112 permits
= rcu_dereference_protected(vnode
->permit_cache
,
113 lockdep_is_held(&vnode
->lock
));
114 RCU_INIT_POINTER(vnode
->permit_cache
, NULL
);
115 spin_unlock(&vnode
->lock
);
117 afs_put_permits(permits
);
121 * Hash a list of permits. Use simple addition to make it easy to add an extra
122 * one at an as-yet indeterminate position in the list.
124 static void afs_hash_permits(struct afs_permits
*permits
)
126 unsigned long h
= permits
->nr_permits
;
129 for (i
= 0; i
< permits
->nr_permits
; i
++) {
130 h
+= (unsigned long)permits
->permits
[i
].key
/ sizeof(void *);
131 h
+= permits
->permits
[i
].access
;
138 * Cache the CallerAccess result obtained from doing a fileserver operation
139 * that returned a vnode status for a particular key. If a callback break
140 * occurs whilst the operation was in progress then we have to ditch the cache
141 * as the ACL *may* have changed.
143 void afs_cache_permit(struct afs_vnode
*vnode
, struct key
*key
,
144 unsigned int cb_break
, struct afs_status_cb
*scb
)
146 struct afs_permits
*permits
, *xpermits
, *replacement
, *zap
, *new = NULL
;
147 afs_access_t caller_access
= scb
->status
.caller_access
;
149 bool changed
= false;
152 _enter("{%llx:%llu},%x,%x",
153 vnode
->fid
.vid
, vnode
->fid
.vnode
, key_serial(key
), caller_access
);
157 /* Check for the common case first: We got back the same access as last
158 * time we tried and already have it recorded.
160 permits
= rcu_dereference(vnode
->permit_cache
);
162 if (!permits
->invalidated
) {
163 for (i
= 0; i
< permits
->nr_permits
; i
++) {
164 if (permits
->permits
[i
].key
< key
)
166 if (permits
->permits
[i
].key
> key
)
168 if (permits
->permits
[i
].access
!= caller_access
) {
173 if (afs_cb_is_broken(cb_break
, vnode
)) {
178 /* The cache is still good. */
184 changed
|= permits
->invalidated
;
185 size
= permits
->nr_permits
;
187 /* If this set of permits is now wrong, clear the permits
188 * pointer so that no one tries to use the stale information.
191 spin_lock(&vnode
->lock
);
192 if (permits
!= rcu_access_pointer(vnode
->permit_cache
))
193 goto someone_else_changed_it_unlock
;
194 RCU_INIT_POINTER(vnode
->permit_cache
, NULL
);
195 spin_unlock(&vnode
->lock
);
197 afs_put_permits(permits
);
203 if (afs_cb_is_broken(cb_break
, vnode
))
204 goto someone_else_changed_it
;
206 /* We need a ref on any permits list we want to copy as we'll have to
207 * drop the lock to do memory allocation.
209 if (permits
&& !refcount_inc_not_zero(&permits
->usage
))
210 goto someone_else_changed_it
;
214 /* Speculatively create a new list with the revised permission set. We
215 * discard this if we find an extant match already in the hash, but
216 * it's easier to compare with memcmp this way.
218 * We fill in the key pointers at this time, but we don't get the refs
222 new = kzalloc(struct_size(new, permits
, size
), GFP_NOFS
);
226 refcount_set(&new->usage
, 1);
227 new->nr_permits
= size
;
230 for (i
= 0; i
< permits
->nr_permits
; i
++) {
231 if (j
== i
&& permits
->permits
[i
].key
> key
) {
232 new->permits
[j
].key
= key
;
233 new->permits
[j
].access
= caller_access
;
236 new->permits
[j
].key
= permits
->permits
[i
].key
;
237 new->permits
[j
].access
= permits
->permits
[i
].access
;
243 new->permits
[j
].key
= key
;
244 new->permits
[j
].access
= caller_access
;
247 afs_hash_permits(new);
249 /* Now see if the permit list we want is actually already available */
250 spin_lock(&afs_permits_lock
);
252 hash_for_each_possible(afs_permits_cache
, xpermits
, hash_node
, new->h
) {
253 if (xpermits
->h
!= new->h
||
254 xpermits
->invalidated
||
255 xpermits
->nr_permits
!= new->nr_permits
||
256 memcmp(xpermits
->permits
, new->permits
,
257 new->nr_permits
* sizeof(struct afs_permit
)) != 0)
260 if (refcount_inc_not_zero(&xpermits
->usage
)) {
261 replacement
= xpermits
;
268 for (i
= 0; i
< new->nr_permits
; i
++)
269 key_get(new->permits
[i
].key
);
270 hash_add_rcu(afs_permits_cache
, &new->hash_node
, new->h
);
275 spin_unlock(&afs_permits_lock
);
280 spin_lock(&vnode
->lock
);
281 zap
= rcu_access_pointer(vnode
->permit_cache
);
282 if (!afs_cb_is_broken(cb_break
, vnode
) && zap
== permits
)
283 rcu_assign_pointer(vnode
->permit_cache
, replacement
);
286 spin_unlock(&vnode
->lock
);
288 afs_put_permits(zap
);
290 afs_put_permits(permits
);
293 someone_else_changed_it_unlock
:
294 spin_unlock(&vnode
->lock
);
295 someone_else_changed_it
:
296 /* Someone else changed the cache under us - don't recheck at this
303 static bool afs_check_permit_rcu(struct afs_vnode
*vnode
, struct key
*key
,
304 afs_access_t
*_access
)
306 const struct afs_permits
*permits
;
309 _enter("{%llx:%llu},%x",
310 vnode
->fid
.vid
, vnode
->fid
.vnode
, key_serial(key
));
312 /* check the permits to see if we've got one yet */
313 if (key
== vnode
->volume
->cell
->anonymous_key
) {
314 *_access
= vnode
->status
.anon_access
;
315 _leave(" = t [anon %x]", *_access
);
319 permits
= rcu_dereference(vnode
->permit_cache
);
321 for (i
= 0; i
< permits
->nr_permits
; i
++) {
322 if (permits
->permits
[i
].key
< key
)
324 if (permits
->permits
[i
].key
> key
)
327 *_access
= permits
->permits
[i
].access
;
328 _leave(" = %u [perm %x]", !permits
->invalidated
, *_access
);
329 return !permits
->invalidated
;
338 * check with the fileserver to see if the directory or parent directory is
339 * permitted to be accessed with this authorisation, and if so, what access it
342 int afs_check_permit(struct afs_vnode
*vnode
, struct key
*key
,
343 afs_access_t
*_access
)
345 struct afs_permits
*permits
;
349 _enter("{%llx:%llu},%x",
350 vnode
->fid
.vid
, vnode
->fid
.vnode
, key_serial(key
));
352 /* check the permits to see if we've got one yet */
353 if (key
== vnode
->volume
->cell
->anonymous_key
) {
355 *_access
= vnode
->status
.anon_access
;
359 permits
= rcu_dereference(vnode
->permit_cache
);
361 for (i
= 0; i
< permits
->nr_permits
; i
++) {
362 if (permits
->permits
[i
].key
< key
)
364 if (permits
->permits
[i
].key
> key
)
367 *_access
= permits
->permits
[i
].access
;
368 valid
= !permits
->invalidated
;
376 /* Check the status on the file we're actually interested in
377 * (the post-processing will cache the result).
379 _debug("no valid permit");
381 ret
= afs_fetch_status(vnode
, key
, false, _access
);
384 _leave(" = %d", ret
);
389 _leave(" = 0 [access %x]", *_access
);
394 * check the permissions on an AFS file
395 * - AFS ACLs are attached to directories only, and a file is controlled by its
396 * parent directory's ACL
398 int afs_permission(struct mnt_idmap
*idmap
, struct inode
*inode
,
401 struct afs_vnode
*vnode
= AFS_FS_I(inode
);
406 _enter("{{%llx:%llu},%lx},%x,",
407 vnode
->fid
.vid
, vnode
->fid
.vnode
, vnode
->flags
, mask
);
409 if (mask
& MAY_NOT_BLOCK
) {
410 key
= afs_request_key_rcu(vnode
->volume
->cell
);
415 if (!afs_check_validity(vnode
) ||
416 !afs_check_permit_rcu(vnode
, key
, &access
))
419 key
= afs_request_key(vnode
->volume
->cell
);
421 _leave(" = %ld [key]", PTR_ERR(key
));
425 ret
= afs_validate(vnode
, key
);
429 /* check the permits to see if we've got one yet */
430 ret
= afs_check_permit(vnode
, key
, &access
);
435 /* interpret the access mask */
436 _debug("REQ %x ACC %x on %s",
437 mask
, access
, S_ISDIR(inode
->i_mode
) ? "dir" : "file");
440 if (S_ISDIR(inode
->i_mode
)) {
441 if (mask
& (MAY_EXEC
| MAY_READ
| MAY_CHDIR
)) {
442 if (!(access
& AFS_ACE_LOOKUP
))
443 goto permission_denied
;
445 if (mask
& MAY_WRITE
) {
446 if (!(access
& (AFS_ACE_DELETE
| /* rmdir, unlink, rename from */
447 AFS_ACE_INSERT
))) /* create, mkdir, symlink, rename to */
448 goto permission_denied
;
451 if (!(access
& AFS_ACE_LOOKUP
))
452 goto permission_denied
;
453 if ((mask
& MAY_EXEC
) && !(inode
->i_mode
& S_IXUSR
))
454 goto permission_denied
;
455 if (mask
& (MAY_EXEC
| MAY_READ
)) {
456 if (!(access
& AFS_ACE_READ
))
457 goto permission_denied
;
458 if (!(inode
->i_mode
& S_IRUSR
))
459 goto permission_denied
;
460 } else if (mask
& MAY_WRITE
) {
461 if (!(access
& AFS_ACE_WRITE
))
462 goto permission_denied
;
463 if (!(inode
->i_mode
& S_IWUSR
))
464 goto permission_denied
;
469 _leave(" = %d", ret
);
476 _leave(" = %d", ret
);
480 void __exit
afs_clean_up_permit_cache(void)
484 for (i
= 0; i
< HASH_SIZE(afs_permits_cache
); i
++)
485 WARN_ON_ONCE(!hlist_empty(&afs_permits_cache
[i
]));