]>
git.ipfire.org Git - thirdparty/linux.git/blob - include/linux/sunrpc/gss_api.h
1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/include/linux/sunrpc/gss_api.h
5 * Somewhat simplified version of the gss api.
7 * Dug Song <dugsong@monkey.org>
8 * Andy Adamson <andros@umich.edu>
9 * Bruce Fields <bfields@umich.edu>
10 * Copyright (c) 2000 The Regents of the University of Michigan
13 #ifndef _LINUX_SUNRPC_GSS_API_H
14 #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
;
24 unsigned int slack
, align
;
27 #define GSS_C_NO_BUFFER ((struct xdr_netobj) 0)
28 #define GSS_C_NO_CONTEXT ((struct gss_ctx *) 0)
29 #define GSS_C_QOP_DEFAULT (0)
31 /*XXX arbitrary length - is this set somewhere? */
32 #define GSS_OID_MAX_LEN 32
33 struct rpcsec_gss_oid
{
35 u8 data
[GSS_OID_MAX_LEN
];
39 struct rpcsec_gss_info
{
40 struct rpcsec_gss_oid oid
;
45 /* gss-api prototypes; note that these are somewhat simplified versions of
46 * the prototypes specified in RFC 2744. */
47 int gss_import_sec_context(
48 const void* input_token
,
50 struct gss_api_mech
*mech
,
51 struct gss_ctx
**ctx_id
,
55 struct gss_ctx
*ctx_id
,
56 struct xdr_buf
*message
,
57 struct xdr_netobj
*mic_token
);
59 struct gss_ctx
*ctx_id
,
60 struct xdr_buf
*message
,
61 struct xdr_netobj
*mic_token
);
63 struct gss_ctx
*ctx_id
,
65 struct xdr_buf
*outbuf
,
66 struct page
**inpages
);
68 struct gss_ctx
*ctx_id
,
71 struct xdr_buf
*inbuf
);
72 u32
gss_delete_sec_context(
73 struct gss_ctx
**ctx_id
);
75 rpc_authflavor_t
gss_svc_to_pseudoflavor(struct gss_api_mech
*, u32 qop
,
77 u32
gss_pseudoflavor_to_service(struct gss_api_mech
*, u32 pseudoflavor
);
78 bool gss_pseudoflavor_to_datatouch(struct gss_api_mech
*, u32 pseudoflavor
);
79 char *gss_service_to_auth_domain_name(struct gss_api_mech
*, u32 service
);
86 char *auth_domain_name
;
90 /* Different mechanisms (e.g., krb5 or spkm3) may implement gss-api, and
91 * mechanisms may be dynamically registered or unregistered by modules. */
93 /* Each mechanism is described by the following struct: */
95 struct list_head gm_list
;
96 struct module
*gm_owner
;
97 struct rpcsec_gss_oid gm_oid
;
99 const struct gss_api_ops
*gm_ops
;
100 /* pseudoflavors supported by this mechanism: */
102 struct pf_desc
* gm_pfs
;
103 /* Should the following be a callback operation instead? */
104 const char *gm_upcall_enctypes
;
107 /* and must provide the following operations: */
109 int (*gss_import_sec_context
)(
110 const void *input_token
,
112 struct gss_ctx
*ctx_id
,
116 struct gss_ctx
*ctx_id
,
117 struct xdr_buf
*message
,
118 struct xdr_netobj
*mic_token
);
119 u32 (*gss_verify_mic
)(
120 struct gss_ctx
*ctx_id
,
121 struct xdr_buf
*message
,
122 struct xdr_netobj
*mic_token
);
124 struct gss_ctx
*ctx_id
,
126 struct xdr_buf
*outbuf
,
127 struct page
**inpages
);
129 struct gss_ctx
*ctx_id
,
132 struct xdr_buf
*buf
);
133 void (*gss_delete_sec_context
)(
134 void *internal_ctx_id
);
137 int gss_mech_register(struct gss_api_mech
*);
138 void gss_mech_unregister(struct gss_api_mech
*);
140 /* returns a mechanism descriptor given an OID, and increments the mechanism's
141 * reference count. */
142 struct gss_api_mech
* gss_mech_get_by_OID(struct rpcsec_gss_oid
*);
144 /* Given a GSS security tuple, look up a pseudoflavor */
145 rpc_authflavor_t
gss_mech_info2flavor(struct rpcsec_gss_info
*);
147 /* Given a pseudoflavor, look up a GSS security tuple */
148 int gss_mech_flavor2info(rpc_authflavor_t
, struct rpcsec_gss_info
*);
150 /* Returns a reference to a mechanism, given a name like "krb5" etc. */
151 struct gss_api_mech
*gss_mech_get_by_name(const char *);
153 /* Similar, but get by pseudoflavor. */
154 struct gss_api_mech
*gss_mech_get_by_pseudoflavor(u32
);
156 struct gss_api_mech
* gss_mech_get(struct gss_api_mech
*);
158 /* For every successful gss_mech_get or gss_mech_get_by_* call there must be a
159 * corresponding call to gss_mech_put. */
160 void gss_mech_put(struct gss_api_mech
*);
162 #endif /* _LINUX_SUNRPC_GSS_API_H */