linux/sunrpc/msg_prot.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * linux/include/linux/sunrpc/msg_prot.h
0004  *
0005  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
0006  */
0007
0008 #ifndef _LINUX_SUNRPC_MSGPROT_H_
0009 #define _LINUX_SUNRPC_MSGPROT_H_
0010
0011 #define RPC_VERSION 2
0012
0013 /* spec defines authentication flavor as an unsigned 32 bit integer */
0014 typedef u32 rpc_authflavor_t;
0015
0016 enum rpc_auth_flavors {
0017     RPC_AUTH_NULL  = 0,
0018     RPC_AUTH_UNIX  = 1,
0019     RPC_AUTH_SHORT = 2,
0020     RPC_AUTH_DES   = 3,
0021     RPC_AUTH_KRB   = 4,
0022     RPC_AUTH_GSS   = 6,
0023     RPC_AUTH_TLS   = 7,
0024     RPC_AUTH_MAXFLAVOR = 8,
0025     /* pseudoflavors: */
0026     RPC_AUTH_GSS_KRB5  = 390003,
0027     RPC_AUTH_GSS_KRB5I = 390004,
0028     RPC_AUTH_GSS_KRB5P = 390005,
0029     RPC_AUTH_GSS_LKEY  = 390006,
0030     RPC_AUTH_GSS_LKEYI = 390007,
0031     RPC_AUTH_GSS_LKEYP = 390008,
0032     RPC_AUTH_GSS_SPKM  = 390009,
0033     RPC_AUTH_GSS_SPKMI = 390010,
0034     RPC_AUTH_GSS_SPKMP = 390011,
0035 };
0036
0037 /* Maximum size (in bytes) of an rpc credential or verifier */
0038 #define RPC_MAX_AUTH_SIZE (400)
0039
0040 enum rpc_msg_type {
0041     RPC_CALL = 0,
0042     RPC_REPLY = 1
0043 };
0044
0045 enum rpc_reply_stat {
0046     RPC_MSG_ACCEPTED = 0,
0047     RPC_MSG_DENIED = 1
0048 };
0049
0050 enum rpc_accept_stat {
0051     RPC_SUCCESS = 0,
0052     RPC_PROG_UNAVAIL = 1,
0053     RPC_PROG_MISMATCH = 2,
0054     RPC_PROC_UNAVAIL = 3,
0055     RPC_GARBAGE_ARGS = 4,
0056     RPC_SYSTEM_ERR = 5,
0057     /* internal use only */
0058     RPC_DROP_REPLY = 60000,
0059 };
0060
0061 enum rpc_reject_stat {
0062     RPC_MISMATCH = 0,
0063     RPC_AUTH_ERROR = 1
0064 };
0065
0066 enum rpc_auth_stat {
0067     RPC_AUTH_OK = 0,
0068     RPC_AUTH_BADCRED = 1,
0069     RPC_AUTH_REJECTEDCRED = 2,
0070     RPC_AUTH_BADVERF = 3,
0071     RPC_AUTH_REJECTEDVERF = 4,
0072     RPC_AUTH_TOOWEAK = 5,
0073     /* RPCSEC_GSS errors */
0074     RPCSEC_GSS_CREDPROBLEM = 13,
0075     RPCSEC_GSS_CTXPROBLEM = 14
0076 };
0077
0078 #define RPC_MAXNETNAMELEN   256
0079
0080 /*
0081  * From RFC 1831:
0082  *
0083  * "A record is composed of one or more record fragments.  A record
0084  *  fragment is a four-byte header followed by 0 to (2**31) - 1 bytes of
0085  *  fragment data.  The bytes encode an unsigned binary number; as with
0086  *  XDR integers, the byte order is from highest to lowest.  The number
0087  *  encodes two values -- a boolean which indicates whether the fragment
0088  *  is the last fragment of the record (bit value 1 implies the fragment
0089  *  is the last fragment) and a 31-bit unsigned binary value which is the
0090  *  length in bytes of the fragment's data.  The boolean value is the
0091  *  highest-order bit of the header; the length is the 31 low-order bits.
0092  *  (Note that this record specification is NOT in XDR standard form!)"
0093  *
0094  * The Linux RPC client always sends its requests in a single record
0095  * fragment, limiting the maximum payload size for stream transports to
0096  * 2GB.
0097  */
0098
0099 typedef __be32  rpc_fraghdr;
0100
0101 #define RPC_LAST_STREAM_FRAGMENT    (1U << 31)
0102 #define RPC_FRAGMENT_SIZE_MASK      (~RPC_LAST_STREAM_FRAGMENT)
0103 #define RPC_MAX_FRAGMENT_SIZE       ((1U << 31) - 1)
0104
0105 /*
0106  * RPC call and reply header size as number of 32bit words (verifier
0107  * size computed separately, see below)
0108  */
0109 #define RPC_CALLHDRSIZE     (6)
0110 #define RPC_REPHDRSIZE      (4)
0111
0112
0113 /*
0114  * Maximum RPC header size, including authentication,
0115  * as number of 32bit words (see RFCs 1831, 1832).
0116  *
0117  *  xid             1 xdr unit = 4 bytes
0118  *  mtype               1
0119  *  rpc_version         1
0120  *  program             1
0121  *  prog_version            1
0122  *  procedure           1
0123  *  cred {
0124  *      flavor          1
0125  *      length          1
0126  *      body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes
0127  *  }
0128  *  verf {
0129  *      flavor          1
0130  *      length          1
0131  *      body<RPC_MAX_AUTH_SIZE> 100 xdr units = 400 bytes
0132  *  }
0133  *  TOTAL               210 xdr units = 840 bytes
0134  */
0135 #define RPC_MAX_HEADER_WITH_AUTH \
0136     (RPC_CALLHDRSIZE + 2*(2+RPC_MAX_AUTH_SIZE/4))
0137
0138 #define RPC_MAX_REPHEADER_WITH_AUTH \
0139     (RPC_REPHDRSIZE + (2 + RPC_MAX_AUTH_SIZE/4))
0140
0141 /*
0142  * Well-known netids. See:
0143  *
0144  *   https://www.iana.org/assignments/rpc-netids/rpc-netids.xhtml
0145  */
0146 #define RPCBIND_NETID_UDP   "udp"
0147 #define RPCBIND_NETID_TCP   "tcp"
0148 #define RPCBIND_NETID_RDMA  "rdma"
0149 #define RPCBIND_NETID_SCTP  "sctp"
0150 #define RPCBIND_NETID_UDP6  "udp6"
0151 #define RPCBIND_NETID_TCP6  "tcp6"
0152 #define RPCBIND_NETID_RDMA6 "rdma6"
0153 #define RPCBIND_NETID_SCTP6 "sctp6"
0154 #define RPCBIND_NETID_LOCAL "local"
0155
0156 /*
0157  * Note that RFC 1833 does not put any size restrictions on the
0158  * netid string, but all currently defined netid's fit in 5 bytes.
0159  */
0160 #define RPCBIND_MAXNETIDLEN (5u)
0161
0162 /*
0163  * Universal addresses are introduced in RFC 1833 and further spelled
0164  * out in RFC 3530.  RPCBIND_MAXUADDRLEN defines a maximum byte length
0165  * of a universal address for use in allocating buffers and character
0166  * arrays.
0167  *
0168  * Quoting RFC 3530, section 2.2:
0169  *
0170  * For TCP over IPv4 and for UDP over IPv4, the format of r_addr is the
0171  * US-ASCII string:
0172  *
0173  *  h1.h2.h3.h4.p1.p2
0174  *
0175  * The prefix, "h1.h2.h3.h4", is the standard textual form for
0176  * representing an IPv4 address, which is always four octets long.
0177  * Assuming big-endian ordering, h1, h2, h3, and h4, are respectively,
0178  * the first through fourth octets each converted to ASCII-decimal.
0179  * Assuming big-endian ordering, p1 and p2 are, respectively, the first
0180  * and second octets each converted to ASCII-decimal.  For example, if a
0181  * host, in big-endian order, has an address of 0x0A010307 and there is
0182  * a service listening on, in big endian order, port 0x020F (decimal
0183  * 527), then the complete universal address is "10.1.3.7.2.15".
0184  *
0185  * ...
0186  *
0187  * For TCP over IPv6 and for UDP over IPv6, the format of r_addr is the
0188  * US-ASCII string:
0189  *
0190  *  x1:x2:x3:x4:x5:x6:x7:x8.p1.p2
0191  *
0192  * The suffix "p1.p2" is the service port, and is computed the same way
0193  * as with universal addresses for TCP and UDP over IPv4.  The prefix,
0194  * "x1:x2:x3:x4:x5:x6:x7:x8", is the standard textual form for
0195  * representing an IPv6 address as defined in Section 2.2 of [RFC2373].
0196  * Additionally, the two alternative forms specified in Section 2.2 of
0197  * [RFC2373] are also acceptable.
0198  */
0199
0200 #include <linux/inet.h>
0201
0202 /* Maximum size of the port number part of a universal address */
0203 #define RPCBIND_MAXUADDRPLEN    sizeof(".255.255")
0204
0205 /* Maximum size of an IPv4 universal address */
0206 #define RPCBIND_MAXUADDR4LEN    \
0207         (INET_ADDRSTRLEN + RPCBIND_MAXUADDRPLEN)
0208
0209 /* Maximum size of an IPv6 universal address */
0210 #define RPCBIND_MAXUADDR6LEN    \
0211         (INET6_ADDRSTRLEN + RPCBIND_MAXUADDRPLEN)
0212
0213 /* Assume INET6_ADDRSTRLEN will always be larger than INET_ADDRSTRLEN... */
0214 #define RPCBIND_MAXUADDRLEN RPCBIND_MAXUADDR6LEN
0215
0216 #endif /* _LINUX_SUNRPC_MSGPROT_H_ */