internal.h 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. /* internal.h: authentication token and access key management internal defs
  2. *
  3. * Copyright (C) 2003-5 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. #ifndef _INTERNAL_H
  12. #define _INTERNAL_H
  13. #include <linux/key.h>
  14. #include <linux/key-ui.h>
  15. #if 0
  16. #define kenter(FMT, a...) printk("==> %s("FMT")\n",__FUNCTION__ , ## a)
  17. #define kleave(FMT, a...) printk("<== %s()"FMT"\n",__FUNCTION__ , ## a)
  18. #define kdebug(FMT, a...) printk(FMT"\n" , ## a)
  19. #else
  20. #define kenter(FMT, a...) do {} while(0)
  21. #define kleave(FMT, a...) do {} while(0)
  22. #define kdebug(FMT, a...) do {} while(0)
  23. #endif
  24. extern struct key_type key_type_user;
  25. /*****************************************************************************/
  26. /*
  27. * keep track of keys for a user
  28. * - this needs to be separate to user_struct to avoid a refcount-loop
  29. * (user_struct pins some keyrings which pin this struct)
  30. * - this also keeps track of keys under request from userspace for this UID
  31. */
  32. struct key_user {
  33. struct rb_node node;
  34. struct list_head consq; /* construction queue */
  35. spinlock_t lock;
  36. atomic_t usage; /* for accessing qnkeys & qnbytes */
  37. atomic_t nkeys; /* number of keys */
  38. atomic_t nikeys; /* number of instantiated keys */
  39. uid_t uid;
  40. int qnkeys; /* number of keys allocated to this user */
  41. int qnbytes; /* number of bytes allocated to this user */
  42. };
  43. #define KEYQUOTA_MAX_KEYS 100
  44. #define KEYQUOTA_MAX_BYTES 10000
  45. #define KEYQUOTA_LINK_BYTES 4 /* a link in a keyring is worth 4 bytes */
  46. extern struct rb_root key_user_tree;
  47. extern spinlock_t key_user_lock;
  48. extern struct key_user root_key_user;
  49. extern struct key_user *key_user_lookup(uid_t uid);
  50. extern void key_user_put(struct key_user *user);
  51. extern struct rb_root key_serial_tree;
  52. extern spinlock_t key_serial_lock;
  53. extern struct semaphore key_alloc_sem;
  54. extern struct rw_semaphore key_construction_sem;
  55. extern wait_queue_head_t request_key_conswq;
  56. extern void keyring_publish_name(struct key *keyring);
  57. extern int __key_link(struct key *keyring, struct key *key);
  58. extern key_ref_t __keyring_search_one(key_ref_t keyring_ref,
  59. const struct key_type *type,
  60. const char *description,
  61. key_perm_t perm);
  62. extern struct key *keyring_search_instkey(struct key *keyring,
  63. key_serial_t target_id);
  64. typedef int (*key_match_func_t)(const struct key *, const void *);
  65. extern key_ref_t keyring_search_aux(key_ref_t keyring_ref,
  66. struct task_struct *tsk,
  67. struct key_type *type,
  68. const void *description,
  69. key_match_func_t match);
  70. extern key_ref_t search_process_keyrings(struct key_type *type,
  71. const void *description,
  72. key_match_func_t match,
  73. struct task_struct *tsk);
  74. extern struct key *find_keyring_by_name(const char *name, key_serial_t bound);
  75. extern int install_thread_keyring(struct task_struct *tsk);
  76. extern int install_process_keyring(struct task_struct *tsk);
  77. extern struct key *request_key_and_link(struct key_type *type,
  78. const char *description,
  79. const char *callout_info,
  80. void *aux,
  81. struct key *dest_keyring,
  82. unsigned long flags);
  83. /*
  84. * request_key authorisation
  85. */
  86. struct request_key_auth {
  87. struct key *target_key;
  88. struct task_struct *context;
  89. const char *callout_info;
  90. pid_t pid;
  91. };
  92. extern struct key_type key_type_request_key_auth;
  93. extern struct key *request_key_auth_new(struct key *target,
  94. const char *callout_info);
  95. extern struct key *key_get_instantiation_authkey(key_serial_t target_id);
  96. /*
  97. * keyctl functions
  98. */
  99. extern long keyctl_get_keyring_ID(key_serial_t, int);
  100. extern long keyctl_join_session_keyring(const char __user *);
  101. extern long keyctl_update_key(key_serial_t, const void __user *, size_t);
  102. extern long keyctl_revoke_key(key_serial_t);
  103. extern long keyctl_keyring_clear(key_serial_t);
  104. extern long keyctl_keyring_link(key_serial_t, key_serial_t);
  105. extern long keyctl_keyring_unlink(key_serial_t, key_serial_t);
  106. extern long keyctl_describe_key(key_serial_t, char __user *, size_t);
  107. extern long keyctl_keyring_search(key_serial_t, const char __user *,
  108. const char __user *, key_serial_t);
  109. extern long keyctl_read_key(key_serial_t, char __user *, size_t);
  110. extern long keyctl_chown_key(key_serial_t, uid_t, gid_t);
  111. extern long keyctl_setperm_key(key_serial_t, key_perm_t);
  112. extern long keyctl_instantiate_key(key_serial_t, const void __user *,
  113. size_t, key_serial_t);
  114. extern long keyctl_negate_key(key_serial_t, unsigned, key_serial_t);
  115. extern long keyctl_set_reqkey_keyring(int);
  116. extern long keyctl_set_timeout(key_serial_t, unsigned);
  117. extern long keyctl_assume_authority(key_serial_t);
  118. /*
  119. * debugging key validation
  120. */
  121. #ifdef KEY_DEBUGGING
  122. extern void __key_check(const struct key *);
  123. static inline void key_check(const struct key *key)
  124. {
  125. if (key && (IS_ERR(key) || key->magic != KEY_DEBUG_MAGIC))
  126. __key_check(key);
  127. }
  128. #else
  129. #define key_check(key) do {} while(0)
  130. #endif
  131. #endif /* _INTERNAL_H */