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