Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* internal.h: authentication token and access key management internal defs |
| 2 | * |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 3 | * Copyright (C) 2003-5 Red Hat, Inc. All Rights Reserved. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | * Written by David Howells (dhowells@redhat.com) |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License |
| 8 | * as published by the Free Software Foundation; either version |
| 9 | * 2 of the License, or (at your option) any later version. |
| 10 | */ |
| 11 | |
| 12 | #ifndef _INTERNAL_H |
| 13 | #define _INTERNAL_H |
| 14 | |
| 15 | #include <linux/key.h> |
| 16 | #include <linux/key-ui.h> |
| 17 | |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 18 | #if 0 |
| 19 | #define kenter(FMT, a...) printk("==> %s("FMT")\n",__FUNCTION__ , ## a) |
| 20 | #define kleave(FMT, a...) printk("<== %s()"FMT"\n",__FUNCTION__ , ## a) |
| 21 | #define kdebug(FMT, a...) printk(FMT"\n" , ## a) |
| 22 | #else |
| 23 | #define kenter(FMT, a...) do {} while(0) |
| 24 | #define kleave(FMT, a...) do {} while(0) |
| 25 | #define kdebug(FMT, a...) do {} while(0) |
| 26 | #endif |
| 27 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 28 | extern struct key_type key_type_user; |
| 29 | |
| 30 | /*****************************************************************************/ |
| 31 | /* |
| 32 | * keep track of keys for a user |
| 33 | * - this needs to be separate to user_struct to avoid a refcount-loop |
| 34 | * (user_struct pins some keyrings which pin this struct) |
| 35 | * - this also keeps track of keys under request from userspace for this UID |
| 36 | */ |
| 37 | struct key_user { |
| 38 | struct rb_node node; |
| 39 | struct list_head consq; /* construction queue */ |
| 40 | spinlock_t lock; |
| 41 | atomic_t usage; /* for accessing qnkeys & qnbytes */ |
| 42 | atomic_t nkeys; /* number of keys */ |
| 43 | atomic_t nikeys; /* number of instantiated keys */ |
| 44 | uid_t uid; |
| 45 | int qnkeys; /* number of keys allocated to this user */ |
| 46 | int qnbytes; /* number of bytes allocated to this user */ |
| 47 | }; |
| 48 | |
| 49 | #define KEYQUOTA_MAX_KEYS 100 |
| 50 | #define KEYQUOTA_MAX_BYTES 10000 |
| 51 | #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */ |
| 52 | |
| 53 | extern struct rb_root key_user_tree; |
| 54 | extern spinlock_t key_user_lock; |
| 55 | extern struct key_user root_key_user; |
| 56 | |
| 57 | extern struct key_user *key_user_lookup(uid_t uid); |
| 58 | extern void key_user_put(struct key_user *user); |
| 59 | |
| 60 | |
| 61 | |
| 62 | extern struct rb_root key_serial_tree; |
| 63 | extern spinlock_t key_serial_lock; |
| 64 | extern struct semaphore key_alloc_sem; |
| 65 | extern struct rw_semaphore key_construction_sem; |
| 66 | extern wait_queue_head_t request_key_conswq; |
| 67 | |
| 68 | |
| 69 | extern void keyring_publish_name(struct key *keyring); |
| 70 | |
| 71 | extern int __key_link(struct key *keyring, struct key *key); |
| 72 | |
David Howells | 664cceb | 2005-09-28 17:03:15 +0100 | [diff] [blame] | 73 | extern key_ref_t __keyring_search_one(key_ref_t keyring_ref, |
| 74 | const struct key_type *type, |
| 75 | const char *description, |
| 76 | key_perm_t perm); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 78 | extern struct key *keyring_search_instkey(struct key *keyring, |
| 79 | key_serial_t target_id); |
| 80 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 81 | typedef int (*key_match_func_t)(const struct key *, const void *); |
| 82 | |
David Howells | 664cceb | 2005-09-28 17:03:15 +0100 | [diff] [blame] | 83 | extern key_ref_t keyring_search_aux(key_ref_t keyring_ref, |
| 84 | struct task_struct *tsk, |
| 85 | struct key_type *type, |
| 86 | const void *description, |
| 87 | key_match_func_t match); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 88 | |
David Howells | 664cceb | 2005-09-28 17:03:15 +0100 | [diff] [blame] | 89 | extern key_ref_t search_process_keyrings(struct key_type *type, |
| 90 | const void *description, |
| 91 | key_match_func_t match, |
| 92 | struct task_struct *tsk); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | |
| 94 | extern struct key *find_keyring_by_name(const char *name, key_serial_t bound); |
| 95 | |
| 96 | extern int install_thread_keyring(struct task_struct *tsk); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 97 | extern int install_process_keyring(struct task_struct *tsk); |
| 98 | |
| 99 | extern struct key *request_key_and_link(struct key_type *type, |
| 100 | const char *description, |
| 101 | const char *callout_info, |
| 102 | struct key *dest_keyring); |
| 103 | |
| 104 | /* |
| 105 | * request_key authorisation |
| 106 | */ |
| 107 | struct request_key_auth { |
| 108 | struct key *target_key; |
| 109 | struct task_struct *context; |
| 110 | pid_t pid; |
| 111 | }; |
| 112 | |
| 113 | extern struct key_type key_type_request_key_auth; |
| 114 | extern struct key *request_key_auth_new(struct key *target, |
| 115 | struct key **_rkakey); |
| 116 | |
| 117 | extern struct key *key_get_instantiation_authkey(key_serial_t target_id); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | |
| 119 | /* |
| 120 | * keyctl functions |
| 121 | */ |
| 122 | extern long keyctl_get_keyring_ID(key_serial_t, int); |
| 123 | extern long keyctl_join_session_keyring(const char __user *); |
| 124 | extern long keyctl_update_key(key_serial_t, const void __user *, size_t); |
| 125 | extern long keyctl_revoke_key(key_serial_t); |
| 126 | extern long keyctl_keyring_clear(key_serial_t); |
| 127 | extern long keyctl_keyring_link(key_serial_t, key_serial_t); |
| 128 | extern long keyctl_keyring_unlink(key_serial_t, key_serial_t); |
| 129 | extern long keyctl_describe_key(key_serial_t, char __user *, size_t); |
| 130 | extern long keyctl_keyring_search(key_serial_t, const char __user *, |
| 131 | const char __user *, key_serial_t); |
| 132 | extern long keyctl_read_key(key_serial_t, char __user *, size_t); |
| 133 | extern long keyctl_chown_key(key_serial_t, uid_t, gid_t); |
| 134 | extern long keyctl_setperm_key(key_serial_t, key_perm_t); |
| 135 | extern long keyctl_instantiate_key(key_serial_t, const void __user *, |
| 136 | size_t, key_serial_t); |
| 137 | extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 138 | extern long keyctl_set_reqkey_keyring(int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | |
| 140 | |
| 141 | /* |
| 142 | * debugging key validation |
| 143 | */ |
| 144 | #ifdef KEY_DEBUGGING |
| 145 | extern void __key_check(const struct key *); |
| 146 | |
| 147 | static inline void key_check(const struct key *key) |
| 148 | { |
| 149 | if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC)) |
| 150 | __key_check(key); |
| 151 | } |
| 152 | |
| 153 | #else |
| 154 | |
| 155 | #define key_check(key) do {} while(0) |
| 156 | |
| 157 | #endif |
| 158 | |
| 159 | #endif /* _INTERNAL_H */ |