add test for #41

Author: StefanHri

inc/common/unit_test.h

@@ -52,6 +52,8 @@ enum err oscore_option_generate(struct byte_array *piv, struct byte_array *kid,
 enum err derive(struct common_context *cc, struct byte_array *id,
 		enum derive_type type, struct byte_array *out);
 
+void set_observe_val(struct o_coap_option *options, uint8_t options_cnt,
+		     struct byte_array *piv);
 #else
 #define STATIC static
 #endif

src/oscore/oscore2coap.c

@@ -191,15 +191,43 @@ options_reorder(struct o_coap_option *U_options, uint8_t U_options_cnt,
 	return ok;
 }
 
+/**
+ * @brief 		Set the value of the inner observe option to the three least 
+ * 			significant bytes of the partial IV, see RFC8613 4.1.3.5.2
+ * 
+ * @param options 	array of all inner options
+ * @param options_cnt 	number of options
+ * @param piv 		PIV
+ */
+STATIC void set_observe_val(struct o_coap_option *options,
+				   uint8_t options_cnt, struct byte_array *piv)
+{
+	uint16_t len;
+	if (piv->len > 3) {
+		len = 3;
+	} else {
+		len = (uint16_t)piv->len;
+	}
+
+	for (uint8_t i = 0; i < options_cnt; i++) {
+		if (options[i].option_number == OBSERVE) {
+			options[i].value = piv->ptr;
+			options[i].len = len;
+		}
+	}
+}
+
 /**
  * @brief Generate CoAP packet from OSCORE packet
  * @param decrypted_payload: decrypted OSCORE payload, which contains code, E-options and original unprotected CoAP payload
  * @param oscore_pkt:  input OSCORE packet
+ * @param piv: PIV to be used only in the case of observe notification
  * @param out: pointer to output CoAP packet
  * @return
  */
 static inline enum err o_coap_pkg_generate(struct byte_array *decrypted_payload,
 					   struct o_coap_packet *oscore_pkt,
+					   struct byte_array *piv,
 					   struct o_coap_packet *out)
 {
 	uint8_t code = 0;
@@ -212,6 +240,10 @@ static inline enum err o_coap_pkg_generate(struct byte_array *decrypted_payload,
 					    &E_options_cnt,
 					    &unprotected_o_coap_payload));
 
+	/*set inner observe option value to the three least significant bytes 
+	of the PIV*/
+	set_observe_val(&E_options, E_options_cnt, piv);
+
 	/* Copy each items from OSCORE packet to CoAP packet */
 	/* Header */
 	out->header.ver = oscore_pkt->header.ver;
@@ -286,24 +318,6 @@ decrypt_wrapper(struct byte_array *ciphertext, struct byte_array *plaintext,
 	return ok;
 }
 
-static inline void set_observe_val(struct o_coap_option *options,
-				   uint8_t options_cnt, struct byte_array *piv)
-{
-	uint16_t len;
-	if (piv->len > 3) {
-		len = 3;
-	} else {
-		len = (uint16_t)piv->len;
-	}
-
-	for (uint8_t i = 0; i < options_cnt; i++) {
-		if (options[i].option_number == OBSERVE) {
-			options[i].value = piv->ptr;
-			options[i].len = len;
-		}
-	}
-}
-
 enum err oscore2coap(uint8_t *buf_in, uint32_t buf_in_len, uint8_t *buf_out,
 		     uint32_t *buf_out_len, struct context *c)
 {
@@ -419,12 +433,6 @@ enum err oscore2coap(uint8_t *buf_in, uint32_t buf_in_len, uint8_t *buf_out,
 					&c->rc.notification_num,
 					&c->rc.notification_num_initialized,
 					&oscore_option.piv));
-
-				/*set outer observe option value to the three 
-				least significant bytes of the PIV*/
-				set_observe_val(oscore_packet.options,
-						oscore_packet.options_cnt,
-						&oscore_option.piv);
 			} else {
 				/*Notification without PIV received -- Currently not supported*/
 				return not_supported_feature; //LCOV_EXCL_LINE
@@ -445,7 +453,8 @@ enum err oscore2coap(uint8_t *buf_in, uint32_t buf_in_len, uint8_t *buf_out,
 
 	/* Generate corresponding CoAP packet */
 	struct o_coap_packet o_coap_packet;
-	TRY(o_coap_pkg_generate(&plaintext, &oscore_packet, &o_coap_packet));
+	TRY(o_coap_pkg_generate(&plaintext, &oscore_packet, &oscore_option.piv,
+				&o_coap_packet));
 
 	/*Convert to byte string*/
 	return coap_serialize(&o_coap_packet, buf_out, buf_out_len);

test/main.c

@@ -133,6 +133,8 @@ void test_main(void)
 		ztest_unit_test(test_initiator_responder_interaction2));
 
 	/* OSCORE test-vector tests */
+	// ztest_test_suite(oscore_tests, ztest_unit_test(t304_set_observe_val));
+
 	ztest_test_suite(
 		oscore_tests,
 		ztest_unit_test(t1_oscore_client_request_response),
@@ -165,12 +167,12 @@ void test_main(void)
 		ztest_unit_test(t301_oscore_option_parser_wrong_n),
 		ztest_unit_test(t302_oscore_option_parser_no_kid),
 		ztest_unit_test(t303_options_reorder),
+		ztest_unit_test(t304_set_observe_val),
 		ztest_unit_test(t400_is_class_e),
 		ztest_unit_test(t401_cache_echo_val),
 		ztest_unit_test(t402_echo_val_is_fresh),
 		ztest_unit_test(t500_oscore_context_init_corner_cases),
-		ztest_unit_test(t501_piv2ssn),
-		ztest_unit_test(t502_ssn2piv),
+		ztest_unit_test(t501_piv2ssn), ztest_unit_test(t502_ssn2piv),
 		ztest_unit_test(t503_derive_corner_case),
 		ztest_unit_test(t504_context_freshness),
 		ztest_unit_test(t600_server_replay_init_test),

test/oscore_integration_tests/oscore_integration_tests.c

@@ -368,14 +368,14 @@ void t8_oscore_server_response_simple_ack(void)
  * @brief	This function test the behavior of a server and a client in a typical
  * 			observe exchange as depicted:
  *
- *			client							server
- *			---------						---------
- *				|								|
+ *			      client			     server
+ *			     ---------			    ---------
+ *				|				|
  *				|------registration------------>|
- *				|								|
+ *				|				|
  *				|<-----notification1------------|
- * rejected msg	| x---replayed notification1----|
- *				|								|
+ * 		rejected msg	| x---replayed notification1----|
+ *				|				|
  *
  * 			See as well Appendix A.1. in RFC7641
  */
@@ -579,7 +579,7 @@ void t9_oscore_client_server_observe(void)
 
 	zassert_equal(r, ok, "Error in oscore2coap!");
 	uint8_t EXPECTED_CONVERTED_COAP[] = {
-		0x61, 0x45, 0x00, 0x00, 0x4A, 0x60
+		0x61, 0x45, 0x00, 0x00, 0x4A, 0x61, 0x00
 	};
 	zassert_mem_equal__(&ser_conv_coap_pkt, EXPECTED_CONVERTED_COAP,
 			    sizeof(EXPECTED_CONVERTED_COAP),
@@ -600,23 +600,23 @@ void t9_oscore_client_server_observe(void)
  * @brief	This function test the behavior of a server and a client after 
  * 			reboot of the server and the rejection of a replayed request
  *
- *		   client				 				 		server
- *		  ---------			        				---------
- *			|                                   		|
+ *		   client				 	 server
+ *		  ---------					---------
+ *			|                                           |
  *		1)	|------request----------------------------->|
  *			|<-----response with ECHO option (ECHO1)----|
- *			|                                   		|
+ *			|                                           |
  *		2)	|------new request without ECHO opt-------->| 
  *			|<-----response with new ECHO option (ECHO2)|
- *			|              		            			|
+ *			|                                           |
  *		3)	|------request with old ECHO option-(ECHO1)>|
  * 			|<-----response with new ECHO option (ECHO3)|
- * 			|											|
+ * 			|                                           |
  *		4)	|------request with ECHO option-(ECHO3)---->|
  * 			|<-----response-----------------------------|
- *			|											|
+ *			|                                           |
  *		5)	|------request----------------------------->|
- * 			|------replayed request----------X			| rejected message
+ * 			|------replayed request----------X          | rejected message
  *
  * 			See as RFC8613 Appendix B1.2 and RFC9175
  * 

test/oscore_tests.h

@@ -40,6 +40,7 @@ void t300_oscore_option_parser_no_piv(void);
 void t301_oscore_option_parser_wrong_n(void);
 void t302_oscore_option_parser_no_kid(void);
 void t303_options_reorder(void);
+void t304_set_observe_val(void);
 
 void t400_is_class_e(void);
 void t401_cache_echo_val(void);

test/oscore_unit_tests/unit_test_oscore2coap.c

@@ -186,3 +186,55 @@ void t303_options_reorder(void)
 			      "wrong option_number");
 	}
 }
+
+void t304_set_observe_val(void)
+{
+	uint32_t i;
+
+	//test not having a observe option in the list of options
+	// -> nothing is happening
+	struct o_coap_option options[] = {
+		{ .delta = 2, .len = 0, .value = NULL, .option_number = 2 },
+		{ .delta = 2, .len = 0, .value = NULL, .option_number = 4 },
+	};
+	uint8_t PIV1[] = { 0x00 };
+
+	struct byte_array piv1 = BYTE_ARRAY_INIT(PIV1, sizeof(PIV1));
+
+	set_observe_val(options, sizeof(options) / sizeof(options[0]), &piv1);
+
+	for (i = 0; i < sizeof(options) / sizeof(options[0]); i++) {
+		zassert_equal(options[i].delta, 2, "wrong delta");
+		zassert_equal(options[i].len, 0, "wrong len");
+		zassert_equal(options[i].value, NULL, "wrong value");
+		zassert_equal(options[i].option_number, 2 + i * 2,
+			      "wrong option_number");
+	}
+
+	//test having a single observe option and piv of 2 byte
+	uint8_t PIV2[] = { 0xaa, 0xaa };
+	struct byte_array piv2 = BYTE_ARRAY_INIT(PIV2, sizeof(PIV2));
+	struct o_coap_option option2 = {
+		.delta = 6, .len = 0, .value = NULL, .option_number = OBSERVE
+	};
+
+	set_observe_val(&option2, 1, &piv2);
+	zassert_equal(option2.delta, 6, "wrong delta");
+	zassert_equal(option2.len, 2, "wrong len");
+	zassert_equal(option2.option_number, 6, "wrong option_number");
+	zassert_mem_equal__(option2.value, piv2.ptr, piv2.len, "wrong value");
+
+	//test having a single observe option and piv of 4 byte
+	uint8_t PIV3[] = { 0xaa, 0xaa, 0xaa, 0xaa };
+	struct byte_array piv3 = BYTE_ARRAY_INIT(PIV3, sizeof(PIV3));
+	struct o_coap_option option3 = {
+		.delta = 6, .len = 0, .value = NULL, .option_number = OBSERVE
+	};
+
+	set_observe_val(&option3, 1, &piv3);
+	zassert_equal(option3.delta, 6, "wrong delta");
+	zassert_equal(option3.len, 3, "wrong len");
+	zassert_equal(option3.option_number, 6, "wrong option_number");
+	zassert_mem_equal__(option3.value, piv3.ptr, option3.len,
+			    "wrong value");
+}