msg_prot.h 6.1 KB

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