gss_api.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135
  1. /*
  2. * linux/include/linux/sunrpc/gss_api.h
  3. *
  4. * Somewhat simplified version of the gss api.
  5. *
  6. * Dug Song <dugsong@monkey.org>
  7. * Andy Adamson <andros@umich.edu>
  8. * Bruce Fields <bfields@umich.edu>
  9. * Copyright (c) 2000 The Regents of the University of Michigan
  10. *
  11. * $Id: gss_api.h,v 1.1.1.1 2007/06/12 07:27:16 eyryu Exp $
  12. */
  13. #ifndef _LINUX_SUNRPC_GSS_API_H
  14. #define _LINUX_SUNRPC_GSS_API_H
  15. #ifdef __KERNEL__
  16. #include <linux/sunrpc/xdr.h>
  17. #include <linux/uio.h>
  18. /* The mechanism-independent gss-api context: */
  19. struct gss_ctx {
  20. struct gss_api_mech *mech_type;
  21. void *internal_ctx_id;
  22. };
  23. #define GSS_C_NO_BUFFER ((struct xdr_netobj) 0)
  24. #define GSS_C_NO_CONTEXT ((struct gss_ctx *) 0)
  25. #define GSS_C_NULL_OID ((struct xdr_netobj) 0)
  26. /*XXX arbitrary length - is this set somewhere? */
  27. #define GSS_OID_MAX_LEN 32
  28. /* gss-api prototypes; note that these are somewhat simplified versions of
  29. * the prototypes specified in RFC 2744. */
  30. int gss_import_sec_context(
  31. const void* input_token,
  32. size_t bufsize,
  33. struct gss_api_mech *mech,
  34. struct gss_ctx **ctx_id);
  35. u32 gss_get_mic(
  36. struct gss_ctx *ctx_id,
  37. struct xdr_buf *message,
  38. struct xdr_netobj *mic_token);
  39. u32 gss_verify_mic(
  40. struct gss_ctx *ctx_id,
  41. struct xdr_buf *message,
  42. struct xdr_netobj *mic_token);
  43. u32 gss_wrap(
  44. struct gss_ctx *ctx_id,
  45. int offset,
  46. struct xdr_buf *outbuf,
  47. struct page **inpages);
  48. u32 gss_unwrap(
  49. struct gss_ctx *ctx_id,
  50. int offset,
  51. struct xdr_buf *inbuf);
  52. u32 gss_delete_sec_context(
  53. struct gss_ctx **ctx_id);
  54. u32 gss_pseudoflavor_to_service(struct gss_api_mech *, u32 pseudoflavor);
  55. char *gss_service_to_auth_domain_name(struct gss_api_mech *, u32 service);
  56. struct pf_desc {
  57. u32 pseudoflavor;
  58. u32 service;
  59. char *name;
  60. char *auth_domain_name;
  61. };
  62. /* Different mechanisms (e.g., krb5 or spkm3) may implement gss-api, and
  63. * mechanisms may be dynamically registered or unregistered by modules. */
  64. /* Each mechanism is described by the following struct: */
  65. struct gss_api_mech {
  66. struct list_head gm_list;
  67. struct module *gm_owner;
  68. struct xdr_netobj gm_oid;
  69. char *gm_name;
  70. struct gss_api_ops *gm_ops;
  71. /* pseudoflavors supported by this mechanism: */
  72. int gm_pf_num;
  73. struct pf_desc * gm_pfs;
  74. };
  75. /* and must provide the following operations: */
  76. struct gss_api_ops {
  77. int (*gss_import_sec_context)(
  78. const void *input_token,
  79. size_t bufsize,
  80. struct gss_ctx *ctx_id);
  81. u32 (*gss_get_mic)(
  82. struct gss_ctx *ctx_id,
  83. struct xdr_buf *message,
  84. struct xdr_netobj *mic_token);
  85. u32 (*gss_verify_mic)(
  86. struct gss_ctx *ctx_id,
  87. struct xdr_buf *message,
  88. struct xdr_netobj *mic_token);
  89. u32 (*gss_wrap)(
  90. struct gss_ctx *ctx_id,
  91. int offset,
  92. struct xdr_buf *outbuf,
  93. struct page **inpages);
  94. u32 (*gss_unwrap)(
  95. struct gss_ctx *ctx_id,
  96. int offset,
  97. struct xdr_buf *buf);
  98. void (*gss_delete_sec_context)(
  99. void *internal_ctx_id);
  100. };
  101. int gss_mech_register(struct gss_api_mech *);
  102. void gss_mech_unregister(struct gss_api_mech *);
  103. /* returns a mechanism descriptor given an OID, and increments the mechanism's
  104. * reference count. */
  105. struct gss_api_mech * gss_mech_get_by_OID(struct xdr_netobj *);
  106. /* Returns a reference to a mechanism, given a name like "krb5" etc. */
  107. struct gss_api_mech *gss_mech_get_by_name(const char *);
  108. /* Similar, but get by pseudoflavor. */
  109. struct gss_api_mech *gss_mech_get_by_pseudoflavor(u32);
  110. /* Just increments the mechanism's reference count and returns its input: */
  111. struct gss_api_mech * gss_mech_get(struct gss_api_mech *);
  112. /* For every successful gss_mech_get or gss_mech_get_by_* call there must be a
  113. * corresponding call to gss_mech_put. */
  114. void gss_mech_put(struct gss_api_mech *);
  115. #endif /* __KERNEL__ */
  116. #endif /* _LINUX_SUNRPC_GSS_API_H */