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