security/keys/request_key_auth.c

   1 /* request_key_auth.c: request key authorisation controlling key def
   2  *
   3  * Copyright (C) 2005 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/err.h>
  17 #include <linux/seq_file.h>
  18 #include <asm/uaccess.h>
  19 #include "internal.h"
  20
  21 static int request_key_auth_instantiate(struct key *, const void *, size_t);
  22 static void request_key_auth_describe(const struct key *, struct seq_file *);
  23 static void request_key_auth_revoke(struct key *);
  24 static void request_key_auth_destroy(struct key *);
  25 static long request_key_auth_read(const struct key *, char __user *, size_t);
  26
  27 /*
  28  * the request-key authorisation key type definition
  29  */
  30 struct key_type key_type_request_key_auth = {
  31         .name           = ".request_key_auth",
  32         .def_datalen    = sizeof(struct request_key_auth),
  33         .instantiate    = request_key_auth_instantiate,
  34         .describe       = request_key_auth_describe,
  35         .revoke         = request_key_auth_revoke,
  36         .destroy        = request_key_auth_destroy,
  37         .read           = request_key_auth_read,
  38 };
  39
  40 /*****************************************************************************/
  41 /*
  42  * instantiate a request-key authorisation key
  43  */
  44 static int request_key_auth_instantiate(struct key *key,
  45                                         const void *data,
  46                                         size_t datalen)
  47 {
  48         key->payload.data = (struct request_key_auth *) data;
  49         return 0;
  50
  51 } /* end request_key_auth_instantiate() */
  52
  53 /*****************************************************************************/
  54 /*
  55  * reading a request-key authorisation key retrieves the callout information
  56  */
  57 static void request_key_auth_describe(const struct key *key,
  58                                       struct seq_file *m)
  59 {
  60         struct request_key_auth *rka = key->payload.data;
  61
  62         seq_puts(m, "key:");
  63         seq_puts(m, key->description);
  64         seq_printf(m, " pid:%d ci:%zu", rka->pid, rka->callout_len);
  65
  66 } /* end request_key_auth_describe() */
  67
  68 /*****************************************************************************/
  69 /*
  70  * read the callout_info data
  71  * - the key's semaphore is read-locked
  72  */
  73 static long request_key_auth_read(const struct key *key,
  74                                   char __user *buffer, size_t buflen)
  75 {
  76         struct request_key_auth *rka = key->payload.data;
  77         size_t datalen;
  78         long ret;
  79
  80         datalen = rka->callout_len;
  81         ret = datalen;
  82
  83         /* we can return the data as is */
  84         if (buffer && buflen > 0) {
  85                 if (buflen > datalen)
  86                         buflen = datalen;
  87
  88                 if (copy_to_user(buffer, rka->callout_info, buflen) != 0)
  89                         ret = -EFAULT;
  90         }
  91
  92         return ret;
  93
  94 } /* end request_key_auth_read() */
  95
  96 /*****************************************************************************/
  97 /*
  98  * handle revocation of an authorisation token key
  99  * - called with the key sem write-locked
 100  */
 101 static void request_key_auth_revoke(struct key *key)
 102 {
 103         struct request_key_auth *rka = key->payload.data;
 104
 105         kenter("{%d}", key->serial);
 106
 107         if (rka->context) {
 108                 put_task_struct(rka->context);
 109                 rka->context = NULL;
 110         }
 111
 112 } /* end request_key_auth_revoke() */
 113
 114 /*****************************************************************************/
 115 /*
 116  * destroy an instantiation authorisation token key
 117  */
 118 static void request_key_auth_destroy(struct key *key)
 119 {
 120         struct request_key_auth *rka = key->payload.data;
 121
 122         kenter("{%d}", key->serial);
 123
 124         if (rka->context) {
 125                 put_task_struct(rka->context);
 126                 rka->context = NULL;
 127         }
 128
 129         key_put(rka->target_key);
 130         kfree(rka->callout_info);
 131         kfree(rka);
 132
 133 } /* end request_key_auth_destroy() */
 134
 135 /*****************************************************************************/
 136 /*
 137  * create an authorisation token for /sbin/request-key or whoever to gain
 138  * access to the caller's security data
 139  */
 140 struct key *request_key_auth_new(struct key *target, const void *callout_info,
 141                                  size_t callout_len)
 142 {
 143         struct request_key_auth *rka, *irka;
 144         struct key *authkey = NULL;
 145         char desc[20];
 146         int ret;
 147
 148         kenter("%d,", target->serial);
 149
 150         /* allocate a auth record */
 151         rka = kmalloc(sizeof(*rka), GFP_KERNEL);
 152         if (!rka) {
 153                 kleave(" = -ENOMEM");
 154                 return ERR_PTR(-ENOMEM);
 155         }
 156         rka->callout_info = kmalloc(callout_len, GFP_KERNEL);
 157         if (!rka->callout_info) {
 158                 kleave(" = -ENOMEM");
 159                 kfree(rka);
 160                 return ERR_PTR(-ENOMEM);
 161         }
 162
 163         /* see if the calling process is already servicing the key request of
 164          * another process */
 165         if (current->request_key_auth) {
 166                 /* it is - use that instantiation context here too */
 167                 down_read(&current->request_key_auth->sem);
 168
 169                 /* if the auth key has been revoked, then the key we're
 170                  * servicing is already instantiated */
 171                 if (test_bit(KEY_FLAG_REVOKED,
 172                              &current->request_key_auth->flags))
 173                         goto auth_key_revoked;
 174
 175                 irka = current->request_key_auth->payload.data;
 176                 rka->context = irka->context;
 177                 rka->pid = irka->pid;
 178                 get_task_struct(rka->context);
 179
 180                 up_read(&current->request_key_auth->sem);
 181         }
 182         else {
 183                 /* it isn't - use this process as the context */
 184                 rka->context = current;
 185                 rka->pid = current->pid;
 186                 get_task_struct(rka->context);
 187         }
 188
 189         rka->target_key = key_get(target);
 190         memcpy(rka->callout_info, callout_info, callout_len);
 191         rka->callout_len = callout_len;
 192
 193         /* allocate the auth key */
 194         sprintf(desc, "%x", target->serial);
 195
 196         authkey = key_alloc(&key_type_request_key_auth, desc,
 197                             current->fsuid, current->fsgid, current,
 198                             KEY_POS_VIEW | KEY_POS_READ | KEY_POS_SEARCH |
 199                             KEY_USR_VIEW, KEY_ALLOC_NOT_IN_QUOTA);
 200         if (IS_ERR(authkey)) {
 201                 ret = PTR_ERR(authkey);
 202                 goto error_alloc;
 203         }
 204
 205         /* construct and attach to the keyring */
 206         ret = key_instantiate_and_link(authkey, rka, 0, NULL, NULL);
 207         if (ret < 0)
 208                 goto error_inst;
 209
 210         kleave(" = {%d}", authkey->serial);
 211         return authkey;
 212
 213 auth_key_revoked:
 214         up_read(&current->request_key_auth->sem);
 215         kfree(rka->callout_info);
 216         kfree(rka);
 217         kleave("= -EKEYREVOKED");
 218         return ERR_PTR(-EKEYREVOKED);
 219
 220 error_inst:
 221         key_revoke(authkey);
 222         key_put(authkey);
 223 error_alloc:
 224         key_put(rka->target_key);
 225         kfree(rka->callout_info);
 226         kfree(rka);
 227         kleave("= %d", ret);
 228         return ERR_PTR(ret);
 229
 230 } /* end request_key_auth_new() */
 231
 232 /*****************************************************************************/
 233 /*
 234  * see if an authorisation key is associated with a particular key
 235  */
 236 static int key_get_instantiation_authkey_match(const struct key *key,
 237                                                const void *_id)
 238 {
 239         struct request_key_auth *rka = key->payload.data;
 240         key_serial_t id = (key_serial_t)(unsigned long) _id;
 241
 242         return rka->target_key->serial == id;
 243
 244 } /* end key_get_instantiation_authkey_match() */
 245
 246 /*****************************************************************************/
 247 /*
 248  * get the authorisation key for instantiation of a specific key if attached to
 249  * the current process's keyrings
 250  * - this key is inserted into a keyring and that is set as /sbin/request-key's
 251  *   session keyring
 252  * - a target_id of zero specifies any valid token
 253  */
 254 struct key *key_get_instantiation_authkey(key_serial_t target_id)
 255 {
 256         struct key *authkey;
 257         key_ref_t authkey_ref;
 258
 259         authkey_ref = search_process_keyrings(
 260                 &key_type_request_key_auth,
 261                 (void *) (unsigned long) target_id,
 262                 key_get_instantiation_authkey_match,
 263                 current);
 264
 265         if (IS_ERR(authkey_ref)) {
 266                 authkey = ERR_CAST(authkey_ref);
 267                 goto error;
 268         }
 269
 270         authkey = key_ref_to_ptr(authkey_ref);
 271         if (test_bit(KEY_FLAG_REVOKED, &authkey->flags)) {
 272                 key_put(authkey);
 273                 authkey = ERR_PTR(-EKEYREVOKED);
 274         }
 275
 276 error:
 277         return authkey;
 278
 279 } /* end key_get_instantiation_authkey() */