Merge tag 'for-linus-20140905' of git://git.infradead.org/linux-mtd
[sfrench/cifs-2.6.git] / security / keys / request_key.c
1 /* Request a key from userspace
2  *
3  * Copyright (C) 2004-2007 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  * See Documentation/security/keys-request-key.txt
12  */
13
14 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/kmod.h>
17 #include <linux/err.h>
18 #include <linux/keyctl.h>
19 #include <linux/slab.h>
20 #include "internal.h"
21
22 #define key_negative_timeout    60      /* default timeout on a negative key's existence */
23
24 /**
25  * complete_request_key - Complete the construction of a key.
26  * @cons: The key construction record.
27  * @error: The success or failute of the construction.
28  *
29  * Complete the attempt to construct a key.  The key will be negated
30  * if an error is indicated.  The authorisation key will be revoked
31  * unconditionally.
32  */
33 void complete_request_key(struct key_construction *cons, int error)
34 {
35         kenter("{%d,%d},%d", cons->key->serial, cons->authkey->serial, error);
36
37         if (error < 0)
38                 key_negate_and_link(cons->key, key_negative_timeout, NULL,
39                                     cons->authkey);
40         else
41                 key_revoke(cons->authkey);
42
43         key_put(cons->key);
44         key_put(cons->authkey);
45         kfree(cons);
46 }
47 EXPORT_SYMBOL(complete_request_key);
48
49 /*
50  * Initialise a usermode helper that is going to have a specific session
51  * keyring.
52  *
53  * This is called in context of freshly forked kthread before kernel_execve(),
54  * so we can simply install the desired session_keyring at this point.
55  */
56 static int umh_keys_init(struct subprocess_info *info, struct cred *cred)
57 {
58         struct key *keyring = info->data;
59
60         return install_session_keyring_to_cred(cred, keyring);
61 }
62
63 /*
64  * Clean up a usermode helper with session keyring.
65  */
66 static void umh_keys_cleanup(struct subprocess_info *info)
67 {
68         struct key *keyring = info->data;
69         key_put(keyring);
70 }
71
72 /*
73  * Call a usermode helper with a specific session keyring.
74  */
75 static int call_usermodehelper_keys(char *path, char **argv, char **envp,
76                                         struct key *session_keyring, int wait)
77 {
78         struct subprocess_info *info;
79
80         info = call_usermodehelper_setup(path, argv, envp, GFP_KERNEL,
81                                           umh_keys_init, umh_keys_cleanup,
82                                           session_keyring);
83         if (!info)
84                 return -ENOMEM;
85
86         key_get(session_keyring);
87         return call_usermodehelper_exec(info, wait);
88 }
89
90 /*
91  * Request userspace finish the construction of a key
92  * - execute "/sbin/request-key <op> <key> <uid> <gid> <keyring> <keyring> <keyring>"
93  */
94 static int call_sbin_request_key(struct key_construction *cons,
95                                  const char *op,
96                                  void *aux)
97 {
98         const struct cred *cred = current_cred();
99         key_serial_t prkey, sskey;
100         struct key *key = cons->key, *authkey = cons->authkey, *keyring,
101                 *session;
102         char *argv[9], *envp[3], uid_str[12], gid_str[12];
103         char key_str[12], keyring_str[3][12];
104         char desc[20];
105         int ret, i;
106
107         kenter("{%d},{%d},%s", key->serial, authkey->serial, op);
108
109         ret = install_user_keyrings();
110         if (ret < 0)
111                 goto error_alloc;
112
113         /* allocate a new session keyring */
114         sprintf(desc, "_req.%u", key->serial);
115
116         cred = get_current_cred();
117         keyring = keyring_alloc(desc, cred->fsuid, cred->fsgid, cred,
118                                 KEY_POS_ALL | KEY_USR_VIEW | KEY_USR_READ,
119                                 KEY_ALLOC_QUOTA_OVERRUN, NULL);
120         put_cred(cred);
121         if (IS_ERR(keyring)) {
122                 ret = PTR_ERR(keyring);
123                 goto error_alloc;
124         }
125
126         /* attach the auth key to the session keyring */
127         ret = key_link(keyring, authkey);
128         if (ret < 0)
129                 goto error_link;
130
131         /* record the UID and GID */
132         sprintf(uid_str, "%d", from_kuid(&init_user_ns, cred->fsuid));
133         sprintf(gid_str, "%d", from_kgid(&init_user_ns, cred->fsgid));
134
135         /* we say which key is under construction */
136         sprintf(key_str, "%d", key->serial);
137
138         /* we specify the process's default keyrings */
139         sprintf(keyring_str[0], "%d",
140                 cred->thread_keyring ? cred->thread_keyring->serial : 0);
141
142         prkey = 0;
143         if (cred->process_keyring)
144                 prkey = cred->process_keyring->serial;
145         sprintf(keyring_str[1], "%d", prkey);
146
147         rcu_read_lock();
148         session = rcu_dereference(cred->session_keyring);
149         if (!session)
150                 session = cred->user->session_keyring;
151         sskey = session->serial;
152         rcu_read_unlock();
153
154         sprintf(keyring_str[2], "%d", sskey);
155
156         /* set up a minimal environment */
157         i = 0;
158         envp[i++] = "HOME=/";
159         envp[i++] = "PATH=/sbin:/bin:/usr/sbin:/usr/bin";
160         envp[i] = NULL;
161
162         /* set up the argument list */
163         i = 0;
164         argv[i++] = "/sbin/request-key";
165         argv[i++] = (char *) op;
166         argv[i++] = key_str;
167         argv[i++] = uid_str;
168         argv[i++] = gid_str;
169         argv[i++] = keyring_str[0];
170         argv[i++] = keyring_str[1];
171         argv[i++] = keyring_str[2];
172         argv[i] = NULL;
173
174         /* do it */
175         ret = call_usermodehelper_keys(argv[0], argv, envp, keyring,
176                                        UMH_WAIT_PROC);
177         kdebug("usermode -> 0x%x", ret);
178         if (ret >= 0) {
179                 /* ret is the exit/wait code */
180                 if (test_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags) ||
181                     key_validate(key) < 0)
182                         ret = -ENOKEY;
183                 else
184                         /* ignore any errors from userspace if the key was
185                          * instantiated */
186                         ret = 0;
187         }
188
189 error_link:
190         key_put(keyring);
191
192 error_alloc:
193         complete_request_key(cons, ret);
194         kleave(" = %d", ret);
195         return ret;
196 }
197
198 /*
199  * Call out to userspace for key construction.
200  *
201  * Program failure is ignored in favour of key status.
202  */
203 static int construct_key(struct key *key, const void *callout_info,
204                          size_t callout_len, void *aux,
205                          struct key *dest_keyring)
206 {
207         struct key_construction *cons;
208         request_key_actor_t actor;
209         struct key *authkey;
210         int ret;
211
212         kenter("%d,%p,%zu,%p", key->serial, callout_info, callout_len, aux);
213
214         cons = kmalloc(sizeof(*cons), GFP_KERNEL);
215         if (!cons)
216                 return -ENOMEM;
217
218         /* allocate an authorisation key */
219         authkey = request_key_auth_new(key, callout_info, callout_len,
220                                        dest_keyring);
221         if (IS_ERR(authkey)) {
222                 kfree(cons);
223                 ret = PTR_ERR(authkey);
224                 authkey = NULL;
225         } else {
226                 cons->authkey = key_get(authkey);
227                 cons->key = key_get(key);
228
229                 /* make the call */
230                 actor = call_sbin_request_key;
231                 if (key->type->request_key)
232                         actor = key->type->request_key;
233
234                 ret = actor(cons, "create", aux);
235
236                 /* check that the actor called complete_request_key() prior to
237                  * returning an error */
238                 WARN_ON(ret < 0 &&
239                         !test_bit(KEY_FLAG_REVOKED, &authkey->flags));
240                 key_put(authkey);
241         }
242
243         kleave(" = %d", ret);
244         return ret;
245 }
246
247 /*
248  * Get the appropriate destination keyring for the request.
249  *
250  * The keyring selected is returned with an extra reference upon it which the
251  * caller must release.
252  */
253 static void construct_get_dest_keyring(struct key **_dest_keyring)
254 {
255         struct request_key_auth *rka;
256         const struct cred *cred = current_cred();
257         struct key *dest_keyring = *_dest_keyring, *authkey;
258
259         kenter("%p", dest_keyring);
260
261         /* find the appropriate keyring */
262         if (dest_keyring) {
263                 /* the caller supplied one */
264                 key_get(dest_keyring);
265         } else {
266                 /* use a default keyring; falling through the cases until we
267                  * find one that we actually have */
268                 switch (cred->jit_keyring) {
269                 case KEY_REQKEY_DEFL_DEFAULT:
270                 case KEY_REQKEY_DEFL_REQUESTOR_KEYRING:
271                         if (cred->request_key_auth) {
272                                 authkey = cred->request_key_auth;
273                                 down_read(&authkey->sem);
274                                 rka = authkey->payload.data;
275                                 if (!test_bit(KEY_FLAG_REVOKED,
276                                               &authkey->flags))
277                                         dest_keyring =
278                                                 key_get(rka->dest_keyring);
279                                 up_read(&authkey->sem);
280                                 if (dest_keyring)
281                                         break;
282                         }
283
284                 case KEY_REQKEY_DEFL_THREAD_KEYRING:
285                         dest_keyring = key_get(cred->thread_keyring);
286                         if (dest_keyring)
287                                 break;
288
289                 case KEY_REQKEY_DEFL_PROCESS_KEYRING:
290                         dest_keyring = key_get(cred->process_keyring);
291                         if (dest_keyring)
292                                 break;
293
294                 case KEY_REQKEY_DEFL_SESSION_KEYRING:
295                         rcu_read_lock();
296                         dest_keyring = key_get(
297                                 rcu_dereference(cred->session_keyring));
298                         rcu_read_unlock();
299
300                         if (dest_keyring)
301                                 break;
302
303                 case KEY_REQKEY_DEFL_USER_SESSION_KEYRING:
304                         dest_keyring =
305                                 key_get(cred->user->session_keyring);
306                         break;
307
308                 case KEY_REQKEY_DEFL_USER_KEYRING:
309                         dest_keyring = key_get(cred->user->uid_keyring);
310                         break;
311
312                 case KEY_REQKEY_DEFL_GROUP_KEYRING:
313                 default:
314                         BUG();
315                 }
316         }
317
318         *_dest_keyring = dest_keyring;
319         kleave(" [dk %d]", key_serial(dest_keyring));
320         return;
321 }
322
323 /*
324  * Allocate a new key in under-construction state and attempt to link it in to
325  * the requested keyring.
326  *
327  * May return a key that's already under construction instead if there was a
328  * race between two thread calling request_key().
329  */
330 static int construct_alloc_key(struct keyring_search_context *ctx,
331                                struct key *dest_keyring,
332                                unsigned long flags,
333                                struct key_user *user,
334                                struct key **_key)
335 {
336         struct assoc_array_edit *edit;
337         struct key *key;
338         key_perm_t perm;
339         key_ref_t key_ref;
340         int ret;
341
342         kenter("%s,%s,,,",
343                ctx->index_key.type->name, ctx->index_key.description);
344
345         *_key = NULL;
346         mutex_lock(&user->cons_lock);
347
348         perm = KEY_POS_VIEW | KEY_POS_SEARCH | KEY_POS_LINK | KEY_POS_SETATTR;
349         perm |= KEY_USR_VIEW;
350         if (ctx->index_key.type->read)
351                 perm |= KEY_POS_READ;
352         if (ctx->index_key.type == &key_type_keyring ||
353             ctx->index_key.type->update)
354                 perm |= KEY_POS_WRITE;
355
356         key = key_alloc(ctx->index_key.type, ctx->index_key.description,
357                         ctx->cred->fsuid, ctx->cred->fsgid, ctx->cred,
358                         perm, flags);
359         if (IS_ERR(key))
360                 goto alloc_failed;
361
362         set_bit(KEY_FLAG_USER_CONSTRUCT, &key->flags);
363
364         if (dest_keyring) {
365                 ret = __key_link_begin(dest_keyring, &ctx->index_key, &edit);
366                 if (ret < 0)
367                         goto link_prealloc_failed;
368         }
369
370         /* attach the key to the destination keyring under lock, but we do need
371          * to do another check just in case someone beat us to it whilst we
372          * waited for locks */
373         mutex_lock(&key_construction_mutex);
374
375         key_ref = search_process_keyrings(ctx);
376         if (!IS_ERR(key_ref))
377                 goto key_already_present;
378
379         if (dest_keyring)
380                 __key_link(key, &edit);
381
382         mutex_unlock(&key_construction_mutex);
383         if (dest_keyring)
384                 __key_link_end(dest_keyring, &ctx->index_key, edit);
385         mutex_unlock(&user->cons_lock);
386         *_key = key;
387         kleave(" = 0 [%d]", key_serial(key));
388         return 0;
389
390         /* the key is now present - we tell the caller that we found it by
391          * returning -EINPROGRESS  */
392 key_already_present:
393         key_put(key);
394         mutex_unlock(&key_construction_mutex);
395         key = key_ref_to_ptr(key_ref);
396         if (dest_keyring) {
397                 ret = __key_link_check_live_key(dest_keyring, key);
398                 if (ret == 0)
399                         __key_link(key, &edit);
400                 __key_link_end(dest_keyring, &ctx->index_key, edit);
401                 if (ret < 0)
402                         goto link_check_failed;
403         }
404         mutex_unlock(&user->cons_lock);
405         *_key = key;
406         kleave(" = -EINPROGRESS [%d]", key_serial(key));
407         return -EINPROGRESS;
408
409 link_check_failed:
410         mutex_unlock(&user->cons_lock);
411         key_put(key);
412         kleave(" = %d [linkcheck]", ret);
413         return ret;
414
415 link_prealloc_failed:
416         mutex_unlock(&user->cons_lock);
417         kleave(" = %d [prelink]", ret);
418         return ret;
419
420 alloc_failed:
421         mutex_unlock(&user->cons_lock);
422         kleave(" = %ld", PTR_ERR(key));
423         return PTR_ERR(key);
424 }
425
426 /*
427  * Commence key construction.
428  */
429 static struct key *construct_key_and_link(struct keyring_search_context *ctx,
430                                           const char *callout_info,
431                                           size_t callout_len,
432                                           void *aux,
433                                           struct key *dest_keyring,
434                                           unsigned long flags)
435 {
436         struct key_user *user;
437         struct key *key;
438         int ret;
439
440         kenter("");
441
442         user = key_user_lookup(current_fsuid());
443         if (!user)
444                 return ERR_PTR(-ENOMEM);
445
446         construct_get_dest_keyring(&dest_keyring);
447
448         ret = construct_alloc_key(ctx, dest_keyring, flags, user, &key);
449         key_user_put(user);
450
451         if (ret == 0) {
452                 ret = construct_key(key, callout_info, callout_len, aux,
453                                     dest_keyring);
454                 if (ret < 0) {
455                         kdebug("cons failed");
456                         goto construction_failed;
457                 }
458         } else if (ret == -EINPROGRESS) {
459                 ret = 0;
460         } else {
461                 goto couldnt_alloc_key;
462         }
463
464         key_put(dest_keyring);
465         kleave(" = key %d", key_serial(key));
466         return key;
467
468 construction_failed:
469         key_negate_and_link(key, key_negative_timeout, NULL, NULL);
470         key_put(key);
471 couldnt_alloc_key:
472         key_put(dest_keyring);
473         kleave(" = %d", ret);
474         return ERR_PTR(ret);
475 }
476
477 /**
478  * request_key_and_link - Request a key and cache it in a keyring.
479  * @type: The type of key we want.
480  * @description: The searchable description of the key.
481  * @callout_info: The data to pass to the instantiation upcall (or NULL).
482  * @callout_len: The length of callout_info.
483  * @aux: Auxiliary data for the upcall.
484  * @dest_keyring: Where to cache the key.
485  * @flags: Flags to key_alloc().
486  *
487  * A key matching the specified criteria is searched for in the process's
488  * keyrings and returned with its usage count incremented if found.  Otherwise,
489  * if callout_info is not NULL, a key will be allocated and some service
490  * (probably in userspace) will be asked to instantiate it.
491  *
492  * If successfully found or created, the key will be linked to the destination
493  * keyring if one is provided.
494  *
495  * Returns a pointer to the key if successful; -EACCES, -ENOKEY, -EKEYREVOKED
496  * or -EKEYEXPIRED if an inaccessible, negative, revoked or expired key was
497  * found; -ENOKEY if no key was found and no @callout_info was given; -EDQUOT
498  * if insufficient key quota was available to create a new key; or -ENOMEM if
499  * insufficient memory was available.
500  *
501  * If the returned key was created, then it may still be under construction,
502  * and wait_for_key_construction() should be used to wait for that to complete.
503  */
504 struct key *request_key_and_link(struct key_type *type,
505                                  const char *description,
506                                  const void *callout_info,
507                                  size_t callout_len,
508                                  void *aux,
509                                  struct key *dest_keyring,
510                                  unsigned long flags)
511 {
512         struct keyring_search_context ctx = {
513                 .index_key.type         = type,
514                 .index_key.description  = description,
515                 .cred                   = current_cred(),
516                 .match                  = type->match,
517                 .match_data             = description,
518                 .flags                  = KEYRING_SEARCH_LOOKUP_DIRECT,
519         };
520         struct key *key;
521         key_ref_t key_ref;
522         int ret;
523
524         kenter("%s,%s,%p,%zu,%p,%p,%lx",
525                ctx.index_key.type->name, ctx.index_key.description,
526                callout_info, callout_len, aux, dest_keyring, flags);
527
528         /* search all the process keyrings for a key */
529         key_ref = search_process_keyrings(&ctx);
530
531         if (!IS_ERR(key_ref)) {
532                 key = key_ref_to_ptr(key_ref);
533                 if (dest_keyring) {
534                         construct_get_dest_keyring(&dest_keyring);
535                         ret = key_link(dest_keyring, key);
536                         key_put(dest_keyring);
537                         if (ret < 0) {
538                                 key_put(key);
539                                 key = ERR_PTR(ret);
540                                 goto error;
541                         }
542                 }
543         } else if (PTR_ERR(key_ref) != -EAGAIN) {
544                 key = ERR_CAST(key_ref);
545         } else  {
546                 /* the search failed, but the keyrings were searchable, so we
547                  * should consult userspace if we can */
548                 key = ERR_PTR(-ENOKEY);
549                 if (!callout_info)
550                         goto error;
551
552                 key = construct_key_and_link(&ctx, callout_info, callout_len,
553                                              aux, dest_keyring, flags);
554         }
555
556 error:
557         kleave(" = %p", key);
558         return key;
559 }
560
561 /**
562  * wait_for_key_construction - Wait for construction of a key to complete
563  * @key: The key being waited for.
564  * @intr: Whether to wait interruptibly.
565  *
566  * Wait for a key to finish being constructed.
567  *
568  * Returns 0 if successful; -ERESTARTSYS if the wait was interrupted; -ENOKEY
569  * if the key was negated; or -EKEYREVOKED or -EKEYEXPIRED if the key was
570  * revoked or expired.
571  */
572 int wait_for_key_construction(struct key *key, bool intr)
573 {
574         int ret;
575
576         ret = wait_on_bit(&key->flags, KEY_FLAG_USER_CONSTRUCT,
577                           intr ? TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE);
578         if (ret)
579                 return -ERESTARTSYS;
580         if (test_bit(KEY_FLAG_NEGATIVE, &key->flags)) {
581                 smp_rmb();
582                 return key->type_data.reject_error;
583         }
584         return key_validate(key);
585 }
586 EXPORT_SYMBOL(wait_for_key_construction);
587
588 /**
589  * request_key - Request a key and wait for construction
590  * @type: Type of key.
591  * @description: The searchable description of the key.
592  * @callout_info: The data to pass to the instantiation upcall (or NULL).
593  *
594  * As for request_key_and_link() except that it does not add the returned key
595  * to a keyring if found, new keys are always allocated in the user's quota,
596  * the callout_info must be a NUL-terminated string and no auxiliary data can
597  * be passed.
598  *
599  * Furthermore, it then works as wait_for_key_construction() to wait for the
600  * completion of keys undergoing construction with a non-interruptible wait.
601  */
602 struct key *request_key(struct key_type *type,
603                         const char *description,
604                         const char *callout_info)
605 {
606         struct key *key;
607         size_t callout_len = 0;
608         int ret;
609
610         if (callout_info)
611                 callout_len = strlen(callout_info);
612         key = request_key_and_link(type, description, callout_info, callout_len,
613                                    NULL, NULL, KEY_ALLOC_IN_QUOTA);
614         if (!IS_ERR(key)) {
615                 ret = wait_for_key_construction(key, false);
616                 if (ret < 0) {
617                         key_put(key);
618                         return ERR_PTR(ret);
619                 }
620         }
621         return key;
622 }
623 EXPORT_SYMBOL(request_key);
624
625 /**
626  * request_key_with_auxdata - Request a key with auxiliary data for the upcaller
627  * @type: The type of key we want.
628  * @description: The searchable description of the key.
629  * @callout_info: The data to pass to the instantiation upcall (or NULL).
630  * @callout_len: The length of callout_info.
631  * @aux: Auxiliary data for the upcall.
632  *
633  * As for request_key_and_link() except that it does not add the returned key
634  * to a keyring if found and new keys are always allocated in the user's quota.
635  *
636  * Furthermore, it then works as wait_for_key_construction() to wait for the
637  * completion of keys undergoing construction with a non-interruptible wait.
638  */
639 struct key *request_key_with_auxdata(struct key_type *type,
640                                      const char *description,
641                                      const void *callout_info,
642                                      size_t callout_len,
643                                      void *aux)
644 {
645         struct key *key;
646         int ret;
647
648         key = request_key_and_link(type, description, callout_info, callout_len,
649                                    aux, NULL, KEY_ALLOC_IN_QUOTA);
650         if (!IS_ERR(key)) {
651                 ret = wait_for_key_construction(key, false);
652                 if (ret < 0) {
653                         key_put(key);
654                         return ERR_PTR(ret);
655                 }
656         }
657         return key;
658 }
659 EXPORT_SYMBOL(request_key_with_auxdata);
660
661 /*
662  * request_key_async - Request a key (allow async construction)
663  * @type: Type of key.
664  * @description: The searchable description of the key.
665  * @callout_info: The data to pass to the instantiation upcall (or NULL).
666  * @callout_len: The length of callout_info.
667  *
668  * As for request_key_and_link() except that it does not add the returned key
669  * to a keyring if found, new keys are always allocated in the user's quota and
670  * no auxiliary data can be passed.
671  *
672  * The caller should call wait_for_key_construction() to wait for the
673  * completion of the returned key if it is still undergoing construction.
674  */
675 struct key *request_key_async(struct key_type *type,
676                               const char *description,
677                               const void *callout_info,
678                               size_t callout_len)
679 {
680         return request_key_and_link(type, description, callout_info,
681                                     callout_len, NULL, NULL,
682                                     KEY_ALLOC_IN_QUOTA);
683 }
684 EXPORT_SYMBOL(request_key_async);
685
686 /*
687  * request a key with auxiliary data for the upcaller (allow async construction)
688  * @type: Type of key.
689  * @description: The searchable description of the key.
690  * @callout_info: The data to pass to the instantiation upcall (or NULL).
691  * @callout_len: The length of callout_info.
692  * @aux: Auxiliary data for the upcall.
693  *
694  * As for request_key_and_link() except that it does not add the returned key
695  * to a keyring if found and new keys are always allocated in the user's quota.
696  *
697  * The caller should call wait_for_key_construction() to wait for the
698  * completion of the returned key if it is still undergoing construction.
699  */
700 struct key *request_key_async_with_auxdata(struct key_type *type,
701                                            const char *description,
702                                            const void *callout_info,
703                                            size_t callout_len,
704                                            void *aux)
705 {
706         return request_key_and_link(type, description, callout_info,
707                                     callout_len, aux, NULL, KEY_ALLOC_IN_QUOTA);
708 }
709 EXPORT_SYMBOL(request_key_async_with_auxdata);