gss_mech_switch.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  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. /**
  97. * gss_mech_register - register a GSS mechanism
  98. * @gm: GSS mechanism handle
  99. *
  100. * Returns zero if successful, or a negative errno.
  101. */
  102. int gss_mech_register(struct gss_api_mech *gm)
  103. {
  104. int status;
  105. status = gss_mech_svc_setup(gm);
  106. if (status)
  107. return status;
  108. spin_lock(&registered_mechs_lock);
  109. list_add(&gm->gm_list, &registered_mechs);
  110. spin_unlock(&registered_mechs_lock);
  111. dprintk("RPC: registered gss mechanism %s\n", gm->gm_name);
  112. return 0;
  113. }
  114. EXPORT_SYMBOL_GPL(gss_mech_register);
  115. /**
  116. * gss_mech_unregister - release a GSS mechanism
  117. * @gm: GSS mechanism handle
  118. *
  119. */
  120. void gss_mech_unregister(struct gss_api_mech *gm)
  121. {
  122. spin_lock(&registered_mechs_lock);
  123. list_del(&gm->gm_list);
  124. spin_unlock(&registered_mechs_lock);
  125. dprintk("RPC: unregistered gss mechanism %s\n", gm->gm_name);
  126. gss_mech_free(gm);
  127. }
  128. EXPORT_SYMBOL_GPL(gss_mech_unregister);
  129. static struct gss_api_mech *gss_mech_get(struct gss_api_mech *gm)
  130. {
  131. __module_get(gm->gm_owner);
  132. return gm;
  133. }
  134. static struct gss_api_mech *
  135. _gss_mech_get_by_name(const char *name)
  136. {
  137. struct gss_api_mech *pos, *gm = NULL;
  138. spin_lock(&registered_mechs_lock);
  139. list_for_each_entry(pos, &registered_mechs, gm_list) {
  140. if (0 == strcmp(name, pos->gm_name)) {
  141. if (try_module_get(pos->gm_owner))
  142. gm = pos;
  143. break;
  144. }
  145. }
  146. spin_unlock(&registered_mechs_lock);
  147. return gm;
  148. }
  149. struct gss_api_mech * gss_mech_get_by_name(const char *name)
  150. {
  151. struct gss_api_mech *gm = NULL;
  152. gm = _gss_mech_get_by_name(name);
  153. if (!gm) {
  154. request_module("rpc-auth-gss-%s", name);
  155. gm = _gss_mech_get_by_name(name);
  156. }
  157. return gm;
  158. }
  159. struct gss_api_mech *gss_mech_get_by_OID(struct rpcsec_gss_oid *obj)
  160. {
  161. struct gss_api_mech *pos, *gm = NULL;
  162. char buf[32];
  163. if (sprint_oid(obj->data, obj->len, buf, sizeof(buf)) < 0)
  164. return NULL;
  165. dprintk("RPC: %s(%s)\n", __func__, buf);
  166. request_module("rpc-auth-gss-%s", buf);
  167. spin_lock(&registered_mechs_lock);
  168. list_for_each_entry(pos, &registered_mechs, gm_list) {
  169. if (obj->len == pos->gm_oid.len) {
  170. if (0 == memcmp(obj->data, pos->gm_oid.data, obj->len)) {
  171. if (try_module_get(pos->gm_owner))
  172. gm = pos;
  173. break;
  174. }
  175. }
  176. }
  177. spin_unlock(&registered_mechs_lock);
  178. return gm;
  179. }
  180. static inline int
  181. mech_supports_pseudoflavor(struct gss_api_mech *gm, u32 pseudoflavor)
  182. {
  183. int i;
  184. for (i = 0; i < gm->gm_pf_num; i++) {
  185. if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
  186. return 1;
  187. }
  188. return 0;
  189. }
  190. static struct gss_api_mech *_gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
  191. {
  192. struct gss_api_mech *gm = NULL, *pos;
  193. spin_lock(&registered_mechs_lock);
  194. list_for_each_entry(pos, &registered_mechs, gm_list) {
  195. if (!mech_supports_pseudoflavor(pos, pseudoflavor)) {
  196. module_put(pos->gm_owner);
  197. continue;
  198. }
  199. if (try_module_get(pos->gm_owner))
  200. gm = pos;
  201. break;
  202. }
  203. spin_unlock(&registered_mechs_lock);
  204. return gm;
  205. }
  206. struct gss_api_mech *
  207. gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
  208. {
  209. struct gss_api_mech *gm;
  210. gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
  211. if (!gm) {
  212. request_module("rpc-auth-gss-%u", pseudoflavor);
  213. gm = _gss_mech_get_by_pseudoflavor(pseudoflavor);
  214. }
  215. return gm;
  216. }
  217. /**
  218. * gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors
  219. * @array: array to fill in
  220. * @size: size of "array"
  221. *
  222. * Returns the number of array items filled in, or a negative errno.
  223. *
  224. * The returned array is not sorted by any policy. Callers should not
  225. * rely on the order of the items in the returned array.
  226. */
  227. int gss_mech_list_pseudoflavors(rpc_authflavor_t *array_ptr, int size)
  228. {
  229. struct gss_api_mech *pos = NULL;
  230. int j, i = 0;
  231. spin_lock(&registered_mechs_lock);
  232. list_for_each_entry(pos, &registered_mechs, gm_list) {
  233. for (j = 0; j < pos->gm_pf_num; j++) {
  234. if (i >= size) {
  235. spin_unlock(&registered_mechs_lock);
  236. return -ENOMEM;
  237. }
  238. array_ptr[i++] = pos->gm_pfs[j].pseudoflavor;
  239. }
  240. }
  241. spin_unlock(&registered_mechs_lock);
  242. return i;
  243. }
  244. /**
  245. * gss_svc_to_pseudoflavor - map a GSS service number to a pseudoflavor
  246. * @gm: GSS mechanism handle
  247. * @qop: GSS quality-of-protection value
  248. * @service: GSS service value
  249. *
  250. * Returns a matching security flavor, or RPC_AUTH_MAXFLAVOR if none is found.
  251. */
  252. rpc_authflavor_t gss_svc_to_pseudoflavor(struct gss_api_mech *gm, u32 qop,
  253. u32 service)
  254. {
  255. int i;
  256. for (i = 0; i < gm->gm_pf_num; i++) {
  257. if (gm->gm_pfs[i].qop == qop &&
  258. gm->gm_pfs[i].service == service) {
  259. return gm->gm_pfs[i].pseudoflavor;
  260. }
  261. }
  262. return RPC_AUTH_MAXFLAVOR;
  263. }
  264. /**
  265. * gss_mech_info2flavor - look up a pseudoflavor given a GSS tuple
  266. * @info: a GSS mech OID, quality of protection, and service value
  267. *
  268. * Returns a matching pseudoflavor, or RPC_AUTH_MAXFLAVOR if the tuple is
  269. * not supported.
  270. */
  271. rpc_authflavor_t gss_mech_info2flavor(struct rpcsec_gss_info *info)
  272. {
  273. rpc_authflavor_t pseudoflavor;
  274. struct gss_api_mech *gm;
  275. gm = gss_mech_get_by_OID(&info->oid);
  276. if (gm == NULL)
  277. return RPC_AUTH_MAXFLAVOR;
  278. pseudoflavor = gss_svc_to_pseudoflavor(gm, info->qop, info->service);
  279. gss_mech_put(gm);
  280. return pseudoflavor;
  281. }
  282. /**
  283. * gss_mech_flavor2info - look up a GSS tuple for a given pseudoflavor
  284. * @pseudoflavor: GSS pseudoflavor to match
  285. * @info: rpcsec_gss_info structure to fill in
  286. *
  287. * Returns zero and fills in "info" if pseudoflavor matches a
  288. * supported mechanism. Otherwise a negative errno is returned.
  289. */
  290. int gss_mech_flavor2info(rpc_authflavor_t pseudoflavor,
  291. struct rpcsec_gss_info *info)
  292. {
  293. struct gss_api_mech *gm;
  294. int i;
  295. gm = gss_mech_get_by_pseudoflavor(pseudoflavor);
  296. if (gm == NULL)
  297. return -ENOENT;
  298. for (i = 0; i < gm->gm_pf_num; i++) {
  299. if (gm->gm_pfs[i].pseudoflavor == pseudoflavor) {
  300. memcpy(info->oid.data, gm->gm_oid.data, gm->gm_oid.len);
  301. info->oid.len = gm->gm_oid.len;
  302. info->qop = gm->gm_pfs[i].qop;
  303. info->service = gm->gm_pfs[i].service;
  304. gss_mech_put(gm);
  305. return 0;
  306. }
  307. }
  308. gss_mech_put(gm);
  309. return -ENOENT;
  310. }
  311. u32
  312. gss_pseudoflavor_to_service(struct gss_api_mech *gm, u32 pseudoflavor)
  313. {
  314. int i;
  315. for (i = 0; i < gm->gm_pf_num; i++) {
  316. if (gm->gm_pfs[i].pseudoflavor == pseudoflavor)
  317. return gm->gm_pfs[i].service;
  318. }
  319. return 0;
  320. }
  321. char *
  322. gss_service_to_auth_domain_name(struct gss_api_mech *gm, u32 service)
  323. {
  324. int i;
  325. for (i = 0; i < gm->gm_pf_num; i++) {
  326. if (gm->gm_pfs[i].service == service)
  327. return gm->gm_pfs[i].auth_domain_name;
  328. }
  329. return NULL;
  330. }
  331. void
  332. gss_mech_put(struct gss_api_mech * gm)
  333. {
  334. if (gm)
  335. module_put(gm->gm_owner);
  336. }
  337. /* The mech could probably be determined from the token instead, but it's just
  338. * as easy for now to pass it in. */
  339. int
  340. gss_import_sec_context(const void *input_token, size_t bufsize,
  341. struct gss_api_mech *mech,
  342. struct gss_ctx **ctx_id,
  343. time_t *endtime,
  344. gfp_t gfp_mask)
  345. {
  346. if (!(*ctx_id = kzalloc(sizeof(**ctx_id), gfp_mask)))
  347. return -ENOMEM;
  348. (*ctx_id)->mech_type = gss_mech_get(mech);
  349. return mech->gm_ops->gss_import_sec_context(input_token, bufsize,
  350. *ctx_id, endtime, gfp_mask);
  351. }
  352. /* gss_get_mic: compute a mic over message and return mic_token. */
  353. u32
  354. gss_get_mic(struct gss_ctx *context_handle,
  355. struct xdr_buf *message,
  356. struct xdr_netobj *mic_token)
  357. {
  358. return context_handle->mech_type->gm_ops
  359. ->gss_get_mic(context_handle,
  360. message,
  361. mic_token);
  362. }
  363. /* gss_verify_mic: check whether the provided mic_token verifies message. */
  364. u32
  365. gss_verify_mic(struct gss_ctx *context_handle,
  366. struct xdr_buf *message,
  367. struct xdr_netobj *mic_token)
  368. {
  369. return context_handle->mech_type->gm_ops
  370. ->gss_verify_mic(context_handle,
  371. message,
  372. mic_token);
  373. }
  374. /*
  375. * This function is called from both the client and server code.
  376. * Each makes guarantees about how much "slack" space is available
  377. * for the underlying function in "buf"'s head and tail while
  378. * performing the wrap.
  379. *
  380. * The client and server code allocate RPC_MAX_AUTH_SIZE extra
  381. * space in both the head and tail which is available for use by
  382. * the wrap function.
  383. *
  384. * Underlying functions should verify they do not use more than
  385. * RPC_MAX_AUTH_SIZE of extra space in either the head or tail
  386. * when performing the wrap.
  387. */
  388. u32
  389. gss_wrap(struct gss_ctx *ctx_id,
  390. int offset,
  391. struct xdr_buf *buf,
  392. struct page **inpages)
  393. {
  394. return ctx_id->mech_type->gm_ops
  395. ->gss_wrap(ctx_id, offset, buf, inpages);
  396. }
  397. u32
  398. gss_unwrap(struct gss_ctx *ctx_id,
  399. int offset,
  400. struct xdr_buf *buf)
  401. {
  402. return ctx_id->mech_type->gm_ops
  403. ->gss_unwrap(ctx_id, offset, buf);
  404. }
  405. /* gss_delete_sec_context: free all resources associated with context_handle.
  406. * Note this differs from the RFC 2744-specified prototype in that we don't
  407. * bother returning an output token, since it would never be used anyway. */
  408. u32
  409. gss_delete_sec_context(struct gss_ctx **context_handle)
  410. {
  411. dprintk("RPC: gss_delete_sec_context deleting %p\n",
  412. *context_handle);
  413. if (!*context_handle)
  414. return GSS_S_NO_CONTEXT;
  415. if ((*context_handle)->internal_ctx_id)
  416. (*context_handle)->mech_type->gm_ops
  417. ->gss_delete_sec_context((*context_handle)
  418. ->internal_ctx_id);
  419. gss_mech_put((*context_handle)->mech_type);
  420. kfree(*context_handle);
  421. *context_handle=NULL;
  422. return GSS_S_COMPLETE;
  423. }