diff --git a/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_08/test_case_vector.json b/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_08/test_case_vector.json index 0753d4ec94cf62..41d5d3d94211cb 100644 --- a/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_08/test_case_vector.json +++ b/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_08/test_case_vector.json @@ -1,9 +1,9 @@ { "description": "PAI Test Vector: Fallback VID and PID encoding example from spec: invalid, since substring following Mpid: is not exactly 4 uppercase hexadecimal digits", - "is_success_case": "true", - "dac_cert": "308201d93082017fa00302010202082b33ac6e16c75827300a06082a8648ce3d040302303b3139303706035504030c3041434d45204d617474657220446576656c20504149203543444139383939204d7669643a46464631204d7069643a42313020170d3232303532373030303030305a180f39393939313233313233353935395a30463118301606035504030c0f4d617474657220546573742044414331143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04303042313059301306072a8648ce3d020106082a8648ce3d03010703420004410ca0cf2143eb925ff8f89a4471a73904b0330f3e52154eeeaaaf18c0a54cfb02129483b22d6a8da0db09defee44990edc69d3fbb52cf33ab455db1b5a5ac7fa360305e300c0603551d130101ff04023000300e0603551d0f0101ff040403020780301d0603551d0e04160414a59346294c65373c763039bdd0d7f5cb7ded0fae301f0603551d230418301680146e31cd74718cd9105e98710237d19eb2fe480d86300a06082a8648ce3d040302034800304502203c63e51f456137ef959bb51487aa25616d8ab6f12bbc534f77842189bd495a9e022100fd3f7de5dc7237b97f3bccf4255a7dd5501179c8cf480e34809cfdd8b1dc53d7", - "pai_cert": "308201ca3082016fa0030201020208652ab3c085eed037300a06082a8648ce3d04030230303118301606035504030c0f4d617474657220546573742050414131143012060a2b0601040182a27c02010c04464646313020170d3232303532373030303030305a180f39393939313233313233353935395a303b3139303706035504030c3041434d45204d617474657220446576656c20504149203543444139383939204d7669643a46464631204d7069643a42313059301306072a8648ce3d020106082a8648ce3d0301070342000431319f3024f53e8bcd44acb77a4a8a1d4df61966f0b4a06ffb8fa5af5ba2988fa3e2c67747fb59e94e9d356e9509dbc95d9345ca0c5e78078c89360fe749ca2da366306430120603551d130101ff040830060101ff020100300e0603551d0f0101ff040403020106301d0603551d0e041604146e31cd74718cd9105e98710237d19eb2fe480d86301f0603551d230418301680146afd22771f511fecbf1641976710dcdc31a1717e300a06082a8648ce3d040302034900304602210093091c5610f921d9d7e3afe68e77fe9fdf2857ba09e2bcd2e503196187e79032022100ce8f88e1e9469044ef583fc06ed7de227779757206f3779e7517663d826df612", - "certification_declaration": "3081e806092a864886f70d010702a081da3081d7020103310d300b0609608648016503040201304406092a864886f70d010701a0370435152400012501f1ff360204b118250334122c04135a494732303134315a423333303030312d32342405002406002507769824080018317d307b020103801462fa823359acfaa9963e1cfa140addf504f37160300b0609608648016503040201300a06082a8648ce3d04030204473045022100ffe39b9f479f0f6c98a02a3a97c0a8c7c1754d3c87e7b70f6c676bc12ed83dc302203c6f75ed2d90c9c75a28836c6cdf4191f4c9ad9d940d5108217ac597c2f16980", - "dac_private_key": "da503e4cbc05d3f3e5054da8f42f8c523a37f93d2ccc0c8a62e4830f66293182", - "dac_public_key": "04410ca0cf2143eb925ff8f89a4471a73904b0330f3e52154eeeaaaf18c0a54cfb02129483b22d6a8da0db09defee44990edc69d3fbb52cf33ab455db1b5a5ac7f" + "is_success_case": "false", + "dac_cert": "308201d93082017fa003020102020846cb41af3a7fc9c3300a06082a8648ce3d040302303b3139303706035504030c3041434d45204d617474657220446576656c20504149203543444139383939204d7669643a46464631204d7069643a42313020170d3232303932333030303030305a180f39393939313233313233353935395a30463118301606035504030c0f4d617474657220546573742044414331143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04303042313059301306072a8648ce3d020106082a8648ce3d03010703420004d3e1c5422ab213f118f959a33d2204342cf598dffcf5cec0474a1bba6e4c1a7263a59c605cf892038a704fd266149b5c89fe35e17e8dda279bb03cb1c7bf8ca6a360305e300c0603551d130101ff04023000300e0603551d0f0101ff040403020780301d0603551d0e0416041430616dcabe874ac65e3dce88de7c5cc5defd86f9301f0603551d230418301680148fa036268e8eedbc73e12a0eeadcb2fbec8faaac300a06082a8648ce3d040302034800304502204ef134d60bb150def30f7c2df8f88c46755e36f48a12831aaedf17c4944cd70d022100f61555085107e4e783a5ad6abc64e1ee1f0d719b7d83a5f8bace41949f85c284", + "pai_cert": "308201c93082016fa003020102020821b17d362fe9afae300a06082a8648ce3d04030230303118301606035504030c0f4d617474657220546573742050414131143012060a2b0601040182a27c02010c04464646313020170d3232303932333030303030305a180f39393939313233313233353935395a303b3139303706035504030c3041434d45204d617474657220446576656c20504149203543444139383939204d7669643a46464631204d7069643a42313059301306072a8648ce3d020106082a8648ce3d03010703420004e72dbe2a0f600358978022ea70fb7ef3ef14de92a0dfb9cfb83b542fbccb7b8a7b13d3f37a26dfd2400224ae4ab82e1c13ca57a45e4ee54e862a192a6d4f1f3aa366306430120603551d130101ff040830060101ff020100300e0603551d0f0101ff040403020106301d0603551d0e041604148fa036268e8eedbc73e12a0eeadcb2fbec8faaac301f0603551d230418301680146afd22771f511fecbf1641976710dcdc31a1717e300a06082a8648ce3d040302034800304502210093a63c6f397d39dfa5b60c06c2839448ab5db0bf0728c7449c66bdc55e3ff6c302207b0c997ff95f1795b86828d1137b34f3f2aef1ffb2183a6e4c02836c1c735171", + "certification_declaration": "3081e906092a864886f70d010702a081db3081d8020103310d300b0609608648016503040201304406092a864886f70d010701a0370435152400012501f1ff360204b118250334122c04135a494732303134315a423333303030312d32342405002406002507769824080018317e307c020103801462fa823359acfaa9963e1cfa140addf504f37160300b0609608648016503040201300a06082a8648ce3d04030204483046022100e1d4967878513c474101db44c68061689be47443e21f6675c34b872edc5a319c022100a963e07bcd8e4abeb8b4fcb19f6a59c92f1a3bad4d7153f333684f93a836e3f9", + "dac_private_key": "05da60e1debbee09f31881ac82eb6ce5116db802606077661ff968312465fa75", + "dac_public_key": "04d3e1c5422ab213f118f959a33d2204342cf598dffcf5cec0474a1bba6e4c1a7263a59c605cf892038a704fd266149b5c89fe35e17e8dda279bb03cb1c7bf8ca6" } diff --git a/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_09/test_case_vector.json b/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_09/test_case_vector.json index 58f67d5a51c7ee..210bc861b49deb 100644 --- a/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_09/test_case_vector.json +++ b/credentials/development/commissioner_dut/struct_pai_vidpid_fallback_encoding_09/test_case_vector.json @@ -1,9 +1,9 @@ { "description": "PAI Test Vector: Fallback VID and PID encoding example from spec: invalid, since substring following Mpid: is not exactly 4 uppercase hexadecimal digits", - "is_success_case": "true", - "dac_cert": "308201d83082017da00302010202084e7b4a5111ae21af300a06082a8648ce3d04030230393137303506035504030c2e41434d45204d617474657220446576656c20504149203543444139383939204d7069643a204d7669643a464646313020170d3232303532373030303030305a180f39393939313233313233353935395a30463118301606035504030c0f4d617474657220546573742044414331143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04303042313059301306072a8648ce3d020106082a8648ce3d03010703420004760c320e7c2d565082eefdeba1d66f357ef50b87a98c90c3bb4b314a79c42a3e4014296a1ab0bf166dcefef3a86c30e3334f85debb09250b64752f945d44089fa360305e300c0603551d130101ff04023000300e0603551d0f0101ff040403020780301d0603551d0e04160414d7e07a4b844e5ba0fe9bef40476e9e8ac9e8a5bf301f0603551d2304183016801455140af506976d92611c51cec3c2037790dd47c0300a06082a8648ce3d0403020349003046022100dc41cf2813b922f0f9c84fb55059b5d2e3f684923a1d83f6d9aabaee60cbfbd4022100a2495b08a4a6aa7bb4ec9f7000a410b04bb69f48c4557f5bdc4864fcbaaa787d", - "pai_cert": "308201c63082016da00302010202083d95522ea6682a4c300a06082a8648ce3d04030230303118301606035504030c0f4d617474657220546573742050414131143012060a2b0601040182a27c02010c04464646313020170d3232303532373030303030305a180f39393939313233313233353935395a30393137303506035504030c2e41434d45204d617474657220446576656c20504149203543444139383939204d7069643a204d7669643a464646313059301306072a8648ce3d020106082a8648ce3d03010703420004fdea8bcdc408e5a885cbc62176957583a0421e4e44711a080ff1572262e7afefc4d6b56a788d4d3b571ac25d678af964e8a235b05fe112f99eee3bf57d717cd8a366306430120603551d130101ff040830060101ff020100300e0603551d0f0101ff040403020106301d0603551d0e0416041455140af506976d92611c51cec3c2037790dd47c0301f0603551d230418301680146afd22771f511fecbf1641976710dcdc31a1717e300a06082a8648ce3d04030203470030440220143dfe46f8ffaa1321a281c1c5cfd0c3be4976ed0582d26a529a93ea18783637022045a5fd90301d1156fb3ec2dfe273f9ca663b01b41885790b81182937ed1b9f6c", - "certification_declaration": "3081e706092a864886f70d010702a081d93081d6020103310d300b0609608648016503040201304406092a864886f70d010701a0370435152400012501f1ff360204b118250334122c04135a494732303134315a423333303030312d32342405002406002507769824080018317c307a020103801462fa823359acfaa9963e1cfa140addf504f37160300b0609608648016503040201300a06082a8648ce3d0403020446304402206d1701c37ff7fffb8dada85e67146289458cc617ac0efc3c115f076ff75d0b280220725e63658d8715bc8dbe2459c499a8456254eec0a518e0205ec52ec80649af4e", - "dac_private_key": "f46cd9b9fbed2827bb506067c19897f23c8ddf68acff11f191e5833b377cee2d", - "dac_public_key": "04760c320e7c2d565082eefdeba1d66f357ef50b87a98c90c3bb4b314a79c42a3e4014296a1ab0bf166dcefef3a86c30e3334f85debb09250b64752f945d44089f" + "is_success_case": "false", + "dac_cert": "308201d83082017da0030201020208697ea481e17f0f9c300a06082a8648ce3d04030230393137303506035504030c2e41434d45204d617474657220446576656c20504149203543444139383939204d7069643a204d7669643a464646313020170d3232303932333030303030305a180f39393939313233313233353935395a30463118301606035504030c0f4d617474657220546573742044414331143012060a2b0601040182a27c02010c044646463131143012060a2b0601040182a27c02020c04303042313059301306072a8648ce3d020106082a8648ce3d030107034200046eb8078776faf91061011baca81d4577b5b6b64e6f3009ddbc05aea20eaa044dbde2f70716de1d0ea2221a57ba5ca2ab23995fff18e63c6c675e403f7bf7ed53a360305e300c0603551d130101ff04023000300e0603551d0f0101ff040403020780301d0603551d0e041604141c1bdaa7b3c18076e81187da63295ee068a7fe29301f0603551d23041830168014bd781517ec524b8b752e7e529063de96d6c2deb1300a06082a8648ce3d0403020349003046022100ca59fb5cc9fd777641ba761c9fbf16dc24f044fcfca5dead17ed7cae02a3f64d022100bb501e52bef2e0ff3d9b6c9bc8dac1c6adf94a19d66f38cf840b89e0bbd7dc12", + "pai_cert": "308201c63082016da00302010202082dbfc034ee2ebe32300a06082a8648ce3d04030230303118301606035504030c0f4d617474657220546573742050414131143012060a2b0601040182a27c02010c04464646313020170d3232303932333030303030305a180f39393939313233313233353935395a30393137303506035504030c2e41434d45204d617474657220446576656c20504149203543444139383939204d7069643a204d7669643a464646313059301306072a8648ce3d020106082a8648ce3d030107034200041a872e39c4f8337945c51b1a5dfa009e0f8402a59d996da057aa370acb18450bc3316babcf7c6eed0555300d7e9e4ac42c0e9556857835e8e8de2d91a1bbd27da366306430120603551d130101ff040830060101ff020100300e0603551d0f0101ff040403020106301d0603551d0e04160414bd781517ec524b8b752e7e529063de96d6c2deb1301f0603551d230418301680146afd22771f511fecbf1641976710dcdc31a1717e300a06082a8648ce3d040302034700304402205c38ff93c407961a98e61bc23ea65381a760f97ac0481ece8ee21bcd451b8c2002201d6c7ee510aec10ea02402f5f6d80bc74489fb8793d64a77e06b8fece69cd4b8", + "certification_declaration": "3081e706092a864886f70d010702a081d93081d6020103310d300b0609608648016503040201304406092a864886f70d010701a0370435152400012501f1ff360204b118250334122c04135a494732303134315a423333303030312d32342405002406002507769824080018317c307a020103801462fa823359acfaa9963e1cfa140addf504f37160300b0609608648016503040201300a06082a8648ce3d0403020446304402201f38b426df25ab4f552ded014845afb1a353e808e9250fc19dcfcab3d717679f0220575a610c996f0221628ff9a76123d3462922f91b6011ba727e6d42884ae88c08", + "dac_private_key": "8c0efeb0d08af4384bf3cf75256c3a47a88a514426d911375ac5bc7d03564212", + "dac_public_key": "046eb8078776faf91061011baca81d4577b5b6b64e6f3009ddbc05aea20eaa044dbde2f70716de1d0ea2221a57ba5ca2ab23995fff18e63c6c675e403f7bf7ed53" } diff --git a/src/crypto/CHIPCryptoPAL.cpp b/src/crypto/CHIPCryptoPAL.cpp index 859f5809e4b742..498db62436f2a0 100644 --- a/src/crypto/CHIPCryptoPAL.cpp +++ b/src/crypto/CHIPCryptoPAL.cpp @@ -29,6 +29,7 @@ #include #include #include +#include #include using chip::ByteSpan; @@ -38,6 +39,8 @@ using chip::Encoding::LittleEndian::Reader; using namespace chip::ASN1; +namespace chip { +namespace Crypto { namespace { constexpr uint8_t kIntegerTag = 0x02u; @@ -192,10 +195,76 @@ CHIP_ERROR ConvertIntegerRawToDerInternal(const ByteSpan & raw_integer, MutableB return CHIP_NO_ERROR; } -} // namespace +/** + * @brief Find a 4 uppercase hex digit hex value after a prefix string. Used to implement + * fallback CN VID/PID encoding for PAA/PAI/DAC. + * + * @param[in] buffer - buffer in which to find the substring. + * @param[in] prefix - prefix to match, which must be followed by 4 uppercase hex characters + * @param[out] out_hex_value - on CHIP_NO_ERROR return, this will be the 16-bit hex value decoded. + * @return CHIP_NO_ERROR on success, CHIP_ERROR_NOT_FOUND if not detected and + * CHIP_ERROR_WRONG_CERT_DN if we saw the prefix but no valid hex string. + */ +CHIP_ERROR Find16BitUpperCaseHexAfterPrefix(const ByteSpan & buffer, const char * prefix, uint16_t & out_hex_value) +{ + chip::CharSpan prefix_span = chip::CharSpan::fromCharString(prefix); -namespace chip { -namespace Crypto { + bool found_prefix_at_least_once = false; + + // Scan string from left to right, to find the desired full matching substring. + // + // IMPORTANT NOTE: We are trying to find the equivalent of prefix + [0-9A-F]{4}. + // The appearance of the full prefix, but not followed by the hex value, must + // be detected, as it is illegal if there isn't a valid prefix within the string. + // This is why we first check for the prefix and then maybe check for the hex + // value, rather than doing a single check of making sure there is enough space + // for both. + for (size_t start_idx = 0; start_idx < buffer.size(); start_idx++) + { + const uint8_t * cursor = buffer.data() + start_idx; + size_t remaining = buffer.size() - start_idx; + + if (remaining < prefix_span.size()) + { + // We can't possibly match prefix if not enough bytes left. + break; + } + + // Try to match the prefix at current position. + if (memcmp(cursor, prefix_span.data(), prefix_span.size()) != 0) + { + // Did not find prefix, move to next position. + continue; + } + + // Otherwise, found prefix, skip to possible hex value. + found_prefix_at_least_once = true; + cursor += prefix_span.size(); + remaining -= prefix_span.size(); + + constexpr size_t expected_hex_len = HEX_ENCODED_LENGTH(sizeof(uint16_t)); + if (remaining < expected_hex_len) + { + // We can't possibly match the hex values if not enough bytes left. + break; + } + + char hex_buf[expected_hex_len]; + memcpy(&hex_buf[0], cursor, sizeof(hex_buf)); + + if (Encoding::UppercaseHexToUint16(&hex_buf[0], sizeof(hex_buf), out_hex_value) != 0) + { + // Found first full valid match, return success, out_hex_value already updated. + return CHIP_NO_ERROR; + } + + // Otherwise, did not find what we were looking for, try next position until exhausted. + } + + return found_prefix_at_least_once ? CHIP_ERROR_WRONG_CERT_DN : CHIP_ERROR_NOT_FOUND; +} + +} // namespace #ifdef ENABLE_HSM_HKDF using HKDF_sha_crypto = HKDF_shaHSM; @@ -873,41 +942,39 @@ CHIP_ERROR ExtractVIDPIDFromAttributeString(DNAttrType attrType, const ByteSpan // Otherwise, it is a CommonName attribute. else if (!vidpidFromCNAttr.Initialized()) { - char cnAttr[kMax_CommonNameAttr_Length + 1]; - if (attr.size() <= chip::Crypto::kMax_CommonNameAttr_Length) + ByteSpan attr_source_span{ attr }; + if (attr_source_span.size() > chip::Crypto::kMax_CommonNameAttr_Length) { - memcpy(cnAttr, attr.data(), attr.size()); - cnAttr[attr.size()] = 0; + attr_source_span.reduce_size(chip::Crypto::kMax_CommonNameAttr_Length); + } - char * vid = strstr(cnAttr, kVIDPrefixForCNEncoding); - if (vid != nullptr) - { - vid += strlen(kVIDPrefixForCNEncoding); - if (cnAttr + attr.size() >= vid + kVIDandPIDHexLength) - { - uint16_t matterAttr; - if (Encoding::UppercaseHexToUint16(vid, kVIDandPIDHexLength, matterAttr) == sizeof(matterAttr)) - { - vidpidFromCNAttr.mVendorId.SetValue(static_cast(matterAttr)); - } - } - } + // Try to find a valid Vendor ID encoded in fallback method. + uint16_t vid = 0; + CHIP_ERROR err = Find16BitUpperCaseHexAfterPrefix(attr_source_span, kVIDPrefixForCNEncoding, vid); + if (err == CHIP_NO_ERROR) + { + vidpidFromCNAttr.mVendorId.SetValue(static_cast(vid)); + } + else if (err != CHIP_ERROR_NOT_FOUND) + { + // This indicates a bad/ambiguous format. + return err; + } - char * pid = strstr(cnAttr, kPIDPrefixForCNEncoding); - if (pid != nullptr) - { - pid += strlen(kPIDPrefixForCNEncoding); - if (cnAttr + attr.size() >= pid + kVIDandPIDHexLength) - { - uint16_t matterAttr; - if (Encoding::UppercaseHexToUint16(pid, kVIDandPIDHexLength, matterAttr) == sizeof(matterAttr)) - { - vidpidFromCNAttr.mProductId.SetValue(matterAttr); - } - } - } + // Try to find a valid Product ID encoded in fallback method. + uint16_t pid = 0; + err = Find16BitUpperCaseHexAfterPrefix(attr_source_span, kPIDPrefixForCNEncoding, pid); + if (err == CHIP_NO_ERROR) + { + vidpidFromCNAttr.mProductId.SetValue(pid); + } + else if (err != CHIP_ERROR_NOT_FOUND) + { + // This indicates a bad/ambiguous format. + return err; } } + return CHIP_NO_ERROR; } diff --git a/src/crypto/CHIPCryptoPAL.h b/src/crypto/CHIPCryptoPAL.h index 544a554dcb31eb..22d217181cd1a0 100644 --- a/src/crypto/CHIPCryptoPAL.h +++ b/src/crypto/CHIPCryptoPAL.h @@ -633,8 +633,9 @@ CHIP_ERROR AES_CCM_decrypt(const uint8_t * ciphertext, size_t ciphertext_length, * be configured to ignore CSR requested subject. * * @param keypair The key pair for which a CSR should be generated. Must not be null. - * @param csr_span Span to hold the resulting CSR. Must be at least kMAX_CSR_Length. Otherwise returns CHIP_ERROR_BUFFER_TOO_SMALL. - * It will get resized to actual size needed on success. + * @param csr_span Span to hold the resulting CSR. Must have size at least kMIN_CSR_Buffer_Size. + * Otherwise returns CHIP_ERROR_BUFFER_TOO_SMALL. It will get resized to + * actual size needed on success. * @return Returns a CHIP_ERROR from P256Keypair or ASN.1 backend on error, CHIP_NO_ERROR otherwise **/ diff --git a/src/crypto/OperationalKeystore.h b/src/crypto/OperationalKeystore.h index bfa846b9d1a8be..9987ccd5833576 100644 --- a/src/crypto/OperationalKeystore.h +++ b/src/crypto/OperationalKeystore.h @@ -67,7 +67,7 @@ class OperationalKeystore * Only one pending operational keypair is supported at a time. * * @param fabricIndex - FabricIndex for which a new keypair must be made available - * @param outCertificateSigningRequest - Buffer to contain the CSR. Must be at least `kMAX_CSR_Length` large. + * @param outCertificateSigningRequest - Buffer to contain the CSR. Must have size at least `kMIN_CSR_Buffer_Size`. * * @retval CHIP_NO_ERROR on success * @retval CHIP_ERROR_BUFFER_TOO_SMALL if `outCertificateSigningRequest` buffer is too small diff --git a/src/crypto/tests/CHIPCryptoPALTest.cpp b/src/crypto/tests/CHIPCryptoPALTest.cpp index 485ead2cf99322..8590afc2094e44 100644 --- a/src/crypto/tests/CHIPCryptoPALTest.cpp +++ b/src/crypto/tests/CHIPCryptoPALTest.cpp @@ -2010,10 +2010,12 @@ static void TestVIDPID_StringExtraction(nlTestSuite * inSuite, void * inContext) const char * sTestCNAttribute11 = "ACME Matter Devel DAC 5CDA9899 Mvid:FFF1 Mpid:B1"; const char * sTestCNAttribute12 = "ACME Matter Devel DAC 5CDA9899 Mpid: Mvid:FFF1"; - // Common Name (CN) VID/PID encoding error cases (more examples): + // Common Name (CN) VID/PID encoding more cases (more examples): const char * sTestCNAttribute13 = "Mpid:987Mvid:FFF10x"; - const char * sTestCNAttribute14 = "MpidMvid:FFF10 Matter Test Mpid:FE67"; + const char * sTestCNAttribute14 = "MpidMvid:FFF10 Matter Test Mpid:FE67"; // Valid, even if there is run-in. const char * sTestCNAttribute15 = "Matter Devel Mpid:Mvid:Fff1"; + // Even though "Mpid:" appears thrice, only the value with correct hex afterwards is taken + const char * sTestCNAttribute16 = "Mpid:Mvid:FFF1 Mpid:12cd Matter Test Mpid:FE67"; struct TestCase { @@ -2054,50 +2056,66 @@ static void TestVIDPID_StringExtraction(nlTestSuite * inSuite, void * inContext) { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute07), strlen(sTestCNAttribute07)), true, true, chip::VendorId::TestVendor1, 0x00B1, CHIP_NO_ERROR }, { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute08), strlen(sTestCNAttribute08)), true, true, chip::VendorId::TestVendor1, 0x00B1, CHIP_NO_ERROR }, // Common Name (CN) VID/PID encoding error cases: - { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute09), strlen(sTestCNAttribute09)), false, true, chip::VendorId::NotSpecified, 0x00B1, CHIP_NO_ERROR }, - { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute10), strlen(sTestCNAttribute10)), false, true, chip::VendorId::NotSpecified, 0x00B1, CHIP_NO_ERROR }, - { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute11), strlen(sTestCNAttribute11)), true, false, chip::VendorId::TestVendor1, 0, CHIP_NO_ERROR }, - { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute12), strlen(sTestCNAttribute12)), true, false, chip::VendorId::TestVendor1, 0, CHIP_NO_ERROR }, - { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute13), strlen(sTestCNAttribute13)), true, false, chip::VendorId::TestVendor1, 0, CHIP_NO_ERROR }, + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute09), strlen(sTestCNAttribute09)), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_WRONG_CERT_DN }, + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute10), strlen(sTestCNAttribute10)), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_WRONG_CERT_DN }, + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute11), strlen(sTestCNAttribute11)), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_WRONG_CERT_DN }, + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute12), strlen(sTestCNAttribute12)), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_WRONG_CERT_DN }, + // Common Name (CN) VID/PID encoding additional cases: + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute13), strlen(sTestCNAttribute13)), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_WRONG_CERT_DN }, { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute14), strlen(sTestCNAttribute14)), true, true, chip::VendorId::TestVendor1, 0xFE67, CHIP_NO_ERROR }, - { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute15), strlen(sTestCNAttribute15)), false, false, chip::VendorId::NotSpecified, 0, CHIP_NO_ERROR }, + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute15), strlen(sTestCNAttribute15)), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_WRONG_CERT_DN }, + { DNAttrType::kCommonName, ByteSpan(reinterpret_cast(sTestCNAttribute16), strlen(sTestCNAttribute16)), true, true, chip::VendorId::TestVendor1, 0xFE67, CHIP_NO_ERROR }, // Other input combinations: { DNAttrType::kUnspecified, ByteSpan(reinterpret_cast(sTestCNAttribute15), strlen(sTestCNAttribute15)), false, false, chip::VendorId::NotSpecified, 0, CHIP_NO_ERROR }, { DNAttrType::kCommonName, ByteSpan(nullptr, 0), false, false, chip::VendorId::NotSpecified, 0, CHIP_ERROR_INVALID_ARGUMENT }, }; // clang-format on + int caseIdx = 0; for (const auto & testCase : kTestCases) { AttestationCertVidPid vidpid; AttestationCertVidPid vidpidFromCN; AttestationCertVidPid vidpidToCheck; CHIP_ERROR result = ExtractVIDPIDFromAttributeString(testCase.attrType, testCase.attr, vidpid, vidpidFromCN); - NL_TEST_ASSERT(inSuite, result == testCase.expectedResult); + ChipLogProgress(Crypto, "Checking VID/PID DN case %d. Expected: %" CHIP_ERROR_FORMAT, caseIdx, + testCase.expectedResult.Format()); - if (testCase.attrType == DNAttrType::kMatterVID || testCase.attrType == DNAttrType::kMatterPID) + if (result != testCase.expectedResult) { - NL_TEST_ASSERT(inSuite, !vidpidFromCN.Initialized()); - vidpidToCheck = vidpid; + ChipLogError(Crypto, "Actual result: %" CHIP_ERROR_FORMAT, result.Format()); } - else if (testCase.attrType == DNAttrType::kCommonName) + NL_TEST_ASSERT(inSuite, result == testCase.expectedResult); + + // Only do assertions on output params in case of success since otherwise + // many of the output params are intermediate outputs. + if (result == CHIP_NO_ERROR) { - NL_TEST_ASSERT(inSuite, !vidpid.Initialized()); - vidpidToCheck = vidpidFromCN; - } + if (testCase.attrType == DNAttrType::kMatterVID || testCase.attrType == DNAttrType::kMatterPID) + { + NL_TEST_ASSERT(inSuite, !vidpidFromCN.Initialized()); + vidpidToCheck = vidpid; + } + else if (testCase.attrType == DNAttrType::kCommonName) + { + NL_TEST_ASSERT(inSuite, !vidpid.Initialized()); + vidpidToCheck = vidpidFromCN; + } - NL_TEST_ASSERT(inSuite, vidpidToCheck.mVendorId.HasValue() == testCase.expectedVidPresent); - NL_TEST_ASSERT(inSuite, vidpidToCheck.mProductId.HasValue() == testCase.expectedPidPresent); + NL_TEST_ASSERT(inSuite, vidpidToCheck.mVendorId.HasValue() == testCase.expectedVidPresent); + NL_TEST_ASSERT(inSuite, vidpidToCheck.mProductId.HasValue() == testCase.expectedPidPresent); - if (testCase.expectedVidPresent) - { - NL_TEST_ASSERT(inSuite, vidpidToCheck.mVendorId.Value() == testCase.expectedVid); - } + if (testCase.expectedVidPresent) + { + NL_TEST_ASSERT(inSuite, vidpidToCheck.mVendorId.Value() == testCase.expectedVid); + } - if (testCase.expectedPidPresent) - { - NL_TEST_ASSERT(inSuite, vidpidToCheck.mProductId.Value() == testCase.expectedPid); + if (testCase.expectedPidPresent) + { + NL_TEST_ASSERT(inSuite, vidpidToCheck.mProductId.Value() == testCase.expectedPid); + } } + ++caseIdx; } } diff --git a/src/lib/support/BufferReader.cpp b/src/lib/support/BufferReader.cpp index 3e9ede6d006710..7116f67f19b5c7 100644 --- a/src/lib/support/BufferReader.cpp +++ b/src/lib/support/BufferReader.cpp @@ -84,10 +84,16 @@ Reader & Reader::ReadBytes(uint8_t * dest, size_t size) } // Explicit Read instantiations for the data types we want to support. -template void Reader::RawRead(uint8_t *); -template void Reader::RawRead(uint16_t *); -template void Reader::RawRead(uint32_t *); -template void Reader::RawRead(uint64_t *); +template void Reader::RawReadLowLevelBeCareful(char *); +template void Reader::RawReadLowLevelBeCareful(bool *); +template void Reader::RawReadLowLevelBeCareful(int8_t *); +template void Reader::RawReadLowLevelBeCareful(int16_t *); +template void Reader::RawReadLowLevelBeCareful(int32_t *); +template void Reader::RawReadLowLevelBeCareful(int64_t *); +template void Reader::RawReadLowLevelBeCareful(uint8_t *); +template void Reader::RawReadLowLevelBeCareful(uint16_t *); +template void Reader::RawReadLowLevelBeCareful(uint32_t *); +template void Reader::RawReadLowLevelBeCareful(uint64_t *); } // namespace LittleEndian } // namespace Encoding diff --git a/src/lib/support/BufferReader.h b/src/lib/support/BufferReader.h index bbf21f529d8fb6..abcd7dd2cd20c2 100644 --- a/src/lib/support/BufferReader.h +++ b/src/lib/support/BufferReader.h @@ -90,6 +90,47 @@ class Reader CHECK_RETURN_VALUE CHIP_ERROR StatusCode() const { return mStatus; } + /** + * @return false if the reader is in error, true if the reader is OK. + */ + bool IsSuccess() const { return StatusCode() == CHIP_NO_ERROR; } + + /** + * Read a bool, assuming single byte storage. + * + * @param [out] dest Where the 8-bit integer goes. + * + * @note The read can put the reader in a failed-status state if there are + * not enough octets available. Callers must either continue to do + * more reads on the return value or check its status to see whether + * the sequence of reads that has been performed succeeded. + */ + CHECK_RETURN_VALUE + Reader & ReadBool(bool * dest) + { + static_assert(sizeof(bool) == 1, "Expect single-byte bools"); + RawReadLowLevelBeCareful(dest); + return *this; + } + + /** + * Read a char, assuming single byte storage. + * + * @param [out] dest Where the char just read should be placed. + * + * @note The read can put the reader in a failed-status state if there are + * not enough octets available. Callers must either continue to do + * more reads on the return value or check its status to see whether + * the sequence of reads that has been performed succeeded. + */ + CHECK_RETURN_VALUE + Reader & ReadChar(char * dest) + { + static_assert(sizeof(char) == 1, "Expect single-byte chars"); + RawReadLowLevelBeCareful(dest); + return *this; + } + /** * Read a single 8-bit unsigned integer. * diff --git a/src/lib/support/tests/TestBufferReader.cpp b/src/lib/support/tests/TestBufferReader.cpp index bcf2cc5503f7b1..d94f8941905630 100644 --- a/src/lib/support/tests/TestBufferReader.cpp +++ b/src/lib/support/tests/TestBufferReader.cpp @@ -133,6 +133,145 @@ static void TestBufferReader_Skip(nlTestSuite * inSuite, void * inContext) NL_TEST_ASSERT(inSuite, err != CHIP_NO_ERROR); } +static void TestBufferReader_LittleEndianScalars(nlTestSuite * inSuite, void * inContext) +{ + const uint8_t test_buf1[10] = { 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01 }; + + // Unsigned 8 bits reads + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + uint8_t val1 = 0; + uint8_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.Read8(&val1).Read8(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, val1 == 0xfe); + NL_TEST_ASSERT(inSuite, val2 == 0xff); + } + + // Unsigned 16 bits reads + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + uint16_t val1 = 0; + uint16_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.Read16(&val1).Read16(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, val1 == 0xfffe); + NL_TEST_ASSERT(inSuite, val2 == 0xffff); + } + + // Unsigned 32 bits reads + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + uint32_t val1 = 0; + uint32_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.Read32(&val1).Read32(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, val1 == static_cast(0xfffffffeUL)); + NL_TEST_ASSERT(inSuite, val2 == static_cast(0xffffffffUL)); + } + + // Unsigned 32 bits reads, unaligned + { + uint8_t test_buf2[10] = { 0x00, 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01 }; + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf2 } }; + + uint32_t val1 = 0; + uint32_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.Skip(1).Read32(&val1).Read32(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, reader.Remaining() == 1); + NL_TEST_ASSERT(inSuite, val1 == static_cast(0xfffffffeUL)); + NL_TEST_ASSERT(inSuite, val2 == static_cast(0xffffffffUL)); + } + + // Unsigned 64 bits read + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + uint64_t val = 0; + NL_TEST_ASSERT(inSuite, reader.Read64(&val).IsSuccess()); + NL_TEST_ASSERT(inSuite, reader.Remaining() == 2); + NL_TEST_ASSERT(inSuite, val == static_cast(0xfffffffffffffffeULL)); + } + + // Signed 8 bits reads + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + int8_t val1 = 0; + int8_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.ReadSigned8(&val1).ReadSigned8(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, val1 == -2); + NL_TEST_ASSERT(inSuite, val2 == -1); + } + + // Signed 16 bits reads + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + int16_t val1 = 0; + int16_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.ReadSigned16(&val1).ReadSigned16(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, val1 == -2); + NL_TEST_ASSERT(inSuite, val2 == -1); + } + + // Signed 32 bits reads + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + int32_t val1 = 0; + int32_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.ReadSigned32(&val1).ReadSigned32(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, val1 == -2); + NL_TEST_ASSERT(inSuite, val2 == -1); + } + + // Signed 32 bits reads, unaligned + { + uint8_t test_buf2[10] = { 0x00, 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01 }; + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf2 } }; + + int32_t val1 = 0; + int32_t val2 = 0; + NL_TEST_ASSERT(inSuite, reader.Skip(1).ReadSigned32(&val1).ReadSigned32(&val2).IsSuccess()); + NL_TEST_ASSERT(inSuite, reader.Remaining() == 1); + NL_TEST_ASSERT(inSuite, val1 == static_cast(-2L)); + NL_TEST_ASSERT(inSuite, val2 == static_cast(-1L)); + } + + // Signed 64 bits read + { + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf1 } }; + int64_t val = 0; + NL_TEST_ASSERT(inSuite, reader.ReadSigned64(&val).IsSuccess()); + NL_TEST_ASSERT(inSuite, reader.Remaining() == 2); + NL_TEST_ASSERT(inSuite, val == static_cast(-2LL)); + } + + // Bools + { + uint8_t test_buf2[5] = { 0x00, 0xff, 0x01, 0x04, 0x07 }; + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf2 } }; + bool val1 = true; + bool val2 = false; + bool val3 = false; + + NL_TEST_ASSERT(inSuite, reader.ReadBool(&val1).ReadBool(&val2).ReadBool(&val3).IsSuccess()); + NL_TEST_ASSERT(inSuite, reader.Remaining() == 2); + NL_TEST_ASSERT(inSuite, val1 == false); + NL_TEST_ASSERT(inSuite, val2 == true); + NL_TEST_ASSERT(inSuite, val3 == true); + } + + // Chars + { + uint8_t test_buf2[5] = { 'a', '\0', static_cast('\xff'), 'b', 'c' }; + chip::Encoding::LittleEndian::Reader reader{ ByteSpan{ test_buf2 } }; + char val1 = 'z'; + char val2 = 'z'; + char val3 = 'z'; + + NL_TEST_ASSERT(inSuite, reader.ReadChar(&val1).ReadChar(&val2).ReadChar(&val3).IsSuccess()); + NL_TEST_ASSERT(inSuite, reader.Remaining() == 2); + NL_TEST_ASSERT(inSuite, val1 == 'a'); + NL_TEST_ASSERT(inSuite, val2 == '\0'); + NL_TEST_ASSERT(inSuite, val3 == '\xff'); + } +} + #define NL_TEST_DEF_FN(fn) NL_TEST_DEF("Test " #fn, fn) /** * Test Suite. It lists all the test functions.