Skip to content

Commit

Permalink
security, keys: convert key.usage from atomic_t to refcount_t
Browse files Browse the repository at this point in the history
refcount_t type and corresponding API should be
used instead of atomic_t when the variable is used as
a reference counter. This allows to avoid accidental
refcounter overflows that might lead to use-after-free
situations.

Signed-off-by: Elena Reshetova <[email protected]>
Signed-off-by: Hans Liljestrand <[email protected]>
Signed-off-by: Kees Cook <[email protected]>
Signed-off-by: David Windsor <[email protected]>
Acked-by: David Howells <[email protected]>
Signed-off-by: James Morris <[email protected]>
  • Loading branch information
ereshetova authored and James Morris committed Apr 3, 2017
1 parent 8291798 commit fff2929
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 12 deletions.
5 changes: 3 additions & 2 deletions include/linux/key.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
#include <linux/rwsem.h>
#include <linux/atomic.h>
#include <linux/assoc_array.h>
#include <linux/refcount.h>

#ifdef __KERNEL__
#include <linux/uidgid.h>
Expand Down Expand Up @@ -135,7 +136,7 @@ static inline bool is_key_possessed(const key_ref_t key_ref)
* - Kerberos TGTs and tickets
*/
struct key {
atomic_t usage; /* number of references */
refcount_t usage; /* number of references */
key_serial_t serial; /* key serial number */
union {
struct list_head graveyard_link;
Expand Down Expand Up @@ -242,7 +243,7 @@ extern void key_put(struct key *key);

static inline struct key *__key_get(struct key *key)
{
atomic_inc(&key->usage);
refcount_inc(&key->usage);
return key;
}

Expand Down
2 changes: 1 addition & 1 deletion security/keys/gc.c
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ static void key_garbage_collector(struct work_struct *work)
key = rb_entry(cursor, struct key, serial_node);
cursor = rb_next(cursor);

if (atomic_read(&key->usage) == 0)
if (refcount_read(&key->usage) == 0)
goto found_unreferenced_key;

if (unlikely(gc_state & KEY_GC_REAPING_DEAD_1)) {
Expand Down
6 changes: 3 additions & 3 deletions security/keys/key.c
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ struct key *key_alloc(struct key_type *type, const char *desc,
if (!key->index_key.description)
goto no_memory_3;

atomic_set(&key->usage, 1);
refcount_set(&key->usage, 1);
init_rwsem(&key->sem);
lockdep_set_class(&key->sem, &type->lock_class);
key->index_key.type = type;
Expand Down Expand Up @@ -621,7 +621,7 @@ void key_put(struct key *key)
if (key) {
key_check(key);

if (atomic_dec_and_test(&key->usage))
if (refcount_dec_and_test(&key->usage))
schedule_work(&key_gc_work);
}
}
Expand Down Expand Up @@ -656,7 +656,7 @@ struct key *key_lookup(key_serial_t id)

found:
/* pretend it doesn't exist if it is awaiting deletion */
if (atomic_read(&key->usage) == 0)
if (refcount_read(&key->usage) == 0)
goto not_found;

/* this races with key_put(), but that doesn't matter since key_put()
Expand Down
8 changes: 4 additions & 4 deletions security/keys/keyring.c
Original file line number Diff line number Diff line change
Expand Up @@ -1033,7 +1033,7 @@ struct key *find_keyring_by_name(const char *name, bool skip_perm_check)
/* we've got a match but we might end up racing with
* key_cleanup() if the keyring is currently 'dead'
* (ie. it has a zero usage count) */
if (!atomic_inc_not_zero(&keyring->usage))
if (!refcount_inc_not_zero(&keyring->usage))
continue;
keyring->last_used_at = current_kernel_time().tv_sec;
goto out;
Expand Down Expand Up @@ -1250,14 +1250,14 @@ int key_link(struct key *keyring, struct key *key)
struct assoc_array_edit *edit;
int ret;

kenter("{%d,%d}", keyring->serial, atomic_read(&keyring->usage));
kenter("{%d,%d}", keyring->serial, refcount_read(&keyring->usage));

key_check(keyring);
key_check(key);

ret = __key_link_begin(keyring, &key->index_key, &edit);
if (ret == 0) {
kdebug("begun {%d,%d}", keyring->serial, atomic_read(&keyring->usage));
kdebug("begun {%d,%d}", keyring->serial, refcount_read(&keyring->usage));
ret = __key_link_check_restriction(keyring, key);
if (ret == 0)
ret = __key_link_check_live_key(keyring, key);
Expand All @@ -1266,7 +1266,7 @@ int key_link(struct key *keyring, struct key *key)
__key_link_end(keyring, &key->index_key, edit);
}

kleave(" = %d {%d,%d}", ret, keyring->serial, atomic_read(&keyring->usage));
kleave(" = %d {%d,%d}", ret, keyring->serial, refcount_read(&keyring->usage));
return ret;
}
EXPORT_SYMBOL(key_link);
Expand Down
2 changes: 1 addition & 1 deletion security/keys/proc.c
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ static int proc_keys_show(struct seq_file *m, void *v)
showflag(key, 'U', KEY_FLAG_USER_CONSTRUCT),
showflag(key, 'N', KEY_FLAG_NEGATIVE),
showflag(key, 'i', KEY_FLAG_INVALIDATED),
atomic_read(&key->usage),
refcount_read(&key->usage),
xbuf,
key->perm,
from_kuid_munged(seq_user_ns(m), key->uid),
Expand Down
2 changes: 1 addition & 1 deletion security/keys/request_key_auth.c
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ struct key *request_key_auth_new(struct key *target, const void *callout_info,
if (ret < 0)
goto error_inst;

kleave(" = {%d,%d}", authkey->serial, atomic_read(&authkey->usage));
kleave(" = {%d,%d}", authkey->serial, refcount_read(&authkey->usage));
return authkey;

auth_key_revoked:
Expand Down

0 comments on commit fff2929

Please sign in to comment.