11da177e4SLinus Torvalds /* internal.h: 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 1576181c13SDavid Howells #include <linux/key-type.h> 161da177e4SLinus Torvalds #include <linux/key-ui.h> 171da177e4SLinus Torvalds 1876181c13SDavid Howells static inline __attribute__((format(printf, 1, 2))) 1976181c13SDavid Howells void no_printk(const char *fmt, ...) 2076181c13SDavid Howells { 2176181c13SDavid Howells } 2276181c13SDavid Howells 2376181c13SDavid Howells #ifdef __KDEBUG 2476181c13SDavid Howells #define kenter(FMT, ...) \ 25dd6f953aSHarvey Harrison printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) 2676181c13SDavid Howells #define kleave(FMT, ...) \ 27dd6f953aSHarvey Harrison printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) 2876181c13SDavid Howells #define kdebug(FMT, ...) \ 2976181c13SDavid Howells printk(KERN_DEBUG "xxx" FMT"yyy\n", ##__VA_ARGS__) 303e30148cSDavid Howells #else 3176181c13SDavid Howells #define kenter(FMT, ...) \ 32dd6f953aSHarvey Harrison no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__) 3376181c13SDavid Howells #define kleave(FMT, ...) \ 34dd6f953aSHarvey Harrison no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__) 3576181c13SDavid Howells #define kdebug(FMT, ...) \ 3676181c13SDavid Howells no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__) 373e30148cSDavid Howells #endif 383e30148cSDavid Howells 391da177e4SLinus Torvalds extern struct key_type key_type_user; 401da177e4SLinus Torvalds 411da177e4SLinus Torvalds /*****************************************************************************/ 421da177e4SLinus Torvalds /* 431da177e4SLinus Torvalds * keep track of keys for a user 441da177e4SLinus Torvalds * - this needs to be separate to user_struct to avoid a refcount-loop 451da177e4SLinus Torvalds * (user_struct pins some keyrings which pin this struct) 461da177e4SLinus Torvalds * - this also keeps track of keys under request from userspace for this UID 471da177e4SLinus Torvalds */ 481da177e4SLinus Torvalds struct key_user { 491da177e4SLinus Torvalds struct rb_node node; 5076181c13SDavid Howells struct mutex cons_lock; /* construction initiation lock */ 511da177e4SLinus Torvalds spinlock_t lock; 521da177e4SLinus Torvalds atomic_t usage; /* for accessing qnkeys & qnbytes */ 531da177e4SLinus Torvalds atomic_t nkeys; /* number of keys */ 541da177e4SLinus Torvalds atomic_t nikeys; /* number of instantiated keys */ 551da177e4SLinus Torvalds uid_t uid; 561da177e4SLinus Torvalds int qnkeys; /* number of keys allocated to this user */ 571da177e4SLinus Torvalds int qnbytes; /* number of bytes allocated to this user */ 581da177e4SLinus Torvalds }; 591da177e4SLinus Torvalds 601da177e4SLinus Torvalds #define KEYQUOTA_MAX_KEYS 100 611da177e4SLinus Torvalds #define KEYQUOTA_MAX_BYTES 10000 621da177e4SLinus Torvalds #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */ 631da177e4SLinus Torvalds 641da177e4SLinus Torvalds extern struct rb_root key_user_tree; 651da177e4SLinus Torvalds extern spinlock_t key_user_lock; 661da177e4SLinus Torvalds extern struct key_user root_key_user; 671da177e4SLinus Torvalds 681da177e4SLinus Torvalds extern struct key_user *key_user_lookup(uid_t uid); 691da177e4SLinus Torvalds extern void key_user_put(struct key_user *user); 701da177e4SLinus Torvalds 711da177e4SLinus Torvalds 721da177e4SLinus Torvalds 731da177e4SLinus Torvalds extern struct rb_root key_serial_tree; 741da177e4SLinus Torvalds extern spinlock_t key_serial_lock; 751da177e4SLinus Torvalds extern struct semaphore key_alloc_sem; 7676181c13SDavid Howells extern struct mutex key_construction_mutex; 771da177e4SLinus Torvalds extern wait_queue_head_t request_key_conswq; 781da177e4SLinus Torvalds 791da177e4SLinus Torvalds 801da177e4SLinus Torvalds extern void keyring_publish_name(struct key *keyring); 811da177e4SLinus Torvalds 821da177e4SLinus Torvalds extern int __key_link(struct key *keyring, struct key *key); 831da177e4SLinus Torvalds 84664cceb0SDavid Howells extern key_ref_t __keyring_search_one(key_ref_t keyring_ref, 851da177e4SLinus Torvalds const struct key_type *type, 861da177e4SLinus Torvalds const char *description, 871da177e4SLinus Torvalds key_perm_t perm); 881da177e4SLinus Torvalds 893e30148cSDavid Howells extern struct key *keyring_search_instkey(struct key *keyring, 903e30148cSDavid Howells key_serial_t target_id); 913e30148cSDavid Howells 921da177e4SLinus Torvalds typedef int (*key_match_func_t)(const struct key *, const void *); 931da177e4SLinus Torvalds 94664cceb0SDavid Howells extern key_ref_t keyring_search_aux(key_ref_t keyring_ref, 953e30148cSDavid Howells struct task_struct *tsk, 961da177e4SLinus Torvalds struct key_type *type, 971da177e4SLinus Torvalds const void *description, 981da177e4SLinus Torvalds key_match_func_t match); 991da177e4SLinus Torvalds 100664cceb0SDavid Howells extern key_ref_t search_process_keyrings(struct key_type *type, 1011da177e4SLinus Torvalds const void *description, 1023e30148cSDavid Howells key_match_func_t match, 1033e30148cSDavid Howells struct task_struct *tsk); 1041da177e4SLinus Torvalds 1051da177e4SLinus Torvalds extern struct key *find_keyring_by_name(const char *name, key_serial_t bound); 1061da177e4SLinus Torvalds 1071da177e4SLinus Torvalds extern int install_thread_keyring(struct task_struct *tsk); 1083e30148cSDavid Howells extern int install_process_keyring(struct task_struct *tsk); 1093e30148cSDavid Howells 1103e30148cSDavid Howells extern struct key *request_key_and_link(struct key_type *type, 1113e30148cSDavid Howells const char *description, 1123e30148cSDavid Howells const char *callout_info, 1134e54f085SDavid Howells void *aux, 1147e047ef5SDavid Howells struct key *dest_keyring, 1157e047ef5SDavid Howells unsigned long flags); 1163e30148cSDavid Howells 1173e30148cSDavid Howells /* 1183e30148cSDavid Howells * request_key authorisation 1193e30148cSDavid Howells */ 1203e30148cSDavid Howells struct request_key_auth { 1213e30148cSDavid Howells struct key *target_key; 1223e30148cSDavid Howells struct task_struct *context; 12376181c13SDavid Howells char *callout_info; 1243e30148cSDavid Howells pid_t pid; 1253e30148cSDavid Howells }; 1263e30148cSDavid Howells 1273e30148cSDavid Howells extern struct key_type key_type_request_key_auth; 1283e30148cSDavid Howells extern struct key *request_key_auth_new(struct key *target, 129b5f545c8SDavid Howells const char *callout_info); 1303e30148cSDavid Howells 1313e30148cSDavid Howells extern struct key *key_get_instantiation_authkey(key_serial_t target_id); 1321da177e4SLinus Torvalds 1331da177e4SLinus Torvalds /* 1341da177e4SLinus Torvalds * keyctl functions 1351da177e4SLinus Torvalds */ 1361da177e4SLinus Torvalds extern long keyctl_get_keyring_ID(key_serial_t, int); 1371da177e4SLinus Torvalds extern long keyctl_join_session_keyring(const char __user *); 1381da177e4SLinus Torvalds extern long keyctl_update_key(key_serial_t, const void __user *, size_t); 1391da177e4SLinus Torvalds extern long keyctl_revoke_key(key_serial_t); 1401da177e4SLinus Torvalds extern long keyctl_keyring_clear(key_serial_t); 1411da177e4SLinus Torvalds extern long keyctl_keyring_link(key_serial_t, key_serial_t); 1421da177e4SLinus Torvalds extern long keyctl_keyring_unlink(key_serial_t, key_serial_t); 1431da177e4SLinus Torvalds extern long keyctl_describe_key(key_serial_t, char __user *, size_t); 1441da177e4SLinus Torvalds extern long keyctl_keyring_search(key_serial_t, const char __user *, 1451da177e4SLinus Torvalds const char __user *, key_serial_t); 1461da177e4SLinus Torvalds extern long keyctl_read_key(key_serial_t, char __user *, size_t); 1471da177e4SLinus Torvalds extern long keyctl_chown_key(key_serial_t, uid_t, gid_t); 1481da177e4SLinus Torvalds extern long keyctl_setperm_key(key_serial_t, key_perm_t); 1491da177e4SLinus Torvalds extern long keyctl_instantiate_key(key_serial_t, const void __user *, 1501da177e4SLinus Torvalds size_t, key_serial_t); 1511da177e4SLinus Torvalds extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t); 1523e30148cSDavid Howells extern long keyctl_set_reqkey_keyring(int); 153017679c4SDavid Howells extern long keyctl_set_timeout(key_serial_t, unsigned); 154b5f545c8SDavid Howells extern long keyctl_assume_authority(key_serial_t); 1551da177e4SLinus Torvalds 1561da177e4SLinus Torvalds 1571da177e4SLinus Torvalds /* 1581da177e4SLinus Torvalds * debugging key validation 1591da177e4SLinus Torvalds */ 1601da177e4SLinus Torvalds #ifdef KEY_DEBUGGING 1611da177e4SLinus Torvalds extern void __key_check(const struct key *); 1621da177e4SLinus Torvalds 1631da177e4SLinus Torvalds static inline void key_check(const struct key *key) 1641da177e4SLinus Torvalds { 1651da177e4SLinus Torvalds if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC)) 1661da177e4SLinus Torvalds __key_check(key); 1671da177e4SLinus Torvalds } 1681da177e4SLinus Torvalds 1691da177e4SLinus Torvalds #else 1701da177e4SLinus Torvalds 1711da177e4SLinus Torvalds #define key_check(key) do {} while(0) 1721da177e4SLinus Torvalds 1731da177e4SLinus Torvalds #endif 1741da177e4SLinus Torvalds 1751da177e4SLinus Torvalds #endif /* _INTERNAL_H */ 176