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