msg_prot.h 5.9 KB

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