xref: /OK3568_Linux_fs/kernel/include/linux/sunrpc/auth_gss.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * linux/include/linux/sunrpc/auth_gss.h
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Declarations for RPCSEC_GSS
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Dug Song <dugsong@monkey.org>
8*4882a593Smuzhiyun  * Andy Adamson <andros@umich.edu>
9*4882a593Smuzhiyun  * Bruce Fields <bfields@umich.edu>
10*4882a593Smuzhiyun  * Copyright (c) 2000 The Regents of the University of Michigan
11*4882a593Smuzhiyun  */
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #ifndef _LINUX_SUNRPC_AUTH_GSS_H
14*4882a593Smuzhiyun #define _LINUX_SUNRPC_AUTH_GSS_H
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #include <linux/refcount.h>
17*4882a593Smuzhiyun #include <linux/sunrpc/auth.h>
18*4882a593Smuzhiyun #include <linux/sunrpc/svc.h>
19*4882a593Smuzhiyun #include <linux/sunrpc/gss_api.h>
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define RPC_GSS_VERSION		1
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define MAXSEQ 0x80000000 /* maximum legal sequence number, from rfc 2203 */
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun enum rpc_gss_proc {
26*4882a593Smuzhiyun 	RPC_GSS_PROC_DATA = 0,
27*4882a593Smuzhiyun 	RPC_GSS_PROC_INIT = 1,
28*4882a593Smuzhiyun 	RPC_GSS_PROC_CONTINUE_INIT = 2,
29*4882a593Smuzhiyun 	RPC_GSS_PROC_DESTROY = 3
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun enum rpc_gss_svc {
33*4882a593Smuzhiyun 	RPC_GSS_SVC_NONE = 1,
34*4882a593Smuzhiyun 	RPC_GSS_SVC_INTEGRITY = 2,
35*4882a593Smuzhiyun 	RPC_GSS_SVC_PRIVACY = 3
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun /* on-the-wire gss cred: */
39*4882a593Smuzhiyun struct rpc_gss_wire_cred {
40*4882a593Smuzhiyun 	u32			gc_v;		/* version */
41*4882a593Smuzhiyun 	u32			gc_proc;	/* control procedure */
42*4882a593Smuzhiyun 	u32			gc_seq;		/* sequence number */
43*4882a593Smuzhiyun 	u32			gc_svc;		/* service */
44*4882a593Smuzhiyun 	struct xdr_netobj	gc_ctx;		/* context handle */
45*4882a593Smuzhiyun };
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun /* on-the-wire gss verifier: */
48*4882a593Smuzhiyun struct rpc_gss_wire_verf {
49*4882a593Smuzhiyun 	u32			gv_flavor;
50*4882a593Smuzhiyun 	struct xdr_netobj	gv_verf;
51*4882a593Smuzhiyun };
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun /* return from gss NULL PROC init sec context */
54*4882a593Smuzhiyun struct rpc_gss_init_res {
55*4882a593Smuzhiyun 	struct xdr_netobj	gr_ctx;		/* context handle */
56*4882a593Smuzhiyun 	u32			gr_major;	/* major status */
57*4882a593Smuzhiyun 	u32			gr_minor;	/* minor status */
58*4882a593Smuzhiyun 	u32			gr_win;		/* sequence window */
59*4882a593Smuzhiyun 	struct xdr_netobj	gr_token;	/* token */
60*4882a593Smuzhiyun };
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /* The gss_cl_ctx struct holds all the information the rpcsec_gss client
63*4882a593Smuzhiyun  * code needs to know about a single security context.  In particular,
64*4882a593Smuzhiyun  * gc_gss_ctx is the context handle that is used to do gss-api calls, while
65*4882a593Smuzhiyun  * gc_wire_ctx is the context handle that is used to identify the context on
66*4882a593Smuzhiyun  * the wire when communicating with a server. */
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun struct gss_cl_ctx {
69*4882a593Smuzhiyun 	refcount_t		count;
70*4882a593Smuzhiyun 	enum rpc_gss_proc	gc_proc;
71*4882a593Smuzhiyun 	u32			gc_seq;
72*4882a593Smuzhiyun 	u32			gc_seq_xmit;
73*4882a593Smuzhiyun 	spinlock_t		gc_seq_lock;
74*4882a593Smuzhiyun 	struct gss_ctx		*gc_gss_ctx;
75*4882a593Smuzhiyun 	struct xdr_netobj	gc_wire_ctx;
76*4882a593Smuzhiyun 	struct xdr_netobj	gc_acceptor;
77*4882a593Smuzhiyun 	u32			gc_win;
78*4882a593Smuzhiyun 	unsigned long		gc_expiry;
79*4882a593Smuzhiyun 	struct rcu_head		gc_rcu;
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun struct gss_upcall_msg;
83*4882a593Smuzhiyun struct gss_cred {
84*4882a593Smuzhiyun 	struct rpc_cred		gc_base;
85*4882a593Smuzhiyun 	enum rpc_gss_svc	gc_service;
86*4882a593Smuzhiyun 	struct gss_cl_ctx __rcu	*gc_ctx;
87*4882a593Smuzhiyun 	struct gss_upcall_msg	*gc_upcall;
88*4882a593Smuzhiyun 	const char		*gc_principal;
89*4882a593Smuzhiyun 	unsigned long		gc_upcall_timestamp;
90*4882a593Smuzhiyun };
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun #endif /* _LINUX_SUNRPC_AUTH_GSS_H */
93*4882a593Smuzhiyun 
94