Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* user_defined.c: user defined key type |
2 | * | |
3 | * Copyright (C) 2004 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. | |
10 | */ | |
11 | ||
12 | #include <linux/module.h> | |
13 | #include <linux/init.h> | |
1da177e4 LT |
14 | #include <linux/slab.h> |
15 | #include <linux/seq_file.h> | |
16 | #include <linux/err.h> | |
2aa349f6 | 17 | #include <keys/user-type.h> |
1da177e4 LT |
18 | #include <asm/uaccess.h> |
19 | #include "internal.h" | |
20 | ||
9f6ed2ca JL |
21 | static int logon_vet_description(const char *desc); |
22 | ||
1da177e4 LT |
23 | /* |
24 | * user defined keys take an arbitrary string as the description and an | |
25 | * arbitrary blob of data as the payload | |
26 | */ | |
27 | struct key_type key_type_user = { | |
4bdf0bc3 | 28 | .name = "user", |
f9167789 DH |
29 | .preparse = user_preparse, |
30 | .free_preparse = user_free_preparse, | |
31 | .instantiate = generic_key_instantiate, | |
4bdf0bc3 | 32 | .update = user_update, |
4bdf0bc3 DH |
33 | .revoke = user_revoke, |
34 | .destroy = user_destroy, | |
35 | .describe = user_describe, | |
36 | .read = user_read, | |
1da177e4 LT |
37 | }; |
38 | ||
16c29b67 MH |
39 | EXPORT_SYMBOL_GPL(key_type_user); |
40 | ||
9f6ed2ca JL |
41 | /* |
42 | * This key type is essentially the same as key_type_user, but it does | |
43 | * not define a .read op. This is suitable for storing username and | |
44 | * password pairs in the keyring that you do not want to be readable | |
45 | * from userspace. | |
46 | */ | |
47 | struct key_type key_type_logon = { | |
48 | .name = "logon", | |
f9167789 DH |
49 | .preparse = user_preparse, |
50 | .free_preparse = user_free_preparse, | |
51 | .instantiate = generic_key_instantiate, | |
9f6ed2ca | 52 | .update = user_update, |
9f6ed2ca JL |
53 | .revoke = user_revoke, |
54 | .destroy = user_destroy, | |
55 | .describe = user_describe, | |
56 | .vet_description = logon_vet_description, | |
57 | }; | |
58 | EXPORT_SYMBOL_GPL(key_type_logon); | |
59 | ||
1da177e4 | 60 | /* |
f9167789 | 61 | * Preparse a user defined key payload |
1da177e4 | 62 | */ |
f9167789 | 63 | int user_preparse(struct key_preparsed_payload *prep) |
1da177e4 | 64 | { |
76d8aeab | 65 | struct user_key_payload *upayload; |
cf7f601c | 66 | size_t datalen = prep->datalen; |
1da177e4 | 67 | |
cf7f601c | 68 | if (datalen <= 0 || datalen > 32767 || !prep->data) |
f9167789 | 69 | return -EINVAL; |
1da177e4 | 70 | |
76d8aeab DH |
71 | upayload = kmalloc(sizeof(*upayload) + datalen, GFP_KERNEL); |
72 | if (!upayload) | |
f9167789 | 73 | return -ENOMEM; |
1da177e4 | 74 | |
76d8aeab | 75 | /* attach the data */ |
f9167789 | 76 | prep->quotalen = datalen; |
146aa8b1 | 77 | prep->payload.data[0] = upayload; |
76d8aeab | 78 | upayload->datalen = datalen; |
cf7f601c | 79 | memcpy(upayload->data, prep->data, datalen); |
f9167789 | 80 | return 0; |
a8b17ed0 | 81 | } |
f9167789 | 82 | EXPORT_SYMBOL_GPL(user_preparse); |
31204ed9 | 83 | |
f9167789 DH |
84 | /* |
85 | * Free a preparse of a user defined key payload | |
86 | */ | |
87 | void user_free_preparse(struct key_preparsed_payload *prep) | |
88 | { | |
146aa8b1 | 89 | kfree(prep->payload.data[0]); |
f9167789 DH |
90 | } |
91 | EXPORT_SYMBOL_GPL(user_free_preparse); | |
2aa349f6 | 92 | |
1da177e4 LT |
93 | /* |
94 | * update a user defined key | |
76d8aeab | 95 | * - the key's semaphore is write-locked |
1da177e4 | 96 | */ |
cf7f601c | 97 | int user_update(struct key *key, struct key_preparsed_payload *prep) |
1da177e4 | 98 | { |
76d8aeab | 99 | struct user_key_payload *upayload, *zap; |
cf7f601c | 100 | size_t datalen = prep->datalen; |
1da177e4 LT |
101 | int ret; |
102 | ||
103 | ret = -EINVAL; | |
cf7f601c | 104 | if (datalen <= 0 || datalen > 32767 || !prep->data) |
1da177e4 LT |
105 | goto error; |
106 | ||
76d8aeab | 107 | /* construct a replacement payload */ |
1da177e4 | 108 | ret = -ENOMEM; |
76d8aeab DH |
109 | upayload = kmalloc(sizeof(*upayload) + datalen, GFP_KERNEL); |
110 | if (!upayload) | |
1da177e4 LT |
111 | goto error; |
112 | ||
76d8aeab | 113 | upayload->datalen = datalen; |
cf7f601c | 114 | memcpy(upayload->data, prep->data, datalen); |
1da177e4 LT |
115 | |
116 | /* check the quota and attach the new data */ | |
76d8aeab | 117 | zap = upayload; |
1da177e4 LT |
118 | |
119 | ret = key_payload_reserve(key, datalen); | |
120 | ||
121 | if (ret == 0) { | |
122 | /* attach the new data, displacing the old */ | |
096fe9ea DH |
123 | if (!test_bit(KEY_FLAG_NEGATIVE, &key->flags)) |
124 | zap = key->payload.data[0]; | |
125 | else | |
126 | zap = NULL; | |
f6b24579 | 127 | rcu_assign_keypointer(key, upayload); |
1da177e4 LT |
128 | key->expiry = 0; |
129 | } | |
130 | ||
9f35a33b DH |
131 | if (zap) |
132 | kfree_rcu(zap, rcu); | |
1da177e4 | 133 | |
2aa349f6 | 134 | error: |
1da177e4 | 135 | return ret; |
a8b17ed0 | 136 | } |
1da177e4 | 137 | |
2aa349f6 DH |
138 | EXPORT_SYMBOL_GPL(user_update); |
139 | ||
1da177e4 | 140 | /* |
31204ed9 DH |
141 | * dispose of the links from a revoked keyring |
142 | * - called with the key sem write-locked | |
143 | */ | |
144 | void user_revoke(struct key *key) | |
145 | { | |
146aa8b1 | 146 | struct user_key_payload *upayload = key->payload.data[0]; |
31204ed9 DH |
147 | |
148 | /* clear the quota */ | |
149 | key_payload_reserve(key, 0); | |
150 | ||
151 | if (upayload) { | |
f6b24579 | 152 | rcu_assign_keypointer(key, NULL); |
3acb458c | 153 | kfree_rcu(upayload, rcu); |
31204ed9 | 154 | } |
a8b17ed0 | 155 | } |
31204ed9 DH |
156 | |
157 | EXPORT_SYMBOL(user_revoke); | |
158 | ||
31204ed9 DH |
159 | /* |
160 | * dispose of the data dangling from the corpse of a user key | |
1da177e4 | 161 | */ |
2aa349f6 | 162 | void user_destroy(struct key *key) |
1da177e4 | 163 | { |
146aa8b1 | 164 | struct user_key_payload *upayload = key->payload.data[0]; |
76d8aeab DH |
165 | |
166 | kfree(upayload); | |
a8b17ed0 | 167 | } |
1da177e4 | 168 | |
2aa349f6 DH |
169 | EXPORT_SYMBOL_GPL(user_destroy); |
170 | ||
1da177e4 | 171 | /* |
76d8aeab | 172 | * describe the user key |
1da177e4 | 173 | */ |
2aa349f6 | 174 | void user_describe(const struct key *key, struct seq_file *m) |
1da177e4 LT |
175 | { |
176 | seq_puts(m, key->description); | |
78b7280c DH |
177 | if (key_is_instantiated(key)) |
178 | seq_printf(m, ": %u", key->datalen); | |
a8b17ed0 | 179 | } |
1da177e4 | 180 | |
2aa349f6 DH |
181 | EXPORT_SYMBOL_GPL(user_describe); |
182 | ||
1da177e4 LT |
183 | /* |
184 | * read the key data | |
76d8aeab | 185 | * - the key's semaphore is read-locked |
1da177e4 | 186 | */ |
2aa349f6 | 187 | long user_read(const struct key *key, char __user *buffer, size_t buflen) |
1da177e4 | 188 | { |
146aa8b1 | 189 | const struct user_key_payload *upayload; |
76d8aeab DH |
190 | long ret; |
191 | ||
146aa8b1 | 192 | upayload = user_key_payload(key); |
76d8aeab | 193 | ret = upayload->datalen; |
1da177e4 LT |
194 | |
195 | /* we can return the data as is */ | |
196 | if (buffer && buflen > 0) { | |
76d8aeab DH |
197 | if (buflen > upayload->datalen) |
198 | buflen = upayload->datalen; | |
1da177e4 | 199 | |
76d8aeab | 200 | if (copy_to_user(buffer, upayload->data, buflen) != 0) |
1da177e4 LT |
201 | ret = -EFAULT; |
202 | } | |
203 | ||
204 | return ret; | |
a8b17ed0 | 205 | } |
2aa349f6 DH |
206 | |
207 | EXPORT_SYMBOL_GPL(user_read); | |
9f6ed2ca JL |
208 | |
209 | /* Vet the description for a "logon" key */ | |
210 | static int logon_vet_description(const char *desc) | |
211 | { | |
212 | char *p; | |
213 | ||
214 | /* require a "qualified" description string */ | |
215 | p = strchr(desc, ':'); | |
216 | if (!p) | |
217 | return -EINVAL; | |
218 | ||
219 | /* also reject description with ':' as first char */ | |
220 | if (p == desc) | |
221 | return -EINVAL; | |
222 | ||
223 | return 0; | |
224 | } |