2 * linux/include/linux/sunrpc/gss_api.h
4 * Somewhat simplified version of the gss api.
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
12 #ifndef _LINUX_SUNRPC_GSS_API_H
13 #define _LINUX_SUNRPC_GSS_API_H
16 #include <linux/sunrpc/xdr.h>
17 #include <linux/sunrpc/msg_prot.h>
18 #include <linux/uio.h>
20 /* The mechanism-independent gss-api context: */
22 struct gss_api_mech *mech_type;
23 void *internal_ctx_id;
26 #define GSS_C_NO_BUFFER ((struct xdr_netobj) 0)
27 #define GSS_C_NO_CONTEXT ((struct gss_ctx *) 0)
28 #define GSS_C_QOP_DEFAULT (0)
30 /*XXX arbitrary length - is this set somewhere? */
31 #define GSS_OID_MAX_LEN 32
32 struct rpcsec_gss_oid {
34 u8 data[GSS_OID_MAX_LEN];
38 struct rpcsec_gss_info {
39 struct rpcsec_gss_oid oid;
44 /* gss-api prototypes; note that these are somewhat simplified versions of
45 * the prototypes specified in RFC 2744. */
46 int gss_import_sec_context(
47 const void* input_token,
49 struct gss_api_mech *mech,
50 struct gss_ctx **ctx_id,
54 struct gss_ctx *ctx_id,
55 struct xdr_buf *message,
56 struct xdr_netobj *mic_token);
58 struct gss_ctx *ctx_id,
59 struct xdr_buf *message,
60 struct xdr_netobj *mic_token);
62 struct gss_ctx *ctx_id,
64 struct xdr_buf *outbuf,
65 struct page **inpages);
67 struct gss_ctx *ctx_id,
69 struct xdr_buf *inbuf);
70 u32 gss_delete_sec_context(
71 struct gss_ctx **ctx_id);
73 rpc_authflavor_t gss_svc_to_pseudoflavor(struct gss_api_mech *, u32 qop,
75 u32 gss_pseudoflavor_to_service(struct gss_api_mech *, u32 pseudoflavor);
76 char *gss_service_to_auth_domain_name(struct gss_api_mech *, u32 service);
83 char *auth_domain_name;
84 struct auth_domain *domain;
87 /* Different mechanisms (e.g., krb5 or spkm3) may implement gss-api, and
88 * mechanisms may be dynamically registered or unregistered by modules. */
90 /* Each mechanism is described by the following struct: */
92 struct list_head gm_list;
93 struct module *gm_owner;
94 struct rpcsec_gss_oid gm_oid;
96 const struct gss_api_ops *gm_ops;
97 /* pseudoflavors supported by this mechanism: */
99 struct pf_desc * gm_pfs;
100 /* Should the following be a callback operation instead? */
101 const char *gm_upcall_enctypes;
104 /* and must provide the following operations: */
106 int (*gss_import_sec_context)(
107 const void *input_token,
109 struct gss_ctx *ctx_id,
113 struct gss_ctx *ctx_id,
114 struct xdr_buf *message,
115 struct xdr_netobj *mic_token);
116 u32 (*gss_verify_mic)(
117 struct gss_ctx *ctx_id,
118 struct xdr_buf *message,
119 struct xdr_netobj *mic_token);
121 struct gss_ctx *ctx_id,
123 struct xdr_buf *outbuf,
124 struct page **inpages);
126 struct gss_ctx *ctx_id,
128 struct xdr_buf *buf);
129 void (*gss_delete_sec_context)(
130 void *internal_ctx_id);
133 int gss_mech_register(struct gss_api_mech *);
134 void gss_mech_unregister(struct gss_api_mech *);
136 /* returns a mechanism descriptor given an OID, and increments the mechanism's
137 * reference count. */
138 struct gss_api_mech * gss_mech_get_by_OID(struct rpcsec_gss_oid *);
140 /* Given a GSS security tuple, look up a pseudoflavor */
141 rpc_authflavor_t gss_mech_info2flavor(struct rpcsec_gss_info *);
143 /* Given a pseudoflavor, look up a GSS security tuple */
144 int gss_mech_flavor2info(rpc_authflavor_t, struct rpcsec_gss_info *);
146 /* Returns a reference to a mechanism, given a name like "krb5" etc. */
147 struct gss_api_mech *gss_mech_get_by_name(const char *);
149 /* Similar, but get by pseudoflavor. */
150 struct gss_api_mech *gss_mech_get_by_pseudoflavor(u32);
152 /* Fill in an array with a list of supported pseudoflavors */
153 int gss_mech_list_pseudoflavors(rpc_authflavor_t *, int);
155 struct gss_api_mech * gss_mech_get(struct gss_api_mech *);
157 /* For every successful gss_mech_get or gss_mech_get_by_* call there must be a
158 * corresponding call to gss_mech_put. */
159 void gss_mech_put(struct gss_api_mech *);
161 #endif /* __KERNEL__ */
162 #endif /* _LINUX_SUNRPC_GSS_API_H */