get rid of cred argument of vfs_open() and do_dentry_open()
[muen/linux.git] / net / dns_resolver / dns_key.c
1 /* Key type used to cache DNS lookups made by the kernel
2  *
3  * See Documentation/networking/dns_resolver.txt
4  *
5  *   Copyright (c) 2007 Igor Mammedov
6  *   Author(s): Igor Mammedov (niallain@gmail.com)
7  *              Steve French (sfrench@us.ibm.com)
8  *              Wang Lei (wang840925@gmail.com)
9  *              David Howells (dhowells@redhat.com)
10  *
11  *   This library is free software; you can redistribute it and/or modify
12  *   it under the terms of the GNU Lesser General Public License as published
13  *   by the Free Software Foundation; either version 2.1 of the License, or
14  *   (at your option) any later version.
15  *
16  *   This library is distributed in the hope that it will be useful,
17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
19  *   the GNU Lesser General Public License for more details.
20  *
21  *   You should have received a copy of the GNU Lesser General Public License
22  *   along with this library; if not, see <http://www.gnu.org/licenses/>.
23  */
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <linux/slab.h>
27 #include <linux/string.h>
28 #include <linux/kernel.h>
29 #include <linux/keyctl.h>
30 #include <linux/err.h>
31 #include <linux/seq_file.h>
32 #include <keys/dns_resolver-type.h>
33 #include <keys/user-type.h>
34 #include "internal.h"
35
36 MODULE_DESCRIPTION("DNS Resolver");
37 MODULE_AUTHOR("Wang Lei");
38 MODULE_LICENSE("GPL");
39
40 unsigned int dns_resolver_debug;
41 module_param_named(debug, dns_resolver_debug, uint, 0644);
42 MODULE_PARM_DESC(debug, "DNS Resolver debugging mask");
43
44 const struct cred *dns_resolver_cache;
45
46 #define DNS_ERRORNO_OPTION      "dnserror"
47
48 /*
49  * Preparse instantiation data for a dns_resolver key.
50  *
51  * The data must be a NUL-terminated string, with the NUL char accounted in
52  * datalen.
53  *
54  * If the data contains a '#' characters, then we take the clause after each
55  * one to be an option of the form 'key=value'.  The actual data of interest is
56  * the string leading up to the first '#'.  For instance:
57  *
58  *        "ip1,ip2,...#foo=bar"
59  */
60 static int
61 dns_resolver_preparse(struct key_preparsed_payload *prep)
62 {
63         struct user_key_payload *upayload;
64         unsigned long derrno;
65         int ret;
66         int datalen = prep->datalen, result_len = 0;
67         const char *data = prep->data, *end, *opt;
68
69         kenter("'%*.*s',%u", datalen, datalen, data, datalen);
70
71         if (datalen <= 1 || !data || data[datalen - 1] != '\0')
72                 return -EINVAL;
73         datalen--;
74
75         /* deal with any options embedded in the data */
76         end = data + datalen;
77         opt = memchr(data, '#', datalen);
78         if (!opt) {
79                 /* no options: the entire data is the result */
80                 kdebug("no options");
81                 result_len = datalen;
82         } else {
83                 const char *next_opt;
84
85                 result_len = opt - data;
86                 opt++;
87                 kdebug("options: '%s'", opt);
88                 do {
89                         const char *eq;
90                         int opt_len, opt_nlen, opt_vlen, tmp;
91
92                         next_opt = memchr(opt, '#', end - opt) ?: end;
93                         opt_len = next_opt - opt;
94                         if (opt_len <= 0 || opt_len > 128) {
95                                 pr_warn_ratelimited("Invalid option length (%d) for dns_resolver key\n",
96                                                     opt_len);
97                                 return -EINVAL;
98                         }
99
100                         eq = memchr(opt, '=', opt_len) ?: end;
101                         opt_nlen = eq - opt;
102                         eq++;
103                         opt_vlen = next_opt - eq; /* will be -1 if no value */
104
105                         tmp = opt_vlen >= 0 ? opt_vlen : 0;
106                         kdebug("option '%*.*s' val '%*.*s'",
107                                opt_nlen, opt_nlen, opt, tmp, tmp, eq);
108
109                         /* see if it's an error number representing a DNS error
110                          * that's to be recorded as the result in this key */
111                         if (opt_nlen == sizeof(DNS_ERRORNO_OPTION) - 1 &&
112                             memcmp(opt, DNS_ERRORNO_OPTION, opt_nlen) == 0) {
113                                 kdebug("dns error number option");
114                                 if (opt_vlen <= 0)
115                                         goto bad_option_value;
116
117                                 ret = kstrtoul(eq, 10, &derrno);
118                                 if (ret < 0)
119                                         goto bad_option_value;
120
121                                 if (derrno < 1 || derrno > 511)
122                                         goto bad_option_value;
123
124                                 kdebug("dns error no. = %lu", derrno);
125                                 prep->payload.data[dns_key_error] = ERR_PTR(-derrno);
126                                 continue;
127                         }
128
129                 bad_option_value:
130                         pr_warn_ratelimited("Option '%*.*s' to dns_resolver key: bad/missing value\n",
131                                             opt_nlen, opt_nlen, opt);
132                         return -EINVAL;
133                 } while (opt = next_opt + 1, opt < end);
134         }
135
136         /* don't cache the result if we're caching an error saying there's no
137          * result */
138         if (prep->payload.data[dns_key_error]) {
139                 kleave(" = 0 [h_error %ld]", PTR_ERR(prep->payload.data[dns_key_error]));
140                 return 0;
141         }
142
143         kdebug("store result");
144         prep->quotalen = result_len;
145
146         upayload = kmalloc(sizeof(*upayload) + result_len + 1, GFP_KERNEL);
147         if (!upayload) {
148                 kleave(" = -ENOMEM");
149                 return -ENOMEM;
150         }
151
152         upayload->datalen = result_len;
153         memcpy(upayload->data, data, result_len);
154         upayload->data[result_len] = '\0';
155
156         prep->payload.data[dns_key_data] = upayload;
157         kleave(" = 0");
158         return 0;
159 }
160
161 /*
162  * Clean up the preparse data
163  */
164 static void dns_resolver_free_preparse(struct key_preparsed_payload *prep)
165 {
166         pr_devel("==>%s()\n", __func__);
167
168         kfree(prep->payload.data[dns_key_data]);
169 }
170
171 /*
172  * The description is of the form "[<type>:]<domain_name>"
173  *
174  * The domain name may be a simple name or an absolute domain name (which
175  * should end with a period).  The domain name is case-independent.
176  */
177 static bool dns_resolver_cmp(const struct key *key,
178                              const struct key_match_data *match_data)
179 {
180         int slen, dlen, ret = 0;
181         const char *src = key->description, *dsp = match_data->raw_data;
182
183         kenter("%s,%s", src, dsp);
184
185         if (!src || !dsp)
186                 goto no_match;
187
188         if (strcasecmp(src, dsp) == 0)
189                 goto matched;
190
191         slen = strlen(src);
192         dlen = strlen(dsp);
193         if (slen <= 0 || dlen <= 0)
194                 goto no_match;
195         if (src[slen - 1] == '.')
196                 slen--;
197         if (dsp[dlen - 1] == '.')
198                 dlen--;
199         if (slen != dlen || strncasecmp(src, dsp, slen) != 0)
200                 goto no_match;
201
202 matched:
203         ret = 1;
204 no_match:
205         kleave(" = %d", ret);
206         return ret;
207 }
208
209 /*
210  * Preparse the match criterion.
211  */
212 static int dns_resolver_match_preparse(struct key_match_data *match_data)
213 {
214         match_data->lookup_type = KEYRING_SEARCH_LOOKUP_ITERATE;
215         match_data->cmp = dns_resolver_cmp;
216         return 0;
217 }
218
219 /*
220  * Describe a DNS key
221  */
222 static void dns_resolver_describe(const struct key *key, struct seq_file *m)
223 {
224         seq_puts(m, key->description);
225         if (key_is_positive(key)) {
226                 int err = PTR_ERR(key->payload.data[dns_key_error]);
227
228                 if (err)
229                         seq_printf(m, ": %d", err);
230                 else
231                         seq_printf(m, ": %u", key->datalen);
232         }
233 }
234
235 /*
236  * read the DNS data
237  * - the key's semaphore is read-locked
238  */
239 static long dns_resolver_read(const struct key *key,
240                               char __user *buffer, size_t buflen)
241 {
242         int err = PTR_ERR(key->payload.data[dns_key_error]);
243
244         if (err)
245                 return err;
246
247         return user_read(key, buffer, buflen);
248 }
249
250 struct key_type key_type_dns_resolver = {
251         .name           = "dns_resolver",
252         .preparse       = dns_resolver_preparse,
253         .free_preparse  = dns_resolver_free_preparse,
254         .instantiate    = generic_key_instantiate,
255         .match_preparse = dns_resolver_match_preparse,
256         .revoke         = user_revoke,
257         .destroy        = user_destroy,
258         .describe       = dns_resolver_describe,
259         .read           = dns_resolver_read,
260 };
261
262 static int __init init_dns_resolver(void)
263 {
264         struct cred *cred;
265         struct key *keyring;
266         int ret;
267
268         /* create an override credential set with a special thread keyring in
269          * which DNS requests are cached
270          *
271          * this is used to prevent malicious redirections from being installed
272          * with add_key().
273          */
274         cred = prepare_kernel_cred(NULL);
275         if (!cred)
276                 return -ENOMEM;
277
278         keyring = keyring_alloc(".dns_resolver",
279                                 GLOBAL_ROOT_UID, GLOBAL_ROOT_GID, cred,
280                                 (KEY_POS_ALL & ~KEY_POS_SETATTR) |
281                                 KEY_USR_VIEW | KEY_USR_READ,
282                                 KEY_ALLOC_NOT_IN_QUOTA, NULL, NULL);
283         if (IS_ERR(keyring)) {
284                 ret = PTR_ERR(keyring);
285                 goto failed_put_cred;
286         }
287
288         ret = register_key_type(&key_type_dns_resolver);
289         if (ret < 0)
290                 goto failed_put_key;
291
292         /* instruct request_key() to use this special keyring as a cache for
293          * the results it looks up */
294         set_bit(KEY_FLAG_ROOT_CAN_CLEAR, &keyring->flags);
295         cred->thread_keyring = keyring;
296         cred->jit_keyring = KEY_REQKEY_DEFL_THREAD_KEYRING;
297         dns_resolver_cache = cred;
298
299         kdebug("DNS resolver keyring: %d\n", key_serial(keyring));
300         return 0;
301
302 failed_put_key:
303         key_put(keyring);
304 failed_put_cred:
305         put_cred(cred);
306         return ret;
307 }
308
309 static void __exit exit_dns_resolver(void)
310 {
311         key_revoke(dns_resolver_cache->thread_keyring);
312         unregister_key_type(&key_type_dns_resolver);
313         put_cred(dns_resolver_cache);
314 }
315
316 module_init(init_dns_resolver)
317 module_exit(exit_dns_resolver)
318 MODULE_LICENSE("GPL");
319