xref: /linux-6.15/include/linux/sunrpc/msg_prot.h (revision 7adae489)
1 /*
2  * linux/include/linux/sunrpc/msg_prot.h
3  *
4  * Copyright (C) 1996, Olaf Kirch <[email protected]>
5  */
6 
7 #ifndef _LINUX_SUNRPC_MSGPROT_H_
8 #define _LINUX_SUNRPC_MSGPROT_H_
9 
10 #ifdef __KERNEL__ /* user programs should get these from the rpc header files */
11 
12 #define RPC_VERSION 2
13 
14 /* size of an XDR encoding unit in bytes, i.e. 32bit */
15 #define XDR_UNIT	(4)
16 
17 /* spec defines authentication flavor as an unsigned 32 bit integer */
18 typedef u32	rpc_authflavor_t;
19 
20 enum rpc_auth_flavors {
21 	RPC_AUTH_NULL  = 0,
22 	RPC_AUTH_UNIX  = 1,
23 	RPC_AUTH_SHORT = 2,
24 	RPC_AUTH_DES   = 3,
25 	RPC_AUTH_KRB   = 4,
26 	RPC_AUTH_GSS   = 6,
27 	RPC_AUTH_MAXFLAVOR = 8,
28 	/* pseudoflavors: */
29 	RPC_AUTH_GSS_KRB5  = 390003,
30 	RPC_AUTH_GSS_KRB5I = 390004,
31 	RPC_AUTH_GSS_KRB5P = 390005,
32 	RPC_AUTH_GSS_LKEY  = 390006,
33 	RPC_AUTH_GSS_LKEYI = 390007,
34 	RPC_AUTH_GSS_LKEYP = 390008,
35 	RPC_AUTH_GSS_SPKM  = 390009,
36 	RPC_AUTH_GSS_SPKMI = 390010,
37 	RPC_AUTH_GSS_SPKMP = 390011,
38 };
39 
40 /* Maximum size (in bytes) of an rpc credential or verifier */
41 #define RPC_MAX_AUTH_SIZE (400)
42 
43 enum rpc_msg_type {
44 	RPC_CALL = 0,
45 	RPC_REPLY = 1
46 };
47 
48 enum rpc_reply_stat {
49 	RPC_MSG_ACCEPTED = 0,
50 	RPC_MSG_DENIED = 1
51 };
52 
53 enum rpc_accept_stat {
54 	RPC_SUCCESS = 0,
55 	RPC_PROG_UNAVAIL = 1,
56 	RPC_PROG_MISMATCH = 2,
57 	RPC_PROC_UNAVAIL = 3,
58 	RPC_GARBAGE_ARGS = 4,
59 	RPC_SYSTEM_ERR = 5
60 };
61 
62 enum rpc_reject_stat {
63 	RPC_MISMATCH = 0,
64 	RPC_AUTH_ERROR = 1
65 };
66 
67 enum rpc_auth_stat {
68 	RPC_AUTH_OK = 0,
69 	RPC_AUTH_BADCRED = 1,
70 	RPC_AUTH_REJECTEDCRED = 2,
71 	RPC_AUTH_BADVERF = 3,
72 	RPC_AUTH_REJECTEDVERF = 4,
73 	RPC_AUTH_TOOWEAK = 5,
74 	/* RPCSEC_GSS errors */
75 	RPCSEC_GSS_CREDPROBLEM = 13,
76 	RPCSEC_GSS_CTXPROBLEM = 14
77 };
78 
79 #define RPC_PMAP_PROGRAM	100000
80 #define RPC_PMAP_VERSION	2
81 #define RPC_PMAP_PORT		111
82 
83 #define RPC_MAXNETNAMELEN	256
84 
85 /*
86  * From RFC 1831:
87  *
88  * "A record is composed of one or more record fragments.  A record
89  *  fragment is a four-byte header followed by 0 to (2**31) - 1 bytes of
90  *  fragment data.  The bytes encode an unsigned binary number; as with
91  *  XDR integers, the byte order is from highest to lowest.  The number
92  *  encodes two values -- a boolean which indicates whether the fragment
93  *  is the last fragment of the record (bit value 1 implies the fragment
94  *  is the last fragment) and a 31-bit unsigned binary value which is the
95  *  length in bytes of the fragment's data.  The boolean value is the
96  *  highest-order bit of the header; the length is the 31 low-order bits.
97  *  (Note that this record specification is NOT in XDR standard form!)"
98  *
99  * The Linux RPC client always sends its requests in a single record
100  * fragment, limiting the maximum payload size for stream transports to
101  * 2GB.
102  */
103 
104 typedef __be32	rpc_fraghdr;
105 
106 #define	RPC_LAST_STREAM_FRAGMENT	(1U << 31)
107 #define	RPC_FRAGMENT_SIZE_MASK		(~RPC_LAST_STREAM_FRAGMENT)
108 #define	RPC_MAX_FRAGMENT_SIZE		((1U << 31) - 1)
109 
110 /*
111  * RPC call and reply header size as number of 32bit words (verifier
112  * size computed separately, see below)
113  */
114 #define RPC_CALLHDRSIZE		(6)
115 #define RPC_REPHDRSIZE		(4)
116 
117 
118 /*
119  * Maximum RPC header size, including authentication,
120  * as number of 32bit words (see RFCs 1831, 1832).
121  *
122  *	xid			    1 xdr unit = 4 bytes
123  *	mtype			    1
124  *	rpc_version		    1
125  *	program			    1
126  *	prog_version		    1
127  *	procedure		    1
128  *	cred {
129  *	    flavor		    1
130  *	    length		    1
131  *	    body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes
132  *	}
133  *	verf {
134  *	    flavor		    1
135  *	    length		    1
136  *	    body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes
137  *	}
138  *	TOTAL			    210 xdr units = 840 bytes
139  */
140 #define RPC_MAX_HEADER_WITH_AUTH \
141 	(RPC_CALLHDRSIZE + 2*(2+RPC_MAX_AUTH_SIZE/4))
142 
143 
144 #endif /* __KERNEL__ */
145 #endif /* _LINUX_SUNRPC_MSGPROT_H_ */
146