security/keys/big_key.c

   1 /* Large capacity key type
   2  *
   3  * Copyright (C) 2013 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 Licence
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the Licence, or (at your option) any later version.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/init.h>
  14 #include <linux/seq_file.h>
  15 #include <linux/file.h>
  16 #include <linux/shmem_fs.h>
  17 #include <linux/err.h>
  18 #include <keys/user-type.h>
  19 #include <keys/big_key-type.h>
  20
  21 MODULE_LICENSE("GPL");
  22
  23 /*
  24  * If the data is under this limit, there's no point creating a shm file to
  25  * hold it as the permanently resident metadata for the shmem fs will be at
  26  * least as large as the data.
  27  */
  28 #define BIG_KEY_FILE_THRESHOLD (sizeof(struct inode) + sizeof(struct dentry))
  29
  30 /*
  31  * big_key defined keys take an arbitrary string as the description and an
  32  * arbitrary blob of data as the payload
  33  */
  34 struct key_type key_type_big_key = {
  35         .name                   = "big_key",
  36         .preparse               = big_key_preparse,
  37         .free_preparse          = big_key_free_preparse,
  38         .instantiate            = generic_key_instantiate,
  39         .match                  = user_match,
  40         .revoke                 = big_key_revoke,
  41         .destroy                = big_key_destroy,
  42         .describe               = big_key_describe,
  43         .read                   = big_key_read,
  44 };
  45
  46 /*
  47  * Preparse a big key
  48  */
  49 int big_key_preparse(struct key_preparsed_payload *prep)
  50 {
  51         struct path *path = (struct path *)&prep->payload;
  52         struct file *file;
  53         ssize_t written;
  54         size_t datalen = prep->datalen;
  55         int ret;
  56
  57         ret = -EINVAL;
  58         if (datalen <= 0 || datalen > 1024 * 1024 || !prep->data)
  59                 goto error;
  60
  61         /* Set an arbitrary quota */
  62         prep->quotalen = 16;
  63
  64         prep->type_data[1] = (void *)(unsigned long)datalen;
  65
  66         if (datalen > BIG_KEY_FILE_THRESHOLD) {
  67                 /* Create a shmem file to store the data in.  This will permit the data
  68                  * to be swapped out if needed.
  69                  *
  70                  * TODO: Encrypt the stored data with a temporary key.
  71                  */
  72                 file = shmem_kernel_file_setup("", datalen, 0);
  73                 if (IS_ERR(file)) {
  74                         ret = PTR_ERR(file);
  75                         goto error;
  76                 }
  77
  78                 written = kernel_write(file, prep->data, prep->datalen, 0);
  79                 if (written != datalen) {
  80                         ret = written;
  81                         if (written >= 0)
  82                                 ret = -ENOMEM;
  83                         goto err_fput;
  84                 }
  85
  86                 /* Pin the mount and dentry to the key so that we can open it again
  87                  * later
  88                  */
  89                 *path = file->f_path;
  90                 path_get(path);
  91                 fput(file);
  92         } else {
  93                 /* Just store the data in a buffer */
  94                 void *data = kmalloc(datalen, GFP_KERNEL);
  95                 if (!data)
  96                         return -ENOMEM;
  97
  98                 prep->payload[0] = memcpy(data, prep->data, prep->datalen);
  99         }
 100         return 0;
 101
 102 err_fput:
 103         fput(file);
 104 error:
 105         return ret;
 106 }
 107
 108 /*
 109  * Clear preparsement.
 110  */
 111 void big_key_free_preparse(struct key_preparsed_payload *prep)
 112 {
 113         if (prep->datalen > BIG_KEY_FILE_THRESHOLD) {
 114                 struct path *path = (struct path *)&prep->payload;
 115                 path_put(path);
 116         } else {
 117                 kfree(prep->payload[0]);
 118         }
 119 }
 120
 121 /*
 122  * dispose of the links from a revoked keyring
 123  * - called with the key sem write-locked
 124  */
 125 void big_key_revoke(struct key *key)
 126 {
 127         struct path *path = (struct path *)&key->payload.data2;
 128
 129         /* clear the quota */
 130         key_payload_reserve(key, 0);
 131         if (key_is_instantiated(key) && key->type_data.x[1] > BIG_KEY_FILE_THRESHOLD)
 132                 vfs_truncate(path, 0);
 133 }
 134
 135 /*
 136  * dispose of the data dangling from the corpse of a big_key key
 137  */
 138 void big_key_destroy(struct key *key)
 139 {
 140         if (key->type_data.x[1] > BIG_KEY_FILE_THRESHOLD) {
 141                 struct path *path = (struct path *)&key->payload.data2;
 142                 path_put(path);
 143                 path->mnt = NULL;
 144                 path->dentry = NULL;
 145         } else {
 146                 kfree(key->payload.data);
 147                 key->payload.data = NULL;
 148         }
 149 }
 150
 151 /*
 152  * describe the big_key key
 153  */
 154 void big_key_describe(const struct key *key, struct seq_file *m)
 155 {
 156         unsigned long datalen = key->type_data.x[1];
 157
 158         seq_puts(m, key->description);
 159
 160         if (key_is_instantiated(key))
 161                 seq_printf(m, ": %lu [%s]",
 162                            datalen,
 163                            datalen > BIG_KEY_FILE_THRESHOLD ? "file" : "buff");
 164 }
 165
 166 /*
 167  * read the key data
 168  * - the key's semaphore is read-locked
 169  */
 170 long big_key_read(const struct key *key, char __user *buffer, size_t buflen)
 171 {
 172         unsigned long datalen = key->type_data.x[1];
 173         long ret;
 174
 175         if (!buffer || buflen < datalen)
 176                 return datalen;
 177
 178         if (datalen > BIG_KEY_FILE_THRESHOLD) {
 179                 struct path *path = (struct path *)&key->payload.data2;
 180                 struct file *file;
 181                 loff_t pos;
 182
 183                 file = dentry_open(path, O_RDONLY, current_cred());
 184                 if (IS_ERR(file))
 185                         return PTR_ERR(file);
 186
 187                 pos = 0;
 188                 ret = vfs_read(file, buffer, datalen, &pos);
 189                 fput(file);
 190                 if (ret >= 0 && ret != datalen)
 191                         ret = -EIO;
 192         } else {
 193                 ret = datalen;
 194                 if (copy_to_user(buffer, key->payload.data, datalen) != 0)
 195                         ret = -EFAULT;
 196         }
 197
 198         return ret;
 199 }
 200
 201 /*
 202  * Module stuff
 203  */
 204 static int __init big_key_init(void)
 205 {
 206         return register_key_type(&key_type_big_key);
 207 }
 208
 209 static void __exit big_key_cleanup(void)
 210 {
 211         unregister_key_type(&key_type_big_key);
 212 }
 213
 214 module_init(big_key_init);
 215 module_exit(big_key_cleanup);