protocol.h 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /* packet.h: Rx packet layout and definitions
  3. *
  4. * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
  5. * Written by David Howells (dhowells@redhat.com)
  6. */
  7. #ifndef _LINUX_RXRPC_PACKET_H
  8. #define _LINUX_RXRPC_PACKET_H
  9. typedef u32 rxrpc_seq_t; /* Rx message sequence number */
  10. typedef u32 rxrpc_serial_t; /* Rx message serial number */
  11. typedef __be32 rxrpc_seq_net_t; /* on-the-wire Rx message sequence number */
  12. typedef __be32 rxrpc_serial_net_t; /* on-the-wire Rx message serial number */
  13. /*****************************************************************************/
  14. /*
  15. * on-the-wire Rx packet header
  16. * - all multibyte fields should be in network byte order
  17. */
  18. struct rxrpc_wire_header {
  19. __be32 epoch; /* client boot timestamp */
  20. #define RXRPC_RANDOM_EPOCH 0x80000000 /* Random if set, date-based if not */
  21. __be32 cid; /* connection and channel ID */
  22. #define RXRPC_MAXCALLS 4 /* max active calls per conn */
  23. #define RXRPC_CHANNELMASK (RXRPC_MAXCALLS-1) /* mask for channel ID */
  24. #define RXRPC_CIDMASK (~RXRPC_CHANNELMASK) /* mask for connection ID */
  25. #define RXRPC_CIDSHIFT ilog2(RXRPC_MAXCALLS) /* shift for connection ID */
  26. #define RXRPC_CID_INC (1 << RXRPC_CIDSHIFT) /* connection ID increment */
  27. __be32 callNumber; /* call ID (0 for connection-level packets) */
  28. __be32 seq; /* sequence number of pkt in call stream */
  29. __be32 serial; /* serial number of pkt sent to network */
  30. uint8_t type; /* packet type */
  31. #define RXRPC_PACKET_TYPE_DATA 1 /* data */
  32. #define RXRPC_PACKET_TYPE_ACK 2 /* ACK */
  33. #define RXRPC_PACKET_TYPE_BUSY 3 /* call reject */
  34. #define RXRPC_PACKET_TYPE_ABORT 4 /* call/connection abort */
  35. #define RXRPC_PACKET_TYPE_ACKALL 5 /* ACK all outstanding packets on call */
  36. #define RXRPC_PACKET_TYPE_CHALLENGE 6 /* connection security challenge (SRVR->CLNT) */
  37. #define RXRPC_PACKET_TYPE_RESPONSE 7 /* connection secutity response (CLNT->SRVR) */
  38. #define RXRPC_PACKET_TYPE_DEBUG 8 /* debug info request */
  39. #define RXRPC_PACKET_TYPE_PARAMS 9 /* Parameter negotiation (unspec'd, ignore) */
  40. #define RXRPC_PACKET_TYPE_10 10 /* Ignored */
  41. #define RXRPC_PACKET_TYPE_11 11 /* Ignored */
  42. #define RXRPC_PACKET_TYPE_VERSION 13 /* version string request */
  43. uint8_t flags; /* packet flags */
  44. #define RXRPC_CLIENT_INITIATED 0x01 /* signifies a packet generated by a client */
  45. #define RXRPC_REQUEST_ACK 0x02 /* request an unconditional ACK of this packet */
  46. #define RXRPC_LAST_PACKET 0x04 /* the last packet from this side for this call */
  47. #define RXRPC_MORE_PACKETS 0x08 /* more packets to come */
  48. #define RXRPC_JUMBO_PACKET 0x20 /* [DATA] this is a jumbo packet */
  49. #define RXRPC_SLOW_START_OK 0x20 /* [ACK] slow start supported */
  50. uint8_t userStatus; /* app-layer defined status */
  51. #define RXRPC_USERSTATUS_SERVICE_UPGRADE 0x01 /* AuriStor service upgrade request */
  52. uint8_t securityIndex; /* security protocol ID */
  53. union {
  54. __be16 _rsvd; /* reserved */
  55. __be16 cksum; /* kerberos security checksum */
  56. };
  57. __be16 serviceId; /* service ID */
  58. } __packed;
  59. /*****************************************************************************/
  60. /*
  61. * jumbo packet secondary header
  62. * - can be mapped to read header by:
  63. * - new_serial = serial + 1
  64. * - new_seq = seq + 1
  65. * - new_flags = j_flags
  66. * - new__rsvd = j__rsvd
  67. * - duplicating all other fields
  68. */
  69. struct rxrpc_jumbo_header {
  70. uint8_t flags; /* packet flags (as per rxrpc_header) */
  71. uint8_t pad;
  72. union {
  73. __be16 _rsvd; /* reserved */
  74. __be16 cksum; /* kerberos security checksum */
  75. };
  76. };
  77. #define RXRPC_JUMBO_DATALEN 1412 /* non-terminal jumbo packet data length */
  78. #define RXRPC_JUMBO_SUBPKTLEN (RXRPC_JUMBO_DATALEN + sizeof(struct rxrpc_jumbo_header))
  79. /*
  80. * The maximum number of subpackets that can possibly fit in a UDP packet is:
  81. *
  82. * ((max_IP - IP_hdr - UDP_hdr) / RXRPC_JUMBO_SUBPKTLEN) + 1
  83. * = ((65535 - 28 - 28) / 1416) + 1
  84. * = 46 non-terminal packets and 1 terminal packet.
  85. */
  86. #define RXRPC_MAX_NR_JUMBO 47
  87. /*****************************************************************************/
  88. /*
  89. * on-the-wire Rx ACK packet data payload
  90. * - all multibyte fields should be in network byte order
  91. */
  92. struct rxrpc_ackpacket {
  93. __be16 bufferSpace; /* number of packet buffers available */
  94. __be16 maxSkew; /* diff between serno being ACK'd and highest serial no
  95. * received */
  96. __be32 firstPacket; /* sequence no of first ACK'd packet in attached list */
  97. __be32 previousPacket; /* sequence no of previous packet received */
  98. __be32 serial; /* serial no of packet that prompted this ACK */
  99. uint8_t reason; /* reason for ACK */
  100. #define RXRPC_ACK_REQUESTED 1 /* ACK was requested on packet */
  101. #define RXRPC_ACK_DUPLICATE 2 /* duplicate packet received */
  102. #define RXRPC_ACK_OUT_OF_SEQUENCE 3 /* out of sequence packet received */
  103. #define RXRPC_ACK_EXCEEDS_WINDOW 4 /* packet received beyond end of ACK window */
  104. #define RXRPC_ACK_NOSPACE 5 /* packet discarded due to lack of buffer space */
  105. #define RXRPC_ACK_PING 6 /* keep alive ACK */
  106. #define RXRPC_ACK_PING_RESPONSE 7 /* response to RXRPC_ACK_PING */
  107. #define RXRPC_ACK_DELAY 8 /* nothing happened since received packet */
  108. #define RXRPC_ACK_IDLE 9 /* ACK due to fully received ACK window */
  109. #define RXRPC_ACK__INVALID 10 /* Representation of invalid ACK reason */
  110. uint8_t nAcks; /* number of ACKs */
  111. #define RXRPC_MAXACKS 255
  112. uint8_t acks[0]; /* list of ACK/NAKs */
  113. #define RXRPC_ACK_TYPE_NACK 0
  114. #define RXRPC_ACK_TYPE_ACK 1
  115. } __packed;
  116. /* Some ACKs refer to specific packets and some are general and can be updated. */
  117. #define RXRPC_ACK_UPDATEABLE ((1 << RXRPC_ACK_REQUESTED) | \
  118. (1 << RXRPC_ACK_PING_RESPONSE) | \
  119. (1 << RXRPC_ACK_DELAY) | \
  120. (1 << RXRPC_ACK_IDLE))
  121. /*
  122. * ACK packets can have a further piece of information tagged on the end
  123. */
  124. struct rxrpc_ackinfo {
  125. __be32 rxMTU; /* maximum Rx MTU size (bytes) [AFS 3.3] */
  126. __be32 maxMTU; /* maximum interface MTU size (bytes) [AFS 3.3] */
  127. __be32 rwind; /* Rx window size (packets) [AFS 3.4] */
  128. __be32 jumbo_max; /* max packets to stick into a jumbo packet [AFS 3.5] */
  129. };
  130. /*****************************************************************************/
  131. /*
  132. * Kerberos security type-2 challenge packet
  133. */
  134. struct rxkad_challenge {
  135. __be32 version; /* version of this challenge type */
  136. __be32 nonce; /* encrypted random number */
  137. __be32 min_level; /* minimum security level */
  138. __be32 __padding; /* padding to 8-byte boundary */
  139. } __packed;
  140. /*****************************************************************************/
  141. /*
  142. * Kerberos security type-2 response packet
  143. */
  144. struct rxkad_response {
  145. __be32 version; /* version of this response type */
  146. __be32 __pad;
  147. /* encrypted bit of the response */
  148. struct {
  149. __be32 epoch; /* current epoch */
  150. __be32 cid; /* parent connection ID */
  151. __be32 checksum; /* checksum */
  152. __be32 securityIndex; /* security type */
  153. __be32 call_id[4]; /* encrypted call IDs */
  154. __be32 inc_nonce; /* challenge nonce + 1 */
  155. __be32 level; /* desired level */
  156. } encrypted;
  157. __be32 kvno; /* Kerberos key version number */
  158. __be32 ticket_len; /* Kerberos ticket length */
  159. } __packed;
  160. #endif /* _LINUX_RXRPC_PACKET_H */