sysfs: trivial: fix sysfs_create_file kerneldoc spelling mistake
[linux-2.6/mini2440.git] / net / rxrpc / ar-key.c
blob9a8ff684da79b3c9c98bc7d61ea10290d54f05ff
1 /* RxRPC key management
3 * Copyright (C) 2007 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 * RxRPC keys should have a description of describing their purpose:
12 * "afs@CAMBRIDGE.REDHAT.COM>
15 #include <linux/module.h>
16 #include <linux/net.h>
17 #include <linux/skbuff.h>
18 #include <linux/key-type.h>
19 #include <linux/crypto.h>
20 #include <net/sock.h>
21 #include <net/af_rxrpc.h>
22 #include <keys/rxrpc-type.h>
23 #include <keys/user-type.h>
24 #include "ar-internal.h"
26 static int rxrpc_instantiate(struct key *, const void *, size_t);
27 static int rxrpc_instantiate_s(struct key *, const void *, size_t);
28 static void rxrpc_destroy(struct key *);
29 static void rxrpc_destroy_s(struct key *);
30 static void rxrpc_describe(const struct key *, struct seq_file *);
33 * rxrpc defined keys take an arbitrary string as the description and an
34 * arbitrary blob of data as the payload
36 struct key_type key_type_rxrpc = {
37 .name = "rxrpc",
38 .instantiate = rxrpc_instantiate,
39 .match = user_match,
40 .destroy = rxrpc_destroy,
41 .describe = rxrpc_describe,
43 EXPORT_SYMBOL(key_type_rxrpc);
46 * rxrpc server defined keys take "<serviceId>:<securityIndex>" as the
47 * description and an 8-byte decryption key as the payload
49 struct key_type key_type_rxrpc_s = {
50 .name = "rxrpc_s",
51 .instantiate = rxrpc_instantiate_s,
52 .match = user_match,
53 .destroy = rxrpc_destroy_s,
54 .describe = rxrpc_describe,
58 * instantiate an rxrpc defined key
59 * data should be of the form:
60 * OFFSET LEN CONTENT
61 * 0 4 key interface version number
62 * 4 2 security index (type)
63 * 6 2 ticket length
64 * 8 4 key expiry time (time_t)
65 * 12 4 kvno
66 * 16 8 session key
67 * 24 [len] ticket
69 * if no data is provided, then a no-security key is made
71 static int rxrpc_instantiate(struct key *key, const void *data, size_t datalen)
73 const struct rxkad_key *tsec;
74 struct rxrpc_key_payload *upayload;
75 size_t plen;
76 u32 kver;
77 int ret;
79 _enter("{%x},,%zu", key_serial(key), datalen);
81 /* handle a no-security key */
82 if (!data && datalen == 0)
83 return 0;
85 /* get the key interface version number */
86 ret = -EINVAL;
87 if (datalen <= 4 || !data)
88 goto error;
89 memcpy(&kver, data, sizeof(kver));
90 data += sizeof(kver);
91 datalen -= sizeof(kver);
93 _debug("KEY I/F VERSION: %u", kver);
95 ret = -EKEYREJECTED;
96 if (kver != 1)
97 goto error;
99 /* deal with a version 1 key */
100 ret = -EINVAL;
101 if (datalen < sizeof(*tsec))
102 goto error;
104 tsec = data;
105 if (datalen != sizeof(*tsec) + tsec->ticket_len)
106 goto error;
108 _debug("SCIX: %u", tsec->security_index);
109 _debug("TLEN: %u", tsec->ticket_len);
110 _debug("EXPY: %x", tsec->expiry);
111 _debug("KVNO: %u", tsec->kvno);
112 _debug("SKEY: %02x%02x%02x%02x%02x%02x%02x%02x",
113 tsec->session_key[0], tsec->session_key[1],
114 tsec->session_key[2], tsec->session_key[3],
115 tsec->session_key[4], tsec->session_key[5],
116 tsec->session_key[6], tsec->session_key[7]);
117 if (tsec->ticket_len >= 8)
118 _debug("TCKT: %02x%02x%02x%02x%02x%02x%02x%02x",
119 tsec->ticket[0], tsec->ticket[1],
120 tsec->ticket[2], tsec->ticket[3],
121 tsec->ticket[4], tsec->ticket[5],
122 tsec->ticket[6], tsec->ticket[7]);
124 ret = -EPROTONOSUPPORT;
125 if (tsec->security_index != 2)
126 goto error;
128 key->type_data.x[0] = tsec->security_index;
130 plen = sizeof(*upayload) + tsec->ticket_len;
131 ret = key_payload_reserve(key, plen);
132 if (ret < 0)
133 goto error;
135 ret = -ENOMEM;
136 upayload = kmalloc(plen, GFP_KERNEL);
137 if (!upayload)
138 goto error;
140 /* attach the data */
141 memcpy(&upayload->k, tsec, sizeof(*tsec));
142 memcpy(&upayload->k.ticket, (void *)tsec + sizeof(*tsec),
143 tsec->ticket_len);
144 key->payload.data = upayload;
145 key->expiry = tsec->expiry;
146 ret = 0;
148 error:
149 return ret;
153 * instantiate a server secret key
154 * data should be a pointer to the 8-byte secret key
156 static int rxrpc_instantiate_s(struct key *key, const void *data,
157 size_t datalen)
159 struct crypto_blkcipher *ci;
161 _enter("{%x},,%zu", key_serial(key), datalen);
163 if (datalen != 8)
164 return -EINVAL;
166 memcpy(&key->type_data, data, 8);
168 ci = crypto_alloc_blkcipher("pcbc(des)", 0, CRYPTO_ALG_ASYNC);
169 if (IS_ERR(ci)) {
170 _leave(" = %ld", PTR_ERR(ci));
171 return PTR_ERR(ci);
174 if (crypto_blkcipher_setkey(ci, data, 8) < 0)
175 BUG();
177 key->payload.data = ci;
178 _leave(" = 0");
179 return 0;
183 * dispose of the data dangling from the corpse of a rxrpc key
185 static void rxrpc_destroy(struct key *key)
187 kfree(key->payload.data);
191 * dispose of the data dangling from the corpse of a rxrpc key
193 static void rxrpc_destroy_s(struct key *key)
195 if (key->payload.data) {
196 crypto_free_blkcipher(key->payload.data);
197 key->payload.data = NULL;
202 * describe the rxrpc key
204 static void rxrpc_describe(const struct key *key, struct seq_file *m)
206 seq_puts(m, key->description);
210 * grab the security key for a socket
212 int rxrpc_request_key(struct rxrpc_sock *rx, char __user *optval, int optlen)
214 struct key *key;
215 char *description;
217 _enter("");
219 if (optlen <= 0 || optlen > PAGE_SIZE - 1)
220 return -EINVAL;
222 description = kmalloc(optlen + 1, GFP_KERNEL);
223 if (!description)
224 return -ENOMEM;
226 if (copy_from_user(description, optval, optlen)) {
227 kfree(description);
228 return -EFAULT;
230 description[optlen] = 0;
232 key = request_key(&key_type_rxrpc, description, NULL);
233 if (IS_ERR(key)) {
234 kfree(description);
235 _leave(" = %ld", PTR_ERR(key));
236 return PTR_ERR(key);
239 rx->key = key;
240 kfree(description);
241 _leave(" = 0 [key %x]", key->serial);
242 return 0;
246 * grab the security keyring for a server socket
248 int rxrpc_server_keyring(struct rxrpc_sock *rx, char __user *optval,
249 int optlen)
251 struct key *key;
252 char *description;
254 _enter("");
256 if (optlen <= 0 || optlen > PAGE_SIZE - 1)
257 return -EINVAL;
259 description = kmalloc(optlen + 1, GFP_KERNEL);
260 if (!description)
261 return -ENOMEM;
263 if (copy_from_user(description, optval, optlen)) {
264 kfree(description);
265 return -EFAULT;
267 description[optlen] = 0;
269 key = request_key(&key_type_keyring, description, NULL);
270 if (IS_ERR(key)) {
271 kfree(description);
272 _leave(" = %ld", PTR_ERR(key));
273 return PTR_ERR(key);
276 rx->securities = key;
277 kfree(description);
278 _leave(" = 0 [key %x]", key->serial);
279 return 0;
283 * generate a server data key
285 int rxrpc_get_server_data_key(struct rxrpc_connection *conn,
286 const void *session_key,
287 time_t expiry,
288 u32 kvno)
290 struct key *key;
291 int ret;
293 struct {
294 u32 kver;
295 struct rxkad_key tsec;
296 } data;
298 _enter("");
300 key = key_alloc(&key_type_rxrpc, "x", 0, 0, current, 0,
301 KEY_ALLOC_NOT_IN_QUOTA);
302 if (IS_ERR(key)) {
303 _leave(" = -ENOMEM [alloc %ld]", PTR_ERR(key));
304 return -ENOMEM;
307 _debug("key %d", key_serial(key));
309 data.kver = 1;
310 data.tsec.security_index = 2;
311 data.tsec.ticket_len = 0;
312 data.tsec.expiry = expiry;
313 data.tsec.kvno = 0;
315 memcpy(&data.tsec.session_key, session_key,
316 sizeof(data.tsec.session_key));
318 ret = key_instantiate_and_link(key, &data, sizeof(data), NULL, NULL);
319 if (ret < 0)
320 goto error;
322 conn->key = key;
323 _leave(" = 0 [%d]", key_serial(key));
324 return 0;
326 error:
327 key_revoke(key);
328 key_put(key);
329 _leave(" = -ENOMEM [ins %d]", ret);
330 return -ENOMEM;
332 EXPORT_SYMBOL(rxrpc_get_server_data_key);
335 * rxrpc_get_null_key - Generate a null RxRPC key
336 * @keyname: The name to give the key.
338 * Generate a null RxRPC key that can be used to indicate anonymous security is
339 * required for a particular domain.
341 struct key *rxrpc_get_null_key(const char *keyname)
343 struct key *key;
344 int ret;
346 key = key_alloc(&key_type_rxrpc, keyname, 0, 0, current,
347 KEY_POS_SEARCH, KEY_ALLOC_NOT_IN_QUOTA);
348 if (IS_ERR(key))
349 return key;
351 ret = key_instantiate_and_link(key, NULL, 0, NULL, NULL);
352 if (ret < 0) {
353 key_revoke(key);
354 key_put(key);
355 return ERR_PTR(ret);
358 return key;
360 EXPORT_SYMBOL(rxrpc_get_null_key);