From: "plaisthos (Code Review)" Date: Sun, 29 Dec 2024 03:12:52 +0000 In-Reply-To: References: Reply-To: arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641..., max@...2606..., lstipakov@...277... Message-ID: <337abc1cee297b56a0ba728f33d17d3b9f0ae5eb-EmailReplacePatchSet-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="XSLAuPCn4sA="; 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 , MaxF --XSLAuPCn4sA= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, plaisthos, 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 (#10). 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/10 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..fa7ef7c 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: 10 Gerrit-Owner: plaisthos Gerrit-Reviewer: flichtenheld Gerrit-CC: MaxF Gerrit-CC: openvpn-devel Gerrit-CC: stipa Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-Attention: stipa Gerrit-MessageType: newpatchset --XSLAuPCn4sA= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, plaisthos, stipa. <= /p>

plaisthos uploaded patch set #10 to this change.

= View Chan= ge

Add methods to read/write packet ids for epoch data

Change-Id= : I2a104decdb1e77a460f7a6976bcd0560b67a07b5
Signed-off-by: Arne Schwabe = <arne@...1227...>
---
M src/openvpn/packet_id.c
M src/openvp= n/packet_id.h
M tests/unit_tests/openvpn/test_packet_id.c
3 files cha= nged, 140 insertions(+), 3 deletions(-)

git pull ssh://gerrit.ope=
nvpn.net:29418/openvpn refs/changes/03/803/10
diff --git a/src/open=
vpn/packet_id.c b/src/openvpn/packet_id.c
index 117c95f..08= 06e99 100644
--- a/src/openvpn/packet_id.c
= +++ b/src/openvpn/packet_id.c
@@ -120,7 +120,8 @@ int64_t diff;

/*=
- * If time va= lue 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-&= gt;time =3D now;
+ = }
+ if (p->id = =3D=3D PACKET_ID_EPOCH_MAX)
+ {
+ = return false;
+ = }
+ p->id++;
+ return true;
+}
+
bool
p= acket_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_epoc= h(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 mos= t 16 bits */
+ uin= t16_t epoch =3D id >> 48;
+
+ pin= ->id =3D id & PACKET_ID_MASK;
+ return epoch;
+}
+
+bool
+packet_id_write_epoch(struct packet_i= d_send *p, uint16_t epoch, struct buffer *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 ((ui= nt64_t) epoch) << 48 | p->id;
+
+= /* convert to network order. This ensures that the highest bytes=
+ * also become the fir= st ones on the wire*/
+ net_id =3D htonll(net_id);
+
+ re= turn 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 d8a3e1= a..fa7ef7c 100644
--- a/src/openvpn/packet_id.h
<= span>+++ 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
+#d= efine PACKET_ID_EPOCH_MAX 0x0000ffffffffffffull
+/** Mask of the bits that contain the 48-bit o= f the per-epoch packet
+#define PACKET_ID_MASK 0x0000ffffffffffffull
<= span> 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 a= nd for control channel
@@ -321,4 +326,25 @@
}

}

+/**
+ * Writes the packet ID containing both the epoch and the packet i= d to the
+ * buffer s= pecified 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 pa= cket id space is exhausted and cannot be written

+ */
+bool
+pa= cket_id_write_epoch(struct packet_id_send *p, uint16_t epoch, struct buffer= *buf);
+
<= span style=3D"color: hsl(120, 100%, 40%);">+/**

+ * Reads the packet ID containing both the epoc= h and the per-epoch counter
+ * from the buf. Will return 0 as epoch id if there is any error.<= /span>
+ * @param p pa= cket_id struct to popupulate with the on-wire counter
+ * @param buf buffer to read the pack= et id from.
+ * @retu= rn 0 for an error/invalid id, epoch otherwise
+ */
+uint16_t
+packet_id_read_epoch(struct packet_id_net *p, struct buffer *buf);
+
#en= dif /* PACKET_ID_H */
diff --git a/tests/unit_tests/openvpn= /test_packet_id.c b/tests/unit_tests/openvpn/test_packet_id.c
index d918985..a24580b 100644

--- a/tests/unit_tests/ope= nvpn/test_packet_id.c
+++ b/tests/unit_tests/openvpn/test_p= acket_id.c
@@ -44,6 +44,7 @@
} test_bu= f_data;
struct buffer test_buf;
s= truct packet_id_send pis;
+ struct gc_arena gc;
};
<= br> static int
@@ -59,6 +60,7 @@

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

*state = =3D data;
return 0;
@@ -67,6 +69,8 @@<= /span>
static int
test_packet_id_write_teardown(= void **state)
{
+ struct test_packet_id_write_data *data =3D *state;<= br>+ gc_free(&data->g= c);
free(*state);
return 0;
}
@@ -209,6 +213,53 @@
rel= iable_free(rel);
}

+static void
+test_packet_id_write_epoch(void **state)+{
+ struct test_packet_id_write_data *data =3D= *state;
+
= + struct buffer buf =3D allo= c_buf_gc(128, &data->gc);
+
+ /*= test normal writing of packet id to the buffer */
+ assert_true(packet_id_write_epoch(&d= ata->pis, 0x23, &buf));
+
+ asse= rt_int_equal(buf.len, 8);
+ uint8_t expected_header[8] =3D { 0x00, 0x23, 0, 0, 0, 0, 0, 1};
+ assert_memory_equ= al(BPTR(&buf), expected_header, 8);
+
= + /* too small buffer should error out */
+ struct buffer buf_short =3D alloc_buf_gc(5, &a= mp;data->gc);
+ = assert_false(packet_id_write_epoch(&data->pis, 0xabde, &buf_sho= rt));
+
+ /* test a true 48 bit packet = id */

+ data->p= is.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), e= xpected_header_48, 8);
+ /* test writ= ing/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, &am= p;buf_of));
+ uint= 8_t expected_header_of[8] =3D { 0xf0, 0x0f, 0xff, 0xff, 0xff, 0xff, 0xff, 0= xff};
+ assert_mem= ory_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 ar= e 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_e= qual(packet_id_read_epoch(&pin, &buf_48), 0xfffe);
+ assert_int_equal(pin.id, 0xfa079= ab9d2e9);
++ assert_int_equal(packet_i= d_read_epoch(&pin, &buf_of), 0xf00f);
+ assert_int_equal(pin.id, 0xffffffffffff);
+}

static void
test_copy_acks_to_lru(void **sta= te)
@@ -296,6 +347,10 @@
cmocka_un= it_test_setup_teardown(test_packet_id_write_long_wrap,
= test_packet_id_write_setup,
= test_packet_id_write_teardow= n),
+ cmocka_u= nit_test_setup_teardown(test_packet_id_write_epoch,
+ t= est_packet_id_write_setup,
+ test_packet_id_write_teardow= n),
+
cmocka_unit_test(test_get_num_output_sequenced_available),
=
cmocka_unit_test(test_copy_acks_to_lru)
=

To view, visit change 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: 10
Gerrit-Owner: plaisthos <arne-openvpn@...1711...= 27...>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-CC: MaxF <max@...2606...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-CC: stipa <lstipakov@...277...> <= /div>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-Attention: stipa <lstipakov@...1663...= .>
Gerrit-MessageType: newpatchset
--XSLAuPCn4sA=--