include/linux/sunrpc/msg_prot.h

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