user_defined.c 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. /* user_defined.c: user defined key type
  2. *
  3. * Copyright (C) 2004 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. #include <linux/module.h>
  12. #include <linux/init.h>
  13. #include <linux/slab.h>
  14. #include <linux/seq_file.h>
  15. #include <linux/err.h>
  16. #include <keys/user-type.h>
  17. #include <asm/uaccess.h>
  18. #include "internal.h"
  19. static int logon_vet_description(const char *desc);
  20. /*
  21. * user defined keys take an arbitrary string as the description and an
  22. * arbitrary blob of data as the payload
  23. */
  24. struct key_type key_type_user = {
  25. .name = "user",
  26. .instantiate = user_instantiate,
  27. .update = user_update,
  28. .match = user_match,
  29. .revoke = user_revoke,
  30. .destroy = user_destroy,
  31. .describe = user_describe,
  32. .read = user_read,
  33. };
  34. EXPORT_SYMBOL_GPL(key_type_user);
  35. /*
  36. * This key type is essentially the same as key_type_user, but it does
  37. * not define a .read op. This is suitable for storing username and
  38. * password pairs in the keyring that you do not want to be readable
  39. * from userspace.
  40. */
  41. struct key_type key_type_logon = {
  42. .name = "logon",
  43. .instantiate = user_instantiate,
  44. .update = user_update,
  45. .match = user_match,
  46. .revoke = user_revoke,
  47. .destroy = user_destroy,
  48. .describe = user_describe,
  49. .vet_description = logon_vet_description,
  50. };
  51. EXPORT_SYMBOL_GPL(key_type_logon);
  52. /*
  53. * instantiate a user defined key
  54. */
  55. int user_instantiate(struct key *key, const void *data, size_t datalen)
  56. {
  57. struct user_key_payload *upayload;
  58. int ret;
  59. ret = -EINVAL;
  60. if (datalen <= 0 || datalen > 32767 || !data)
  61. goto error;
  62. ret = key_payload_reserve(key, datalen);
  63. if (ret < 0)
  64. goto error;
  65. ret = -ENOMEM;
  66. upayload = kmalloc(sizeof(*upayload) + datalen, GFP_KERNEL);
  67. if (!upayload)
  68. goto error;
  69. /* attach the data */
  70. upayload->datalen = datalen;
  71. memcpy(upayload->data, data, datalen);
  72. rcu_assign_keypointer(key, upayload);
  73. ret = 0;
  74. error:
  75. return ret;
  76. }
  77. EXPORT_SYMBOL_GPL(user_instantiate);
  78. /*
  79. * update a user defined key
  80. * - the key's semaphore is write-locked
  81. */
  82. int user_update(struct key *key, const void *data, size_t datalen)
  83. {
  84. struct user_key_payload *upayload, *zap;
  85. int ret;
  86. ret = -EINVAL;
  87. if (datalen <= 0 || datalen > 32767 || !data)
  88. goto error;
  89. /* construct a replacement payload */
  90. ret = -ENOMEM;
  91. upayload = kmalloc(sizeof(*upayload) + datalen, GFP_KERNEL);
  92. if (!upayload)
  93. goto error;
  94. upayload->datalen = datalen;
  95. memcpy(upayload->data, data, datalen);
  96. /* check the quota and attach the new data */
  97. zap = upayload;
  98. ret = key_payload_reserve(key, datalen);
  99. if (ret == 0) {
  100. /* attach the new data, displacing the old */
  101. if (!test_bit(KEY_FLAG_NEGATIVE, &key->flags))
  102. zap = key->payload.data;
  103. else
  104. zap = NULL;
  105. rcu_assign_keypointer(key, upayload);
  106. key->expiry = 0;
  107. }
  108. if (zap)
  109. kfree_rcu(zap, rcu);
  110. error:
  111. return ret;
  112. }
  113. EXPORT_SYMBOL_GPL(user_update);
  114. /*
  115. * match users on their name
  116. */
  117. int user_match(const struct key *key, const void *description)
  118. {
  119. return strcmp(key->description, description) == 0;
  120. }
  121. EXPORT_SYMBOL_GPL(user_match);
  122. /*
  123. * dispose of the links from a revoked keyring
  124. * - called with the key sem write-locked
  125. */
  126. void user_revoke(struct key *key)
  127. {
  128. struct user_key_payload *upayload = key->payload.data;
  129. /* clear the quota */
  130. key_payload_reserve(key, 0);
  131. if (upayload) {
  132. rcu_assign_keypointer(key, NULL);
  133. kfree_rcu(upayload, rcu);
  134. }
  135. }
  136. EXPORT_SYMBOL(user_revoke);
  137. /*
  138. * dispose of the data dangling from the corpse of a user key
  139. */
  140. void user_destroy(struct key *key)
  141. {
  142. struct user_key_payload *upayload = key->payload.data;
  143. #ifdef CONFIG_CRYPTO_FIPS
  144. if(upayload)
  145. {
  146. memset(upayload->data, 0, upayload->datalen);
  147. }
  148. #endif
  149. kfree(upayload);
  150. }
  151. EXPORT_SYMBOL_GPL(user_destroy);
  152. /*
  153. * describe the user key
  154. */
  155. void user_describe(const struct key *key, struct seq_file *m)
  156. {
  157. seq_puts(m, key->description);
  158. if (key_is_instantiated(key))
  159. seq_printf(m, ": %u", key->datalen);
  160. }
  161. EXPORT_SYMBOL_GPL(user_describe);
  162. /*
  163. * read the key data
  164. * - the key's semaphore is read-locked
  165. */
  166. long user_read(const struct key *key, char __user *buffer, size_t buflen)
  167. {
  168. struct user_key_payload *upayload;
  169. long ret;
  170. upayload = rcu_dereference_key(key);
  171. ret = upayload->datalen;
  172. /* we can return the data as is */
  173. if (buffer && buflen > 0) {
  174. if (buflen > upayload->datalen)
  175. buflen = upayload->datalen;
  176. if (copy_to_user(buffer, upayload->data, buflen) != 0)
  177. ret = -EFAULT;
  178. }
  179. return ret;
  180. }
  181. EXPORT_SYMBOL_GPL(user_read);
  182. /* Vet the description for a "logon" key */
  183. static int logon_vet_description(const char *desc)
  184. {
  185. char *p;
  186. /* require a "qualified" description string */
  187. p = strchr(desc, ':');
  188. if (!p)
  189. return -EINVAL;
  190. /* also reject description with ':' as first char */
  191. if (p == desc)
  192. return -EINVAL;
  193. return 0;
  194. }