From: "plaisthos (Code Review)" Date: Fri, 27 Dec 2024 18:19:18 +0000 In-Reply-To: References: Reply-To: arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641..., lstipakov@...277... Message-ID: <4aa5f9560ab30a675e4f4d817028677b7895e416-EmailReplacePatchSet-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="DW5WjDaunr8="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: Add methods to read/write packet ids for epoch data List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: flichtenheld Cc: openvpn-devel , stipa --DW5WjDaunr8= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, stipa. Hello flichtenheld, I'd like you to reexamine a change. Please visit http://gerrit.openvpn.net/c/openvpn/+/803?usp=3Demail to look at the new patch set (#9). The following approvals got outdated and were removed: Code-Review-1 by flichtenheld Change subject: Add methods to read/write packet ids for epoch data ...................................................................... Add methods to read/write packet ids for epoch data Change-Id: I2a104decdb1e77a460f7a6976bcd0560b67a07b5 Signed-off-by: Arne Schwabe --- M src/openvpn/packet_id.c M src/openvpn/packet_id.h M tests/unit_tests/openvpn/test_packet_id.c 3 files changed, 140 insertions(+), 3 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/03/803/9 diff --git a/src/openvpn/packet_id.c b/src/openvpn/packet_id.c index 117c95f..0806e99 100644 --- a/src/openvpn/packet_id.c +++ b/src/openvpn/packet_id.c @@ -120,7 +120,8 @@ int64_t diff; /* - * If time value increases, start a new sequence number sequence. + * If time value increases, start a new sequence list of number + * sequence for the new time point. */ if (!CIRC_LIST_SIZE(p->seq_list) || pin->time > p->time @@ -343,6 +344,21 @@ return true; } +static bool +packet_id_send_update_epoch(struct packet_id_send *p) +{ + if (!p->time) + { + p->time =3D now; + } + if (p->id =3D=3D PACKET_ID_EPOCH_MAX) + { + return false; + } + p->id++; + return true; +} + bool packet_id_write(struct packet_id_send *p, struct buffer *buf, bool long_fo= rm, bool prepend) @@ -634,4 +650,44 @@ gc_free(&gc); } +uint16_t +packet_id_read_epoch(struct packet_id_net *pin, struct buffer *buf) +{ + uint64_t packet_id; + + + if (!buf_read(buf, &packet_id, sizeof(packet_id))) + { + return 0; + } + + uint64_t id =3D ntohll(packet_id); + /* top most 16 bits */ + uint16_t epoch =3D id >> 48; + + pin->id =3D id & PACKET_ID_MASK; + return epoch; +} + +bool +packet_id_write_epoch(struct packet_id_send *p, uint16_t epoch, struct buf= fer *buf) +{ + if (!packet_id_send_update_epoch(p)) + { + return false; + } + + /* Highest 16 bits of packet id is the epoch. + * + * The lower 48 bits are the per-epoch packet id counter. */ + uint64_t net_id =3D ((uint64_t) epoch) << 48 | p->id; + + /* convert to network order. This ensures that the highest bytes + * also become the first ones on the wire*/ + net_id =3D htonll(net_id); + + return buf_write(buf, &net_id, sizeof(net_id)); +} + + #endif /* ifdef ENABLE_DEBUG */ diff --git a/src/openvpn/packet_id.h b/src/openvpn/packet_id.h index d8a3e1a..4f947e8 100644 --- a/src/openvpn/packet_id.h +++ b/src/openvpn/packet_id.h @@ -44,7 +44,11 @@ * These are ephemeral and are never saved to a file. */ typedef uint32_t packet_id_type; -#define PACKET_ID_MAX UINT32_MAX +#define PACKET_ID_MAX UINT32_MAX +#define PACKET_ID_EPOCH_MAX 0x0000ffffffffffffull +/** Mask of the bits that contain the 48-bit of the per-epoch packet + * counter in the packet id*/ +#define PACKET_ID_MASK 0x0000ffffffffffffull typedef uint32_t net_time_t; /* @@ -158,7 +162,8 @@ * includes a timestamp as well. * * An epoch packet-id is a 16 bit epoch - * counter plus a 48 per-epoch packet-id + * counter plus a 48 per-epoch packet-id. + * * * Long packet-ids are used as IVs for * CFB/OFB ciphers and for control channel @@ -321,4 +326,25 @@ } } +/** + * Writes the packet ID containing both the epoch and the packet id to the + * buffer specified by buf. + * @param p packed id send structure to use for the packet id + * @param epoch epoch to write to the packet + * @param buf buffer to write the packet id/epoch to + * @return false if the packet id space is exhausted and cannot b= e written + */ +bool +packet_id_write_epoch(struct packet_id_send *p, uint16_t epoch, struct buf= fer *buf); + +/** + * Reads the packet ID containing both the epoch and the per-epoch counter + * from the buf. Will return 0 as epoch id if there is any error. + * @param p packet_id struct to popupulate with the on-wire counter + * @param buf buffer to read the packet id from. + * @return 0 for an error/invalid id, epoch otherwise + */ +uint16_t +packet_id_read_epoch(struct packet_id_net *p, struct buffer *buf); + #endif /* PACKET_ID_H */ diff --git a/tests/unit_tests/openvpn/test_packet_id.c b/tests/unit_tests/o= penvpn/test_packet_id.c index d918985..a24580b 100644 --- a/tests/unit_tests/openvpn/test_packet_id.c +++ b/tests/unit_tests/openvpn/test_packet_id.c @@ -44,6 +44,7 @@ } test_buf_data; struct buffer test_buf; struct packet_id_send pis; + struct gc_arena gc; }; static int @@ -59,6 +60,7 @@ data->test_buf.data =3D (void *) &data->test_buf_data; data->test_buf.capacity =3D sizeof(data->test_buf_data); + data->gc =3D gc_new(); *state =3D data; return 0; @@ -67,6 +69,8 @@ static int test_packet_id_write_teardown(void **state) { + struct test_packet_id_write_data *data =3D *state; + gc_free(&data->gc); free(*state); return 0; } @@ -209,6 +213,53 @@ reliable_free(rel); } =20 +static void +test_packet_id_write_epoch(void **state) +{ + struct test_packet_id_write_data *data =3D *state; + + struct buffer buf =3D alloc_buf_gc(128, &data->gc); + + /* test normal writing of packet id to the buffer */ + assert_true(packet_id_write_epoch(&data->pis, 0x23, &buf)); + + assert_int_equal(buf.len, 8); + uint8_t expected_header[8] =3D { 0x00, 0x23, 0, 0, 0, 0, 0, 1}; + assert_memory_equal(BPTR(&buf), expected_header, 8); + + /* too small buffer should error out */ + struct buffer buf_short =3D alloc_buf_gc(5, &data->gc); + assert_false(packet_id_write_epoch(&data->pis, 0xabde, &buf_short)); + + /* test a true 48 bit packet id */ + data->pis.id =3D 0xfa079ab9d2e8; + struct buffer buf_48 =3D alloc_buf_gc(128, &data->gc); + assert_true(packet_id_write_epoch(&data->pis, 0xfffe, &buf_48)); + uint8_t expected_header_48[8] =3D { 0xff, 0xfe, 0xfa, 0x07, 0x9a, 0xb9= , 0xd2, 0xe9}; + assert_memory_equal(BPTR(&buf_48), expected_header_48, 8); + + /* test writing/checking the 48 bit overflow */ + data->pis.id =3D 0xfffffffffffe; + struct buffer buf_of =3D alloc_buf_gc(128, &data->gc); + assert_true(packet_id_write_epoch(&data->pis, 0xf00f, &buf_of)); + uint8_t expected_header_of[8] =3D { 0xf0, 0x0f, 0xff, 0xff, 0xff, 0xff= , 0xff, 0xff}; + assert_memory_equal(BPTR(&buf_of), expected_header_of, 8); + + /* This is go over 2^48 - 1 and should error out. */ + assert_false(packet_id_write_epoch(&data->pis, 0xf00f, &buf_of)); + + /* Now read back the packet ids and check if they are the same as what= we + * have written */ + struct packet_id_net pin; + assert_int_equal(packet_id_read_epoch(&pin, &buf), 0x23); + assert_int_equal(pin.id, 1); + + assert_int_equal(packet_id_read_epoch(&pin, &buf_48), 0xfffe); + assert_int_equal(pin.id, 0xfa079ab9d2e9); + + assert_int_equal(packet_id_read_epoch(&pin, &buf_of), 0xf00f); + assert_int_equal(pin.id, 0xffffffffffff); +} static void test_copy_acks_to_lru(void **state) @@ -296,6 +347,10 @@ cmocka_unit_test_setup_teardown(test_packet_id_write_long_wrap, test_packet_id_write_setup, test_packet_id_write_teardown), + cmocka_unit_test_setup_teardown(test_packet_id_write_epoch, + test_packet_id_write_setup, + test_packet_id_write_teardown), + cmocka_unit_test(test_get_num_output_sequenced_available), cmocka_unit_test(test_copy_acks_to_lru) -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/803?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I2a104decdb1e77a460f7a6976bcd0560b67a07b5 Gerrit-Change-Number: 803 Gerrit-PatchSet: 9 Gerrit-Owner: plaisthos Gerrit-Reviewer: flichtenheld Gerrit-CC: openvpn-devel Gerrit-CC: stipa Gerrit-Attention: flichtenheld Gerrit-Attention: stipa Gerrit-MessageType: newpatchset --DW5WjDaunr8= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, stipa.

plaisthos uploaded patch set #9 to this change.

<= a href=3D"http://gerrit.openvpn.net/c/openvpn/+/803?usp=3Demail">View Chang= e

The following approvals got outdated and were removed: Code-Review-1 by flichtenheld

Add methods to read/write packet ids for epoc=
h data

Change-Id: I2a104decdb1e77a460f7a6976bcd0560b67a07b5
Signe= d-off-by: Arne Schwabe <arne@...1227...>
---
M src/openvpn/pack= et_id.c
M src/openvpn/packet_id.h
M tests/unit_tests/openvpn/test_pac= ket_id.c
3 files changed, 140 insertions(+), 3 deletions(-)

gi=
t pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/03/803/9
diff --git a/src/openvpn/packet_id.c b/src/openvpn/packet_id.c
<= span>index 117c95f..0806e99 100644
--- a/src/openvpn/packet= _id.c
+++ b/src/openvpn/packet_id.c
@@ -120= ,7 +120,8 @@
int64_t diff;

/*
= - * If time value increases, start a new sequence number sequence.<= /span>
+ * If time v= alue increases, start a new sequence list of number
+ * sequence for the new time poin= t.
*/
if (!CIRC_LIST_SIZ= E(p->seq_list)
|| pin->time > p->t= ime
@@ -343,6 +344,21 @@
return true;<= /span>
}

+static bool
+packet_id_send_update_epoch(struct packet_id_send *p)
+{

+ if (!p->time)
+ {
+ p->time =3D now;
+ }
+ if (p->id =3D=3D PACKET_ID_EPOCH_MAX)
+ {
+ return false;
+ }
+ p->id++;
= + return true;
+}<= /span>
+
bo= ol
packet_id_write(struct packet_id_send *p, struct buffer= *buf, bool long_form,
bool prepend)
@@ -634,4 +650,44 @@
gc_free(&gc);
}

+uint16_t
+packet_id_read_epoch(struct packet_id_net *pin, struct buffer *buf)
+{
+ uint64_t packet_id;
+
+
+= if (!buf_read(buf, &packet_id, sizeof(packet_id)))
+ {
+ return 0;
+ }
+
+ uint64= _t id =3D ntohll(packet_id);
+ /* top most 16 bits */
+ uint16_t epoch =3D id >> 48;
+
+ pin->id =3D id & PACKET_ID_MASK;
+ return epoch;

+}
+
= +bool
+packet_id_writ= e_epoch(struct packet_id_send *p, uint16_t epoch, struct buffer *buf)
+{
+ if (!packet_id_send_update_epoch(p))<= /span>
+ {
+ return false;

+ }

+
+ /* Highest 16 bits of packet id is the epoch.
+ *

+ * The lower 48 bits are the per-epoch packe= t id counter. */
+ = uint64_t net_id =3D ((uint64_t) epoch) << 48 | p->id;
<= span style=3D"color: hsl(120, 100%, 40%);">+

+ /* convert to network order. This ensures that= the highest bytes
+ = * also become the first ones on the wire*/
+ net_id =3D htonll(net_id);
+
+ return buf_write(buf, &net_id, sizeof(net_id));<= /span>
+}
+
+
#endif /* ifdef ENABLE_DEBUG */<= br>diff --git a/src/openvpn/packet_id.h b/src/openvpn/packet_id.h
index d8a3e1a..4f947e8 100644
--- a/src/openvp= n/packet_id.h
+++ b/src/openvpn/packet_id.h
@@ -44,7 +44,11 @@

* These are ephemeral and are never s= aved to a file.
*/
typedef uint32_t pack= et_id_type;
-#define PA= CKET_ID_MAX UINT32_MAX
+#define PACKET_ID_EPOCH_MAX 0x0000ffffffffffffull
+/** Mask of the bits = that contain the 48-bit of the per-epoch packet
+ * counter in the packet id*/
+#define PACKET_ID_MASK 0x0000f= fffffffffffull
typedef uint32_t net_time_t;

/*
@@ -158,7 +162,8 @@
* includes a timestamp as well.

*
* = An epoch packet-id is a 16 bit epoch
- * counter plus a 48 per-epoch packet-id
+ * counter plus a 48 per-epoch packet-i= d.
+ *
*

* Long packet-ids are used as IVs for
* CFB/OFB ciphers and for control channel

@@ -321,4 +3= 26,25 @@
}
}
=
+/**
+ * Writes the packet ID containing both t= he epoch and the packet id to the
+ * buffer specified by buf.
+ * @param p packed id send structure to use f= or the packet id
+ * = @param epoch epoch to write to the packet
+ * @param buf buffer to write the packet id= /epoch to
+ * @return= false if the packet id space is exhausted and cannot be written
+ */
+bool
+packet_id_write_epoch(struct packet_id_send *p, uint= 16_t epoch, struct buffer *buf);
+
+/**
+ * Reads the packet ID= containing both the epoch and the per-epoch counter
+ * from the buf. Will return 0 as epoch = id if there is any error.
+ * @param p packet_id struct to popupulate with the on-wire cou= nter
+ * @param buf = buffer to read the packet id from.
+ * @return 0 for an error/invalid id, epoch otherw= ise
+ */
+uint16_t

+packet_id_read_epoch(struct packet_id_net= *p, struct buffer *buf);
+
#endif /* PACKET_ID_H */
diff --git= a/tests/unit_tests/openvpn/test_packet_id.c b/tests/unit_tests/openvpn/tes= t_packet_id.c
index d918985..a24580b 100644
--- a/tests/unit_tests/openvpn/test_packet_id.c

+++ b/test= s/unit_tests/openvpn/test_packet_id.c
@@ -44,6 +44,7 @@
} test_buf_data;
struct buffer test_= buf;
struct packet_id_send pis;
+ struct gc_arena gc;
= };

static int
@@ -59,6 += 60,7 @@

data->test_buf.data =3D (= void *) &data->test_buf_data;
data->test_buf= .capacity =3D sizeof(data->test_buf_data);
+ data->gc =3D gc_new();

*state =3D data;
return 0;<= br>@@ -67,6 +69,8 @@
static int
tes= t_packet_id_write_teardown(void **state)
{
+ struct test_packet_id_write_dat= a *data =3D *state;

+= gc_free(&data->gc);
free(*state); return 0;
}
@@ -209,6 +213,53 = @@
reliable_free(rel);
}

+static void
+test_packet_id_write_e= poch(void **state)
+{=
+ struct test_pac= ket_id_write_data *data =3D *state;
+
+ = struct buffer buf =3D alloc_buf_gc(128, &data->gc);
+

+ /* test normal writing of packet id to the buffer = */
+ assert_true(p= acket_id_write_epoch(&data->pis, 0x23, &buf));
+
+ assert_int_equal(buf.len, 8);
+ uint8_t expected_header[8] =3D { 0x00= , 0x23, 0, 0, 0, 0, 0, 1};
+ assert_memory_equal(BPTR(&buf), expected_header, 8);<= br>+
+ /* too small buffer should error out */
+ struct buffer buf_= short =3D alloc_buf_gc(5, &data->gc);
+ assert_false(packet_id_write_epoch(&data-&= gt;pis, 0xabde, &buf_short));
+
+ /= * test a true 48 bit packet id */
+ data->pis.id =3D 0xfa079ab9d2e8;
+ struct buffer buf_48 =3D alloc_buf_gc= (128, &data->gc);
+ assert_true(packet_id_write_epoch(&data->pis, 0xfffe, &= buf_48));
+ uint8_= t expected_header_48[8] =3D { 0xff, 0xfe, 0xfa, 0x07, 0x9a, 0xb9, 0xd2, 0xe= 9};
+ assert_memor= y_equal(BPTR(&buf_48), expected_header_48, 8);
+
+ /* test writing/checking the 48 bit overflow */
<= span style=3D"color: hsl(120, 100%, 40%);">+ data->pis.id =3D 0xfffff= ffffffe;

+ struct = buffer buf_of =3D alloc_buf_gc(128, &data->gc);
+ assert_true(packet_id_write_epoch(&a= mp;data->pis, 0xf00f, &buf_of));
+ uint8_t expected_header_of[8] =3D { 0xf0, 0x0f, 0xf= f, 0xff, 0xff, 0xff, 0xff, 0xff};
+ assert_memory_equal(BPTR(&buf_of), expected_header_of= , 8);
+
+ /* This is go over 2^48 - 1 a= nd should error out. */
+ assert_false(packet_id_write_epoch(&data->pis, 0xf00f, &= buf_of));
++ /* Now read back the pack= et ids and check if they are the same as what we
+ * have written */
+ struct packet_id_net pin;
<= span style=3D"color: hsl(120, 100%, 40%);">+ assert_int_equal(packet_id_= read_epoch(&pin, &buf), 0x23);
+ assert_int_equal(pin.id, 1);
+
+ assert_int_equal(packet_id_read_epoch(&pin, &buf= _48), 0xfffe);
+ a= ssert_int_equal(pin.id, 0xfa079ab9d2e9);
+
+ assert_int_equal(packet_id_read_epoch(&pin, &buf_of), 0xf00f)= ;
+ assert_int_equ= al(pin.id, 0xffffffffffff);
+}

static void
t= est_copy_acks_to_lru(void **state)
@@ -296,6 +347,10 @@

cmocka_unit_test_setup_teardown(test_packet_id_write_= long_wrap,
test_pa= cket_id_write_setup,
= test_packet_id_write_teardown),
+ cmocka_unit_test_setup_teardown(test_packet_id_write= _epoch,
+ = test_packet_id_write_setup,
+ = test_packet_id_write_teardown),
+
cmocka_unit_test(test_get_num_output= _sequenced_available),
cmocka_unit_test(test_copy_= acks_to_lru)


To view,= visit ch= ange 803. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I2a104decdb1e77a460f7a6976bc= d0560b67a07b5
Gerrit-Change-Number: 803
Gerrit-PatchSet: 9
Gerrit-Owner: plaisthos <arne-openvpn@...1711...= 27...>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-CC: stipa <lstipakov@...277...> <= /div>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-Attention: stipa <lstipakov@...1663...= .>
Gerrit-MessageType: newpatchset
--DW5WjDaunr8=--