96e5a81a54d754fd71f7b52ab13908103920380d
[linux-3.10.git] / include / linux / sunrpc / gss_api.h
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
12 #ifndef _LINUX_SUNRPC_GSS_API_H
13 #define _LINUX_SUNRPC_GSS_API_H
14
15 #ifdef __KERNEL__
16 #include <linux/sunrpc/xdr.h>
17 #include <linux/sunrpc/msg_prot.h>
18 #include <linux/uio.h>
19
20 /* The mechanism-independent gss-api context: */
21 struct gss_ctx {
22         struct gss_api_mech     *mech_type;
23         void                    *internal_ctx_id;
24 };
25
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)
29
30 /*XXX  arbitrary length - is this set somewhere? */
31 #define GSS_OID_MAX_LEN 32
32 struct rpcsec_gss_oid {
33         unsigned int    len;
34         u8              data[GSS_OID_MAX_LEN];
35 };
36
37 /* From RFC 3530 */
38 struct rpcsec_gss_info {
39         struct rpcsec_gss_oid   oid;
40         u32                     qop;
41         u32                     service;
42 };
43
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,
48                 size_t                  bufsize,
49                 struct gss_api_mech     *mech,
50                 struct gss_ctx          **ctx_id,
51                 gfp_t                   gfp_mask);
52 u32 gss_get_mic(
53                 struct gss_ctx          *ctx_id,
54                 struct xdr_buf          *message,
55                 struct xdr_netobj       *mic_token);
56 u32 gss_verify_mic(
57                 struct gss_ctx          *ctx_id,
58                 struct xdr_buf          *message,
59                 struct xdr_netobj       *mic_token);
60 u32 gss_wrap(
61                 struct gss_ctx          *ctx_id,
62                 int                     offset,
63                 struct xdr_buf          *outbuf,
64                 struct page             **inpages);
65 u32 gss_unwrap(
66                 struct gss_ctx          *ctx_id,
67                 int                     offset,
68                 struct xdr_buf          *inbuf);
69 u32 gss_delete_sec_context(
70                 struct gss_ctx          **ctx_id);
71
72 rpc_authflavor_t gss_svc_to_pseudoflavor(struct gss_api_mech *, u32 qop,
73                                         u32 service);
74 u32 gss_pseudoflavor_to_service(struct gss_api_mech *, u32 pseudoflavor);
75 char *gss_service_to_auth_domain_name(struct gss_api_mech *, u32 service);
76
77 struct pf_desc {
78         u32     pseudoflavor;
79         u32     qop;
80         u32     service;
81         char    *name;
82         char    *auth_domain_name;
83 };
84
85 /* Different mechanisms (e.g., krb5 or spkm3) may implement gss-api, and
86  * mechanisms may be dynamically registered or unregistered by modules. */
87
88 /* Each mechanism is described by the following struct: */
89 struct gss_api_mech {
90         struct list_head        gm_list;
91         struct module           *gm_owner;
92         struct rpcsec_gss_oid   gm_oid;
93         char                    *gm_name;
94         const struct gss_api_ops *gm_ops;
95         /* pseudoflavors supported by this mechanism: */
96         int                     gm_pf_num;
97         struct pf_desc *        gm_pfs;
98         /* Should the following be a callback operation instead? */
99         const char              *gm_upcall_enctypes;
100 };
101
102 /* and must provide the following operations: */
103 struct gss_api_ops {
104         int (*gss_import_sec_context)(
105                         const void              *input_token,
106                         size_t                  bufsize,
107                         struct gss_ctx          *ctx_id,
108                         gfp_t                   gfp_mask);
109         u32 (*gss_get_mic)(
110                         struct gss_ctx          *ctx_id,
111                         struct xdr_buf          *message,
112                         struct xdr_netobj       *mic_token);
113         u32 (*gss_verify_mic)(
114                         struct gss_ctx          *ctx_id,
115                         struct xdr_buf          *message,
116                         struct xdr_netobj       *mic_token);
117         u32 (*gss_wrap)(
118                         struct gss_ctx          *ctx_id,
119                         int                     offset,
120                         struct xdr_buf          *outbuf,
121                         struct page             **inpages);
122         u32 (*gss_unwrap)(
123                         struct gss_ctx          *ctx_id,
124                         int                     offset,
125                         struct xdr_buf          *buf);
126         void (*gss_delete_sec_context)(
127                         void                    *internal_ctx_id);
128 };
129
130 int gss_mech_register(struct gss_api_mech *);
131 void gss_mech_unregister(struct gss_api_mech *);
132
133 /* Given a GSS security tuple, look up a pseudoflavor */
134 rpc_authflavor_t gss_mech_info2flavor(struct rpcsec_gss_info *);
135
136 /* Returns a reference to a mechanism, given a name like "krb5" etc. */
137 struct gss_api_mech *gss_mech_get_by_name(const char *);
138
139 /* Similar, but get by pseudoflavor. */
140 struct gss_api_mech *gss_mech_get_by_pseudoflavor(u32);
141
142 /* Fill in an array with a list of supported pseudoflavors */
143 int gss_mech_list_pseudoflavors(rpc_authflavor_t *, int);
144
145 /* Just increments the mechanism's reference count and returns its input: */
146 struct gss_api_mech * gss_mech_get(struct gss_api_mech *);
147
148 /* For every successful gss_mech_get or gss_mech_get_by_* call there must be a
149  * corresponding call to gss_mech_put. */
150 void gss_mech_put(struct gss_api_mech *);
151
152 #endif /* __KERNEL__ */
153 #endif /* _LINUX_SUNRPC_GSS_API_H */
154