1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * linux/include/linux/sunrpc/msg_prot.h 4 * 5 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de> 6 */ 7 8 #ifndef _LINUX_SUNRPC_MSGPROT_H_ 9 #define _LINUX_SUNRPC_MSGPROT_H_ 10 11 #ifdef __KERNEL__ /* user programs should get these from the rpc header files */ 12 13 #define RPC_VERSION 2 14 15 /* size of an XDR encoding unit in bytes, i.e. 32bit */ 16 #define XDR_UNIT (4) 17 18 /* spec defines authentication flavor as an unsigned 32 bit integer */ 19 typedef u32 rpc_authflavor_t; 20 21 enum rpc_auth_flavors { 22 RPC_AUTH_NULL = 0, 23 RPC_AUTH_UNIX = 1, 24 RPC_AUTH_SHORT = 2, 25 RPC_AUTH_DES = 3, 26 RPC_AUTH_KRB = 4, 27 RPC_AUTH_GSS = 6, 28 RPC_AUTH_MAXFLAVOR = 8, 29 /* pseudoflavors: */ 30 RPC_AUTH_GSS_KRB5 = 390003, 31 RPC_AUTH_GSS_KRB5I = 390004, 32 RPC_AUTH_GSS_KRB5P = 390005, 33 RPC_AUTH_GSS_LKEY = 390006, 34 RPC_AUTH_GSS_LKEYI = 390007, 35 RPC_AUTH_GSS_LKEYP = 390008, 36 RPC_AUTH_GSS_SPKM = 390009, 37 RPC_AUTH_GSS_SPKMI = 390010, 38 RPC_AUTH_GSS_SPKMP = 390011, 39 }; 40 41 /* Maximum size (in bytes) of an rpc credential or verifier */ 42 #define RPC_MAX_AUTH_SIZE (400) 43 44 enum rpc_msg_type { 45 RPC_CALL = 0, 46 RPC_REPLY = 1 47 }; 48 49 enum rpc_reply_stat { 50 RPC_MSG_ACCEPTED = 0, 51 RPC_MSG_DENIED = 1 52 }; 53 54 enum rpc_accept_stat { 55 RPC_SUCCESS = 0, 56 RPC_PROG_UNAVAIL = 1, 57 RPC_PROG_MISMATCH = 2, 58 RPC_PROC_UNAVAIL = 3, 59 RPC_GARBAGE_ARGS = 4, 60 RPC_SYSTEM_ERR = 5, 61 /* internal use only */ 62 RPC_DROP_REPLY = 60000, 63 }; 64 65 enum rpc_reject_stat { 66 RPC_MISMATCH = 0, 67 RPC_AUTH_ERROR = 1 68 }; 69 70 enum rpc_auth_stat { 71 RPC_AUTH_OK = 0, 72 RPC_AUTH_BADCRED = 1, 73 RPC_AUTH_REJECTEDCRED = 2, 74 RPC_AUTH_BADVERF = 3, 75 RPC_AUTH_REJECTEDVERF = 4, 76 RPC_AUTH_TOOWEAK = 5, 77 /* RPCSEC_GSS errors */ 78 RPCSEC_GSS_CREDPROBLEM = 13, 79 RPCSEC_GSS_CTXPROBLEM = 14 80 }; 81 82 #define RPC_MAXNETNAMELEN 256 83 84 /* 85 * From RFC 1831: 86 * 87 * "A record is composed of one or more record fragments. A record 88 * fragment is a four-byte header followed by 0 to (2**31) - 1 bytes of 89 * fragment data. The bytes encode an unsigned binary number; as with 90 * XDR integers, the byte order is from highest to lowest. The number 91 * encodes two values -- a boolean which indicates whether the fragment 92 * is the last fragment of the record (bit value 1 implies the fragment 93 * is the last fragment) and a 31-bit unsigned binary value which is the 94 * length in bytes of the fragment's data. The boolean value is the 95 * highest-order bit of the header; the length is the 31 low-order bits. 96 * (Note that this record specification is NOT in XDR standard form!)" 97 * 98 * The Linux RPC client always sends its requests in a single record 99 * fragment, limiting the maximum payload size for stream transports to 100 * 2GB. 101 */ 102 103 typedef __be32 rpc_fraghdr; 104 105 #define RPC_LAST_STREAM_FRAGMENT (1U << 31) 106 #define RPC_FRAGMENT_SIZE_MASK (~RPC_LAST_STREAM_FRAGMENT) 107 #define RPC_MAX_FRAGMENT_SIZE ((1U << 31) - 1) 108 109 /* 110 * RPC call and reply header size as number of 32bit words (verifier 111 * size computed separately, see below) 112 */ 113 #define RPC_CALLHDRSIZE (6) 114 #define RPC_REPHDRSIZE (4) 115 116 117 /* 118 * Maximum RPC header size, including authentication, 119 * as number of 32bit words (see RFCs 1831, 1832). 120 * 121 * xid 1 xdr unit = 4 bytes 122 * mtype 1 123 * rpc_version 1 124 * program 1 125 * prog_version 1 126 * procedure 1 127 * cred { 128 * flavor 1 129 * length 1 130 * body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes 131 * } 132 * verf { 133 * flavor 1 134 * length 1 135 * body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes 136 * } 137 * TOTAL 210 xdr units = 840 bytes 138 */ 139 #define RPC_MAX_HEADER_WITH_AUTH \ 140 (RPC_CALLHDRSIZE + 2*(2+RPC_MAX_AUTH_SIZE/4)) 141 142 #define RPC_MAX_REPHEADER_WITH_AUTH \ 143 (RPC_REPHDRSIZE + (2 + RPC_MAX_AUTH_SIZE/4)) 144 145 /* 146 * Well-known netids. See: 147 * 148 * http://www.iana.org/assignments/rpc-netids/rpc-netids.xhtml 149 */ 150 #define RPCBIND_NETID_UDP "udp" 151 #define RPCBIND_NETID_TCP "tcp" 152 #define RPCBIND_NETID_RDMA "rdma" 153 #define RPCBIND_NETID_SCTP "sctp" 154 #define RPCBIND_NETID_UDP6 "udp6" 155 #define RPCBIND_NETID_TCP6 "tcp6" 156 #define RPCBIND_NETID_RDMA6 "rdma6" 157 #define RPCBIND_NETID_SCTP6 "sctp6" 158 #define RPCBIND_NETID_LOCAL "local" 159 160 /* 161 * Note that RFC 1833 does not put any size restrictions on the 162 * netid string, but all currently defined netid's fit in 5 bytes. 163 */ 164 #define RPCBIND_MAXNETIDLEN (5u) 165 166 /* 167 * Universal addresses are introduced in RFC 1833 and further spelled 168 * out in RFC 3530. RPCBIND_MAXUADDRLEN defines a maximum byte length 169 * of a universal address for use in allocating buffers and character 170 * arrays. 171 * 172 * Quoting RFC 3530, section 2.2: 173 * 174 * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the 175 * US-ASCII string: 176 * 177 * h1.h2.h3.h4.p1.p2 178 * 179 * The prefix, "h1.h2.h3.h4", is the standard textual form for 180 * representing an IPv4 address, which is always four octets long. 181 * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively, 182 * the first through fourth octets each converted to ASCII-decimal. 183 * Assuming big-endian ordering, p1 and p2 are, respectively, the first 184 * and second octets each converted to ASCII-decimal. For example, if a 185 * host, in big-endian order, has an address of 0x0A010307 and there is 186 * a service listening on, in big endian order, port 0x020F (decimal 187 * 527), then the complete universal address is "10.1.3.7.2.15". 188 * 189 * ... 190 * 191 * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the 192 * US-ASCII string: 193 * 194 * x1:x2:x3:x4:x5:x6:x7:x8.p1.p2 195 * 196 * The suffix "p1.p2" is the service port, and is computed the same way 197 * as with universal addresses for TCP and UDP over IPv4. The prefix, 198 * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for 199 * representing an IPv6 address as defined in Section 2.2 of [RFC2373]. 200 * Additionally, the two alternative forms specified in Section 2.2 of 201 * [RFC2373] are also acceptable. 202 */ 203 204 #include <linux/inet.h> 205 206 /* Maximum size of the port number part of a universal address */ 207 #define RPCBIND_MAXUADDRPLEN sizeof(".255.255") 208 209 /* Maximum size of an IPv4 universal address */ 210 #define RPCBIND_MAXUADDR4LEN \ 211 (INET_ADDRSTRLEN + RPCBIND_MAXUADDRPLEN) 212 213 /* Maximum size of an IPv6 universal address */ 214 #define RPCBIND_MAXUADDR6LEN \ 215 (INET6_ADDRSTRLEN + RPCBIND_MAXUADDRPLEN) 216 217 /* Assume INET6_ADDRSTRLEN will always be larger than INET_ADDRSTRLEN... */ 218 #define RPCBIND_MAXUADDRLEN RPCBIND_MAXUADDR6LEN 219 220 #endif /* __KERNEL__ */ 221 #endif /* _LINUX_SUNRPC_MSGPROT_H_ */ 222