gss_mech_switch.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482
  1. /*
  2. * linux/net/sunrpc/gss_mech_switch.c
  3. *
  4. * Copyright (c) 2001 The Regents of the University of Michigan.
  5. * All rights reserved.
  6. *
  7. * J. Bruce Fields <bfields@umich.edu>
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. *
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in the
  17. * documentation and/or other materials provided with the distribution.
  18. * 3. Neither the name of the University nor the names of its
  19. * contributors may be used to endorse or promote products derived
  20. * from this software without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  23. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  29. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  30. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  31. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. */
  35. #include <linux/types.h>
  36. #include <linux/slab.h>
  37. #include <linux/module.h>
  38. #include <linux/oid_registry.h>
  39. #include <linux/sunrpc/msg_prot.h>
  40. #include <linux/sunrpc/gss_asn1.h>
  41. #include <linux/sunrpc/auth_gss.h>
  42. #include <linux/sunrpc/svcauth_gss.h>
  43. #include <linux/sunrpc/gss_err.h>
  44. #include <linux/sunrpc/sched.h>
  45. #include <linux/sunrpc/gss_api.h>
  46. #include <linux/sunrpc/clnt.h>
  47. #ifdef RPC_DEBUG
  48. # define RPCDBG_FACILITY RPCDBG_AUTH
  49. #endif
  50. static LIST_HEAD(registered_mechs);
  51. static DEFINE_SPINLOCK(registered_mechs_lock);
  52. static void
  53. gss_mech_free(struct gss_api_mech *gm)
  54. {
  55. struct pf_desc *pf;
  56. int i;
  57. for (i = 0; i < gm->gm_pf_num; i++) {
  58. pf = &gm->gm_pfs[i];
  59. kfree(pf->auth_domain_name);
  60. pf->auth_domain_name = NULL;
  61. }
  62. }
  63. static inline char *
  64. make_auth_domain_name(char *name)
  65. {
  66. static char *prefix = "gss/";
  67. char *new;
  68. new = kmalloc(strlen(name) + strlen(prefix) + 1, GFP_KERNEL);
  69. if (new) {
  70. strcpy(new, prefix);
  71. strcat(new, name);
  72. }
  73. return new;
  74. }
  75. static int
  76. gss_mech_svc_setup(struct gss_api_mech *gm)
  77. {
  78. struct pf_desc *pf;
  79. int i, status;
  80. for (i = 0; i < gm->gm_pf_num; i++) {
  81. pf = &gm->gm_pfs[i];
  82. pf->auth_domain_name = make_auth_domain_name(pf->name);
  83. status = -ENOMEM;
  84. if (pf->auth_domain_name == NULL)
  85. goto out;
  86. status = svcauth_gss_register_pseudoflavor(pf->pseudoflavor,
  87. pf->auth_domain_name);
  88. if (status)
  89. goto out;
  90. }
  91. return 0;
  92. out:
  93. gss_mech_free(gm);
  94. return status;
  95. }
  96. int
  97. gss_mech_register(struct gss_api_mech *gm)
  98. {
  99. int status;
  100. status = gss_mech_svc_setup(gm);
  101. if (status)
  102. return status;
  103. spin_lock(&registered_mechs_lock);
  104. list_add(&gm->gm_list, &registered_mechs);
  105. spin_unlock(&registered_mechs_lock);
  106. dprintk("RPC: registered gss mechanism %s\n", gm->gm_name);
  107. return 0;
  108. }
  109. EXPORT_SYMBOL_GPL(gss_mech_register);
  110. void
  111. gss_mech_unregister(struct gss_api_mech *gm)
  112. {
  113. spin_lock(&registered_mechs_lock);
  114. list_del(&gm->gm_list);
  115. spin_unlock(&registered_mechs_lock);
  116. dprintk("RPC: unregistered gss mechanism %s\n", gm->gm_name);
  117. gss_mech_free(gm);
  118. }
  119. EXPORT_SYMBOL_GPL(gss_mech_unregister);
  120. struct gss_api_mech *
  121. gss_mech_get(struct gss_api_mech *gm)
  122. {
  123. __module_get(gm->gm_owner);
  124. return gm;
  125. }
  126. EXPORT_SYMBOL_GPL(gss_mech_get);
  127. static struct gss_api_mech *
  128. _gss_mech_get_by_name(const char *name)
  129. {
  130. struct gss_api_mech *pos, *gm = NULL;
  131. spin_lock(&registered_mechs_lock);
  132. list_for_each_entry(pos, &registered_mechs, gm_list) {
  133. if (0 == strcmp(name, pos->gm_name)) {
  134. if (try_module_get(pos->gm_owner))
  135. gm = pos;
  136. break;
  137. }
  138. }
  139. spin_unlock(&registered_mechs_lock);
  140. return gm;
  141. }
  142. struct gss_api_mech * gss_mech_get_by_name(const char *name)
  143. {
  144. struct gss_api_mech *gm = NULL;
  145. gm = _gss_mech_get_by_name(name);
  146. if (!gm) {
  147. request_module("rpc-auth-gss-%s", name);
  148. gm = _gss_mech_get_by_name(name);
  149. }
  150. return gm;
  151. }
  152. EXPORT_SYMBOL_GPL(gss_mech_get_by_name);
  153. static struct gss_api_mech *gss_mech_get_by_OID(struct rpcsec_gss_oid *obj)
  154. {
  155. struct gss_api_mech *pos, *gm = NULL;
  156. char buf[32];
  157. if (sprint_oid(obj->data, obj->len, buf, sizeof(buf)) < 0)
  158. return NULL;
  159. dprintk("RPC: %s(%s)\n", __func__, buf);
  160. request_module("rpc-auth-gss-%s", buf);
  161. spin_lock(&registered_mechs_lock);
  162. list_for_each_entry(pos, &registered_mechs, gm_list) {
  163. if (obj->len == pos->gm_oid.len) {
  164. if (0 == memcmp(obj->data, pos->gm_oid.data, obj->len)) {
  165. if (try_module_get(pos->gm_owner))
  166. gm = pos;
  167. break;
  168. }
  169. }
  170. }
  171. spin_unlock(&registered_mechs_lock);
  172. return gm;
  173. }
  174. static inline int
  175. mech_supports_pseudoflavor(struct gss_api_mech *gm, u32 pseudoflavor)
  176. {
  177. int i;
  178. for (i = 0; i < gm->gm_pf_num; i++) {
  179. if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
  180. return 1;
  181. }
  182. return 0;
  183. }
  184. static struct gss_api_mech *_gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
  185. {
  186. struct gss_api_mech *gm = NULL, *pos;
  187. spin_lock(&registered_mechs_lock);
  188. list_for_each_entry(pos, &registered_mechs, gm_list) {
  189. if (!mech_supports_pseudoflavor(pos, pseudoflavor)) {
  190. module_put(pos->gm_owner);
  191. continue;
  192. }
  193. if (try_module_get(pos->gm_owner))
  194. gm = pos;
  195. break;
  196. }
  197. spin_unlock(&registered_mechs_lock);
  198. return gm;
  199. }
  200. struct gss_api_mech *
  201. gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
  202. {
  203. struct gss_api_mech *gm;
  204. gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
  205. if (!gm) {
  206. request_module("rpc-auth-gss-%u", pseudoflavor);
  207. gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
  208. }
  209. return gm;
  210. }
  211. /**
  212. * gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors
  213. * @array: array to fill in
  214. * @size: size of "array"
  215. *
  216. * Returns the number of array items filled in, or a negative errno.
  217. *
  218. * The returned array is not sorted by any policy. Callers should not
  219. * rely on the order of the items in the returned array.
  220. */
  221. int gss_mech_list_pseudoflavors(rpc_authflavor_t *array_ptr, int size)
  222. {
  223. struct gss_api_mech *pos = NULL;
  224. int j, i = 0;
  225. spin_lock(&registered_mechs_lock);
  226. list_for_each_entry(pos, &registered_mechs, gm_list) {
  227. for (j = 0; j < pos->gm_pf_num; j++) {
  228. if (i >= size) {
  229. spin_unlock(&registered_mechs_lock);
  230. return -ENOMEM;
  231. }
  232. array_ptr[i++] = pos->gm_pfs[j].pseudoflavor;
  233. }
  234. }
  235. spin_unlock(&registered_mechs_lock);
  236. return i;
  237. }
  238. /**
  239. * gss_svc_to_pseudoflavor - map a GSS service number to a pseudoflavor
  240. * @gm: GSS mechanism handle
  241. * @qop: GSS quality-of-protection value
  242. * @service: GSS service value
  243. *
  244. * Returns a matching security flavor, or RPC_AUTH_MAXFLAVOR if none is found.
  245. */
  246. rpc_authflavor_t gss_svc_to_pseudoflavor(struct gss_api_mech *gm, u32 qop,
  247. u32 service)
  248. {
  249. int i;
  250. for (i = 0; i < gm->gm_pf_num; i++) {
  251. if (gm->gm_pfs[i].qop == qop &&
  252. gm->gm_pfs[i].service == service) {
  253. return gm->gm_pfs[i].pseudoflavor;
  254. }
  255. }
  256. return RPC_AUTH_MAXFLAVOR;
  257. }
  258. /**
  259. * gss_mech_info2flavor - look up a pseudoflavor given a GSS tuple
  260. * @info: a GSS mech OID, quality of protection, and service value
  261. *
  262. * Returns a matching pseudoflavor, or RPC_AUTH_MAXFLAVOR if the tuple is
  263. * not supported.
  264. */
  265. rpc_authflavor_t gss_mech_info2flavor(struct rpcsec_gss_info *info)
  266. {
  267. rpc_authflavor_t pseudoflavor;
  268. struct gss_api_mech *gm;
  269. gm = gss_mech_get_by_OID(&info->oid);
  270. if (gm == NULL)
  271. return RPC_AUTH_MAXFLAVOR;
  272. pseudoflavor = gss_svc_to_pseudoflavor(gm, info->qop, info->service);
  273. gss_mech_put(gm);
  274. return pseudoflavor;
  275. }
  276. /**
  277. * gss_mech_flavor2info - look up a GSS tuple for a given pseudoflavor
  278. * @pseudoflavor: GSS pseudoflavor to match
  279. * @info: rpcsec_gss_info structure to fill in
  280. *
  281. * Returns zero and fills in "info" if pseudoflavor matches a
  282. * supported mechanism. Otherwise a negative errno is returned.
  283. */
  284. int gss_mech_flavor2info(rpc_authflavor_t pseudoflavor,
  285. struct rpcsec_gss_info *info)
  286. {
  287. struct gss_api_mech *gm;
  288. int i;
  289. gm = gss_mech_get_by_pseudoflavor(pseudoflavor);
  290. if (gm == NULL)
  291. return -ENOENT;
  292. for (i = 0; i < gm->gm_pf_num; i++) {
  293. if (gm->gm_pfs[i].pseudoflavor == pseudoflavor) {
  294. memcpy(info->oid.data, gm->gm_oid.data, gm->gm_oid.len);
  295. info->oid.len = gm->gm_oid.len;
  296. info->qop = gm->gm_pfs[i].qop;
  297. info->service = gm->gm_pfs[i].service;
  298. gss_mech_put(gm);
  299. return 0;
  300. }
  301. }
  302. gss_mech_put(gm);
  303. return -ENOENT;
  304. }
  305. u32
  306. gss_pseudoflavor_to_service(struct gss_api_mech *gm, u32 pseudoflavor)
  307. {
  308. int i;
  309. for (i = 0; i < gm->gm_pf_num; i++) {
  310. if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
  311. return gm->gm_pfs[i].service;
  312. }
  313. return 0;
  314. }
  315. EXPORT_SYMBOL_GPL(gss_pseudoflavor_to_service);
  316. char *
  317. gss_service_to_auth_domain_name(struct gss_api_mech *gm, u32 service)
  318. {
  319. int i;
  320. for (i = 0; i < gm->gm_pf_num; i++) {
  321. if (gm->gm_pfs[i].service == service)
  322. return gm->gm_pfs[i].auth_domain_name;
  323. }
  324. return NULL;
  325. }
  326. EXPORT_SYMBOL_GPL(gss_service_to_auth_domain_name);
  327. void
  328. gss_mech_put(struct gss_api_mech * gm)
  329. {
  330. if (gm)
  331. module_put(gm->gm_owner);
  332. }
  333. EXPORT_SYMBOL_GPL(gss_mech_put);
  334. /* The mech could probably be determined from the token instead, but it's just
  335. * as easy for now to pass it in. */
  336. int
  337. gss_import_sec_context(const void *input_token, size_t bufsize,
  338. struct gss_api_mech *mech,
  339. struct gss_ctx **ctx_id,
  340. gfp_t gfp_mask)
  341. {
  342. if (!(*ctx_id = kzalloc(sizeof(**ctx_id), gfp_mask)))
  343. return -ENOMEM;
  344. (*ctx_id)->mech_type = gss_mech_get(mech);
  345. return mech->gm_ops
  346. ->gss_import_sec_context(input_token, bufsize, *ctx_id, gfp_mask);
  347. }
  348. /* gss_get_mic: compute a mic over message and return mic_token. */
  349. u32
  350. gss_get_mic(struct gss_ctx *context_handle,
  351. struct xdr_buf *message,
  352. struct xdr_netobj *mic_token)
  353. {
  354. return context_handle->mech_type->gm_ops
  355. ->gss_get_mic(context_handle,
  356. message,
  357. mic_token);
  358. }
  359. /* gss_verify_mic: check whether the provided mic_token verifies message. */
  360. u32
  361. gss_verify_mic(struct gss_ctx *context_handle,
  362. struct xdr_buf *message,
  363. struct xdr_netobj *mic_token)
  364. {
  365. return context_handle->mech_type->gm_ops
  366. ->gss_verify_mic(context_handle,
  367. message,
  368. mic_token);
  369. }
  370. /*
  371. * This function is called from both the client and server code.
  372. * Each makes guarantees about how much "slack" space is available
  373. * for the underlying function in "buf"'s head and tail while
  374. * performing the wrap.
  375. *
  376. * The client and server code allocate RPC_MAX_AUTH_SIZE extra
  377. * space in both the head and tail which is available for use by
  378. * the wrap function.
  379. *
  380. * Underlying functions should verify they do not use more than
  381. * RPC_MAX_AUTH_SIZE of extra space in either the head or tail
  382. * when performing the wrap.
  383. */
  384. u32
  385. gss_wrap(struct gss_ctx *ctx_id,
  386. int offset,
  387. struct xdr_buf *buf,
  388. struct page **inpages)
  389. {
  390. return ctx_id->mech_type->gm_ops
  391. ->gss_wrap(ctx_id, offset, buf, inpages);
  392. }
  393. u32
  394. gss_unwrap(struct gss_ctx *ctx_id,
  395. int offset,
  396. struct xdr_buf *buf)
  397. {
  398. return ctx_id->mech_type->gm_ops
  399. ->gss_unwrap(ctx_id, offset, buf);
  400. }
  401. /* gss_delete_sec_context: free all resources associated with context_handle.
  402. * Note this differs from the RFC 2744-specified prototype in that we don't
  403. * bother returning an output token, since it would never be used anyway. */
  404. u32
  405. gss_delete_sec_context(struct gss_ctx **context_handle)
  406. {
  407. dprintk("RPC: gss_delete_sec_context deleting %p\n",
  408. *context_handle);
  409. if (!*context_handle)
  410. return GSS_S_NO_CONTEXT;
  411. if ((*context_handle)->internal_ctx_id)
  412. (*context_handle)->mech_type->gm_ops
  413. ->gss_delete_sec_context((*context_handle)
  414. ->internal_ctx_id);
  415. gss_mech_put((*context_handle)->mech_type);
  416. kfree(*context_handle);
  417. *context_handle=NULL;
  418. return GSS_S_COMPLETE;
  419. }