1973c9f4fSDavid Howells /* Authentication token and access key management internal defs 21da177e4SLinus Torvalds * 376181c13SDavid Howells * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved. 41da177e4SLinus Torvalds * Written by David Howells (dhowells@redhat.com) 51da177e4SLinus Torvalds * 61da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or 71da177e4SLinus Torvalds * modify it under the terms of the GNU General Public License 81da177e4SLinus Torvalds * as published by the Free Software Foundation; either version 91da177e4SLinus Torvalds * 2 of the License, or (at your option) any later version. 101da177e4SLinus Torvalds */ 111da177e4SLinus Torvalds 121da177e4SLinus Torvalds #ifndef _INTERNAL_H 131da177e4SLinus Torvalds #define _INTERNAL_H 141da177e4SLinus Torvalds 15d84f4f99SDavid Howells #include <linux/sched.h> 165b825c3aSIngo Molnar #include <linux/cred.h> 1776181c13SDavid Howells #include <linux/key-type.h> 18413cd3d9SOleg Nesterov #include <linux/task_work.h> 19ddbb4114SMat Martineau #include <linux/keyctl.h> 20ddb99e11SElena Reshetova #include <linux/refcount.h> 21f1c316a3SStephan Mueller #include <linux/compat.h> 221da177e4SLinus Torvalds 23a27bb332SKent Overstreet struct iovec; 24a27bb332SKent Overstreet 2576181c13SDavid Howells #ifdef __KDEBUG 2676181c13SDavid Howells #define kenter(FMT, ...) \ 27dd6f953aSHarvey Harrison printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) 2876181c13SDavid Howells #define kleave(FMT, ...) \ 29dd6f953aSHarvey Harrison printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) 3076181c13SDavid Howells #define kdebug(FMT, ...) \ 31d84f4f99SDavid Howells printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__) 323e30148cSDavid Howells #else 3376181c13SDavid Howells #define kenter(FMT, ...) \ 34dd6f953aSHarvey Harrison no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) 3576181c13SDavid Howells #define kleave(FMT, ...) \ 36dd6f953aSHarvey Harrison no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) 3776181c13SDavid Howells #define kdebug(FMT, ...) \ 3876181c13SDavid Howells no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__) 393e30148cSDavid Howells #endif 403e30148cSDavid Howells 410c061b57SDavid Howells extern struct key_type key_type_dead; 421da177e4SLinus Torvalds extern struct key_type key_type_user; 439f6ed2caSJeff Layton extern struct key_type key_type_logon; 441da177e4SLinus Torvalds 451da177e4SLinus Torvalds /*****************************************************************************/ 461da177e4SLinus Torvalds /* 47973c9f4fSDavid Howells * Keep track of keys for a user. 48973c9f4fSDavid Howells * 49973c9f4fSDavid Howells * This needs to be separate to user_struct to avoid a refcount-loop 50973c9f4fSDavid Howells * (user_struct pins some keyrings which pin this struct). 51973c9f4fSDavid Howells * 52973c9f4fSDavid Howells * We also keep track of keys under request from userspace for this UID here. 531da177e4SLinus Torvalds */ 541da177e4SLinus Torvalds struct key_user { 551da177e4SLinus Torvalds struct rb_node node; 5676181c13SDavid Howells struct mutex cons_lock; /* construction initiation lock */ 571da177e4SLinus Torvalds spinlock_t lock; 58ddb99e11SElena Reshetova refcount_t usage; /* for accessing qnkeys & qnbytes */ 591da177e4SLinus Torvalds atomic_t nkeys; /* number of keys */ 601da177e4SLinus Torvalds atomic_t nikeys; /* number of instantiated keys */ 619a56c2dbSEric W. Biederman kuid_t uid; 621da177e4SLinus Torvalds int qnkeys; /* number of keys allocated to this user */ 631da177e4SLinus Torvalds int qnbytes; /* number of bytes allocated to this user */ 641da177e4SLinus Torvalds }; 651da177e4SLinus Torvalds 661da177e4SLinus Torvalds extern struct rb_root key_user_tree; 671da177e4SLinus Torvalds extern spinlock_t key_user_lock; 681da177e4SLinus Torvalds extern struct key_user root_key_user; 691da177e4SLinus Torvalds 709a56c2dbSEric W. Biederman extern struct key_user *key_user_lookup(kuid_t uid); 711da177e4SLinus Torvalds extern void key_user_put(struct key_user *user); 721da177e4SLinus Torvalds 730b77f5bfSDavid Howells /* 74973c9f4fSDavid Howells * Key quota limits. 750b77f5bfSDavid Howells * - root has its own separate limits to everyone else 760b77f5bfSDavid Howells */ 770b77f5bfSDavid Howells extern unsigned key_quota_root_maxkeys; 780b77f5bfSDavid Howells extern unsigned key_quota_root_maxbytes; 790b77f5bfSDavid Howells extern unsigned key_quota_maxkeys; 800b77f5bfSDavid Howells extern unsigned key_quota_maxbytes; 810b77f5bfSDavid Howells 820b77f5bfSDavid Howells #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */ 831da177e4SLinus Torvalds 841da177e4SLinus Torvalds 858bc16deaSDavid Howells extern struct kmem_cache *key_jar; 861da177e4SLinus Torvalds extern struct rb_root key_serial_tree; 871da177e4SLinus Torvalds extern spinlock_t key_serial_lock; 8876181c13SDavid Howells extern struct mutex key_construction_mutex; 891da177e4SLinus Torvalds extern wait_queue_head_t request_key_conswq; 901da177e4SLinus Torvalds 911da177e4SLinus Torvalds 92e9e349b0SDavid Howells extern struct key_type *key_type_lookup(const char *type); 93e9e349b0SDavid Howells extern void key_type_put(struct key_type *ktype); 94e9e349b0SDavid Howells 95f70e2e06SDavid Howells extern int __key_link_begin(struct key *keyring, 9616feef43SDavid Howells const struct keyring_index_key *index_key, 97b2a4df20SDavid Howells struct assoc_array_edit **_edit); 98f70e2e06SDavid Howells extern int __key_link_check_live_key(struct key *keyring, struct key *key); 99b2a4df20SDavid Howells extern void __key_link(struct key *key, struct assoc_array_edit **_edit); 100f70e2e06SDavid Howells extern void __key_link_end(struct key *keyring, 10116feef43SDavid Howells const struct keyring_index_key *index_key, 102b2a4df20SDavid Howells struct assoc_array_edit *edit); 1031da177e4SLinus Torvalds 104b2a4df20SDavid Howells extern key_ref_t find_key_to_update(key_ref_t keyring_ref, 105e57e8669SDavid Howells const struct keyring_index_key *index_key); 1061da177e4SLinus Torvalds 1073e30148cSDavid Howells extern struct key *keyring_search_instkey(struct key *keyring, 1083e30148cSDavid Howells key_serial_t target_id); 1093e30148cSDavid Howells 110b2a4df20SDavid Howells extern int iterate_over_keyring(const struct key *keyring, 111b2a4df20SDavid Howells int (*func)(const struct key *key, void *data), 112b2a4df20SDavid Howells void *data); 113b2a4df20SDavid Howells 1144bdf0bc3SDavid Howells struct keyring_search_context { 1154bdf0bc3SDavid Howells struct keyring_index_key index_key; 1164bdf0bc3SDavid Howells const struct cred *cred; 11746291959SDavid Howells struct key_match_data match_data; 1184bdf0bc3SDavid Howells unsigned flags; 119614d8c39SDavid Howells #define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */ 120614d8c39SDavid Howells #define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */ 121614d8c39SDavid Howells #define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */ 122614d8c39SDavid Howells #define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */ 123614d8c39SDavid Howells #define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */ 1240b0a8415SDavid Howells #define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */ 1251da177e4SLinus Torvalds 126b2a4df20SDavid Howells int (*iterator)(const void *object, void *iterator_data); 127b2a4df20SDavid Howells 1284bdf0bc3SDavid Howells /* Internal stuff */ 1294bdf0bc3SDavid Howells int skipped_ret; 1304bdf0bc3SDavid Howells bool possessed; 1314bdf0bc3SDavid Howells key_ref_t result; 1324bdf0bc3SDavid Howells struct timespec now; 1334bdf0bc3SDavid Howells }; 1344bdf0bc3SDavid Howells 1350c903ab6SDavid Howells extern bool key_default_cmp(const struct key *key, 136c06cfb08SDavid Howells const struct key_match_data *match_data); 1374bdf0bc3SDavid Howells extern key_ref_t keyring_search_aux(key_ref_t keyring_ref, 1384bdf0bc3SDavid Howells struct keyring_search_context *ctx); 1394bdf0bc3SDavid Howells 1404bdf0bc3SDavid Howells extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx); 1414bdf0bc3SDavid Howells extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx); 1421da177e4SLinus Torvalds 14369664cf1SDavid Howells extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check); 1441da177e4SLinus Torvalds 1458bbf4976SDavid Howells extern int install_user_keyrings(void); 146d84f4f99SDavid Howells extern int install_thread_keyring_to_cred(struct cred *); 147d84f4f99SDavid Howells extern int install_process_keyring_to_cred(struct cred *); 148685bfd2cSOleg Nesterov extern int install_session_keyring_to_cred(struct cred *, struct key *); 1493e30148cSDavid Howells 1503e30148cSDavid Howells extern struct key *request_key_and_link(struct key_type *type, 1513e30148cSDavid Howells const char *description, 1524a38e122SDavid Howells const void *callout_info, 1534a38e122SDavid Howells size_t callout_len, 1544e54f085SDavid Howells void *aux, 1557e047ef5SDavid Howells struct key *dest_keyring, 1567e047ef5SDavid Howells unsigned long flags); 1573e30148cSDavid Howells 1580c903ab6SDavid Howells extern bool lookup_user_key_possessed(const struct key *key, 15946291959SDavid Howells const struct key_match_data *match_data); 1605593122eSDavid Howells extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags, 161e9e349b0SDavid Howells key_perm_t perm); 1625593122eSDavid Howells #define KEY_LOOKUP_CREATE 0x01 1635593122eSDavid Howells #define KEY_LOOKUP_PARTIAL 0x02 1645593122eSDavid Howells #define KEY_LOOKUP_FOR_UNLINK 0x04 165e9e349b0SDavid Howells 166e9e349b0SDavid Howells extern long join_session_keyring(const char *name); 16767d12145SAl Viro extern void key_change_session_keyring(struct callback_head *twork); 168e9e349b0SDavid Howells 1690c061b57SDavid Howells extern struct work_struct key_gc_work; 1705d135440SDavid Howells extern unsigned key_gc_delay; 1715d135440SDavid Howells extern void keyring_gc(struct key *keyring, time_t limit); 1722b6aa412SMat Martineau extern void keyring_restriction_gc(struct key *keyring, 1732b6aa412SMat Martineau struct key_type *dead_type); 174fd75815fSDavid Howells extern void key_schedule_gc(time_t gc_at); 175fd75815fSDavid Howells extern void key_schedule_gc_links(void); 1760c061b57SDavid Howells extern void key_gc_keytype(struct key_type *ktype); 1775d135440SDavid Howells 178e9e349b0SDavid Howells extern int key_task_permission(const key_ref_t key_ref, 179d84f4f99SDavid Howells const struct cred *cred, 180e9e349b0SDavid Howells key_perm_t perm); 181e9e349b0SDavid Howells 182973c9f4fSDavid Howells /* 183973c9f4fSDavid Howells * Check to see whether permission is granted to use a key in the desired way. 184973c9f4fSDavid Howells */ 185f5895943SDavid Howells static inline int key_permission(const key_ref_t key_ref, unsigned perm) 186e9e349b0SDavid Howells { 187d84f4f99SDavid Howells return key_task_permission(key_ref, current_cred(), perm); 188e9e349b0SDavid Howells } 189e9e349b0SDavid Howells 1903e30148cSDavid Howells /* 191973c9f4fSDavid Howells * Authorisation record for request_key(). 1923e30148cSDavid Howells */ 1933e30148cSDavid Howells struct request_key_auth { 1943e30148cSDavid Howells struct key *target_key; 1958bbf4976SDavid Howells struct key *dest_keyring; 196d84f4f99SDavid Howells const struct cred *cred; 1974a38e122SDavid Howells void *callout_info; 1984a38e122SDavid Howells size_t callout_len; 1993e30148cSDavid Howells pid_t pid; 2003e30148cSDavid Howells }; 2013e30148cSDavid Howells 2023e30148cSDavid Howells extern struct key_type key_type_request_key_auth; 2033e30148cSDavid Howells extern struct key *request_key_auth_new(struct key *target, 2044a38e122SDavid Howells const void *callout_info, 2058bbf4976SDavid Howells size_t callout_len, 2068bbf4976SDavid Howells struct key *dest_keyring); 2073e30148cSDavid Howells 2083e30148cSDavid Howells extern struct key *key_get_instantiation_authkey(key_serial_t target_id); 2091da177e4SLinus Torvalds 2101da177e4SLinus Torvalds /* 211fd75815fSDavid Howells * Determine whether a key is dead. 212fd75815fSDavid Howells */ 2137e55ca6dSDavid Howells static inline bool key_is_dead(const struct key *key, time_t limit) 214fd75815fSDavid Howells { 215fd75815fSDavid Howells return 216fd75815fSDavid Howells key->flags & ((1 << KEY_FLAG_DEAD) | 217fd75815fSDavid Howells (1 << KEY_FLAG_INVALIDATED)) || 218fd75815fSDavid Howells (key->expiry > 0 && key->expiry <= limit); 219fd75815fSDavid Howells } 220fd75815fSDavid Howells 221fd75815fSDavid Howells /* 222973c9f4fSDavid Howells * keyctl() functions 2231da177e4SLinus Torvalds */ 2241da177e4SLinus Torvalds extern long keyctl_get_keyring_ID(key_serial_t, int); 2251da177e4SLinus Torvalds extern long keyctl_join_session_keyring(const char __user *); 2261da177e4SLinus Torvalds extern long keyctl_update_key(key_serial_t, const void __user *, size_t); 2271da177e4SLinus Torvalds extern long keyctl_revoke_key(key_serial_t); 2281da177e4SLinus Torvalds extern long keyctl_keyring_clear(key_serial_t); 2291da177e4SLinus Torvalds extern long keyctl_keyring_link(key_serial_t, key_serial_t); 2301da177e4SLinus Torvalds extern long keyctl_keyring_unlink(key_serial_t, key_serial_t); 2311da177e4SLinus Torvalds extern long keyctl_describe_key(key_serial_t, char __user *, size_t); 2321da177e4SLinus Torvalds extern long keyctl_keyring_search(key_serial_t, const char __user *, 2331da177e4SLinus Torvalds const char __user *, key_serial_t); 2341da177e4SLinus Torvalds extern long keyctl_read_key(key_serial_t, char __user *, size_t); 2351da177e4SLinus Torvalds extern long keyctl_chown_key(key_serial_t, uid_t, gid_t); 2361da177e4SLinus Torvalds extern long keyctl_setperm_key(key_serial_t, key_perm_t); 2371da177e4SLinus Torvalds extern long keyctl_instantiate_key(key_serial_t, const void __user *, 2381da177e4SLinus Torvalds size_t, key_serial_t); 2391da177e4SLinus Torvalds extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t); 2403e30148cSDavid Howells extern long keyctl_set_reqkey_keyring(int); 241017679c4SDavid Howells extern long keyctl_set_timeout(key_serial_t, unsigned); 242b5f545c8SDavid Howells extern long keyctl_assume_authority(key_serial_t); 24370a5bb72SDavid Howells extern long keyctl_get_security(key_serial_t keyid, char __user *buffer, 24470a5bb72SDavid Howells size_t buflen); 245ee18d64cSDavid Howells extern long keyctl_session_to_parent(void); 246fdd1b945SDavid Howells extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t); 247ee009e4aSDavid Howells extern long keyctl_instantiate_key_iov(key_serial_t, 248ee009e4aSDavid Howells const struct iovec __user *, 249ee009e4aSDavid Howells unsigned, key_serial_t); 250fd75815fSDavid Howells extern long keyctl_invalidate_key(key_serial_t); 251ee009e4aSDavid Howells 252b353a1f7SAl Viro struct iov_iter; 253ee009e4aSDavid Howells extern long keyctl_instantiate_key_common(key_serial_t, 254b353a1f7SAl Viro struct iov_iter *, 255b353a1f7SAl Viro key_serial_t); 2566563c91fSMat Martineau extern long keyctl_restrict_keyring(key_serial_t id, 2576563c91fSMat Martineau const char __user *_type, 2586563c91fSMat Martineau const char __user *_restriction); 259f36f8c75SDavid Howells #ifdef CONFIG_PERSISTENT_KEYRINGS 260f36f8c75SDavid Howells extern long keyctl_get_persistent(uid_t, key_serial_t); 261f36f8c75SDavid Howells extern unsigned persistent_keyring_expiry; 262f36f8c75SDavid Howells #else 263f36f8c75SDavid Howells static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring) 264f36f8c75SDavid Howells { 265f36f8c75SDavid Howells return -EOPNOTSUPP; 266f36f8c75SDavid Howells } 267f36f8c75SDavid Howells #endif 2681da177e4SLinus Torvalds 269ddbb4114SMat Martineau #ifdef CONFIG_KEY_DH_OPERATIONS 270ddbb4114SMat Martineau extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *, 271f1c316a3SStephan Mueller size_t, struct keyctl_kdf_params __user *); 272f1c316a3SStephan Mueller extern long __keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *, 273f1c316a3SStephan Mueller size_t, struct keyctl_kdf_params *); 274f1c316a3SStephan Mueller #ifdef CONFIG_KEYS_COMPAT 275f1c316a3SStephan Mueller extern long compat_keyctl_dh_compute(struct keyctl_dh_params __user *params, 276f1c316a3SStephan Mueller char __user *buffer, size_t buflen, 277f1c316a3SStephan Mueller struct compat_keyctl_kdf_params __user *kdf); 278f1c316a3SStephan Mueller #endif 279f1c316a3SStephan Mueller #define KEYCTL_KDF_MAX_OUTPUT_LEN 1024 /* max length of KDF output */ 280f1c316a3SStephan Mueller #define KEYCTL_KDF_MAX_OI_LEN 64 /* max length of otherinfo */ 281ddbb4114SMat Martineau #else 282ddbb4114SMat Martineau static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params, 2834693fc73SStephan Mueller char __user *buffer, size_t buflen, 284f1c316a3SStephan Mueller struct keyctl_kdf_params __user *kdf) 285ddbb4114SMat Martineau { 286ddbb4114SMat Martineau return -EOPNOTSUPP; 287ddbb4114SMat Martineau } 288f1c316a3SStephan Mueller 289f1c316a3SStephan Mueller #ifdef CONFIG_KEYS_COMPAT 290f1c316a3SStephan Mueller static inline long compat_keyctl_dh_compute( 291f1c316a3SStephan Mueller struct keyctl_dh_params __user *params, 292f1c316a3SStephan Mueller char __user *buffer, size_t buflen, 293f1c316a3SStephan Mueller struct keyctl_kdf_params __user *kdf) 294f1c316a3SStephan Mueller { 295f1c316a3SStephan Mueller return -EOPNOTSUPP; 296f1c316a3SStephan Mueller } 297f1c316a3SStephan Mueller #endif 298ddbb4114SMat Martineau #endif 299ddbb4114SMat Martineau 3001da177e4SLinus Torvalds /* 301973c9f4fSDavid Howells * Debugging key validation 3021da177e4SLinus Torvalds */ 3031da177e4SLinus Torvalds #ifdef KEY_DEBUGGING 3041da177e4SLinus Torvalds extern void __key_check(const struct key *); 3051da177e4SLinus Torvalds 3061da177e4SLinus Torvalds static inline void key_check(const struct key *key) 3071da177e4SLinus Torvalds { 3081da177e4SLinus Torvalds if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC)) 3091da177e4SLinus Torvalds __key_check(key); 3101da177e4SLinus Torvalds } 3111da177e4SLinus Torvalds 3121da177e4SLinus Torvalds #else 3131da177e4SLinus Torvalds 3141da177e4SLinus Torvalds #define key_check(key) do {} while(0) 3151da177e4SLinus Torvalds 3161da177e4SLinus Torvalds #endif 3171da177e4SLinus Torvalds 3181da177e4SLinus Torvalds #endif /* _INTERNAL_H */ 319