12874c5fdSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */ 2973c9f4fSDavid Howells /* Authentication token and access key management internal defs 31da177e4SLinus Torvalds * 476181c13SDavid Howells * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved. 51da177e4SLinus Torvalds * Written by David Howells (dhowells@redhat.com) 61da177e4SLinus Torvalds */ 71da177e4SLinus Torvalds 81da177e4SLinus Torvalds #ifndef _INTERNAL_H 91da177e4SLinus Torvalds #define _INTERNAL_H 101da177e4SLinus Torvalds 11d84f4f99SDavid Howells #include <linux/sched.h> 125dd43ce2SIngo Molnar #include <linux/wait_bit.h> 135b825c3aSIngo Molnar #include <linux/cred.h> 1476181c13SDavid Howells #include <linux/key-type.h> 15413cd3d9SOleg Nesterov #include <linux/task_work.h> 16ddbb4114SMat Martineau #include <linux/keyctl.h> 17ddb99e11SElena Reshetova #include <linux/refcount.h> 18f1c316a3SStephan Mueller #include <linux/compat.h> 191da177e4SLinus Torvalds 20a27bb332SKent Overstreet struct iovec; 21a27bb332SKent Overstreet 2276181c13SDavid Howells #ifdef __KDEBUG 2376181c13SDavid Howells #define kenter(FMT, ...) \ 24dd6f953aSHarvey Harrison printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) 2576181c13SDavid Howells #define kleave(FMT, ...) \ 26dd6f953aSHarvey Harrison printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) 2776181c13SDavid Howells #define kdebug(FMT, ...) \ 28d84f4f99SDavid Howells printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__) 293e30148cSDavid Howells #else 3076181c13SDavid Howells #define kenter(FMT, ...) \ 31dd6f953aSHarvey Harrison no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) 3276181c13SDavid Howells #define kleave(FMT, ...) \ 33dd6f953aSHarvey Harrison no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) 3476181c13SDavid Howells #define kdebug(FMT, ...) \ 3576181c13SDavid Howells no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__) 363e30148cSDavid Howells #endif 373e30148cSDavid Howells 380c061b57SDavid Howells extern struct key_type key_type_dead; 391da177e4SLinus Torvalds extern struct key_type key_type_user; 409f6ed2caSJeff Layton extern struct key_type key_type_logon; 411da177e4SLinus Torvalds 421da177e4SLinus Torvalds /*****************************************************************************/ 431da177e4SLinus Torvalds /* 44973c9f4fSDavid Howells * Keep track of keys for a user. 45973c9f4fSDavid Howells * 46973c9f4fSDavid Howells * This needs to be separate to user_struct to avoid a refcount-loop 47973c9f4fSDavid Howells * (user_struct pins some keyrings which pin this struct). 48973c9f4fSDavid Howells * 49973c9f4fSDavid Howells * We also keep track of keys under request from userspace for this UID here. 501da177e4SLinus Torvalds */ 511da177e4SLinus Torvalds struct key_user { 521da177e4SLinus Torvalds struct rb_node node; 5376181c13SDavid Howells struct mutex cons_lock; /* construction initiation lock */ 541da177e4SLinus Torvalds spinlock_t lock; 55ddb99e11SElena Reshetova refcount_t usage; /* for accessing qnkeys & qnbytes */ 561da177e4SLinus Torvalds atomic_t nkeys; /* number of keys */ 571da177e4SLinus Torvalds atomic_t nikeys; /* number of instantiated keys */ 589a56c2dbSEric W. Biederman kuid_t uid; 591da177e4SLinus Torvalds int qnkeys; /* number of keys allocated to this user */ 601da177e4SLinus Torvalds int qnbytes; /* number of bytes allocated to this user */ 611da177e4SLinus Torvalds }; 621da177e4SLinus Torvalds 631da177e4SLinus Torvalds extern struct rb_root key_user_tree; 641da177e4SLinus Torvalds extern spinlock_t key_user_lock; 651da177e4SLinus Torvalds extern struct key_user root_key_user; 661da177e4SLinus Torvalds 679a56c2dbSEric W. Biederman extern struct key_user *key_user_lookup(kuid_t uid); 681da177e4SLinus Torvalds extern void key_user_put(struct key_user *user); 691da177e4SLinus Torvalds 700b77f5bfSDavid Howells /* 71973c9f4fSDavid Howells * Key quota limits. 720b77f5bfSDavid Howells * - root has its own separate limits to everyone else 730b77f5bfSDavid Howells */ 740b77f5bfSDavid Howells extern unsigned key_quota_root_maxkeys; 750b77f5bfSDavid Howells extern unsigned key_quota_root_maxbytes; 760b77f5bfSDavid Howells extern unsigned key_quota_maxkeys; 770b77f5bfSDavid Howells extern unsigned key_quota_maxbytes; 780b77f5bfSDavid Howells 790b77f5bfSDavid Howells #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */ 801da177e4SLinus Torvalds 811da177e4SLinus Torvalds 828bc16deaSDavid Howells extern struct kmem_cache *key_jar; 831da177e4SLinus Torvalds extern struct rb_root key_serial_tree; 841da177e4SLinus Torvalds extern spinlock_t key_serial_lock; 8576181c13SDavid Howells extern struct mutex key_construction_mutex; 861da177e4SLinus Torvalds extern wait_queue_head_t request_key_conswq; 871da177e4SLinus Torvalds 881da177e4SLinus Torvalds 89e9e349b0SDavid Howells extern struct key_type *key_type_lookup(const char *type); 90e9e349b0SDavid Howells extern void key_type_put(struct key_type *ktype); 91e9e349b0SDavid Howells 92f70e2e06SDavid Howells extern int __key_link_begin(struct key *keyring, 9316feef43SDavid Howells const struct keyring_index_key *index_key, 94b2a4df20SDavid Howells struct assoc_array_edit **_edit); 95f70e2e06SDavid Howells extern int __key_link_check_live_key(struct key *keyring, struct key *key); 96b2a4df20SDavid Howells extern void __key_link(struct key *key, struct assoc_array_edit **_edit); 97f70e2e06SDavid Howells extern void __key_link_end(struct key *keyring, 9816feef43SDavid Howells const struct keyring_index_key *index_key, 99b2a4df20SDavid Howells struct assoc_array_edit *edit); 1001da177e4SLinus Torvalds 101b2a4df20SDavid Howells extern key_ref_t find_key_to_update(key_ref_t keyring_ref, 102e57e8669SDavid Howells const struct keyring_index_key *index_key); 1031da177e4SLinus Torvalds 1043e30148cSDavid Howells extern struct key *keyring_search_instkey(struct key *keyring, 1053e30148cSDavid Howells key_serial_t target_id); 1063e30148cSDavid Howells 107b2a4df20SDavid Howells extern int iterate_over_keyring(const struct key *keyring, 108b2a4df20SDavid Howells int (*func)(const struct key *key, void *data), 109b2a4df20SDavid Howells void *data); 110b2a4df20SDavid Howells 1114bdf0bc3SDavid Howells struct keyring_search_context { 1124bdf0bc3SDavid Howells struct keyring_index_key index_key; 1134bdf0bc3SDavid Howells const struct cred *cred; 11446291959SDavid Howells struct key_match_data match_data; 1154bdf0bc3SDavid Howells unsigned flags; 116614d8c39SDavid Howells #define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */ 117614d8c39SDavid Howells #define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */ 118614d8c39SDavid Howells #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */ 119614d8c39SDavid Howells #define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */ 120614d8c39SDavid Howells #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */ 1210b0a8415SDavid Howells #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */ 1221da177e4SLinus Torvalds 123b2a4df20SDavid Howells int (*iterator)(const void *object, void *iterator_data); 124b2a4df20SDavid Howells 1254bdf0bc3SDavid Howells /* Internal stuff */ 1264bdf0bc3SDavid Howells int skipped_ret; 1274bdf0bc3SDavid Howells bool possessed; 1284bdf0bc3SDavid Howells key_ref_t result; 129074d5898SBaolin Wang time64_t now; 1304bdf0bc3SDavid Howells }; 1314bdf0bc3SDavid Howells 1320c903ab6SDavid Howells extern bool key_default_cmp(const struct key *key, 133c06cfb08SDavid Howells const struct key_match_data *match_data); 1344bdf0bc3SDavid Howells extern key_ref_t keyring_search_aux(key_ref_t keyring_ref, 1354bdf0bc3SDavid Howells struct keyring_search_context *ctx); 1364bdf0bc3SDavid Howells 1374bdf0bc3SDavid Howells extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx); 1384bdf0bc3SDavid Howells extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx); 1391da177e4SLinus Torvalds 140237bbd29SEric Biggers extern struct key *find_keyring_by_name(const char *name, bool uid_keyring); 1411da177e4SLinus Torvalds 1428bbf4976SDavid Howells extern int install_user_keyrings(void); 143d84f4f99SDavid Howells extern int install_thread_keyring_to_cred(struct cred *); 144d84f4f99SDavid Howells extern int install_process_keyring_to_cred(struct cred *); 145685bfd2cSOleg Nesterov extern int install_session_keyring_to_cred(struct cred *, struct key *); 1463e30148cSDavid Howells 1473e30148cSDavid Howells extern struct key *request_key_and_link(struct key_type *type, 1483e30148cSDavid Howells const char *description, 1494a38e122SDavid Howells const void *callout_info, 1504a38e122SDavid Howells size_t callout_len, 1514e54f085SDavid Howells void *aux, 1527e047ef5SDavid Howells struct key *dest_keyring, 1537e047ef5SDavid Howells unsigned long flags); 1543e30148cSDavid Howells 1550c903ab6SDavid Howells extern bool lookup_user_key_possessed(const struct key *key, 15646291959SDavid Howells const struct key_match_data *match_data); 1575593122eSDavid Howells #define KEY_LOOKUP_CREATE 0x01 1585593122eSDavid Howells #define KEY_LOOKUP_PARTIAL 0x02 1595593122eSDavid Howells #define KEY_LOOKUP_FOR_UNLINK 0x04 160e9e349b0SDavid Howells 161e9e349b0SDavid Howells extern long join_session_keyring(const char *name); 16267d12145SAl Viro extern void key_change_session_keyring(struct callback_head *twork); 163e9e349b0SDavid Howells 1640c061b57SDavid Howells extern struct work_struct key_gc_work; 1655d135440SDavid Howells extern unsigned key_gc_delay; 166074d5898SBaolin Wang extern void keyring_gc(struct key *keyring, time64_t limit); 1672b6aa412SMat Martineau extern void keyring_restriction_gc(struct key *keyring, 1682b6aa412SMat Martineau struct key_type *dead_type); 169074d5898SBaolin Wang extern void key_schedule_gc(time64_t gc_at); 170fd75815fSDavid Howells extern void key_schedule_gc_links(void); 1710c061b57SDavid Howells extern void key_gc_keytype(struct key_type *ktype); 1725d135440SDavid Howells 173e9e349b0SDavid Howells extern int key_task_permission(const key_ref_t key_ref, 174d84f4f99SDavid Howells const struct cred *cred, 175e9e349b0SDavid Howells key_perm_t perm); 176e9e349b0SDavid Howells 177973c9f4fSDavid Howells /* 178973c9f4fSDavid Howells * Check to see whether permission is granted to use a key in the desired way. 179973c9f4fSDavid Howells */ 180f5895943SDavid Howells static inline int key_permission(const key_ref_t key_ref, unsigned perm) 181e9e349b0SDavid Howells { 182d84f4f99SDavid Howells return key_task_permission(key_ref, current_cred(), perm); 183e9e349b0SDavid Howells } 184e9e349b0SDavid Howells 1853e30148cSDavid Howells extern struct key_type key_type_request_key_auth; 1863e30148cSDavid Howells extern struct key *request_key_auth_new(struct key *target, 187822ad64dSDavid Howells const char *op, 1884a38e122SDavid Howells const void *callout_info, 1898bbf4976SDavid Howells size_t callout_len, 1908bbf4976SDavid Howells struct key *dest_keyring); 1913e30148cSDavid Howells 1923e30148cSDavid Howells extern struct key *key_get_instantiation_authkey(key_serial_t target_id); 1931da177e4SLinus Torvalds 1941da177e4SLinus Torvalds /* 195fd75815fSDavid Howells * Determine whether a key is dead. 196fd75815fSDavid Howells */ 197074d5898SBaolin Wang static inline bool key_is_dead(const struct key *key, time64_t limit) 198fd75815fSDavid Howells { 199fd75815fSDavid Howells return 200fd75815fSDavid Howells key->flags & ((1 << KEY_FLAG_DEAD) | 201fd75815fSDavid Howells (1 << KEY_FLAG_INVALIDATED)) || 202fd75815fSDavid Howells (key->expiry > 0 && key->expiry <= limit); 203fd75815fSDavid Howells } 204fd75815fSDavid Howells 205fd75815fSDavid Howells /* 206973c9f4fSDavid Howells * keyctl() functions 2071da177e4SLinus Torvalds */ 2081da177e4SLinus Torvalds extern long keyctl_get_keyring_ID(key_serial_t, int); 2091da177e4SLinus Torvalds extern long keyctl_join_session_keyring(const char __user *); 2101da177e4SLinus Torvalds extern long keyctl_update_key(key_serial_t, const void __user *, size_t); 2111da177e4SLinus Torvalds extern long keyctl_revoke_key(key_serial_t); 2121da177e4SLinus Torvalds extern long keyctl_keyring_clear(key_serial_t); 2131da177e4SLinus Torvalds extern long keyctl_keyring_link(key_serial_t, key_serial_t); 2141da177e4SLinus Torvalds extern long keyctl_keyring_unlink(key_serial_t, key_serial_t); 2151da177e4SLinus Torvalds extern long keyctl_describe_key(key_serial_t, char __user *, size_t); 2161da177e4SLinus Torvalds extern long keyctl_keyring_search(key_serial_t, const char __user *, 2171da177e4SLinus Torvalds const char __user *, key_serial_t); 2181da177e4SLinus Torvalds extern long keyctl_read_key(key_serial_t, char __user *, size_t); 2191da177e4SLinus Torvalds extern long keyctl_chown_key(key_serial_t, uid_t, gid_t); 2201da177e4SLinus Torvalds extern long keyctl_setperm_key(key_serial_t, key_perm_t); 2211da177e4SLinus Torvalds extern long keyctl_instantiate_key(key_serial_t, const void __user *, 2221da177e4SLinus Torvalds size_t, key_serial_t); 2231da177e4SLinus Torvalds extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t); 2243e30148cSDavid Howells extern long keyctl_set_reqkey_keyring(int); 225017679c4SDavid Howells extern long keyctl_set_timeout(key_serial_t, unsigned); 226b5f545c8SDavid Howells extern long keyctl_assume_authority(key_serial_t); 22770a5bb72SDavid Howells extern long keyctl_get_security(key_serial_t keyid, char __user *buffer, 22870a5bb72SDavid Howells size_t buflen); 229ee18d64cSDavid Howells extern long keyctl_session_to_parent(void); 230fdd1b945SDavid Howells extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t); 231ee009e4aSDavid Howells extern long keyctl_instantiate_key_iov(key_serial_t, 232ee009e4aSDavid Howells const struct iovec __user *, 233ee009e4aSDavid Howells unsigned, key_serial_t); 234fd75815fSDavid Howells extern long keyctl_invalidate_key(key_serial_t); 235ee009e4aSDavid Howells 236b353a1f7SAl Viro struct iov_iter; 237ee009e4aSDavid Howells extern long keyctl_instantiate_key_common(key_serial_t, 238b353a1f7SAl Viro struct iov_iter *, 239b353a1f7SAl Viro key_serial_t); 2406563c91fSMat Martineau extern long keyctl_restrict_keyring(key_serial_t id, 2416563c91fSMat Martineau const char __user *_type, 2426563c91fSMat Martineau const char __user *_restriction); 243f36f8c75SDavid Howells #ifdef CONFIG_PERSISTENT_KEYRINGS 244f36f8c75SDavid Howells extern long keyctl_get_persistent(uid_t, key_serial_t); 245f36f8c75SDavid Howells extern unsigned persistent_keyring_expiry; 246f36f8c75SDavid Howells #else 247f36f8c75SDavid Howells static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring) 248f36f8c75SDavid Howells { 249f36f8c75SDavid Howells return -EOPNOTSUPP; 250f36f8c75SDavid Howells } 251f36f8c75SDavid Howells #endif 2521da177e4SLinus Torvalds 253ddbb4114SMat Martineau #ifdef CONFIG_KEY_DH_OPERATIONS 254ddbb4114SMat Martineau extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *, 255f1c316a3SStephan Mueller size_t, struct keyctl_kdf_params __user *); 256f1c316a3SStephan Mueller extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *, 257f1c316a3SStephan Mueller size_t, struct keyctl_kdf_params *); 258f1c316a3SStephan Mueller #ifdef CONFIG_KEYS_COMPAT 259f1c316a3SStephan Mueller extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params, 260f1c316a3SStephan Mueller char __user *buffer, size_t buflen, 261f1c316a3SStephan Mueller struct compat_keyctl_kdf_params __user *kdf); 262f1c316a3SStephan Mueller #endif 263f1c316a3SStephan Mueller #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */ 264f1c316a3SStephan Mueller #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */ 265ddbb4114SMat Martineau #else 266ddbb4114SMat Martineau static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params, 2674693fc73SStephan Mueller char __user *buffer, size_t buflen, 268f1c316a3SStephan Mueller struct keyctl_kdf_params __user *kdf) 269ddbb4114SMat Martineau { 270ddbb4114SMat Martineau return -EOPNOTSUPP; 271ddbb4114SMat Martineau } 272f1c316a3SStephan Mueller 273f1c316a3SStephan Mueller #ifdef CONFIG_KEYS_COMPAT 274f1c316a3SStephan Mueller static inline long compat_keyctl_dh_compute( 275f1c316a3SStephan Mueller struct keyctl_dh_params __user *params, 276f1c316a3SStephan Mueller char __user *buffer, size_t buflen, 277f1c316a3SStephan Mueller struct keyctl_kdf_params __user *kdf) 278f1c316a3SStephan Mueller { 279f1c316a3SStephan Mueller return -EOPNOTSUPP; 280f1c316a3SStephan Mueller } 281f1c316a3SStephan Mueller #endif 282ddbb4114SMat Martineau #endif 283ddbb4114SMat Martineau 28400d60fd3SDavid Howells #ifdef CONFIG_ASYMMETRIC_KEY_TYPE 28500d60fd3SDavid Howells extern long keyctl_pkey_query(key_serial_t, 28600d60fd3SDavid Howells const char __user *, 28700d60fd3SDavid Howells struct keyctl_pkey_query __user *); 28800d60fd3SDavid Howells 28900d60fd3SDavid Howells extern long keyctl_pkey_verify(const struct keyctl_pkey_params __user *, 29000d60fd3SDavid Howells const char __user *, 29100d60fd3SDavid Howells const void __user *, const void __user *); 29200d60fd3SDavid Howells 29300d60fd3SDavid Howells extern long keyctl_pkey_e_d_s(int, 29400d60fd3SDavid Howells const struct keyctl_pkey_params __user *, 29500d60fd3SDavid Howells const char __user *, 29600d60fd3SDavid Howells const void __user *, void __user *); 29700d60fd3SDavid Howells #else 29800d60fd3SDavid Howells static inline long keyctl_pkey_query(key_serial_t id, 29900d60fd3SDavid Howells const char __user *_info, 30000d60fd3SDavid Howells struct keyctl_pkey_query __user *_res) 30100d60fd3SDavid Howells { 30200d60fd3SDavid Howells return -EOPNOTSUPP; 30300d60fd3SDavid Howells } 30400d60fd3SDavid Howells 30500d60fd3SDavid Howells static inline long keyctl_pkey_verify(const struct keyctl_pkey_params __user *params, 30600d60fd3SDavid Howells const char __user *_info, 30700d60fd3SDavid Howells const void __user *_in, 30800d60fd3SDavid Howells const void __user *_in2) 30900d60fd3SDavid Howells { 31000d60fd3SDavid Howells return -EOPNOTSUPP; 31100d60fd3SDavid Howells } 31200d60fd3SDavid Howells 31300d60fd3SDavid Howells static inline long keyctl_pkey_e_d_s(int op, 31400d60fd3SDavid Howells const struct keyctl_pkey_params __user *params, 31500d60fd3SDavid Howells const char __user *_info, 31600d60fd3SDavid Howells const void __user *_in, 31700d60fd3SDavid Howells void __user *_out) 31800d60fd3SDavid Howells { 31900d60fd3SDavid Howells return -EOPNOTSUPP; 32000d60fd3SDavid Howells } 32100d60fd3SDavid Howells #endif 32200d60fd3SDavid Howells 3231da177e4SLinus Torvalds /* 324973c9f4fSDavid Howells * Debugging key validation 3251da177e4SLinus Torvalds */ 3261da177e4SLinus Torvalds #ifdef KEY_DEBUGGING 3271da177e4SLinus Torvalds extern void __key_check(const struct key *); 3281da177e4SLinus Torvalds 3291da177e4SLinus Torvalds static inline void key_check(const struct key *key) 3301da177e4SLinus Torvalds { 3311da177e4SLinus Torvalds if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC)) 3321da177e4SLinus Torvalds __key_check(key); 3331da177e4SLinus Torvalds } 3341da177e4SLinus Torvalds 3351da177e4SLinus Torvalds #else 3361da177e4SLinus Torvalds 3371da177e4SLinus Torvalds #define key_check(key) do {} while(0) 3381da177e4SLinus Torvalds 3391da177e4SLinus Torvalds #endif 3401da177e4SLinus Torvalds 3411da177e4SLinus Torvalds #endif /* _INTERNAL_H */ 342