David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 1 | /* Request a key from userspace |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2 | * |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 3 | * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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. |
David Howells | f1a9bad | 2005-10-07 15:04:52 +0100 | [diff] [blame] | 10 | * |
Randy Dunlap | d410fa4 | 2011-05-19 15:59:38 -0700 | [diff] [blame] | 11 | * See Documentation/security/keys-request-key.txt |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 12 | */ |
| 13 | |
| 14 | #include <linux/module.h> |
| 15 | #include <linux/sched.h> |
| 16 | #include <linux/kmod.h> |
| 17 | #include <linux/err.h> |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 18 | #include <linux/keyctl.h> |
Robert P. J. Day | fdb89bc | 2008-04-29 01:01:32 -0700 | [diff] [blame] | 19 | #include <linux/slab.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | #include "internal.h" |
| 21 | |
David Howells | e9e349b | 2008-11-14 10:39:13 +1100 | [diff] [blame] | 22 | #define key_negative_timeout 60 /* default timeout on a negative key's existence */ |
| 23 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 24 | /* |
| 25 | * wait_on_bit() sleep function for uninterruptible waiting |
| 26 | */ |
| 27 | static int key_wait_bit(void *flags) |
| 28 | { |
| 29 | schedule(); |
| 30 | return 0; |
| 31 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 33 | /* |
| 34 | * wait_on_bit() sleep function for interruptible waiting |
| 35 | */ |
| 36 | static int key_wait_bit_intr(void *flags) |
| 37 | { |
| 38 | schedule(); |
| 39 | return signal_pending(current) ? -ERESTARTSYS : 0; |
| 40 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 42 | /** |
| 43 | * complete_request_key - Complete the construction of a key. |
| 44 | * @cons: The key construction record. |
| 45 | * @error: The success or failute of the construction. |
| 46 | * |
| 47 | * Complete the attempt to construct a key. The key will be negated |
| 48 | * if an error is indicated. The authorisation key will be revoked |
| 49 | * unconditionally. |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 50 | */ |
| 51 | void complete_request_key(struct key_construction *cons, int error) |
| 52 | { |
| 53 | kenter("{%d,%d},%d", cons->key->serial, cons->authkey->serial, error); |
| 54 | |
| 55 | if (error < 0) |
| 56 | key_negate_and_link(cons->key, key_negative_timeout, NULL, |
| 57 | cons->authkey); |
| 58 | else |
| 59 | key_revoke(cons->authkey); |
| 60 | |
| 61 | key_put(cons->key); |
| 62 | key_put(cons->authkey); |
| 63 | kfree(cons); |
| 64 | } |
| 65 | EXPORT_SYMBOL(complete_request_key); |
| 66 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 67 | /* |
| 68 | * Initialise a usermode helper that is going to have a specific session |
| 69 | * keyring. |
| 70 | * |
| 71 | * This is called in context of freshly forked kthread before kernel_execve(), |
| 72 | * so we can simply install the desired session_keyring at this point. |
| 73 | */ |
David Howells | 8796699 | 2011-06-17 11:25:59 +0100 | [diff] [blame] | 74 | static int umh_keys_init(struct subprocess_info *info, struct cred *cred) |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 75 | { |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 76 | struct key *keyring = info->data; |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 77 | |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 78 | return install_session_keyring_to_cred(cred, keyring); |
| 79 | } |
| 80 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 81 | /* |
| 82 | * Clean up a usermode helper with session keyring. |
| 83 | */ |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 84 | static void umh_keys_cleanup(struct subprocess_info *info) |
| 85 | { |
| 86 | struct key *keyring = info->data; |
| 87 | key_put(keyring); |
| 88 | } |
| 89 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 90 | /* |
| 91 | * Call a usermode helper with a specific session keyring. |
| 92 | */ |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 93 | static int call_usermodehelper_keys(char *path, char **argv, char **envp, |
Oleg Nesterov | 9d944ef | 2012-03-23 15:02:48 -0700 | [diff] [blame] | 94 | struct key *session_keyring, int wait) |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 95 | { |
Boaz Harrosh | 81ab6e7 | 2012-05-31 16:26:15 -0700 | [diff] [blame^] | 96 | return call_usermodehelper_fns(path, argv, envp, wait, |
| 97 | umh_keys_init, umh_keys_cleanup, |
| 98 | key_get(session_keyring)); |
Oleg Nesterov | 685bfd2 | 2010-05-26 14:43:00 -0700 | [diff] [blame] | 99 | } |
| 100 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | /* |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 102 | * Request userspace finish the construction of a key |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 103 | * - execute "/sbin/request-key <op> <key> <uid> <gid> <keyring> <keyring> <keyring>" |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | */ |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 105 | static int call_sbin_request_key(struct key_construction *cons, |
David Howells | 4e54f08 | 2006-06-29 02:24:28 -0700 | [diff] [blame] | 106 | const char *op, |
| 107 | void *aux) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | { |
David Howells | 86a264a | 2008-11-14 10:39:18 +1100 | [diff] [blame] | 109 | const struct cred *cred = current_cred(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | key_serial_t prkey, sskey; |
David Howells | 93b4a44 | 2010-04-23 13:18:00 -0400 | [diff] [blame] | 111 | struct key *key = cons->key, *authkey = cons->authkey, *keyring, |
| 112 | *session; |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 113 | char *argv[9], *envp[3], uid_str[12], gid_str[12]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 114 | char key_str[12], keyring_str[3][12]; |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 115 | char desc[20]; |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 116 | int ret, i; |
| 117 | |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 118 | kenter("{%d},{%d},%s", key->serial, authkey->serial, op); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 119 | |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 120 | ret = install_user_keyrings(); |
| 121 | if (ret < 0) |
| 122 | goto error_alloc; |
| 123 | |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 124 | /* allocate a new session keyring */ |
| 125 | sprintf(desc, "_req.%u", key->serial); |
| 126 | |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 127 | cred = get_current_cred(); |
| 128 | keyring = keyring_alloc(desc, cred->fsuid, cred->fsgid, cred, |
David Howells | 7e047ef | 2006-06-26 00:24:50 -0700 | [diff] [blame] | 129 | KEY_ALLOC_QUOTA_OVERRUN, NULL); |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 130 | put_cred(cred); |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 131 | if (IS_ERR(keyring)) { |
| 132 | ret = PTR_ERR(keyring); |
| 133 | goto error_alloc; |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 134 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 136 | /* attach the auth key to the session keyring */ |
David Howells | 896903c | 2010-04-30 14:32:23 +0100 | [diff] [blame] | 137 | ret = key_link(keyring, authkey); |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 138 | if (ret < 0) |
| 139 | goto error_link; |
| 140 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | /* record the UID and GID */ |
David Howells | 86a264a | 2008-11-14 10:39:18 +1100 | [diff] [blame] | 142 | sprintf(uid_str, "%d", cred->fsuid); |
| 143 | sprintf(gid_str, "%d", cred->fsgid); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | |
| 145 | /* we say which key is under construction */ |
| 146 | sprintf(key_str, "%d", key->serial); |
| 147 | |
| 148 | /* we specify the process's default keyrings */ |
| 149 | sprintf(keyring_str[0], "%d", |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 150 | cred->thread_keyring ? cred->thread_keyring->serial : 0); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
| 152 | prkey = 0; |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 153 | if (cred->tgcred->process_keyring) |
| 154 | prkey = cred->tgcred->process_keyring->serial; |
Justin P. Mattock | 5ad18a0 | 2010-06-30 10:39:11 +0100 | [diff] [blame] | 155 | sprintf(keyring_str[1], "%d", prkey); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 156 | |
David Howells | 93b4a44 | 2010-04-23 13:18:00 -0400 | [diff] [blame] | 157 | rcu_read_lock(); |
| 158 | session = rcu_dereference(cred->tgcred->session_keyring); |
| 159 | if (!session) |
| 160 | session = cred->user->session_keyring; |
| 161 | sskey = session->serial; |
| 162 | rcu_read_unlock(); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 163 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 164 | sprintf(keyring_str[2], "%d", sskey); |
| 165 | |
| 166 | /* set up a minimal environment */ |
| 167 | i = 0; |
| 168 | envp[i++] = "HOME=/"; |
| 169 | envp[i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin"; |
| 170 | envp[i] = NULL; |
| 171 | |
| 172 | /* set up the argument list */ |
| 173 | i = 0; |
| 174 | argv[i++] = "/sbin/request-key"; |
| 175 | argv[i++] = (char *) op; |
| 176 | argv[i++] = key_str; |
| 177 | argv[i++] = uid_str; |
| 178 | argv[i++] = gid_str; |
| 179 | argv[i++] = keyring_str[0]; |
| 180 | argv[i++] = keyring_str[1]; |
| 181 | argv[i++] = keyring_str[2]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | argv[i] = NULL; |
| 183 | |
| 184 | /* do it */ |
Jeremy Fitzhardinge | 86313c4 | 2007-07-17 18:37:03 -0700 | [diff] [blame] | 185 | ret = call_usermodehelper_keys(argv[0], argv, envp, keyring, |
| 186 | UMH_WAIT_PROC); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 187 | kdebug("usermode -> 0x%x", ret); |
| 188 | if (ret >= 0) { |
| 189 | /* ret is the exit/wait code */ |
| 190 | if (test_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags) || |
| 191 | key_validate(key) < 0) |
| 192 | ret = -ENOKEY; |
| 193 | else |
| 194 | /* ignore any errors from userspace if the key was |
| 195 | * instantiated */ |
| 196 | ret = 0; |
| 197 | } |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 198 | |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 199 | error_link: |
| 200 | key_put(keyring); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 201 | |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 202 | error_alloc: |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 203 | complete_request_key(cons, ret); |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 204 | kleave(" = %d", ret); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 205 | return ret; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 206 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | /* |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 209 | * Call out to userspace for key construction. |
| 210 | * |
| 211 | * Program failure is ignored in favour of key status. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | */ |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 213 | static int construct_key(struct key *key, const void *callout_info, |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 214 | size_t callout_len, void *aux, |
| 215 | struct key *dest_keyring) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 216 | { |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 217 | struct key_construction *cons; |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 218 | request_key_actor_t actor; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 219 | struct key *authkey; |
| 220 | int ret; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 221 | |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 222 | kenter("%d,%p,%zu,%p", key->serial, callout_info, callout_len, aux); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 223 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 224 | cons = kmalloc(sizeof(*cons), GFP_KERNEL); |
| 225 | if (!cons) |
| 226 | return -ENOMEM; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 228 | /* allocate an authorisation key */ |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 229 | authkey = request_key_auth_new(key, callout_info, callout_len, |
| 230 | dest_keyring); |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 231 | if (IS_ERR(authkey)) { |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 232 | kfree(cons); |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 233 | ret = PTR_ERR(authkey); |
| 234 | authkey = NULL; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 235 | } else { |
| 236 | cons->authkey = key_get(authkey); |
| 237 | cons->key = key_get(key); |
| 238 | |
| 239 | /* make the call */ |
| 240 | actor = call_sbin_request_key; |
| 241 | if (key->type->request_key) |
| 242 | actor = key->type->request_key; |
| 243 | |
| 244 | ret = actor(cons, "create", aux); |
| 245 | |
| 246 | /* check that the actor called complete_request_key() prior to |
| 247 | * returning an error */ |
| 248 | WARN_ON(ret < 0 && |
| 249 | !test_bit(KEY_FLAG_REVOKED, &authkey->flags)); |
| 250 | key_put(authkey); |
David Howells | b5f545c | 2006-01-08 01:02:47 -0800 | [diff] [blame] | 251 | } |
| 252 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 253 | kleave(" = %d", ret); |
| 254 | return ret; |
| 255 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 256 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 257 | /* |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 258 | * Get the appropriate destination keyring for the request. |
| 259 | * |
| 260 | * The keyring selected is returned with an extra reference upon it which the |
| 261 | * caller must release. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 262 | */ |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 263 | static void construct_get_dest_keyring(struct key **_dest_keyring) |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 264 | { |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 265 | struct request_key_auth *rka; |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 266 | const struct cred *cred = current_cred(); |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 267 | struct key *dest_keyring = *_dest_keyring, *authkey; |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 268 | |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 269 | kenter("%p", dest_keyring); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 270 | |
| 271 | /* find the appropriate keyring */ |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 272 | if (dest_keyring) { |
| 273 | /* the caller supplied one */ |
| 274 | key_get(dest_keyring); |
| 275 | } else { |
| 276 | /* use a default keyring; falling through the cases until we |
| 277 | * find one that we actually have */ |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 278 | switch (cred->jit_keyring) { |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 279 | case KEY_REQKEY_DEFL_DEFAULT: |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 280 | case KEY_REQKEY_DEFL_REQUESTOR_KEYRING: |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 281 | if (cred->request_key_auth) { |
| 282 | authkey = cred->request_key_auth; |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 283 | down_read(&authkey->sem); |
| 284 | rka = authkey->payload.data; |
| 285 | if (!test_bit(KEY_FLAG_REVOKED, |
| 286 | &authkey->flags)) |
| 287 | dest_keyring = |
| 288 | key_get(rka->dest_keyring); |
| 289 | up_read(&authkey->sem); |
| 290 | if (dest_keyring) |
| 291 | break; |
| 292 | } |
| 293 | |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 294 | case KEY_REQKEY_DEFL_THREAD_KEYRING: |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 295 | dest_keyring = key_get(cred->thread_keyring); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 296 | if (dest_keyring) |
| 297 | break; |
| 298 | |
| 299 | case KEY_REQKEY_DEFL_PROCESS_KEYRING: |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 300 | dest_keyring = key_get(cred->tgcred->process_keyring); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 301 | if (dest_keyring) |
| 302 | break; |
| 303 | |
| 304 | case KEY_REQKEY_DEFL_SESSION_KEYRING: |
| 305 | rcu_read_lock(); |
| 306 | dest_keyring = key_get( |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 307 | rcu_dereference(cred->tgcred->session_keyring)); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 308 | rcu_read_unlock(); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 309 | |
| 310 | if (dest_keyring) |
| 311 | break; |
| 312 | |
| 313 | case KEY_REQKEY_DEFL_USER_SESSION_KEYRING: |
David Howells | b6dff3e | 2008-11-14 10:39:16 +1100 | [diff] [blame] | 314 | dest_keyring = |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 315 | key_get(cred->user->session_keyring); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 316 | break; |
| 317 | |
| 318 | case KEY_REQKEY_DEFL_USER_KEYRING: |
David Howells | bb952bb | 2008-11-14 10:39:20 +1100 | [diff] [blame] | 319 | dest_keyring = key_get(cred->user->uid_keyring); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 320 | break; |
| 321 | |
| 322 | case KEY_REQKEY_DEFL_GROUP_KEYRING: |
| 323 | default: |
| 324 | BUG(); |
| 325 | } |
| 326 | } |
| 327 | |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 328 | *_dest_keyring = dest_keyring; |
| 329 | kleave(" [dk %d]", key_serial(dest_keyring)); |
| 330 | return; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 331 | } |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 332 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 333 | /* |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 334 | * Allocate a new key in under-construction state and attempt to link it in to |
| 335 | * the requested keyring. |
| 336 | * |
| 337 | * May return a key that's already under construction instead if there was a |
| 338 | * race between two thread calling request_key(). |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 339 | */ |
| 340 | static int construct_alloc_key(struct key_type *type, |
| 341 | const char *description, |
| 342 | struct key *dest_keyring, |
| 343 | unsigned long flags, |
| 344 | struct key_user *user, |
| 345 | struct key **_key) |
| 346 | { |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 347 | const struct cred *cred = current_cred(); |
David Howells | ceb73c1 | 2011-01-25 16:34:28 +0000 | [diff] [blame] | 348 | unsigned long prealloc; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 349 | struct key *key; |
| 350 | key_ref_t key_ref; |
David Howells | 2b9e468 | 2010-04-30 14:32:34 +0100 | [diff] [blame] | 351 | int ret; |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 352 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 353 | kenter("%s,%s,,,", type->name, description); |
| 354 | |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 355 | *_key = NULL; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 356 | mutex_lock(&user->cons_lock); |
| 357 | |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 358 | key = key_alloc(type, description, cred->fsuid, cred->fsgid, cred, |
| 359 | KEY_POS_ALL, flags); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 360 | if (IS_ERR(key)) |
| 361 | goto alloc_failed; |
| 362 | |
| 363 | set_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags); |
| 364 | |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 365 | if (dest_keyring) { |
| 366 | ret = __key_link_begin(dest_keyring, type, description, |
| 367 | &prealloc); |
| 368 | if (ret < 0) |
| 369 | goto link_prealloc_failed; |
| 370 | } |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 371 | |
| 372 | /* attach the key to the destination keyring under lock, but we do need |
| 373 | * to do another check just in case someone beat us to it whilst we |
| 374 | * waited for locks */ |
| 375 | mutex_lock(&key_construction_mutex); |
| 376 | |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 377 | key_ref = search_process_keyrings(type, description, type->match, cred); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 378 | if (!IS_ERR(key_ref)) |
| 379 | goto key_already_present; |
| 380 | |
David Howells | 34574dd | 2009-04-09 17:14:05 +0100 | [diff] [blame] | 381 | if (dest_keyring) |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 382 | __key_link(dest_keyring, key, &prealloc); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 383 | |
| 384 | mutex_unlock(&key_construction_mutex); |
David Howells | 34574dd | 2009-04-09 17:14:05 +0100 | [diff] [blame] | 385 | if (dest_keyring) |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 386 | __key_link_end(dest_keyring, type, prealloc); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 387 | mutex_unlock(&user->cons_lock); |
| 388 | *_key = key; |
| 389 | kleave(" = 0 [%d]", key_serial(key)); |
| 390 | return 0; |
| 391 | |
David Howells | 2b9e468 | 2010-04-30 14:32:34 +0100 | [diff] [blame] | 392 | /* the key is now present - we tell the caller that we found it by |
| 393 | * returning -EINPROGRESS */ |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 394 | key_already_present: |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 395 | key_put(key); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 396 | mutex_unlock(&key_construction_mutex); |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 397 | key = key_ref_to_ptr(key_ref); |
David Howells | 03449cd | 2010-04-27 13:13:08 -0700 | [diff] [blame] | 398 | if (dest_keyring) { |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 399 | ret = __key_link_check_live_key(dest_keyring, key); |
| 400 | if (ret == 0) |
| 401 | __key_link(dest_keyring, key, &prealloc); |
| 402 | __key_link_end(dest_keyring, type, prealloc); |
| 403 | if (ret < 0) |
| 404 | goto link_check_failed; |
David Howells | 03449cd | 2010-04-27 13:13:08 -0700 | [diff] [blame] | 405 | } |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 406 | mutex_unlock(&user->cons_lock); |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 407 | *_key = key; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 408 | kleave(" = -EINPROGRESS [%d]", key_serial(key)); |
| 409 | return -EINPROGRESS; |
| 410 | |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 411 | link_check_failed: |
| 412 | mutex_unlock(&user->cons_lock); |
| 413 | key_put(key); |
| 414 | kleave(" = %d [linkcheck]", ret); |
| 415 | return ret; |
| 416 | |
| 417 | link_prealloc_failed: |
David Howells | f70e2e0 | 2010-04-30 14:32:39 +0100 | [diff] [blame] | 418 | mutex_unlock(&user->cons_lock); |
| 419 | kleave(" = %d [prelink]", ret); |
| 420 | return ret; |
| 421 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 422 | alloc_failed: |
| 423 | mutex_unlock(&user->cons_lock); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 424 | kleave(" = %ld", PTR_ERR(key)); |
| 425 | return PTR_ERR(key); |
| 426 | } |
| 427 | |
| 428 | /* |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 429 | * Commence key construction. |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 430 | */ |
| 431 | static struct key *construct_key_and_link(struct key_type *type, |
| 432 | const char *description, |
| 433 | const char *callout_info, |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 434 | size_t callout_len, |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 435 | void *aux, |
| 436 | struct key *dest_keyring, |
| 437 | unsigned long flags) |
| 438 | { |
| 439 | struct key_user *user; |
| 440 | struct key *key; |
| 441 | int ret; |
| 442 | |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 443 | kenter(""); |
| 444 | |
Serge E. Hallyn | 1d1e975 | 2009-02-26 18:27:38 -0600 | [diff] [blame] | 445 | user = key_user_lookup(current_fsuid(), current_user_ns()); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 446 | if (!user) |
| 447 | return ERR_PTR(-ENOMEM); |
| 448 | |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 449 | construct_get_dest_keyring(&dest_keyring); |
| 450 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 451 | ret = construct_alloc_key(type, description, dest_keyring, flags, user, |
| 452 | &key); |
| 453 | key_user_put(user); |
| 454 | |
| 455 | if (ret == 0) { |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 456 | ret = construct_key(key, callout_info, callout_len, aux, |
| 457 | dest_keyring); |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 458 | if (ret < 0) { |
| 459 | kdebug("cons failed"); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 460 | goto construction_failed; |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 461 | } |
David Howells | 2b9e468 | 2010-04-30 14:32:34 +0100 | [diff] [blame] | 462 | } else if (ret == -EINPROGRESS) { |
| 463 | ret = 0; |
| 464 | } else { |
David Howells | b1d7dd8 | 2011-06-21 14:32:05 +0100 | [diff] [blame] | 465 | goto couldnt_alloc_key; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 466 | } |
| 467 | |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 468 | key_put(dest_keyring); |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 469 | kleave(" = key %d", key_serial(key)); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 470 | return key; |
| 471 | |
| 472 | construction_failed: |
| 473 | key_negate_and_link(key, key_negative_timeout, NULL, NULL); |
| 474 | key_put(key); |
David Howells | b1d7dd8 | 2011-06-21 14:32:05 +0100 | [diff] [blame] | 475 | couldnt_alloc_key: |
David Howells | 8bbf4976 | 2008-11-14 10:39:14 +1100 | [diff] [blame] | 476 | key_put(dest_keyring); |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 477 | kleave(" = %d", ret); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 478 | return ERR_PTR(ret); |
| 479 | } |
| 480 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 481 | /** |
| 482 | * request_key_and_link - Request a key and cache it in a keyring. |
| 483 | * @type: The type of key we want. |
| 484 | * @description: The searchable description of the key. |
| 485 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
| 486 | * @callout_len: The length of callout_info. |
| 487 | * @aux: Auxiliary data for the upcall. |
| 488 | * @dest_keyring: Where to cache the key. |
| 489 | * @flags: Flags to key_alloc(). |
| 490 | * |
| 491 | * A key matching the specified criteria is searched for in the process's |
| 492 | * keyrings and returned with its usage count incremented if found. Otherwise, |
| 493 | * if callout_info is not NULL, a key will be allocated and some service |
| 494 | * (probably in userspace) will be asked to instantiate it. |
| 495 | * |
| 496 | * If successfully found or created, the key will be linked to the destination |
| 497 | * keyring if one is provided. |
| 498 | * |
| 499 | * Returns a pointer to the key if successful; -EACCES, -ENOKEY, -EKEYREVOKED |
| 500 | * or -EKEYEXPIRED if an inaccessible, negative, revoked or expired key was |
| 501 | * found; -ENOKEY if no key was found and no @callout_info was given; -EDQUOT |
| 502 | * if insufficient key quota was available to create a new key; or -ENOMEM if |
| 503 | * insufficient memory was available. |
| 504 | * |
| 505 | * If the returned key was created, then it may still be under construction, |
| 506 | * and wait_for_key_construction() should be used to wait for that to complete. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 507 | */ |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 508 | struct key *request_key_and_link(struct key_type *type, |
| 509 | const char *description, |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 510 | const void *callout_info, |
| 511 | size_t callout_len, |
David Howells | 4e54f08 | 2006-06-29 02:24:28 -0700 | [diff] [blame] | 512 | void *aux, |
David Howells | 7e047ef | 2006-06-26 00:24:50 -0700 | [diff] [blame] | 513 | struct key *dest_keyring, |
| 514 | unsigned long flags) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 515 | { |
David Howells | d84f4f9 | 2008-11-14 10:39:23 +1100 | [diff] [blame] | 516 | const struct cred *cred = current_cred(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 517 | struct key *key; |
David Howells | 664cceb | 2005-09-28 17:03:15 +0100 | [diff] [blame] | 518 | key_ref_t key_ref; |
David Howells | 2b9e468 | 2010-04-30 14:32:34 +0100 | [diff] [blame] | 519 | int ret; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 520 | |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 521 | kenter("%s,%s,%p,%zu,%p,%p,%lx", |
| 522 | type->name, description, callout_info, callout_len, aux, |
David Howells | 4e54f08 | 2006-06-29 02:24:28 -0700 | [diff] [blame] | 523 | dest_keyring, flags); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 524 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 525 | /* search all the process keyrings for a key */ |
David Howells | 78b7280 | 2011-03-11 17:57:23 +0000 | [diff] [blame] | 526 | key_ref = search_process_keyrings(type, description, type->match, cred); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 527 | |
David Howells | 664cceb | 2005-09-28 17:03:15 +0100 | [diff] [blame] | 528 | if (!IS_ERR(key_ref)) { |
| 529 | key = key_ref_to_ptr(key_ref); |
David Howells | 03449cd | 2010-04-27 13:13:08 -0700 | [diff] [blame] | 530 | if (dest_keyring) { |
| 531 | construct_get_dest_keyring(&dest_keyring); |
David Howells | 2b9e468 | 2010-04-30 14:32:34 +0100 | [diff] [blame] | 532 | ret = key_link(dest_keyring, key); |
David Howells | 03449cd | 2010-04-27 13:13:08 -0700 | [diff] [blame] | 533 | key_put(dest_keyring); |
David Howells | 2b9e468 | 2010-04-30 14:32:34 +0100 | [diff] [blame] | 534 | if (ret < 0) { |
| 535 | key_put(key); |
| 536 | key = ERR_PTR(ret); |
| 537 | goto error; |
| 538 | } |
David Howells | 03449cd | 2010-04-27 13:13:08 -0700 | [diff] [blame] | 539 | } |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 540 | } else if (PTR_ERR(key_ref) != -EAGAIN) { |
David Howells | e231c2e | 2008-02-07 00:15:26 -0800 | [diff] [blame] | 541 | key = ERR_CAST(key_ref); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 542 | } else { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 543 | /* the search failed, but the keyrings were searchable, so we |
| 544 | * should consult userspace if we can */ |
| 545 | key = ERR_PTR(-ENOKEY); |
| 546 | if (!callout_info) |
| 547 | goto error; |
| 548 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 549 | key = construct_key_and_link(type, description, callout_info, |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 550 | callout_len, aux, dest_keyring, |
| 551 | flags); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 552 | } |
| 553 | |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 554 | error: |
| 555 | kleave(" = %p", key); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 556 | return key; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 557 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 558 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 559 | /** |
| 560 | * wait_for_key_construction - Wait for construction of a key to complete |
| 561 | * @key: The key being waited for. |
| 562 | * @intr: Whether to wait interruptibly. |
| 563 | * |
| 564 | * Wait for a key to finish being constructed. |
| 565 | * |
| 566 | * Returns 0 if successful; -ERESTARTSYS if the wait was interrupted; -ENOKEY |
| 567 | * if the key was negated; or -EKEYREVOKED or -EKEYEXPIRED if the key was |
| 568 | * revoked or expired. |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 569 | */ |
| 570 | int wait_for_key_construction(struct key *key, bool intr) |
| 571 | { |
| 572 | int ret; |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 573 | |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 574 | ret = wait_on_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT, |
| 575 | intr ? key_wait_bit_intr : key_wait_bit, |
| 576 | intr ? TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE); |
| 577 | if (ret < 0) |
| 578 | return ret; |
David Howells | 1e456a1 | 2010-08-06 16:08:27 +0100 | [diff] [blame] | 579 | if (test_bit(KEY_FLAG_NEGATIVE, &key->flags)) |
David Howells | fdd1b94 | 2011-03-07 15:06:09 +0000 | [diff] [blame] | 580 | return key->type_data.reject_error; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 581 | return key_validate(key); |
| 582 | } |
| 583 | EXPORT_SYMBOL(wait_for_key_construction); |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 584 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 585 | /** |
| 586 | * request_key - Request a key and wait for construction |
| 587 | * @type: Type of key. |
| 588 | * @description: The searchable description of the key. |
| 589 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
| 590 | * |
| 591 | * As for request_key_and_link() except that it does not add the returned key |
| 592 | * to a keyring if found, new keys are always allocated in the user's quota, |
| 593 | * the callout_info must be a NUL-terminated string and no auxiliary data can |
| 594 | * be passed. |
| 595 | * |
| 596 | * Furthermore, it then works as wait_for_key_construction() to wait for the |
| 597 | * completion of keys undergoing construction with a non-interruptible wait. |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 598 | */ |
| 599 | struct key *request_key(struct key_type *type, |
| 600 | const char *description, |
| 601 | const char *callout_info) |
| 602 | { |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 603 | struct key *key; |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 604 | size_t callout_len = 0; |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 605 | int ret; |
David Howells | 3e30148 | 2005-06-23 22:00:56 -0700 | [diff] [blame] | 606 | |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 607 | if (callout_info) |
| 608 | callout_len = strlen(callout_info); |
| 609 | key = request_key_and_link(type, description, callout_info, callout_len, |
| 610 | NULL, NULL, KEY_ALLOC_IN_QUOTA); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 611 | if (!IS_ERR(key)) { |
| 612 | ret = wait_for_key_construction(key, false); |
| 613 | if (ret < 0) { |
| 614 | key_put(key); |
| 615 | return ERR_PTR(ret); |
| 616 | } |
| 617 | } |
| 618 | return key; |
| 619 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 620 | EXPORT_SYMBOL(request_key); |
David Howells | 4e54f08 | 2006-06-29 02:24:28 -0700 | [diff] [blame] | 621 | |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 622 | /** |
| 623 | * request_key_with_auxdata - Request a key with auxiliary data for the upcaller |
| 624 | * @type: The type of key we want. |
| 625 | * @description: The searchable description of the key. |
| 626 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
| 627 | * @callout_len: The length of callout_info. |
| 628 | * @aux: Auxiliary data for the upcall. |
| 629 | * |
| 630 | * As for request_key_and_link() except that it does not add the returned key |
| 631 | * to a keyring if found and new keys are always allocated in the user's quota. |
| 632 | * |
| 633 | * Furthermore, it then works as wait_for_key_construction() to wait for the |
| 634 | * completion of keys undergoing construction with a non-interruptible wait. |
David Howells | 4e54f08 | 2006-06-29 02:24:28 -0700 | [diff] [blame] | 635 | */ |
| 636 | struct key *request_key_with_auxdata(struct key_type *type, |
| 637 | const char *description, |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 638 | const void *callout_info, |
| 639 | size_t callout_len, |
David Howells | 4e54f08 | 2006-06-29 02:24:28 -0700 | [diff] [blame] | 640 | void *aux) |
| 641 | { |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 642 | struct key *key; |
| 643 | int ret; |
| 644 | |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 645 | key = request_key_and_link(type, description, callout_info, callout_len, |
| 646 | aux, NULL, KEY_ALLOC_IN_QUOTA); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 647 | if (!IS_ERR(key)) { |
| 648 | ret = wait_for_key_construction(key, false); |
| 649 | if (ret < 0) { |
| 650 | key_put(key); |
| 651 | return ERR_PTR(ret); |
| 652 | } |
| 653 | } |
| 654 | return key; |
| 655 | } |
| 656 | EXPORT_SYMBOL(request_key_with_auxdata); |
| 657 | |
| 658 | /* |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 659 | * request_key_async - Request a key (allow async construction) |
| 660 | * @type: Type of key. |
| 661 | * @description: The searchable description of the key. |
| 662 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
| 663 | * @callout_len: The length of callout_info. |
| 664 | * |
| 665 | * As for request_key_and_link() except that it does not add the returned key |
| 666 | * to a keyring if found, new keys are always allocated in the user's quota and |
| 667 | * no auxiliary data can be passed. |
| 668 | * |
| 669 | * The caller should call wait_for_key_construction() to wait for the |
| 670 | * completion of the returned key if it is still undergoing construction. |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 671 | */ |
| 672 | struct key *request_key_async(struct key_type *type, |
| 673 | const char *description, |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 674 | const void *callout_info, |
| 675 | size_t callout_len) |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 676 | { |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 677 | return request_key_and_link(type, description, callout_info, |
| 678 | callout_len, NULL, NULL, |
| 679 | KEY_ALLOC_IN_QUOTA); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 680 | } |
| 681 | EXPORT_SYMBOL(request_key_async); |
| 682 | |
| 683 | /* |
| 684 | * request a key with auxiliary data for the upcaller (allow async construction) |
David Howells | 973c9f4 | 2011-01-20 16:38:33 +0000 | [diff] [blame] | 685 | * @type: Type of key. |
| 686 | * @description: The searchable description of the key. |
| 687 | * @callout_info: The data to pass to the instantiation upcall (or NULL). |
| 688 | * @callout_len: The length of callout_info. |
| 689 | * @aux: Auxiliary data for the upcall. |
| 690 | * |
| 691 | * As for request_key_and_link() except that it does not add the returned key |
| 692 | * to a keyring if found and new keys are always allocated in the user's quota. |
| 693 | * |
| 694 | * The caller should call wait_for_key_construction() to wait for the |
| 695 | * completion of the returned key if it is still undergoing construction. |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 696 | */ |
| 697 | struct key *request_key_async_with_auxdata(struct key_type *type, |
| 698 | const char *description, |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 699 | const void *callout_info, |
| 700 | size_t callout_len, |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 701 | void *aux) |
| 702 | { |
David Howells | 4a38e12 | 2008-04-29 01:01:24 -0700 | [diff] [blame] | 703 | return request_key_and_link(type, description, callout_info, |
| 704 | callout_len, aux, NULL, KEY_ALLOC_IN_QUOTA); |
David Howells | 76181c1 | 2007-10-16 23:29:46 -0700 | [diff] [blame] | 705 | } |
| 706 | EXPORT_SYMBOL(request_key_async_with_auxdata); |