blob: 65647f825584becdfa1db48302be9ba5e33df88e [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
David Howells0c061b52011-08-22 14:09:36 +010034extern struct key_type key_type_dead;
Linus Torvalds1da177e2005-04-16 15:20:36 -070035extern struct key_type key_type_user;
Jeff Layton9f6ed2c2012-01-17 16:09:11 -050036extern struct key_type key_type_logon;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38/*****************************************************************************/
39/*
David Howells973c9f42011-01-20 16:38:33 +000040 * Keep track of keys for a user.
41 *
42 * This needs to be separate to user_struct to avoid a refcount-loop
43 * (user_struct pins some keyrings which pin this struct).
44 *
45 * We also keep track of keys under request from userspace for this UID here.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 */
47struct key_user {
48 struct rb_node node;
David Howells76181c12007-10-16 23:29:46 -070049 struct mutex cons_lock; /* construction initiation lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 spinlock_t lock;
51 atomic_t usage; /* for accessing qnkeys & qnbytes */
52 atomic_t nkeys; /* number of keys */
53 atomic_t nikeys; /* number of instantiated keys */
54 uid_t uid;
Serge E. Hallyn1d1e9752009-02-26 18:27:38 -060055 struct user_namespace *user_ns;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 int qnkeys; /* number of keys allocated to this user */
57 int qnbytes; /* number of bytes allocated to this user */
58};
59
Linus Torvalds1da177e2005-04-16 15:20:36 -070060extern struct rb_root key_user_tree;
61extern spinlock_t key_user_lock;
62extern struct key_user root_key_user;
63
Serge E. Hallyn1d1e9752009-02-26 18:27:38 -060064extern struct key_user *key_user_lookup(uid_t uid,
65 struct user_namespace *user_ns);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066extern void key_user_put(struct key_user *user);
67
David Howells0b77f5b2008-04-29 01:01:32 -070068/*
David Howells973c9f42011-01-20 16:38:33 +000069 * Key quota limits.
David Howells0b77f5b2008-04-29 01:01:32 -070070 * - root has its own separate limits to everyone else
71 */
72extern unsigned key_quota_root_maxkeys;
73extern unsigned key_quota_root_maxbytes;
74extern unsigned key_quota_maxkeys;
75extern unsigned key_quota_maxbytes;
76
77#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79
David Howells8bc16de2011-08-22 14:09:11 +010080extern struct kmem_cache *key_jar;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081extern struct rb_root key_serial_tree;
82extern spinlock_t key_serial_lock;
David Howells76181c12007-10-16 23:29:46 -070083extern struct mutex key_construction_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084extern wait_queue_head_t request_key_conswq;
85
86
David Howellse9e349b2008-11-14 10:39:13 +110087extern struct key_type *key_type_lookup(const char *type);
88extern void key_type_put(struct key_type *ktype);
89
David Howellsf70e2e02010-04-30 14:32:39 +010090extern int __key_link_begin(struct key *keyring,
91 const struct key_type *type,
92 const char *description,
David Howellsceb73c12011-01-25 16:34:28 +000093 unsigned long *_prealloc);
David Howellsf70e2e02010-04-30 14:32:39 +010094extern int __key_link_check_live_key(struct key *keyring, struct key *key);
95extern void __key_link(struct key *keyring, struct key *key,
David Howellsceb73c12011-01-25 16:34:28 +000096 unsigned long *_prealloc);
David Howellsf70e2e02010-04-30 14:32:39 +010097extern void __key_link_end(struct key *keyring,
98 struct key_type *type,
David Howellsceb73c12011-01-25 16:34:28 +000099 unsigned long prealloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
David Howells664cceb2005-09-28 17:03:15 +0100101extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
102 const struct key_type *type,
103 const char *description,
104 key_perm_t perm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
David Howells3e301482005-06-23 22:00:56 -0700106extern struct key *keyring_search_instkey(struct key *keyring,
107 key_serial_t target_id);
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109typedef int (*key_match_func_t)(const struct key *, const void *);
110
David Howells664cceb2005-09-28 17:03:15 +0100111extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
David Howellsd84f4f92008-11-14 10:39:23 +1100112 const struct cred *cred,
David Howells664cceb2005-09-28 17:03:15 +0100113 struct key_type *type,
114 const void *description,
David Howells78b72802011-03-11 17:57:23 +0000115 key_match_func_t match,
116 bool no_state_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
David Howells927942a2010-06-11 17:31:10 +0100118extern key_ref_t search_my_process_keyrings(struct key_type *type,
119 const void *description,
120 key_match_func_t match,
David Howells78b72802011-03-11 17:57:23 +0000121 bool no_state_check,
David Howells927942a2010-06-11 17:31:10 +0100122 const struct cred *cred);
David Howells664cceb2005-09-28 17:03:15 +0100123extern key_ref_t search_process_keyrings(struct key_type *type,
124 const void *description,
125 key_match_func_t match,
David Howellsd84f4f92008-11-14 10:39:23 +1100126 const struct cred *cred);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
David Howells69664cf2008-04-29 01:01:31 -0700128extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
David Howells8bbf49762008-11-14 10:39:14 +1100130extern int install_user_keyrings(void);
David Howellsd84f4f92008-11-14 10:39:23 +1100131extern int install_thread_keyring_to_cred(struct cred *);
132extern int install_process_keyring_to_cred(struct cred *);
Oleg Nesterov685bfd22010-05-26 14:43:00 -0700133extern int install_session_keyring_to_cred(struct cred *, struct key *);
David Howells3e301482005-06-23 22:00:56 -0700134
135extern struct key *request_key_and_link(struct key_type *type,
136 const char *description,
David Howells4a38e122008-04-29 01:01:24 -0700137 const void *callout_info,
138 size_t callout_len,
David Howells4e54f082006-06-29 02:24:28 -0700139 void *aux,
David Howells7e047ef2006-06-26 00:24:50 -0700140 struct key *dest_keyring,
141 unsigned long flags);
David Howells3e301482005-06-23 22:00:56 -0700142
David Howells927942a2010-06-11 17:31:10 +0100143extern int lookup_user_key_possessed(const struct key *key, const void *target);
David Howells55931222009-09-02 09:13:45 +0100144extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
David Howellse9e349b2008-11-14 10:39:13 +1100145 key_perm_t perm);
David Howells55931222009-09-02 09:13:45 +0100146#define KEY_LOOKUP_CREATE 0x01
147#define KEY_LOOKUP_PARTIAL 0x02
148#define KEY_LOOKUP_FOR_UNLINK 0x04
David Howellse9e349b2008-11-14 10:39:13 +1100149
150extern long join_session_keyring(const char *name);
151
David Howells0c061b52011-08-22 14:09:36 +0100152extern struct work_struct key_gc_work;
David Howells5d135442009-09-02 09:14:00 +0100153extern unsigned key_gc_delay;
154extern void keyring_gc(struct key *keyring, time_t limit);
155extern void key_schedule_gc(time_t expiry_at);
David Howells0c061b52011-08-22 14:09:36 +0100156extern void key_gc_keytype(struct key_type *ktype);
David Howells5d135442009-09-02 09:14:00 +0100157
David Howellse9e349b2008-11-14 10:39:13 +1100158extern int key_task_permission(const key_ref_t key_ref,
David Howellsd84f4f92008-11-14 10:39:23 +1100159 const struct cred *cred,
David Howellse9e349b2008-11-14 10:39:13 +1100160 key_perm_t perm);
161
David Howells973c9f42011-01-20 16:38:33 +0000162/*
163 * Check to see whether permission is granted to use a key in the desired way.
164 */
David Howellse9e349b2008-11-14 10:39:13 +1100165static inline int key_permission(const key_ref_t key_ref, key_perm_t perm)
166{
David Howellsd84f4f92008-11-14 10:39:23 +1100167 return key_task_permission(key_ref, current_cred(), perm);
David Howellse9e349b2008-11-14 10:39:13 +1100168}
169
170/* required permissions */
171#define KEY_VIEW 0x01 /* require permission to view attributes */
172#define KEY_READ 0x02 /* require permission to read content */
173#define KEY_WRITE 0x04 /* require permission to update / modify */
174#define KEY_SEARCH 0x08 /* require permission to search (keyring) or find (key) */
175#define KEY_LINK 0x10 /* require permission to link */
176#define KEY_SETATTR 0x20 /* require permission to change attributes */
177#define KEY_ALL 0x3f /* all the above permissions */
178
David Howells3e301482005-06-23 22:00:56 -0700179/*
David Howells973c9f42011-01-20 16:38:33 +0000180 * Authorisation record for request_key().
David Howells3e301482005-06-23 22:00:56 -0700181 */
182struct request_key_auth {
183 struct key *target_key;
David Howells8bbf49762008-11-14 10:39:14 +1100184 struct key *dest_keyring;
David Howellsd84f4f92008-11-14 10:39:23 +1100185 const struct cred *cred;
David Howells4a38e122008-04-29 01:01:24 -0700186 void *callout_info;
187 size_t callout_len;
David Howells3e301482005-06-23 22:00:56 -0700188 pid_t pid;
189};
190
191extern struct key_type key_type_request_key_auth;
192extern struct key *request_key_auth_new(struct key *target,
David Howells4a38e122008-04-29 01:01:24 -0700193 const void *callout_info,
David Howells8bbf49762008-11-14 10:39:14 +1100194 size_t callout_len,
195 struct key *dest_keyring);
David Howells3e301482005-06-23 22:00:56 -0700196
197extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199/*
David Howells973c9f42011-01-20 16:38:33 +0000200 * keyctl() functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
202extern long keyctl_get_keyring_ID(key_serial_t, int);
203extern long keyctl_join_session_keyring(const char __user *);
204extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
205extern long keyctl_revoke_key(key_serial_t);
206extern long keyctl_keyring_clear(key_serial_t);
207extern long keyctl_keyring_link(key_serial_t, key_serial_t);
208extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
209extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
210extern long keyctl_keyring_search(key_serial_t, const char __user *,
211 const char __user *, key_serial_t);
212extern long keyctl_read_key(key_serial_t, char __user *, size_t);
213extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
214extern long keyctl_setperm_key(key_serial_t, key_perm_t);
215extern long keyctl_instantiate_key(key_serial_t, const void __user *,
216 size_t, key_serial_t);
217extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
David Howells3e301482005-06-23 22:00:56 -0700218extern long keyctl_set_reqkey_keyring(int);
David Howells017679c2006-01-08 01:02:43 -0800219extern long keyctl_set_timeout(key_serial_t, unsigned);
David Howellsb5f545c2006-01-08 01:02:47 -0800220extern long keyctl_assume_authority(key_serial_t);
David Howells70a5bb72008-04-29 01:01:26 -0700221extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
222 size_t buflen);
David Howellsee18d642009-09-02 09:14:21 +0100223extern long keyctl_session_to_parent(void);
David Howellsfdd1b942011-03-07 15:06:09 +0000224extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
David Howellsee009e4a02011-03-07 15:06:20 +0000225extern long keyctl_instantiate_key_iov(key_serial_t,
226 const struct iovec __user *,
227 unsigned, key_serial_t);
228
229extern long keyctl_instantiate_key_common(key_serial_t,
230 const struct iovec __user *,
231 unsigned, size_t, key_serial_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233/*
David Howells973c9f42011-01-20 16:38:33 +0000234 * Debugging key validation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 */
236#ifdef KEY_DEBUGGING
237extern void __key_check(const struct key *);
238
239static inline void key_check(const struct key *key)
240{
241 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
242 __key_check(key);
243}
244
245#else
246
247#define key_check(key) do {} while(0)
248
249#endif
250
251#endif /* _INTERNAL_H */