Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / 293f1eb551a77fe5c8956a559a3c0baea95cd9bc / . / include / linux / sunrpc / gss_api.h
blob: e896752ffbf9ec629d301538438e71a964f8b2c3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700[diff] [blame]1/*
2 * linux/include/linux/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$
12 */
13
14#ifndef _LINUX_SUNRPC_GSS_API_H
15#define _LINUX_SUNRPC_GSS_API_H
16
17#ifdef __KERNEL__
18#include <linux/sunrpc/xdr.h>
19#include <linux/uio.h>
20
21/* The mechanism-independent gss-api context: */
22struct gss_ctx {
23 struct gss_api_mech *mech_type;
24 void *internal_ctx_id;
25};
26
27#define GSS_C_NO_BUFFER ((struct xdr_netobj) 0)
28#define GSS_C_NO_CONTEXT ((struct gss_ctx *) 0)
29#define GSS_C_NULL_OID ((struct xdr_netobj) 0)
30
31/*XXX arbitrary length - is this set somewhere? */
32#define GSS_OID_MAX_LEN 32
33
34/* gss-api prototypes; note that these are somewhat simplified versions of
35 * the prototypes specified in RFC 2744. */
36int gss_import_sec_context(
37 const void* input_token,
38 size_t bufsize,
39 struct gss_api_mech *mech,
40 struct gss_ctx **ctx_id);
41u32 gss_get_mic(
42 struct gss_ctx *ctx_id,
43 u32 qop,
44 struct xdr_buf *message,
45 struct xdr_netobj *mic_token);
46u32 gss_verify_mic(
47 struct gss_ctx *ctx_id,
48 struct xdr_buf *message,
49 struct xdr_netobj *mic_token,
50 u32 *qstate);
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400[diff] [blame^]51u32 gss_wrap(
52 struct gss_ctx *ctx_id,
53 u32 qop,
54 int offset,
55 struct xdr_buf *outbuf,
56 struct page **inpages);
57u32 gss_unwrap(
58 struct gss_ctx *ctx_id,
59 u32 *qop,
60 int offset,
61 struct xdr_buf *inbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700[diff] [blame]62u32 gss_delete_sec_context(
63 struct gss_ctx **ctx_id);
64
65u32 gss_pseudoflavor_to_service(struct gss_api_mech *, u32 pseudoflavor);
66char *gss_service_to_auth_domain_name(struct gss_api_mech *, u32 service);
67
68struct pf_desc {
69 u32 pseudoflavor;
70 u32 qop;
71 u32 service;
72 char *name;
73 char *auth_domain_name;
74};
75
76/* Different mechanisms (e.g., krb5 or spkm3) may implement gss-api, and
77 * mechanisms may be dynamically registered or unregistered by modules. */
78
79/* Each mechanism is described by the following struct: */
80struct gss_api_mech {
81 struct list_head gm_list;
82 struct module *gm_owner;
83 struct xdr_netobj gm_oid;
84 char *gm_name;
85 struct gss_api_ops *gm_ops;
86 /* pseudoflavors supported by this mechanism: */
87 int gm_pf_num;
88 struct pf_desc * gm_pfs;
89};
90
91/* and must provide the following operations: */
92struct gss_api_ops {
93 int (*gss_import_sec_context)(
94 const void *input_token,
95 size_t bufsize,
96 struct gss_ctx *ctx_id);
97 u32 (*gss_get_mic)(
98 struct gss_ctx *ctx_id,
99 u32 qop,
100 struct xdr_buf *message,
101 struct xdr_netobj *mic_token);
102 u32 (*gss_verify_mic)(
103 struct gss_ctx *ctx_id,
104 struct xdr_buf *message,
105 struct xdr_netobj *mic_token,
106 u32 *qstate);
J. Bruce Fields293f1eb2005-10-13 16:54:37 -0400[diff] [blame^]107 u32 (*gss_wrap)(
108 struct gss_ctx *ctx_id,
109 u32 qop,
110 int offset,
111 struct xdr_buf *outbuf,
112 struct page **inpages);
113 u32 (*gss_unwrap)(
114 struct gss_ctx *ctx_id,
115 u32 *qop,
116 int offset,
117 struct xdr_buf *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700[diff] [blame]118 void (*gss_delete_sec_context)(
119 void *internal_ctx_id);
120};
121
122int gss_mech_register(struct gss_api_mech *);
123void gss_mech_unregister(struct gss_api_mech *);
124
125/* returns a mechanism descriptor given an OID, and increments the mechanism's
126 * reference count. */
127struct gss_api_mech * gss_mech_get_by_OID(struct xdr_netobj *);
128
129/* Returns a reference to a mechanism, given a name like "krb5" etc. */
130struct gss_api_mech *gss_mech_get_by_name(const char *);
131
132/* Similar, but get by pseudoflavor. */
133struct gss_api_mech *gss_mech_get_by_pseudoflavor(u32);
134
135/* Just increments the mechanism's reference count and returns its input: */
136struct gss_api_mech * gss_mech_get(struct gss_api_mech *);
137
138/* For every succesful gss_mech_get or gss_mech_get_by_* call there must be a
139 * corresponding call to gss_mech_put. */
140void gss_mech_put(struct gss_api_mech *);
141
142#endif /* __KERNEL__ */
143#endif /* _LINUX_SUNRPC_GSS_API_H */
144