blob: 07a025f8190233faf66a384816dea03754ee770a [file] [log] [blame]
David Howells973c9f42011-01-20 16:38:33 +00001/* Authentication token and access key management internal defs
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 *
David Howells76181c12007-10-16 23:29:46 -07003 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * 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
David Howellsd84f4f92008-11-14 10:39:23 +110015#include <linux/sched.h>
David Howells76181c12007-10-16 23:29:46 -070016#include <linux/key-type.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
David Howells76181c12007-10-16 23:29:46 -070018#ifdef __KDEBUG
19#define kenter(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110020 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070021#define kleave(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110022 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070023#define kdebug(FMT, ...) \
David Howellsd84f4f92008-11-14 10:39:23 +110024 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
David Howells3e301482005-06-23 22:00:56 -070025#else
David Howells76181c12007-10-16 23:29:46 -070026#define kenter(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110027 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070028#define kleave(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110029 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070030#define kdebug(FMT, ...) \
31 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
David Howells3e301482005-06-23 22:00:56 -070032#endif
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034extern struct key_type key_type_user;
35
36/*****************************************************************************/
37/*
David Howells973c9f42011-01-20 16:38:33 +000038 * Keep track of keys for a user.
39 *
40 * This needs to be separate to user_struct to avoid a refcount-loop
41 * (user_struct pins some keyrings which pin this struct).
42 *
43 * We also keep track of keys under request from userspace for this UID here.
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 */
45struct key_user {
46 struct rb_node node;
David Howells76181c12007-10-16 23:29:46 -070047 struct mutex cons_lock; /* construction initiation lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 spinlock_t lock;
49 atomic_t usage; /* for accessing qnkeys & qnbytes */
50 atomic_t nkeys; /* number of keys */
51 atomic_t nikeys; /* number of instantiated keys */
52 uid_t uid;
Serge E. Hallyn1d1e9752009-02-26 18:27:38 -060053 struct user_namespace *user_ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 int qnkeys; /* number of keys allocated to this user */
55 int qnbytes; /* number of bytes allocated to this user */
56};
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058extern struct rb_root key_user_tree;
59extern spinlock_t key_user_lock;
60extern struct key_user root_key_user;
61
Serge E. Hallyn1d1e9752009-02-26 18:27:38 -060062extern struct key_user *key_user_lookup(uid_t uid,
63 struct user_namespace *user_ns);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064extern void key_user_put(struct key_user *user);
65
David Howells0b77f5b2008-04-29 01:01:32 -070066/*
David Howells973c9f42011-01-20 16:38:33 +000067 * Key quota limits.
David Howells0b77f5b2008-04-29 01:01:32 -070068 * - root has its own separate limits to everyone else
69 */
70extern unsigned key_quota_root_maxkeys;
71extern unsigned key_quota_root_maxbytes;
72extern unsigned key_quota_maxkeys;
73extern unsigned key_quota_maxbytes;
74
75#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77
78extern struct rb_root key_serial_tree;
79extern spinlock_t key_serial_lock;
David Howells76181c12007-10-16 23:29:46 -070080extern struct mutex key_construction_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081extern wait_queue_head_t request_key_conswq;
82
83
David Howellse9e349b2008-11-14 10:39:13 +110084extern struct key_type *key_type_lookup(const char *type);
85extern void key_type_put(struct key_type *ktype);
86
David Howellsf70e2e02010-04-30 14:32:39 +010087extern int __key_link_begin(struct key *keyring,
88 const struct key_type *type,
89 const char *description,
David Howellsceb73c12011-01-25 16:34:28 +000090 unsigned long *_prealloc);
David Howellsf70e2e02010-04-30 14:32:39 +010091extern int __key_link_check_live_key(struct key *keyring, struct key *key);
92extern void __key_link(struct key *keyring, struct key *key,
David Howellsceb73c12011-01-25 16:34:28 +000093 unsigned long *_prealloc);
David Howellsf70e2e02010-04-30 14:32:39 +010094extern void __key_link_end(struct key *keyring,
95 struct key_type *type,
David Howellsceb73c12011-01-25 16:34:28 +000096 unsigned long prealloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
David Howells664cceb2005-09-28 17:03:15 +010098extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
99 const struct key_type *type,
100 const char *description,
101 key_perm_t perm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
David Howells3e301482005-06-23 22:00:56 -0700103extern struct key *keyring_search_instkey(struct key *keyring,
104 key_serial_t target_id);
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106typedef int (*key_match_func_t)(const struct key *, const void *);
107
David Howells664cceb2005-09-28 17:03:15 +0100108extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
David Howellsd84f4f92008-11-14 10:39:23 +1100109 const struct cred *cred,
David Howells664cceb2005-09-28 17:03:15 +0100110 struct key_type *type,
111 const void *description,
112 key_match_func_t match);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
David Howells927942a2010-06-11 17:31:10 +0100114extern key_ref_t search_my_process_keyrings(struct key_type *type,
115 const void *description,
116 key_match_func_t match,
117 const struct cred *cred);
David Howells664cceb2005-09-28 17:03:15 +0100118extern key_ref_t search_process_keyrings(struct key_type *type,
119 const void *description,
120 key_match_func_t match,
David Howellsd84f4f92008-11-14 10:39:23 +1100121 const struct cred *cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
David Howells69664cf2008-04-29 01:01:31 -0700123extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
David Howells8bbf49762008-11-14 10:39:14 +1100125extern int install_user_keyrings(void);
David Howellsd84f4f92008-11-14 10:39:23 +1100126extern int install_thread_keyring_to_cred(struct cred *);
127extern int install_process_keyring_to_cred(struct cred *);
Oleg Nesterov685bfd22010-05-26 14:43:00 -0700128extern int install_session_keyring_to_cred(struct cred *, struct key *);
David Howells3e301482005-06-23 22:00:56 -0700129
130extern struct key *request_key_and_link(struct key_type *type,
131 const char *description,
David Howells4a38e122008-04-29 01:01:24 -0700132 const void *callout_info,
133 size_t callout_len,
David Howells4e54f082006-06-29 02:24:28 -0700134 void *aux,
David Howells7e047ef2006-06-26 00:24:50 -0700135 struct key *dest_keyring,
136 unsigned long flags);
David Howells3e301482005-06-23 22:00:56 -0700137
David Howells927942a2010-06-11 17:31:10 +0100138extern int lookup_user_key_possessed(const struct key *key, const void *target);
David Howells55931222009-09-02 09:13:45 +0100139extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
David Howellse9e349b2008-11-14 10:39:13 +1100140 key_perm_t perm);
David Howells55931222009-09-02 09:13:45 +0100141#define KEY_LOOKUP_CREATE 0x01
142#define KEY_LOOKUP_PARTIAL 0x02
143#define KEY_LOOKUP_FOR_UNLINK 0x04
David Howellse9e349b2008-11-14 10:39:13 +1100144
145extern long join_session_keyring(const char *name);
146
David Howells5d135442009-09-02 09:14:00 +0100147extern unsigned key_gc_delay;
148extern void keyring_gc(struct key *keyring, time_t limit);
149extern void key_schedule_gc(time_t expiry_at);
150
David Howellse9e349b2008-11-14 10:39:13 +1100151extern int key_task_permission(const key_ref_t key_ref,
David Howellsd84f4f92008-11-14 10:39:23 +1100152 const struct cred *cred,
David Howellse9e349b2008-11-14 10:39:13 +1100153 key_perm_t perm);
154
David Howells973c9f42011-01-20 16:38:33 +0000155/*
156 * Check to see whether permission is granted to use a key in the desired way.
157 */
David Howellse9e349b2008-11-14 10:39:13 +1100158static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
159{
David Howellsd84f4f92008-11-14 10:39:23 +1100160 return key_task_permission(key_ref, current_cred(), perm);
David Howellse9e349b2008-11-14 10:39:13 +1100161}
162
163/* required permissions */
164#define KEY_VIEW 0x01 /* require permission to view attributes */
165#define KEY_READ 0x02 /* require permission to read content */
166#define KEY_WRITE 0x04 /* require permission to update / modify */
167#define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */
168#define KEY_LINK 0x10 /* require permission to link */
169#define KEY_SETATTR 0x20 /* require permission to change attributes */
170#define KEY_ALL 0x3f /* all the above permissions */
171
David Howells3e301482005-06-23 22:00:56 -0700172/*
David Howells973c9f42011-01-20 16:38:33 +0000173 * Authorisation record for request_key().
David Howells3e301482005-06-23 22:00:56 -0700174 */
175struct request_key_auth {
176 struct key *target_key;
David Howells8bbf49762008-11-14 10:39:14 +1100177 struct key *dest_keyring;
David Howellsd84f4f92008-11-14 10:39:23 +1100178 const struct cred *cred;
David Howells4a38e122008-04-29 01:01:24 -0700179 void *callout_info;
180 size_t callout_len;
David Howells3e301482005-06-23 22:00:56 -0700181 pid_t pid;
182};
183
184extern struct key_type key_type_request_key_auth;
185extern struct key *request_key_auth_new(struct key *target,
David Howells4a38e122008-04-29 01:01:24 -0700186 const void *callout_info,
David Howells8bbf49762008-11-14 10:39:14 +1100187 size_t callout_len,
188 struct key *dest_keyring);
David Howells3e301482005-06-23 22:00:56 -0700189
190extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192/*
David Howells973c9f42011-01-20 16:38:33 +0000193 * keyctl() functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
195extern long keyctl_get_keyring_ID(key_serial_t, int);
196extern long keyctl_join_session_keyring(const char __user *);
197extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
198extern long keyctl_revoke_key(key_serial_t);
199extern long keyctl_keyring_clear(key_serial_t);
200extern long keyctl_keyring_link(key_serial_t, key_serial_t);
201extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
202extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
203extern long keyctl_keyring_search(key_serial_t, const char __user *,
204 const char __user *, key_serial_t);
205extern long keyctl_read_key(key_serial_t, char __user *, size_t);
206extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
207extern long keyctl_setperm_key(key_serial_t, key_perm_t);
208extern long keyctl_instantiate_key(key_serial_t, const void __user *,
209 size_t, key_serial_t);
210extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
David Howells3e301482005-06-23 22:00:56 -0700211extern long keyctl_set_reqkey_keyring(int);
David Howells017679c2006-01-08 01:02:43 -0800212extern long keyctl_set_timeout(key_serial_t, unsigned);
David Howellsb5f545c2006-01-08 01:02:47 -0800213extern long keyctl_assume_authority(key_serial_t);
David Howells70a5bb72008-04-29 01:01:26 -0700214extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
215 size_t buflen);
David Howellsee18d642009-09-02 09:14:21 +0100216extern long keyctl_session_to_parent(void);
David Howellsfdd1b942011-03-07 15:06:09 +0000217extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
David Howellsee009e42011-03-07 15:06:20 +0000218extern long keyctl_instantiate_key_iov(key_serial_t,
219 const struct iovec __user *,
220 unsigned, key_serial_t);
221
222extern long keyctl_instantiate_key_common(key_serial_t,
223 const struct iovec __user *,
224 unsigned, size_t, key_serial_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
226/*
David Howells973c9f42011-01-20 16:38:33 +0000227 * Debugging key validation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 */
229#ifdef KEY_DEBUGGING
230extern void __key_check(const struct key *);
231
232static inline void key_check(const struct key *key)
233{
234 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
235 __key_check(key);
236}
237
238#else
239
240#define key_check(key) do {} while(0)
241
242#endif
243
244#endif /* _INTERNAL_H */