Merge drm/drm-next into drm-intel-next-queued
[linux-2.6-block.git] / security / keys / request_key_auth.c
CommitLineData
973c9f4f 1/* Request key authorisation token key definition.
3e30148c
DH
2 *
3 * Copyright (C) 2005 Red Hat, Inc. All Rights Reserved.
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.
f1a9badc 10 *
3db38ed7 11 * See Documentation/security/keys/request-key.rst
3e30148c
DH
12 */
13
3e30148c
DH
14#include <linux/sched.h>
15#include <linux/err.h>
16#include <linux/seq_file.h>
fdb89bce 17#include <linux/slab.h>
7c0f6ba6 18#include <linux/uaccess.h>
3e30148c 19#include "internal.h"
822ad64d 20#include <keys/request_key_auth-type.h>
3e30148c 21
f1dcde91
DH
22static int request_key_auth_preparse(struct key_preparsed_payload *);
23static void request_key_auth_free_preparse(struct key_preparsed_payload *);
cf7f601c
DH
24static int request_key_auth_instantiate(struct key *,
25 struct key_preparsed_payload *);
3e30148c 26static void request_key_auth_describe(const struct key *, struct seq_file *);
04c567d9 27static void request_key_auth_revoke(struct key *);
3e30148c 28static void request_key_auth_destroy(struct key *);
b5f545c8 29static long request_key_auth_read(const struct key *, char __user *, size_t);
3e30148c
DH
30
31/*
973c9f4f 32 * The request-key authorisation key type definition.
3e30148c
DH
33 */
34struct key_type key_type_request_key_auth = {
35 .name = ".request_key_auth",
36 .def_datalen = sizeof(struct request_key_auth),
f1dcde91
DH
37 .preparse = request_key_auth_preparse,
38 .free_preparse = request_key_auth_free_preparse,
3e30148c
DH
39 .instantiate = request_key_auth_instantiate,
40 .describe = request_key_auth_describe,
04c567d9 41 .revoke = request_key_auth_revoke,
3e30148c 42 .destroy = request_key_auth_destroy,
b5f545c8 43 .read = request_key_auth_read,
3e30148c
DH
44};
45
8da79b64 46static int request_key_auth_preparse(struct key_preparsed_payload *prep)
f1dcde91
DH
47{
48 return 0;
49}
50
8da79b64 51static void request_key_auth_free_preparse(struct key_preparsed_payload *prep)
f1dcde91
DH
52{
53}
54
3e30148c 55/*
973c9f4f 56 * Instantiate a request-key authorisation key.
3e30148c
DH
57 */
58static int request_key_auth_instantiate(struct key *key,
cf7f601c 59 struct key_preparsed_payload *prep)
3e30148c 60{
146aa8b1 61 key->payload.data[0] = (struct request_key_auth *)prep->data;
b5f545c8 62 return 0;
a8b17ed0 63}
3e30148c 64
3e30148c 65/*
973c9f4f 66 * Describe an authorisation token.
3e30148c
DH
67 */
68static void request_key_auth_describe(const struct key *key,
69 struct seq_file *m)
70{
822ad64d 71 struct request_key_auth *rka = get_request_key_auth(key);
3e30148c
DH
72
73 seq_puts(m, "key:");
74 seq_puts(m, key->description);
363b02da 75 if (key_is_positive(key))
78b7280c 76 seq_printf(m, " pid:%d ci:%zu", rka->pid, rka->callout_len);
a8b17ed0 77}
3e30148c 78
b5f545c8 79/*
973c9f4f 80 * Read the callout_info data (retrieves the callout information).
b5f545c8
DH
81 * - the key's semaphore is read-locked
82 */
83static long request_key_auth_read(const struct key *key,
84 char __user *buffer, size_t buflen)
85{
822ad64d 86 struct request_key_auth *rka = get_request_key_auth(key);
b5f545c8
DH
87 size_t datalen;
88 long ret;
89
4a38e122 90 datalen = rka->callout_len;
b5f545c8
DH
91 ret = datalen;
92
93 /* we can return the data as is */
94 if (buffer && buflen > 0) {
95 if (buflen > datalen)
96 buflen = datalen;
97
98 if (copy_to_user(buffer, rka->callout_info, buflen) != 0)
99 ret = -EFAULT;
100 }
101
102 return ret;
a8b17ed0 103}
b5f545c8 104
04c567d9 105/*
973c9f4f
DH
106 * Handle revocation of an authorisation token key.
107 *
108 * Called with the key sem write-locked.
04c567d9
DH
109 */
110static void request_key_auth_revoke(struct key *key)
111{
822ad64d 112 struct request_key_auth *rka = get_request_key_auth(key);
04c567d9
DH
113
114 kenter("{%d}", key->serial);
115
d84f4f99
DH
116 if (rka->cred) {
117 put_cred(rka->cred);
118 rka->cred = NULL;
04c567d9 119 }
a8b17ed0 120}
04c567d9 121
44d81433
EB
122static void free_request_key_auth(struct request_key_auth *rka)
123{
124 if (!rka)
125 return;
126 key_put(rka->target_key);
127 key_put(rka->dest_keyring);
128 if (rka->cred)
129 put_cred(rka->cred);
130 kfree(rka->callout_info);
131 kfree(rka);
132}
133
3e30148c 134/*
973c9f4f 135 * Destroy an instantiation authorisation token key.
3e30148c
DH
136 */
137static void request_key_auth_destroy(struct key *key)
138{
822ad64d 139 struct request_key_auth *rka = get_request_key_auth(key);
3e30148c
DH
140
141 kenter("{%d}", key->serial);
142
44d81433 143 free_request_key_auth(rka);
a8b17ed0 144}
3e30148c 145
3e30148c 146/*
973c9f4f
DH
147 * Create an authorisation token for /sbin/request-key or whoever to gain
148 * access to the caller's security data.
3e30148c 149 */
822ad64d
DH
150struct key *request_key_auth_new(struct key *target, const char *op,
151 const void *callout_info, size_t callout_len,
152 struct key *dest_keyring)
3e30148c 153{
b5f545c8 154 struct request_key_auth *rka, *irka;
d84f4f99 155 const struct cred *cred = current->cred;
b5f545c8 156 struct key *authkey = NULL;
3e30148c 157 char desc[20];
44d81433 158 int ret = -ENOMEM;
3e30148c
DH
159
160 kenter("%d,", target->serial);
161
b5f545c8 162 /* allocate a auth record */
44d81433
EB
163 rka = kzalloc(sizeof(*rka), GFP_KERNEL);
164 if (!rka)
165 goto error;
e007ce9c 166 rka->callout_info = kmemdup(callout_info, callout_len, GFP_KERNEL);
44d81433
EB
167 if (!rka->callout_info)
168 goto error_free_rka;
e007ce9c 169 rka->callout_len = callout_len;
822ad64d 170 strlcpy(rka->op, op, sizeof(rka->op));
3e30148c 171
b5f545c8
DH
172 /* see if the calling process is already servicing the key request of
173 * another process */
d84f4f99 174 if (cred->request_key_auth) {
b5f545c8 175 /* it is - use that instantiation context here too */
d84f4f99 176 down_read(&cred->request_key_auth->sem);
04c567d9
DH
177
178 /* if the auth key has been revoked, then the key we're
179 * servicing is already instantiated */
44d81433
EB
180 if (test_bit(KEY_FLAG_REVOKED,
181 &cred->request_key_auth->flags)) {
182 up_read(&cred->request_key_auth->sem);
183 ret = -EKEYREVOKED;
184 goto error_free_rka;
185 }
04c567d9 186
146aa8b1 187 irka = cred->request_key_auth->payload.data[0];
d84f4f99 188 rka->cred = get_cred(irka->cred);
b5f545c8 189 rka->pid = irka->pid;
04c567d9 190
d84f4f99 191 up_read(&cred->request_key_auth->sem);
3e30148c 192 }
b5f545c8
DH
193 else {
194 /* it isn't - use this process as the context */
d84f4f99 195 rka->cred = get_cred(cred);
b5f545c8
DH
196 rka->pid = current->pid;
197 }
198
199 rka->target_key = key_get(target);
8bbf4976 200 rka->dest_keyring = key_get(dest_keyring);
3e30148c
DH
201
202 /* allocate the auth key */
203 sprintf(desc, "%x", target->serial);
204
b5f545c8 205 authkey = key_alloc(&key_type_request_key_auth, desc,
d84f4f99 206 cred->fsuid, cred->fsgid, cred,
b5f545c8 207 KEY_POS_VIEW | KEY_POS_READ | KEY_POS_SEARCH |
5ac7eace 208 KEY_USR_VIEW, KEY_ALLOC_NOT_IN_QUOTA, NULL);
b5f545c8
DH
209 if (IS_ERR(authkey)) {
210 ret = PTR_ERR(authkey);
44d81433 211 goto error_free_rka;
3e30148c
DH
212 }
213
d84f4f99 214 /* construct the auth key */
b5f545c8
DH
215 ret = key_instantiate_and_link(authkey, rka, 0, NULL, NULL);
216 if (ret < 0)
44d81433 217 goto error_put_authkey;
3e30148c 218
fff29291 219 kleave(" = {%d,%d}", authkey->serial, refcount_read(&authkey->usage));
b5f545c8
DH
220 return authkey;
221
44d81433 222error_put_authkey:
b5f545c8 223 key_put(authkey);
44d81433
EB
224error_free_rka:
225 free_request_key_auth(rka);
226error:
b5f545c8
DH
227 kleave("= %d", ret);
228 return ERR_PTR(ret);
a8b17ed0 229}
3e30148c 230
3e30148c 231/*
973c9f4f
DH
232 * Search the current process's keyrings for the authorisation key for
233 * instantiation of a key.
3e30148c
DH
234 */
235struct key *key_get_instantiation_authkey(key_serial_t target_id)
236{
d0a059ca 237 char description[16];
4bdf0bc3
DH
238 struct keyring_search_context ctx = {
239 .index_key.type = &key_type_request_key_auth,
d0a059ca 240 .index_key.description = description,
4bdf0bc3 241 .cred = current_cred(),
c06cfb08 242 .match_data.cmp = key_default_cmp,
46291959
DH
243 .match_data.raw_data = description,
244 .match_data.lookup_type = KEYRING_SEARCH_LOOKUP_DIRECT,
054f6180 245 .flags = KEYRING_SEARCH_DO_STATE_CHECK,
4bdf0bc3 246 };
b5f545c8
DH
247 struct key *authkey;
248 key_ref_t authkey_ref;
249
ede0fa98 250 ctx.index_key.desc_len = sprintf(description, "%x", target_id);
d0a059ca 251
4bdf0bc3 252 authkey_ref = search_process_keyrings(&ctx);
b5f545c8
DH
253
254 if (IS_ERR(authkey_ref)) {
e231c2ee 255 authkey = ERR_CAST(authkey_ref);
4d67431f
DH
256 if (authkey == ERR_PTR(-EAGAIN))
257 authkey = ERR_PTR(-ENOKEY);
b5f545c8
DH
258 goto error;
259 }
3e30148c 260
b5f545c8
DH
261 authkey = key_ref_to_ptr(authkey_ref);
262 if (test_bit(KEY_FLAG_REVOKED, &authkey->flags)) {
263 key_put(authkey);
264 authkey = ERR_PTR(-EKEYREVOKED);
265 }
3e30148c 266
b5f545c8
DH
267error:
268 return authkey;
a8b17ed0 269}