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