1 /* request_key_auth.c: request key authorisation controlling key def
3 * Copyright (C) 2005 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
11 * See Documentation/keys-request-key.txt
14 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/err.h>
17 #include <linux/seq_file.h>
18 #include <linux/slab.h>
19 #include <asm/uaccess.h>
22 static int request_key_auth_instantiate(struct key *, const void *, size_t);
23 static void request_key_auth_describe(const struct key *, struct seq_file *);
24 static void request_key_auth_revoke(struct key *);
25 static void request_key_auth_destroy(struct key *);
26 static long request_key_auth_read(const struct key *, char __user *, size_t);
29 * the request-key authorisation key type definition
31 struct key_type key_type_request_key_auth = {
32 .name = ".request_key_auth",
33 .def_datalen = sizeof(struct request_key_auth),
34 .instantiate = request_key_auth_instantiate,
35 .describe = request_key_auth_describe,
36 .revoke = request_key_auth_revoke,
37 .destroy = request_key_auth_destroy,
38 .read = request_key_auth_read,
41 /*****************************************************************************/
43 * instantiate a request-key authorisation key
45 static int request_key_auth_instantiate(struct key *key,
49 key->payload.data = (struct request_key_auth *) data;
52 } /* end request_key_auth_instantiate() */
54 /*****************************************************************************/
56 * reading a request-key authorisation key retrieves the callout information
58 static void request_key_auth_describe(const struct key *key,
61 struct request_key_auth *rka = key->payload.data;
64 seq_puts(m, key->description);
65 seq_printf(m, " pid:%d ci:%zu", rka->pid, rka->callout_len);
67 } /* end request_key_auth_describe() */
69 /*****************************************************************************/
71 * read the callout_info data
72 * - the key's semaphore is read-locked
74 static long request_key_auth_read(const struct key *key,
75 char __user *buffer, size_t buflen)
77 struct request_key_auth *rka = key->payload.data;
81 datalen = rka->callout_len;
84 /* we can return the data as is */
85 if (buffer && buflen > 0) {
89 if (copy_to_user(buffer, rka->callout_info, buflen) != 0)
95 } /* end request_key_auth_read() */
97 /*****************************************************************************/
99 * handle revocation of an authorisation token key
100 * - called with the key sem write-locked
102 static void request_key_auth_revoke(struct key *key)
104 struct request_key_auth *rka = key->payload.data;
106 kenter("{%d}", key->serial);
109 put_task_struct(rka->context);
113 } /* end request_key_auth_revoke() */
115 /*****************************************************************************/
117 * destroy an instantiation authorisation token key
119 static void request_key_auth_destroy(struct key *key)
121 struct request_key_auth *rka = key->payload.data;
123 kenter("{%d}", key->serial);
126 put_task_struct(rka->context);
130 key_put(rka->target_key);
131 kfree(rka->callout_info);
134 } /* end request_key_auth_destroy() */
136 /*****************************************************************************/
138 * create an authorisation token for /sbin/request-key or whoever to gain
139 * access to the caller's security data
141 struct key *request_key_auth_new(struct key *target, const void *callout_info,
144 struct request_key_auth *rka, *irka;
145 struct key *authkey = NULL;
149 kenter("%d,", target->serial);
151 /* allocate a auth record */
152 rka = kmalloc(sizeof(*rka), GFP_KERNEL);
154 kleave(" = -ENOMEM");
155 return ERR_PTR(-ENOMEM);
157 rka->callout_info = kmalloc(callout_len, GFP_KERNEL);
158 if (!rka->callout_info) {
159 kleave(" = -ENOMEM");
161 return ERR_PTR(-ENOMEM);
164 /* see if the calling process is already servicing the key request of
166 if (current->request_key_auth) {
167 /* it is - use that instantiation context here too */
168 down_read(¤t->request_key_auth->sem);
170 /* if the auth key has been revoked, then the key we're
171 * servicing is already instantiated */
172 if (test_bit(KEY_FLAG_REVOKED,
173 ¤t->request_key_auth->flags))
174 goto auth_key_revoked;
176 irka = current->request_key_auth->payload.data;
177 rka->context = irka->context;
178 rka->pid = irka->pid;
179 get_task_struct(rka->context);
181 up_read(¤t->request_key_auth->sem);
184 /* it isn't - use this process as the context */
185 rka->context = current;
186 rka->pid = current->pid;
187 get_task_struct(rka->context);
190 rka->target_key = key_get(target);
191 memcpy(rka->callout_info, callout_info, callout_len);
192 rka->callout_len = callout_len;
194 /* allocate the auth key */
195 sprintf(desc, "%x", target->serial);
197 authkey = key_alloc(&key_type_request_key_auth, desc,
198 current->fsuid, current->fsgid, current,
199 KEY_POS_VIEW | KEY_POS_READ | KEY_POS_SEARCH |
200 KEY_USR_VIEW, KEY_ALLOC_NOT_IN_QUOTA);
201 if (IS_ERR(authkey)) {
202 ret = PTR_ERR(authkey);
206 /* construct and attach to the keyring */
207 ret = key_instantiate_and_link(authkey, rka, 0, NULL, NULL);
211 kleave(" = {%d}", authkey->serial);
215 up_read(¤t->request_key_auth->sem);
216 kfree(rka->callout_info);
218 kleave("= -EKEYREVOKED");
219 return ERR_PTR(-EKEYREVOKED);
225 key_put(rka->target_key);
226 kfree(rka->callout_info);
231 } /* end request_key_auth_new() */
233 /*****************************************************************************/
235 * see if an authorisation key is associated with a particular key
237 static int key_get_instantiation_authkey_match(const struct key *key,
240 struct request_key_auth *rka = key->payload.data;
241 key_serial_t id = (key_serial_t)(unsigned long) _id;
243 return rka->target_key->serial == id;
245 } /* end key_get_instantiation_authkey_match() */
247 /*****************************************************************************/
249 * get the authorisation key for instantiation of a specific key if attached to
250 * the current process's keyrings
251 * - this key is inserted into a keyring and that is set as /sbin/request-key's
253 * - a target_id of zero specifies any valid token
255 struct key *key_get_instantiation_authkey(key_serial_t target_id)
258 key_ref_t authkey_ref;
260 authkey_ref = search_process_keyrings(
261 &key_type_request_key_auth,
262 (void *) (unsigned long) target_id,
263 key_get_instantiation_authkey_match,
266 if (IS_ERR(authkey_ref)) {
267 authkey = ERR_CAST(authkey_ref);
271 authkey = key_ref_to_ptr(authkey_ref);
272 if (test_bit(KEY_FLAG_REVOKED, &authkey->flags)) {
274 authkey = ERR_PTR(-EKEYREVOKED);
280 } /* end key_get_instantiation_authkey() */