]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - security/keys/internal.h
sched/headers: Prepare to remove <linux/cred.h> inclusion from <linux/sched.h>
[mirror_ubuntu-jammy-kernel.git] / security / keys / internal.h
CommitLineData
973c9f4f 1/* Authentication token and access key management internal defs
1da177e4 2 *
76181c13 3 * Copyright (C) 2003-5, 2007 Red Hat, Inc. All Rights Reserved.
1da177e4
LT
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
d84f4f99 15#include <linux/sched.h>
5b825c3a 16#include <linux/cred.h>
76181c13 17#include <linux/key-type.h>
413cd3d9 18#include <linux/task_work.h>
ddbb4114 19#include <linux/keyctl.h>
1da177e4 20
a27bb332
KO
21struct iovec;
22
76181c13
DH
23#ifdef __KDEBUG
24#define kenter(FMT, ...) \
dd6f953a 25 printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13 26#define kleave(FMT, ...) \
dd6f953a 27 printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13 28#define kdebug(FMT, ...) \
d84f4f99 29 printk(KERN_DEBUG " "FMT"\n", ##__VA_ARGS__)
3e30148c 30#else
76181c13 31#define kenter(FMT, ...) \
dd6f953a 32 no_printk(KERN_DEBUG "==> %s("FMT")\n", __func__, ##__VA_ARGS__)
76181c13 33#define kleave(FMT, ...) \
dd6f953a 34 no_printk(KERN_DEBUG "<== %s()"FMT"\n", __func__, ##__VA_ARGS__)
76181c13
DH
35#define kdebug(FMT, ...) \
36 no_printk(KERN_DEBUG FMT"\n", ##__VA_ARGS__)
3e30148c
DH
37#endif
38
0c061b57 39extern struct key_type key_type_dead;
1da177e4 40extern struct key_type key_type_user;
9f6ed2ca 41extern struct key_type key_type_logon;
1da177e4
LT
42
43/*****************************************************************************/
44/*
973c9f4f
DH
45 * Keep track of keys for a user.
46 *
47 * This needs to be separate to user_struct to avoid a refcount-loop
48 * (user_struct pins some keyrings which pin this struct).
49 *
50 * We also keep track of keys under request from userspace for this UID here.
1da177e4
LT
51 */
52struct key_user {
53 struct rb_node node;
76181c13 54 struct mutex cons_lock; /* construction initiation lock */
1da177e4
LT
55 spinlock_t lock;
56 atomic_t usage; /* for accessing qnkeys & qnbytes */
57 atomic_t nkeys; /* number of keys */
58 atomic_t nikeys; /* number of instantiated keys */
9a56c2db 59 kuid_t uid;
1da177e4
LT
60 int qnkeys; /* number of keys allocated to this user */
61 int qnbytes; /* number of bytes allocated to this user */
62};
63
1da177e4
LT
64extern struct rb_root key_user_tree;
65extern spinlock_t key_user_lock;
66extern struct key_user root_key_user;
67
9a56c2db 68extern struct key_user *key_user_lookup(kuid_t uid);
1da177e4
LT
69extern void key_user_put(struct key_user *user);
70
0b77f5bf 71/*
973c9f4f 72 * Key quota limits.
0b77f5bf
DH
73 * - root has its own separate limits to everyone else
74 */
75extern unsigned key_quota_root_maxkeys;
76extern unsigned key_quota_root_maxbytes;
77extern unsigned key_quota_maxkeys;
78extern unsigned key_quota_maxbytes;
79
80#define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
1da177e4
LT
81
82
8bc16dea 83extern struct kmem_cache *key_jar;
1da177e4
LT
84extern struct rb_root key_serial_tree;
85extern spinlock_t key_serial_lock;
76181c13 86extern struct mutex key_construction_mutex;
1da177e4
LT
87extern wait_queue_head_t request_key_conswq;
88
89
e9e349b0
DH
90extern struct key_type *key_type_lookup(const char *type);
91extern void key_type_put(struct key_type *ktype);
92
f70e2e06 93extern int __key_link_begin(struct key *keyring,
16feef43 94 const struct keyring_index_key *index_key,
b2a4df20 95 struct assoc_array_edit **_edit);
f70e2e06 96extern int __key_link_check_live_key(struct key *keyring, struct key *key);
b2a4df20 97extern void __key_link(struct key *key, struct assoc_array_edit **_edit);
f70e2e06 98extern void __key_link_end(struct key *keyring,
16feef43 99 const struct keyring_index_key *index_key,
b2a4df20 100 struct assoc_array_edit *edit);
1da177e4 101
b2a4df20
DH
102extern key_ref_t find_key_to_update(key_ref_t keyring_ref,
103 const struct keyring_index_key *index_key);
1da177e4 104
3e30148c
DH
105extern struct key *keyring_search_instkey(struct key *keyring,
106 key_serial_t target_id);
107
b2a4df20
DH
108extern int iterate_over_keyring(const struct key *keyring,
109 int (*func)(const struct key *key, void *data),
110 void *data);
111
4bdf0bc3
DH
112struct keyring_search_context {
113 struct keyring_index_key index_key;
114 const struct cred *cred;
46291959 115 struct key_match_data match_data;
4bdf0bc3 116 unsigned flags;
614d8c39
DH
117#define KEYRING_SEARCH_NO_STATE_CHECK 0x0001 /* Skip state checks */
118#define KEYRING_SEARCH_DO_STATE_CHECK 0x0002 /* Override NO_STATE_CHECK */
119#define KEYRING_SEARCH_NO_UPDATE_TIME 0x0004 /* Don't update times */
120#define KEYRING_SEARCH_NO_CHECK_PERM 0x0008 /* Don't check permissions */
121#define KEYRING_SEARCH_DETECT_TOO_DEEP 0x0010 /* Give an error on excessive depth */
0b0a8415 122#define KEYRING_SEARCH_SKIP_EXPIRED 0x0020 /* Ignore expired keys (intention to replace) */
4bdf0bc3 123
b2a4df20
DH
124 int (*iterator)(const void *object, void *iterator_data);
125
4bdf0bc3
DH
126 /* Internal stuff */
127 int skipped_ret;
128 bool possessed;
129 key_ref_t result;
130 struct timespec now;
131};
132
0c903ab6
DH
133extern bool key_default_cmp(const struct key *key,
134 const struct key_match_data *match_data);
664cceb0 135extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
4bdf0bc3
DH
136 struct keyring_search_context *ctx);
137
138extern key_ref_t search_my_process_keyrings(struct keyring_search_context *ctx);
139extern key_ref_t search_process_keyrings(struct keyring_search_context *ctx);
1da177e4 140
69664cf1 141extern struct key *find_keyring_by_name(const char *name, bool skip_perm_check);
1da177e4 142
8bbf4976 143extern int install_user_keyrings(void);
d84f4f99
DH
144extern int install_thread_keyring_to_cred(struct cred *);
145extern int install_process_keyring_to_cred(struct cred *);
685bfd2c 146extern int install_session_keyring_to_cred(struct cred *, struct key *);
3e30148c
DH
147
148extern struct key *request_key_and_link(struct key_type *type,
149 const char *description,
4a38e122
DH
150 const void *callout_info,
151 size_t callout_len,
4e54f085 152 void *aux,
7e047ef5
DH
153 struct key *dest_keyring,
154 unsigned long flags);
3e30148c 155
0c903ab6
DH
156extern bool lookup_user_key_possessed(const struct key *key,
157 const struct key_match_data *match_data);
5593122e 158extern key_ref_t lookup_user_key(key_serial_t id, unsigned long flags,
e9e349b0 159 key_perm_t perm);
5593122e
DH
160#define KEY_LOOKUP_CREATE 0x01
161#define KEY_LOOKUP_PARTIAL 0x02
162#define KEY_LOOKUP_FOR_UNLINK 0x04
e9e349b0
DH
163
164extern long join_session_keyring(const char *name);
67d12145 165extern void key_change_session_keyring(struct callback_head *twork);
e9e349b0 166
0c061b57 167extern struct work_struct key_gc_work;
5d135440
DH
168extern unsigned key_gc_delay;
169extern void keyring_gc(struct key *keyring, time_t limit);
fd75815f
DH
170extern void key_schedule_gc(time_t gc_at);
171extern void key_schedule_gc_links(void);
0c061b57 172extern void key_gc_keytype(struct key_type *ktype);
5d135440 173
e9e349b0 174extern int key_task_permission(const key_ref_t key_ref,
d84f4f99 175 const struct cred *cred,
e9e349b0
DH
176 key_perm_t perm);
177
973c9f4f
DH
178/*
179 * Check to see whether permission is granted to use a key in the desired way.
180 */
f5895943 181static inline int key_permission(const key_ref_t key_ref, unsigned perm)
e9e349b0 182{
d84f4f99 183 return key_task_permission(key_ref, current_cred(), perm);
e9e349b0
DH
184}
185
3e30148c 186/*
973c9f4f 187 * Authorisation record for request_key().
3e30148c
DH
188 */
189struct request_key_auth {
190 struct key *target_key;
8bbf4976 191 struct key *dest_keyring;
d84f4f99 192 const struct cred *cred;
4a38e122
DH
193 void *callout_info;
194 size_t callout_len;
3e30148c
DH
195 pid_t pid;
196};
197
198extern struct key_type key_type_request_key_auth;
199extern struct key *request_key_auth_new(struct key *target,
4a38e122 200 const void *callout_info,
8bbf4976
DH
201 size_t callout_len,
202 struct key *dest_keyring);
3e30148c
DH
203
204extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
1da177e4 205
fd75815f
DH
206/*
207 * Determine whether a key is dead.
208 */
7e55ca6d 209static inline bool key_is_dead(const struct key *key, time_t limit)
fd75815f
DH
210{
211 return
212 key->flags & ((1 << KEY_FLAG_DEAD) |
213 (1 << KEY_FLAG_INVALIDATED)) ||
214 (key->expiry > 0 && key->expiry <= limit);
215}
216
1da177e4 217/*
973c9f4f 218 * keyctl() functions
1da177e4
LT
219 */
220extern long keyctl_get_keyring_ID(key_serial_t, int);
221extern long keyctl_join_session_keyring(const char __user *);
222extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
223extern long keyctl_revoke_key(key_serial_t);
224extern long keyctl_keyring_clear(key_serial_t);
225extern long keyctl_keyring_link(key_serial_t, key_serial_t);
226extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
227extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
228extern long keyctl_keyring_search(key_serial_t, const char __user *,
229 const char __user *, key_serial_t);
230extern long keyctl_read_key(key_serial_t, char __user *, size_t);
231extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
232extern long keyctl_setperm_key(key_serial_t, key_perm_t);
233extern long keyctl_instantiate_key(key_serial_t, const void __user *,
234 size_t, key_serial_t);
235extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
3e30148c 236extern long keyctl_set_reqkey_keyring(int);
017679c4 237extern long keyctl_set_timeout(key_serial_t, unsigned);
b5f545c8 238extern long keyctl_assume_authority(key_serial_t);
70a5bb72
DH
239extern long keyctl_get_security(key_serial_t keyid, char __user *buffer,
240 size_t buflen);
ee18d64c 241extern long keyctl_session_to_parent(void);
fdd1b945 242extern long keyctl_reject_key(key_serial_t, unsigned, unsigned, key_serial_t);
ee009e4a
DH
243extern long keyctl_instantiate_key_iov(key_serial_t,
244 const struct iovec __user *,
245 unsigned, key_serial_t);
fd75815f 246extern long keyctl_invalidate_key(key_serial_t);
ee009e4a 247
b353a1f7 248struct iov_iter;
ee009e4a 249extern long keyctl_instantiate_key_common(key_serial_t,
b353a1f7
AV
250 struct iov_iter *,
251 key_serial_t);
f36f8c75
DH
252#ifdef CONFIG_PERSISTENT_KEYRINGS
253extern long keyctl_get_persistent(uid_t, key_serial_t);
254extern unsigned persistent_keyring_expiry;
255#else
256static inline long keyctl_get_persistent(uid_t uid, key_serial_t destring)
257{
258 return -EOPNOTSUPP;
259}
260#endif
1da177e4 261
ddbb4114
MM
262#ifdef CONFIG_KEY_DH_OPERATIONS
263extern long keyctl_dh_compute(struct keyctl_dh_params __user *, char __user *,
4693fc73 264 size_t, void __user *);
ddbb4114
MM
265#else
266static inline long keyctl_dh_compute(struct keyctl_dh_params __user *params,
4693fc73
SM
267 char __user *buffer, size_t buflen,
268 void __user *reserved)
ddbb4114
MM
269{
270 return -EOPNOTSUPP;
271}
272#endif
273
1da177e4 274/*
973c9f4f 275 * Debugging key validation
1da177e4
LT
276 */
277#ifdef KEY_DEBUGGING
278extern void __key_check(const struct key *);
279
280static inline void key_check(const struct key *key)
281{
282 if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
283 __key_check(key);
284}
285
286#else
287
288#define key_check(key) do {} while(0)
289
290#endif
291
292#endif /* _INTERNAL_H */