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