include/linux/key.h

   1 /* Authentication token and access key management
   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  *
  12  * See Documentation/keys.txt for information on keys/keyrings.
  13  */
  14
  15 #ifndef _LINUX_KEY_H
  16 #define _LINUX_KEY_H
  17
  18 #include <linux/types.h>
  19 #include <linux/list.h>
  20 #include <linux/rbtree.h>
  21 #include <linux/rcupdate.h>
  22 #include <asm/atomic.h>
  23
  24 #ifdef __KERNEL__
  25
  26 /* key handle serial number */
  27 typedef int32_t key_serial_t;
  28
  29 /* key handle permissions mask */
  30 typedef uint32_t key_perm_t;
  31
  32 struct key;
  33
  34 #ifdef CONFIG_KEYS
  35
  36 #undef KEY_DEBUGGING
  37
  38 #define KEY_POS_VIEW    0x01000000      /* possessor can view a key's attributes */
  39 #define KEY_POS_READ    0x02000000      /* possessor can read key payload / view keyring */
  40 #define KEY_POS_WRITE   0x04000000      /* possessor can update key payload / add link to keyring */
  41 #define KEY_POS_SEARCH  0x08000000      /* possessor can find a key in search / search a keyring */
  42 #define KEY_POS_LINK    0x10000000      /* possessor can create a link to a key/keyring */
  43 #define KEY_POS_SETATTR 0x20000000      /* possessor can set key attributes */
  44 #define KEY_POS_ALL     0x3f000000
  45
  46 #define KEY_USR_VIEW    0x00010000      /* user permissions... */
  47 #define KEY_USR_READ    0x00020000
  48 #define KEY_USR_WRITE   0x00040000
  49 #define KEY_USR_SEARCH  0x00080000
  50 #define KEY_USR_LINK    0x00100000
  51 #define KEY_USR_SETATTR 0x00200000
  52 #define KEY_USR_ALL     0x003f0000
  53
  54 #define KEY_GRP_VIEW    0x00000100      /* group permissions... */
  55 #define KEY_GRP_READ    0x00000200
  56 #define KEY_GRP_WRITE   0x00000400
  57 #define KEY_GRP_SEARCH  0x00000800
  58 #define KEY_GRP_LINK    0x00001000
  59 #define KEY_GRP_SETATTR 0x00002000
  60 #define KEY_GRP_ALL     0x00003f00
  61
  62 #define KEY_OTH_VIEW    0x00000001      /* third party permissions... */
  63 #define KEY_OTH_READ    0x00000002
  64 #define KEY_OTH_WRITE   0x00000004
  65 #define KEY_OTH_SEARCH  0x00000008
  66 #define KEY_OTH_LINK    0x00000010
  67 #define KEY_OTH_SETATTR 0x00000020
  68 #define KEY_OTH_ALL     0x0000003f
  69
  70 #define KEY_PERM_UNDEF  0xffffffff
  71
  72 struct seq_file;
  73 struct user_struct;
  74 struct signal_struct;
  75
  76 struct key_type;
  77 struct key_owner;
  78 struct keyring_list;
  79 struct keyring_name;
  80
  81 /*****************************************************************************/
  82 /*
  83  * key reference with possession attribute handling
  84  *
  85  * NOTE! key_ref_t is a typedef'd pointer to a type that is not actually
  86  * defined. This is because we abuse the bottom bit of the reference to carry a
  87  * flag to indicate whether the calling process possesses that key in one of
  88  * its keyrings.
  89  *
  90  * the key_ref_t has been made a separate type so that the compiler can reject
  91  * attempts to dereference it without proper conversion.
  92  *
  93  * the three functions are used to assemble and disassemble references
  94  */
  95 typedef struct __key_reference_with_attributes *key_ref_t;
  96
  97 static inline key_ref_t make_key_ref(const struct key *key,
  98                                      unsigned long possession)
  99 {
 100         return (key_ref_t) ((unsigned long) key | possession);
 101 }
 102
 103 static inline struct key *key_ref_to_ptr(const key_ref_t key_ref)
 104 {
 105         return (struct key *) ((unsigned long) key_ref & ~1UL);
 106 }
 107
 108 static inline unsigned long is_key_possessed(const key_ref_t key_ref)
 109 {
 110         return (unsigned long) key_ref & 1UL;
 111 }
 112
 113 /*****************************************************************************/
 114 /*
 115  * authentication token / access credential / keyring
 116  * - types of key include:
 117  *   - keyrings
 118  *   - disk encryption IDs
 119  *   - Kerberos TGTs and tickets
 120  */
 121 struct key {
 122         atomic_t                usage;          /* number of references */
 123         key_serial_t            serial;         /* key serial number */
 124         struct rb_node          serial_node;
 125         struct key_type         *type;          /* type of key */
 126         struct rw_semaphore     sem;            /* change vs change sem */
 127         struct key_user         *user;          /* owner of this key */
 128         void                    *security;      /* security data for this key */
 129         time_t                  expiry;         /* time at which key expires (or 0) */
 130         uid_t                   uid;
 131         gid_t                   gid;
 132         key_perm_t              perm;           /* access permissions */
 133         unsigned short          quotalen;       /* length added to quota */
 134         unsigned short          datalen;        /* payload data length
 135                                                  * - may not match RCU dereferenced payload
 136                                                  * - payload should contain own length
 137                                                  */
 138
 139 #ifdef KEY_DEBUGGING
 140         unsigned                magic;
 141 #define KEY_DEBUG_MAGIC         0x18273645u
 142 #define KEY_DEBUG_MAGIC_X       0xf8e9dacbu
 143 #endif
 144
 145         unsigned long           flags;          /* status flags (change with bitops) */
 146 #define KEY_FLAG_INSTANTIATED   0       /* set if key has been instantiated */
 147 #define KEY_FLAG_DEAD           1       /* set if key type has been deleted */
 148 #define KEY_FLAG_REVOKED        2       /* set if key had been revoked */
 149 #define KEY_FLAG_IN_QUOTA       3       /* set if key consumes quota */
 150 #define KEY_FLAG_USER_CONSTRUCT 4       /* set if key is being constructed in userspace */
 151 #define KEY_FLAG_NEGATIVE       5       /* set if key is negative */
 152
 153         /* the description string
 154          * - this is used to match a key against search criteria
 155          * - this should be a printable string
 156          * - eg: for krb5 AFS, this might be "afs@REDHAT.COM"
 157          */
 158         char                    *description;
 159
 160         /* type specific data
 161          * - this is used by the keyring type to index the name
 162          */
 163         union {
 164                 struct list_head        link;
 165                 unsigned long           x[2];
 166                 void                    *p[2];
 167         } type_data;
 168
 169         /* key data
 170          * - this is used to hold the data actually used in cryptography or
 171          *   whatever
 172          */
 173         union {
 174                 unsigned long           value;
 175                 void                    *data;
 176                 struct keyring_list     *subscriptions;
 177         } payload;
 178 };
 179
 180 extern struct key *key_alloc(struct key_type *type,
 181                              const char *desc,
 182                              uid_t uid, gid_t gid,
 183                              struct task_struct *ctx,
 184                              key_perm_t perm,
 185                              unsigned long flags);
 186
 187
 188 #define KEY_ALLOC_IN_QUOTA      0x0000  /* add to quota, reject if would overrun */
 189 #define KEY_ALLOC_QUOTA_OVERRUN 0x0001  /* add to quota, permit even if overrun */
 190 #define KEY_ALLOC_NOT_IN_QUOTA  0x0002  /* not in quota */
 191
 192 extern void key_revoke(struct key *key);
 193 extern void key_put(struct key *key);
 194
 195 static inline struct key *key_get(struct key *key)
 196 {
 197         if (key)
 198                 atomic_inc(&key->usage);
 199         return key;
 200 }
 201
 202 static inline void key_ref_put(key_ref_t key_ref)
 203 {
 204         key_put(key_ref_to_ptr(key_ref));
 205 }
 206
 207 extern struct key *request_key(struct key_type *type,
 208                                const char *description,
 209                                const char *callout_info);
 210
 211 extern struct key *request_key_with_auxdata(struct key_type *type,
 212                                             const char *description,
 213                                             const void *callout_info,
 214                                             size_t callout_len,
 215                                             void *aux);
 216
 217 extern struct key *request_key_async(struct key_type *type,
 218                                      const char *description,
 219                                      const void *callout_info,
 220                                      size_t callout_len);
 221
 222 extern struct key *request_key_async_with_auxdata(struct key_type *type,
 223                                                   const char *description,
 224                                                   const void *callout_info,
 225                                                   size_t callout_len,
 226                                                   void *aux);
 227
 228 extern int wait_for_key_construction(struct key *key, bool intr);
 229
 230 extern int key_validate(struct key *key);
 231
 232 extern key_ref_t key_create_or_update(key_ref_t keyring,
 233                                       const char *type,
 234                                       const char *description,
 235                                       const void *payload,
 236                                       size_t plen,
 237                                       key_perm_t perm,
 238                                       unsigned long flags);
 239
 240 extern int key_update(key_ref_t key,
 241                       const void *payload,
 242                       size_t plen);
 243
 244 extern int key_link(struct key *keyring,
 245                     struct key *key);
 246
 247 extern int key_unlink(struct key *keyring,
 248                       struct key *key);
 249
 250 extern struct key *keyring_alloc(const char *description, uid_t uid, gid_t gid,
 251                                  struct task_struct *ctx,
 252                                  unsigned long flags,
 253                                  struct key *dest);
 254
 255 extern int keyring_clear(struct key *keyring);
 256
 257 extern key_ref_t keyring_search(key_ref_t keyring,
 258                                 struct key_type *type,
 259                                 const char *description);
 260
 261 extern int keyring_add_key(struct key *keyring,
 262                            struct key *key);
 263
 264 extern struct key *key_lookup(key_serial_t id);
 265
 266 #define key_serial(key) ((key) ? (key)->serial : 0)
 267
 268 /*
 269  * the userspace interface
 270  */
 271 extern void switch_uid_keyring(struct user_struct *new_user);
 272 extern int copy_keys(unsigned long clone_flags, struct task_struct *tsk);
 273 extern int copy_thread_group_keys(struct task_struct *tsk);
 274 extern void exit_keys(struct task_struct *tsk);
 275 extern void exit_thread_group_keys(struct signal_struct *tg);
 276 extern int suid_keys(struct task_struct *tsk);
 277 extern int exec_keys(struct task_struct *tsk);
 278 extern void key_fsuid_changed(struct task_struct *tsk);
 279 extern void key_fsgid_changed(struct task_struct *tsk);
 280 extern void key_init(void);
 281
 282 #define __install_session_keyring(tsk, keyring)                 \
 283 ({                                                              \
 284         struct key *old_session = tsk->signal->session_keyring; \
 285         tsk->signal->session_keyring = keyring;                 \
 286         old_session;                                            \
 287 })
 288
 289 #else /* CONFIG_KEYS */
 290
 291 #define key_validate(k)                 0
 292 #define key_serial(k)                   0
 293 #define key_get(k)                      ({ NULL; })
 294 #define key_put(k)                      do { } while(0)
 295 #define key_ref_put(k)                  do { } while(0)
 296 #define make_key_ref(k, p)                      ({ NULL; })
 297 #define key_ref_to_ptr(k)               ({ NULL; })
 298 #define is_key_possessed(k)             0
 299 #define switch_uid_keyring(u)           do { } while(0)
 300 #define __install_session_keyring(t, k) ({ NULL; })
 301 #define copy_keys(f,t)                  0
 302 #define copy_thread_group_keys(t)       0
 303 #define exit_keys(t)                    do { } while(0)
 304 #define exit_thread_group_keys(tg)      do { } while(0)
 305 #define suid_keys(t)                    do { } while(0)
 306 #define exec_keys(t)                    do { } while(0)
 307 #define key_fsuid_changed(t)            do { } while(0)
 308 #define key_fsgid_changed(t)            do { } while(0)
 309 #define key_init()                      do { } while(0)
 310
 311 #endif /* CONFIG_KEYS */
 312 #endif /* __KERNEL__ */
 313 #endif /* _LINUX_KEY_H */