Blame view
include/linux/key.h
8.82 KB
76181c134 KEYS: Make reques... |
1 |
/* Authentication token and access key management |
1da177e4c Linux-2.6.12-rc2 |
2 |
* |
76181c134 KEYS: Make reques... |
3 |
* Copyright (C) 2004, 2007 Red Hat, Inc. All Rights Reserved. |
1da177e4c Linux-2.6.12-rc2 |
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
* Written by David Howells (dhowells@redhat.com) * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version * 2 of the License, or (at your option) any later version. * * * See Documentation/keys.txt for information on keys/keyrings. */ #ifndef _LINUX_KEY_H #define _LINUX_KEY_H #include <linux/types.h> #include <linux/list.h> #include <linux/rbtree.h> |
76d8aeabf [PATCH] keys: Dis... |
21 |
#include <linux/rcupdate.h> |
0b77f5bfb keys: make the ke... |
22 |
#include <linux/sysctl.h> |
aa84442d6 kmemtrace, securi... |
23 |
#include <linux/rwsem.h> |
1da177e4c Linux-2.6.12-rc2 |
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
#include <asm/atomic.h> #ifdef __KERNEL__ /* key handle serial number */ typedef int32_t key_serial_t; /* key handle permissions mask */ typedef uint32_t key_perm_t; struct key; #ifdef CONFIG_KEYS #undef KEY_DEBUGGING |
664cceb00 [PATCH] Keys: Add... |
39 40 41 42 43 |
#define KEY_POS_VIEW 0x01000000 /* possessor can view a key's attributes */ #define KEY_POS_READ 0x02000000 /* possessor can read key payload / view keyring */ #define KEY_POS_WRITE 0x04000000 /* possessor can update key payload / add link to keyring */ #define KEY_POS_SEARCH 0x08000000 /* possessor can find a key in search / search a keyring */ #define KEY_POS_LINK 0x10000000 /* possessor can create a link to a key/keyring */ |
29db91906 [PATCH] Keys: Add... |
44 45 |
#define KEY_POS_SETATTR 0x20000000 /* possessor can set key attributes */ #define KEY_POS_ALL 0x3f000000 |
664cceb00 [PATCH] Keys: Add... |
46 47 48 49 50 51 |
#define KEY_USR_VIEW 0x00010000 /* user permissions... */ #define KEY_USR_READ 0x00020000 #define KEY_USR_WRITE 0x00040000 #define KEY_USR_SEARCH 0x00080000 #define KEY_USR_LINK 0x00100000 |
29db91906 [PATCH] Keys: Add... |
52 53 |
#define KEY_USR_SETATTR 0x00200000 #define KEY_USR_ALL 0x003f0000 |
1da177e4c Linux-2.6.12-rc2 |
54 55 56 57 58 59 |
#define KEY_GRP_VIEW 0x00000100 /* group permissions... */ #define KEY_GRP_READ 0x00000200 #define KEY_GRP_WRITE 0x00000400 #define KEY_GRP_SEARCH 0x00000800 #define KEY_GRP_LINK 0x00001000 |
29db91906 [PATCH] Keys: Add... |
60 61 |
#define KEY_GRP_SETATTR 0x00002000 #define KEY_GRP_ALL 0x00003f00 |
1da177e4c Linux-2.6.12-rc2 |
62 63 64 65 66 67 |
#define KEY_OTH_VIEW 0x00000001 /* third party permissions... */ #define KEY_OTH_READ 0x00000002 #define KEY_OTH_WRITE 0x00000004 #define KEY_OTH_SEARCH 0x00000008 #define KEY_OTH_LINK 0x00000010 |
29db91906 [PATCH] Keys: Add... |
68 69 |
#define KEY_OTH_SETATTR 0x00000020 #define KEY_OTH_ALL 0x0000003f |
1da177e4c Linux-2.6.12-rc2 |
70 |
|
6b79ccb51 keys: allow clien... |
71 |
#define KEY_PERM_UNDEF 0xffffffff |
1da177e4c Linux-2.6.12-rc2 |
72 73 74 |
struct seq_file; struct user_struct; struct signal_struct; |
d84f4f992 CRED: Inaugurate ... |
75 |
struct cred; |
1da177e4c Linux-2.6.12-rc2 |
76 77 78 79 80 81 82 83 |
struct key_type; struct key_owner; struct keyring_list; struct keyring_name; /*****************************************************************************/ /* |
664cceb00 [PATCH] Keys: Add... |
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
* key reference with possession attribute handling * * NOTE! key_ref_t is a typedef'd pointer to a type that is not actually * defined. This is because we abuse the bottom bit of the reference to carry a * flag to indicate whether the calling process possesses that key in one of * its keyrings. * * the key_ref_t has been made a separate type so that the compiler can reject * attempts to dereference it without proper conversion. * * the three functions are used to assemble and disassemble references */ typedef struct __key_reference_with_attributes *key_ref_t; static inline key_ref_t make_key_ref(const struct key *key, unsigned long possession) { return (key_ref_t) ((unsigned long) key | possession); } static inline struct key *key_ref_to_ptr(const key_ref_t key_ref) { return (struct key *) ((unsigned long) key_ref & ~1UL); } static inline unsigned long is_key_possessed(const key_ref_t key_ref) { return (unsigned long) key_ref & 1UL; } /*****************************************************************************/ /* |
1da177e4c Linux-2.6.12-rc2 |
116 117 118 119 120 121 122 123 124 125 126 |
* authentication token / access credential / keyring * - types of key include: * - keyrings * - disk encryption IDs * - Kerberos TGTs and tickets */ struct key { atomic_t usage; /* number of references */ key_serial_t serial; /* key serial number */ struct rb_node serial_node; struct key_type *type; /* type of key */ |
1da177e4c Linux-2.6.12-rc2 |
127 128 |
struct rw_semaphore sem; /* change vs change sem */ struct key_user *user; /* owner of this key */ |
29db91906 [PATCH] Keys: Add... |
129 |
void *security; /* security data for this key */ |
5d135440f KEYS: Add garbage... |
130 131 132 133 |
union { time_t expiry; /* time at which key expires (or 0) */ time_t revoked_at; /* time at which key was revoked */ }; |
1da177e4c Linux-2.6.12-rc2 |
134 135 136 137 |
uid_t uid; gid_t gid; key_perm_t perm; /* access permissions */ unsigned short quotalen; /* length added to quota */ |
76d8aeabf [PATCH] keys: Dis... |
138 139 140 141 |
unsigned short datalen; /* payload data length * - may not match RCU dereferenced payload * - payload should contain own length */ |
1da177e4c Linux-2.6.12-rc2 |
142 143 144 145 146 147 |
#ifdef KEY_DEBUGGING unsigned magic; #define KEY_DEBUG_MAGIC 0x18273645u #define KEY_DEBUG_MAGIC_X 0xf8e9dacbu #endif |
76d8aeabf [PATCH] keys: Dis... |
148 149 150 151 152 153 154 |
unsigned long flags; /* status flags (change with bitops) */ #define KEY_FLAG_INSTANTIATED 0 /* set if key has been instantiated */ #define KEY_FLAG_DEAD 1 /* set if key type has been deleted */ #define KEY_FLAG_REVOKED 2 /* set if key had been revoked */ #define KEY_FLAG_IN_QUOTA 3 /* set if key consumes quota */ #define KEY_FLAG_USER_CONSTRUCT 4 /* set if key is being constructed in userspace */ #define KEY_FLAG_NEGATIVE 5 /* set if key is negative */ |
1da177e4c Linux-2.6.12-rc2 |
155 156 157 158 159 160 161 162 163 164 165 166 |
/* the description string * - this is used to match a key against search criteria * - this should be a printable string * - eg: for krb5 AFS, this might be "afs@REDHAT.COM" */ char *description; /* type specific data * - this is used by the keyring type to index the name */ union { struct list_head link; |
7318226ea [AF_RXRPC]: Key f... |
167 168 |
unsigned long x[2]; void *p[2]; |
1da177e4c Linux-2.6.12-rc2 |
169 170 171 172 173 174 175 176 177 178 179 180 |
} type_data; /* key data * - this is used to hold the data actually used in cryptography or * whatever */ union { unsigned long value; void *data; struct keyring_list *subscriptions; } payload; }; |
1da177e4c Linux-2.6.12-rc2 |
181 182 |
extern struct key *key_alloc(struct key_type *type, const char *desc, |
d720024e9 [PATCH] selinux: ... |
183 |
uid_t uid, gid_t gid, |
d84f4f992 CRED: Inaugurate ... |
184 |
const struct cred *cred, |
7e047ef5f [PATCH] keys: sor... |
185 186 187 188 189 190 191 |
key_perm_t perm, unsigned long flags); #define KEY_ALLOC_IN_QUOTA 0x0000 /* add to quota, reject if would overrun */ #define KEY_ALLOC_QUOTA_OVERRUN 0x0001 /* add to quota, permit even if overrun */ #define KEY_ALLOC_NOT_IN_QUOTA 0x0002 /* not in quota */ |
1da177e4c Linux-2.6.12-rc2 |
192 193 194 195 196 197 198 199 200 |
extern void key_revoke(struct key *key); extern void key_put(struct key *key); static inline struct key *key_get(struct key *key) { if (key) atomic_inc(&key->usage); return key; } |
664cceb00 [PATCH] Keys: Add... |
201 202 203 204 |
static inline void key_ref_put(key_ref_t key_ref) { key_put(key_ref_to_ptr(key_ref)); } |
1da177e4c Linux-2.6.12-rc2 |
205 206 207 |
extern struct key *request_key(struct key_type *type, const char *description, const char *callout_info); |
4e54f0854 [PATCH] Keys: All... |
208 209 |
extern struct key *request_key_with_auxdata(struct key_type *type, const char *description, |
4a38e122e keys: allow the c... |
210 211 |
const void *callout_info, size_t callout_len, |
4e54f0854 [PATCH] Keys: All... |
212 |
void *aux); |
76181c134 KEYS: Make reques... |
213 214 |
extern struct key *request_key_async(struct key_type *type, const char *description, |
4a38e122e keys: allow the c... |
215 216 |
const void *callout_info, size_t callout_len); |
76181c134 KEYS: Make reques... |
217 218 219 |
extern struct key *request_key_async_with_auxdata(struct key_type *type, const char *description, |
4a38e122e keys: allow the c... |
220 221 |
const void *callout_info, size_t callout_len, |
76181c134 KEYS: Make reques... |
222 223 224 |
void *aux); extern int wait_for_key_construction(struct key *key, bool intr); |
1da177e4c Linux-2.6.12-rc2 |
225 |
extern int key_validate(struct key *key); |
664cceb00 [PATCH] Keys: Add... |
226 227 228 229 230 |
extern key_ref_t key_create_or_update(key_ref_t keyring, const char *type, const char *description, const void *payload, size_t plen, |
6b79ccb51 keys: allow clien... |
231 |
key_perm_t perm, |
7e047ef5f [PATCH] keys: sor... |
232 |
unsigned long flags); |
1da177e4c Linux-2.6.12-rc2 |
233 |
|
664cceb00 [PATCH] Keys: Add... |
234 |
extern int key_update(key_ref_t key, |
1da177e4c Linux-2.6.12-rc2 |
235 236 237 238 239 240 241 242 243 244 |
const void *payload, size_t plen); extern int key_link(struct key *keyring, struct key *key); extern int key_unlink(struct key *keyring, struct key *key); extern struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid, |
d84f4f992 CRED: Inaugurate ... |
245 |
const struct cred *cred, |
7e047ef5f [PATCH] keys: sor... |
246 |
unsigned long flags, |
d720024e9 [PATCH] selinux: ... |
247 |
struct key *dest); |
1da177e4c Linux-2.6.12-rc2 |
248 249 |
extern int keyring_clear(struct key *keyring); |
664cceb00 [PATCH] Keys: Add... |
250 251 252 |
extern key_ref_t keyring_search(key_ref_t keyring, struct key_type *type, const char *description); |
1da177e4c Linux-2.6.12-rc2 |
253 |
|
1da177e4c Linux-2.6.12-rc2 |
254 255 256 257 |
extern int keyring_add_key(struct key *keyring, struct key *key); extern struct key *key_lookup(key_serial_t id); |
7249db2c2 keys: make key_se... |
258 259 260 261 |
static inline key_serial_t key_serial(struct key *key) { return key ? key->serial : 0; } |
1da177e4c Linux-2.6.12-rc2 |
262 |
|
0b77f5bfb keys: make the ke... |
263 264 265 |
#ifdef CONFIG_SYSCTL extern ctl_table key_sysctls[]; #endif |
ee18d64c1 KEYS: Add a keyct... |
266 |
extern void key_replace_session_keyring(void); |
1da177e4c Linux-2.6.12-rc2 |
267 268 269 |
/* * the userspace interface */ |
d84f4f992 CRED: Inaugurate ... |
270 |
extern int install_thread_keyring_to_cred(struct cred *cred); |
1da177e4c Linux-2.6.12-rc2 |
271 272 273 274 275 276 277 278 |
extern void key_fsuid_changed(struct task_struct *tsk); extern void key_fsgid_changed(struct task_struct *tsk); extern void key_init(void); #else /* CONFIG_KEYS */ #define key_validate(k) 0 #define key_serial(k) 0 |
7888e7ff4 [PATCH] Keys: Pas... |
279 |
#define key_get(k) ({ NULL; }) |
0dab9cfa1 add key_revoke() ... |
280 |
#define key_revoke(k) do { } while(0) |
1da177e4c Linux-2.6.12-rc2 |
281 |
#define key_put(k) do { } while(0) |
664cceb00 [PATCH] Keys: Add... |
282 |
#define key_ref_put(k) do { } while(0) |
8bbf4976b KEYS: Alter use o... |
283 284 |
#define make_key_ref(k, p) NULL #define key_ref_to_ptr(k) NULL |
664cceb00 [PATCH] Keys: Add... |
285 |
#define is_key_possessed(k) 0 |
1da177e4c Linux-2.6.12-rc2 |
286 287 288 |
#define key_fsuid_changed(t) do { } while(0) #define key_fsgid_changed(t) do { } while(0) #define key_init() do { } while(0) |
ee18d64c1 KEYS: Add a keyct... |
289 |
#define key_replace_session_keyring() do { } while(0) |
1da177e4c Linux-2.6.12-rc2 |
290 291 292 293 |
#endif /* CONFIG_KEYS */ #endif /* __KERNEL__ */ #endif /* _LINUX_KEY_H */ |