blob: a705a7d92ad7a95ca513ae2d3da8a18879196a2a [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>
Oleg Nesterov413cd3d2012-05-11 10:59:08 +100017#include <linux/task_work.h>
Mat Martineauddbb4112016-04-12 19:54:58 +010018#include <linux/keyctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
Kent Overstreeta27bb332013-05-07 16:19:08 -070020struct iovec;
21
David Howells76181c12007-10-16 23:29:46 -070022#ifdef __KDEBUG
23#define kenter(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110024 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070025#define kleave(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110026 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070027#define kdebug(FMT, ...) \
David Howellsd84f4f92008-11-14 10:39:23 +110028 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
David Howells3e301482005-06-23 22:00:56 -070029#else
David Howells76181c12007-10-16 23:29:46 -070030#define kenter(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110031 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070032#define kleave(FMT, ...) \
Harvey Harrisondd6f9532008-03-06 10:03:59 +110033 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
David Howells76181c12007-10-16 23:29:46 -070034#define kdebug(FMT, ...) \
35 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
David Howells3e301482005-06-23 22:00:56 -070036#endif
37
David Howells0c061b52011-08-22 14:09:36 +010038extern struct key_type key_type_dead;
Linus Torvalds1da177e2005-04-16 15:20:36 -070039extern struct key_type key_type_user;
Jeff Layton9f6ed2c2012-01-17 16:09:11 -050040extern struct key_type key_type_logon;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
42/*****************************************************************************/
43/*
David Howells973c9f42011-01-20 16:38:33 +000044 * Keep track of keys for a user.
45 *
46 * This needs to be separate to user_struct to avoid a refcount-loop
47 * (user_struct pins some keyrings which pin this struct).
48 *
49 * We also keep track of keys under request from userspace for this UID here.
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 */
51struct key_user {
52 struct rb_node node;
David Howells76181c12007-10-16 23:29:46 -070053 struct mutex cons_lock; /* construction initiation lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 spinlock_t lock;
55 atomic_t usage; /* for accessing qnkeys & qnbytes */
56 atomic_t nkeys; /* number of keys */
57 atomic_t nikeys; /* number of instantiated keys */
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080058 kuid_t uid;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 int qnkeys; /* number of keys allocated to this user */
60 int qnbytes; /* number of bytes allocated to this user */
61};
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063extern struct rb_root key_user_tree;
64extern spinlock_t key_user_lock;
65extern struct key_user root_key_user;
66
Eric W. Biederman9a56c2d2012-02-08 07:53:04 -080067extern struct key_user *key_user_lookup(kuid_t uid);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068extern void key_user_put(struct key_user *user);
69
David Howells0b77f5b2008-04-29 01:01:32 -070070/*
David Howells973c9f42011-01-20 16:38:33 +000071 * Key quota limits.
David Howells0b77f5b2008-04-29 01:01:32 -070072 * - root has its own separate limits to everyone else
73 */
74extern unsigned key_quota_root_maxkeys;
75extern unsigned key_quota_root_maxbytes;
76extern unsigned key_quota_maxkeys;
77extern unsigned key_quota_maxbytes;
78
79#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81
David Howells8bc16de2011-08-22 14:09:11 +010082extern struct kmem_cache *key_jar;
Linus Torvalds1da177e2005-04-16 15:20:36 -070083extern struct rb_root key_serial_tree;
84extern spinlock_t key_serial_lock;
David Howells76181c12007-10-16 23:29:46 -070085extern struct mutex key_construction_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086extern wait_queue_head_t request_key_conswq;
87
88
David Howellse9e349b2008-11-14 10:39:13 +110089extern struct key_type *key_type_lookup(const char *type);
90extern void key_type_put(struct key_type *ktype);
91
David Howellsf70e2e02010-04-30 14:32:39 +010092extern int __key_link_begin(struct key *keyring,
David Howells16feef42013-09-24 10:35:15 +010093 const struct keyring_index_key *index_key,
David Howellsb2a4df22013-09-24 10:35:18 +010094 struct assoc_array_edit **_edit);
David Howellsf70e2e02010-04-30 14:32:39 +010095extern int __key_link_check_live_key(struct key *keyring, struct key *key);
David Howellsb2a4df22013-09-24 10:35:18 +010096extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
David Howellsf70e2e02010-04-30 14:32:39 +010097extern void __key_link_end(struct key *keyring,
David Howells16feef42013-09-24 10:35:15 +010098 const struct keyring_index_key *index_key,
David Howellsb2a4df22013-09-24 10:35:18 +010099 struct assoc_array_edit *edit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
David Howellsb2a4df22013-09-24 10:35:18 +0100101extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
102 const struct keyring_index_key *index_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
David Howells3e301482005-06-23 22:00:56 -0700104extern struct key *keyring_search_instkey(struct key *keyring,
105 key_serial_t target_id);
106
David Howellsb2a4df22013-09-24 10:35:18 +0100107extern int iterate_over_keyring(const struct key *keyring,
108 int (*func)(const struct key *key, void *data),
109 void *data);
110
David Howells4bdf0bc2013-09-24 10:35:15 +0100111struct keyring_search_context {
112 struct keyring_index_key index_key;
113 const struct cred *cred;
David Howells46291952014-09-16 17:36:02 +0100114 struct key_match_data match_data;
David Howells4bdf0bc2013-09-24 10:35:15 +0100115 unsigned flags;
David Howells614d8c32014-09-16 17:36:04 +0100116#define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */
117#define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */
118#define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */
119#define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */
120#define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */
David Howells0b0a8412014-12-01 22:52:53 +0000121#define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
David Howellsb2a4df22013-09-24 10:35:18 +0100123 int (*iterator)(const void *object, void *iterator_data);
124
David Howells4bdf0bc2013-09-24 10:35:15 +0100125 /* Internal stuff */
126 int skipped_ret;
127 bool possessed;
128 key_ref_t result;
129 struct timespec now;
130};
131
David Howells0c903ab2014-09-16 17:36:08 +0100132extern bool key_default_cmp(const struct key *key,
133 const struct key_match_data *match_data);
David Howells4bdf0bc2013-09-24 10:35:15 +0100134extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
135 struct keyring_search_context *ctx);
136
137extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx);
138extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
David Howells69664cf2008-04-29 01:01:31 -0700140extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
David Howells8bbf49762008-11-14 10:39:14 +1100142extern int install_user_keyrings(void);
David Howellsd84f4f92008-11-14 10:39:23 +1100143extern int install_thread_keyring_to_cred(struct cred *);
144extern int install_process_keyring_to_cred(struct cred *);
Oleg Nesterov685bfd22010-05-26 14:43:00 -0700145extern int install_session_keyring_to_cred(struct cred *, struct key *);
David Howells3e301482005-06-23 22:00:56 -0700146
147extern struct key *request_key_and_link(struct key_type *type,
148 const char *description,
David Howells4a38e122008-04-29 01:01:24 -0700149 const void *callout_info,
150 size_t callout_len,
David Howells4e54f082006-06-29 02:24:28 -0700151 void *aux,
David Howells7e047ef2006-06-26 00:24:50 -0700152 struct key *dest_keyring,
153 unsigned long flags);
David Howells3e301482005-06-23 22:00:56 -0700154
David Howells0c903ab2014-09-16 17:36:08 +0100155extern bool lookup_user_key_possessed(const struct key *key,
156 const struct key_match_data *match_data);
David Howells55931222009-09-02 09:13:45 +0100157extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
David Howellse9e349b2008-11-14 10:39:13 +1100158 key_perm_t perm);
David Howells55931222009-09-02 09:13:45 +0100159#define KEY_LOOKUP_CREATE 0x01
160#define KEY_LOOKUP_PARTIAL 0x02
161#define KEY_LOOKUP_FOR_UNLINK 0x04
David Howellse9e349b2008-11-14 10:39:13 +1100162
163extern long join_session_keyring(const char *name);
Al Viro67d12142012-06-27 11:07:19 +0400164extern void key_change_session_keyring(struct callback_head *twork);
David Howellse9e349b2008-11-14 10:39:13 +1100165
David Howells0c061b52011-08-22 14:09:36 +0100166extern struct work_struct key_gc_work;
David Howells5d135442009-09-02 09:14:00 +0100167extern unsigned key_gc_delay;
168extern void keyring_gc(struct key *keyring, time_t limit);
David Howellsfd758152012-05-11 10:56:56 +0100169extern void key_schedule_gc(time_t gc_at);
170extern void key_schedule_gc_links(void);
David Howells0c061b52011-08-22 14:09:36 +0100171extern void key_gc_keytype(struct key_type *ktype);
David Howells5d135442009-09-02 09:14:00 +0100172
David Howellse9e349b2008-11-14 10:39:13 +1100173extern int key_task_permission(const key_ref_t key_ref,
David Howellsd84f4f92008-11-14 10:39:23 +1100174 const struct cred *cred,
David Howellse9e349b2008-11-14 10:39:13 +1100175 key_perm_t perm);
176
David Howells973c9f42011-01-20 16:38:33 +0000177/*
178 * Check to see whether permission is granted to use a key in the desired way.
179 */
David Howellsf5895942014-03-14 17:44:49 +0000180static inline int key_permission(const key_ref_t key_ref, unsigned perm)
David Howellse9e349b2008-11-14 10:39:13 +1100181{
David Howellsd84f4f92008-11-14 10:39:23 +1100182 return key_task_permission(key_ref, current_cred(), perm);
David Howellse9e349b2008-11-14 10:39:13 +1100183}
184
David Howells3e301482005-06-23 22:00:56 -0700185/*
David Howells973c9f42011-01-20 16:38:33 +0000186 * Authorisation record for request_key().
David Howells3e301482005-06-23 22:00:56 -0700187 */
188struct request_key_auth {
189 struct key *target_key;
David Howells8bbf49762008-11-14 10:39:14 +1100190 struct key *dest_keyring;
David Howellsd84f4f92008-11-14 10:39:23 +1100191 const struct cred *cred;
David Howells4a38e122008-04-29 01:01:24 -0700192 void *callout_info;
193 size_t callout_len;
David Howells3e301482005-06-23 22:00:56 -0700194 pid_t pid;
195};
196
197extern struct key_type key_type_request_key_auth;
198extern struct key *request_key_auth_new(struct key *target,
David Howells4a38e122008-04-29 01:01:24 -0700199 const void *callout_info,
David Howells8bbf49762008-11-14 10:39:14 +1100200 size_t callout_len,
201 struct key *dest_keyring);
David Howells3e301482005-06-23 22:00:56 -0700202
203extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205/*
David Howellsfd758152012-05-11 10:56:56 +0100206 * Determine whether a key is dead.
207 */
David Howells7e55ca62013-09-24 10:35:14 +0100208static inline bool key_is_dead(const struct key *key, time_t limit)
David Howellsfd758152012-05-11 10:56:56 +0100209{
210 return
211 key->flags & ((1 << KEY_FLAG_DEAD) |
212 (1 << KEY_FLAG_INVALIDATED)) ||
213 (key->expiry > 0 && key->expiry <= limit);
214}
215
216/*
David Howells973c9f42011-01-20 16:38:33 +0000217 * keyctl() functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 */
219extern long keyctl_get_keyring_ID(key_serial_t, int);
220extern long keyctl_join_session_keyring(const char __user *);
221extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
222extern long keyctl_revoke_key(key_serial_t);
223extern long keyctl_keyring_clear(key_serial_t);
224extern long keyctl_keyring_link(key_serial_t, key_serial_t);
225extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
226extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
227extern long keyctl_keyring_search(key_serial_t, const char __user *,
228 const char __user *, key_serial_t);
229extern long keyctl_read_key(key_serial_t, char __user *, size_t);
230extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
231extern long keyctl_setperm_key(key_serial_t, key_perm_t);
232extern long keyctl_instantiate_key(key_serial_t, const void __user *,
233 size_t, key_serial_t);
234extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
David Howells3e301482005-06-23 22:00:56 -0700235extern long keyctl_set_reqkey_keyring(int);
David Howells017679c2006-01-08 01:02:43 -0800236extern long keyctl_set_timeout(key_serial_t, unsigned);
David Howellsb5f545c2006-01-08 01:02:47 -0800237extern long keyctl_assume_authority(key_serial_t);
David Howells70a5bb72008-04-29 01:01:26 -0700238extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
239 size_t buflen);
David Howellsee18d642009-09-02 09:14:21 +0100240extern long keyctl_session_to_parent(void);
David Howellsfdd1b942011-03-07 15:06:09 +0000241extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
David Howellsee009e4a02011-03-07 15:06:20 +0000242extern long keyctl_instantiate_key_iov(key_serial_t,
243 const struct iovec __user *,
244 unsigned, key_serial_t);
David Howellsfd758152012-05-11 10:56:56 +0100245extern long keyctl_invalidate_key(key_serial_t);
David Howellsee009e4a02011-03-07 15:06:20 +0000246
Al Virob353a1f2015-03-17 09:59:38 -0400247struct iov_iter;
David Howellsee009e4a02011-03-07 15:06:20 +0000248extern long keyctl_instantiate_key_common(key_serial_t,
Al Virob353a1f2015-03-17 09:59:38 -0400249 struct iov_iter *,
250 key_serial_t);
David Howellsf36f8c72013-09-24 10:35:19 +0100251#ifdef CONFIG_PERSISTENT_KEYRINGS
252extern long keyctl_get_persistent(uid_t, key_serial_t);
253extern unsigned persistent_keyring_expiry;
254#else
255static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
256{
257 return -EOPNOTSUPP;
258}
259#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
Mat Martineauddbb4112016-04-12 19:54:58 +0100261#ifdef CONFIG_KEY_DH_OPERATIONS
262extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
Stephan Mueller4693fc72016-05-26 23:38:12 +0200263 size_t, void __user *);
Mat Martineauddbb4112016-04-12 19:54:58 +0100264#else
265static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
Stephan Mueller4693fc72016-05-26 23:38:12 +0200266 char __user *buffer, size_t buflen,
267 void __user *reserved)
Mat Martineauddbb4112016-04-12 19:54:58 +0100268{
269 return -EOPNOTSUPP;
270}
271#endif
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273/*
David Howells973c9f42011-01-20 16:38:33 +0000274 * Debugging key validation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 */
276#ifdef KEY_DEBUGGING
277extern void __key_check(const struct key *);
278
279static inline void key_check(const struct key *key)
280{
281 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
282 __key_check(key);
283}
284
285#else
286
287#define key_check(key) do {} while(0)
288
289#endif
290
291#endif /* _INTERNAL_H */