test_nvs.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544
  1. #include <stdio.h>
  2. #include <ctype.h>
  3. #include <errno.h>
  4. #include <stdlib.h>
  5. #include <time.h>
  6. #include "unity.h"
  7. #include "nvs.h"
  8. #include "nvs_flash.h"
  9. #include "esp_partition.h"
  10. #include "esp_flash_encrypt.h"
  11. #include "esp_log.h"
  12. #include <string.h>
  13. #include "esp_system.h"
  14. #ifdef CONFIG_NVS_ENCRYPTION
  15. #include "mbedtls/aes.h"
  16. #endif
  17. static const char* TAG = "test_nvs";
  18. TEST_CASE("Partition name no longer than 16 characters", "[nvs]")
  19. {
  20. const char *TOO_LONG_NAME = "0123456789abcdefg";
  21. TEST_ESP_ERR(ESP_ERR_INVALID_ARG, nvs_flash_init_partition(TOO_LONG_NAME));
  22. nvs_flash_deinit_partition(TOO_LONG_NAME); // just in case
  23. }
  24. TEST_CASE("flash erase deinitializes initialized partition", "[nvs]")
  25. {
  26. nvs_handle_t handle;
  27. esp_err_t err = nvs_flash_init();
  28. if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
  29. nvs_flash_erase();
  30. err = nvs_flash_init();
  31. }
  32. TEST_ESP_OK( err );
  33. TEST_ESP_OK(nvs_flash_init());
  34. TEST_ESP_OK(nvs_open("uninit_ns", NVS_READWRITE, &handle));
  35. nvs_close(handle);
  36. TEST_ESP_OK(nvs_flash_erase());
  37. // exptected: no partition is initialized since nvs_flash_erase() deinitialized the partition again
  38. TEST_ESP_ERR(ESP_ERR_NVS_NOT_INITIALIZED, nvs_open("uninit_ns", NVS_READWRITE, &handle));
  39. // just to be sure it's deinitialized in case of error and not affecting other tests
  40. nvs_flash_deinit();
  41. }
  42. // test could have different output on host tests
  43. TEST_CASE("nvs deinit with open handle", "[nvs]")
  44. {
  45. nvs_handle_t handle_1;
  46. esp_err_t err = nvs_flash_init();
  47. if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
  48. ESP_LOGW(TAG, "nvs_flash_init failed (0x%x), erasing partition and retrying", err);
  49. ESP_ERROR_CHECK(nvs_flash_erase());
  50. err = nvs_flash_init();
  51. }
  52. ESP_ERROR_CHECK( err );
  53. TEST_ESP_OK(nvs_open("deinit_ns", NVS_READWRITE, &handle_1));
  54. nvs_flash_deinit();
  55. }
  56. TEST_CASE("various nvs tests", "[nvs]")
  57. {
  58. nvs_handle_t handle_1;
  59. esp_err_t err = nvs_flash_init();
  60. if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
  61. ESP_LOGW(TAG, "nvs_flash_init failed (0x%x), erasing partition and retrying", err);
  62. ESP_ERROR_CHECK(nvs_flash_erase());
  63. err = nvs_flash_init();
  64. }
  65. ESP_ERROR_CHECK( err );
  66. TEST_ESP_ERR(ESP_ERR_NVS_NOT_FOUND, nvs_open("test_namespace1", NVS_READONLY, &handle_1));
  67. TEST_ESP_ERR(ESP_ERR_NVS_INVALID_HANDLE, nvs_set_i32(handle_1, "foo", 0x12345678));
  68. nvs_close(handle_1);
  69. TEST_ESP_OK(nvs_open("test_namespace2", NVS_READWRITE, &handle_1));
  70. TEST_ESP_OK(nvs_erase_all(handle_1));
  71. TEST_ESP_OK(nvs_set_i32(handle_1, "foo", 0x12345678));
  72. TEST_ESP_OK(nvs_set_i32(handle_1, "foo", 0x23456789));
  73. nvs_handle_t handle_2;
  74. TEST_ESP_OK(nvs_open("test_namespace3", NVS_READWRITE, &handle_2));
  75. TEST_ESP_OK(nvs_erase_all(handle_2));
  76. TEST_ESP_OK(nvs_set_i32(handle_2, "foo", 0x3456789a));
  77. const char* str = "value 0123456789abcdef0123456789abcdef";
  78. TEST_ESP_OK(nvs_set_str(handle_2, "key", str));
  79. int32_t v1;
  80. TEST_ESP_OK(nvs_get_i32(handle_1, "foo", &v1));
  81. TEST_ASSERT_EQUAL_INT32(0x23456789, v1);
  82. int32_t v2;
  83. TEST_ESP_OK(nvs_get_i32(handle_2, "foo", &v2));
  84. TEST_ASSERT_EQUAL_INT32(0x3456789a, v2);
  85. char buf[strlen(str) + 1];
  86. size_t buf_len = sizeof(buf);
  87. TEST_ESP_OK(nvs_get_str(handle_2, "key", buf, &buf_len));
  88. TEST_ASSERT_EQUAL_INT32(0, strcmp(buf, str));
  89. nvs_close(handle_1);
  90. // check that deinit does not leak memory if some handles are still open
  91. nvs_flash_deinit();
  92. nvs_close(handle_2);
  93. }
  94. TEST_CASE("calculate used and free space", "[nvs]")
  95. {
  96. TEST_ESP_ERR(ESP_ERR_INVALID_ARG, nvs_get_stats(NULL, NULL));
  97. nvs_stats_t stat1;
  98. nvs_stats_t stat2;
  99. TEST_ESP_ERR(ESP_ERR_NVS_NOT_INITIALIZED, nvs_get_stats(NULL, &stat1));
  100. TEST_ASSERT_TRUE(stat1.free_entries == 0);
  101. TEST_ASSERT_TRUE(stat1.namespace_count == 0);
  102. TEST_ASSERT_TRUE(stat1.total_entries == 0);
  103. TEST_ASSERT_TRUE(stat1.used_entries == 0);
  104. nvs_handle_t handle = 0;
  105. size_t h_count_entries;
  106. TEST_ESP_ERR(ESP_ERR_NVS_INVALID_HANDLE, nvs_get_used_entry_count(handle, &h_count_entries));
  107. TEST_ASSERT_TRUE(h_count_entries == 0);
  108. esp_err_t err = nvs_flash_init();
  109. if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
  110. ESP_LOGW(TAG, "nvs_flash_init failed (0x%x), erasing partition and retrying", err);
  111. const esp_partition_t* nvs_partition = esp_partition_find_first(
  112. ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS, NULL);
  113. assert(nvs_partition && "partition table must have an NVS partition");
  114. ESP_ERROR_CHECK(nvs_flash_erase());
  115. err = nvs_flash_init();
  116. }
  117. ESP_ERROR_CHECK( err );
  118. // erase if have any namespace
  119. TEST_ESP_OK(nvs_get_stats(NULL, &stat1));
  120. if(stat1.namespace_count != 0) {
  121. TEST_ESP_OK(nvs_flash_deinit());
  122. TEST_ESP_OK(nvs_flash_erase());
  123. TEST_ESP_OK(nvs_flash_init());
  124. }
  125. // after erase. empty partition
  126. TEST_ESP_OK(nvs_get_stats(NULL, &stat1));
  127. TEST_ASSERT_TRUE(stat1.free_entries != 0);
  128. TEST_ASSERT_TRUE(stat1.namespace_count == 0);
  129. TEST_ASSERT_TRUE(stat1.total_entries != 0);
  130. TEST_ASSERT_TRUE(stat1.used_entries == 0);
  131. // create namespace test_k1
  132. nvs_handle_t handle_1;
  133. TEST_ESP_OK(nvs_open("test_k1", NVS_READWRITE, &handle_1));
  134. TEST_ESP_OK(nvs_get_stats(NULL, &stat2));
  135. TEST_ASSERT_TRUE(stat2.free_entries + 1 == stat1.free_entries);
  136. TEST_ASSERT_TRUE(stat2.namespace_count == 1);
  137. TEST_ASSERT_TRUE(stat2.total_entries == stat1.total_entries);
  138. TEST_ASSERT_TRUE(stat2.used_entries == 1);
  139. // create pair key-value com
  140. TEST_ESP_OK(nvs_set_i32(handle_1, "com", 0x12345678));
  141. TEST_ESP_OK(nvs_get_stats(NULL, &stat1));
  142. TEST_ASSERT_TRUE(stat1.free_entries + 1 == stat2.free_entries);
  143. TEST_ASSERT_TRUE(stat1.namespace_count == 1);
  144. TEST_ASSERT_TRUE(stat1.total_entries == stat2.total_entries);
  145. TEST_ASSERT_TRUE(stat1.used_entries == 2);
  146. // change value in com
  147. TEST_ESP_OK(nvs_set_i32(handle_1, "com", 0x01234567));
  148. TEST_ESP_OK(nvs_get_stats(NULL, &stat2));
  149. TEST_ASSERT_TRUE(stat2.free_entries == stat1.free_entries);
  150. TEST_ASSERT_TRUE(stat2.namespace_count == 1);
  151. TEST_ASSERT_TRUE(stat2.total_entries != 0);
  152. TEST_ASSERT_TRUE(stat2.used_entries == 2);
  153. // create pair key-value ru
  154. TEST_ESP_OK(nvs_set_i32(handle_1, "ru", 0x00FF00FF));
  155. TEST_ESP_OK(nvs_get_stats(NULL, &stat1));
  156. TEST_ASSERT_TRUE(stat1.free_entries + 1 == stat2.free_entries);
  157. TEST_ASSERT_TRUE(stat1.namespace_count == 1);
  158. TEST_ASSERT_TRUE(stat1.total_entries != 0);
  159. TEST_ASSERT_TRUE(stat1.used_entries == 3);
  160. // amount valid pair in namespace 1
  161. size_t h1_count_entries;
  162. TEST_ESP_OK(nvs_get_used_entry_count(handle_1, &h1_count_entries));
  163. TEST_ASSERT_TRUE(h1_count_entries == 2);
  164. nvs_handle_t handle_2;
  165. // create namespace test_k2
  166. TEST_ESP_OK(nvs_open("test_k2", NVS_READWRITE, &handle_2));
  167. TEST_ESP_OK(nvs_get_stats(NULL, &stat2));
  168. TEST_ASSERT_TRUE(stat2.free_entries + 1 == stat1.free_entries);
  169. TEST_ASSERT_TRUE(stat2.namespace_count == 2);
  170. TEST_ASSERT_TRUE(stat2.total_entries == stat1.total_entries);
  171. TEST_ASSERT_TRUE(stat2.used_entries == 4);
  172. // create pair key-value
  173. TEST_ESP_OK(nvs_set_i32(handle_2, "su1", 0x00000001));
  174. TEST_ESP_OK(nvs_set_i32(handle_2, "su2", 0x00000002));
  175. TEST_ESP_OK(nvs_set_i32(handle_2, "sus", 0x00000003));
  176. TEST_ESP_OK(nvs_get_stats(NULL, &stat1));
  177. TEST_ASSERT_TRUE(stat1.free_entries + 3 == stat2.free_entries);
  178. TEST_ASSERT_TRUE(stat1.namespace_count == 2);
  179. TEST_ASSERT_TRUE(stat1.total_entries == stat2.total_entries);
  180. TEST_ASSERT_TRUE(stat1.used_entries == 7);
  181. TEST_ASSERT_TRUE(stat1.total_entries == (stat1.used_entries + stat1.free_entries));
  182. // amount valid pair in namespace 2
  183. size_t h2_count_entries;
  184. TEST_ESP_OK(nvs_get_used_entry_count(handle_2, &h2_count_entries));
  185. TEST_ASSERT_TRUE(h2_count_entries == 3);
  186. TEST_ASSERT_TRUE(stat1.used_entries == (h1_count_entries + h2_count_entries + stat1.namespace_count));
  187. nvs_close(handle_1);
  188. nvs_close(handle_2);
  189. size_t temp = h2_count_entries;
  190. TEST_ESP_ERR(ESP_ERR_NVS_INVALID_HANDLE, nvs_get_used_entry_count(handle_1, &h2_count_entries));
  191. TEST_ASSERT_TRUE(h2_count_entries == 0);
  192. h2_count_entries = temp;
  193. TEST_ESP_ERR(ESP_ERR_INVALID_ARG, nvs_get_used_entry_count(handle_1, NULL));
  194. nvs_handle_t handle_3;
  195. // create namespace test_k3
  196. TEST_ESP_OK(nvs_open("test_k3", NVS_READWRITE, &handle_3));
  197. TEST_ESP_OK(nvs_get_stats(NULL, &stat2));
  198. TEST_ASSERT_TRUE(stat2.free_entries + 1 == stat1.free_entries);
  199. TEST_ASSERT_TRUE(stat2.namespace_count == 3);
  200. TEST_ASSERT_TRUE(stat2.total_entries == stat1.total_entries);
  201. TEST_ASSERT_TRUE(stat2.used_entries == 8);
  202. // create pair blobs
  203. uint32_t blob[12];
  204. TEST_ESP_OK(nvs_set_blob(handle_3, "bl1", &blob, sizeof(blob)));
  205. TEST_ESP_OK(nvs_get_stats(NULL, &stat1));
  206. TEST_ASSERT_TRUE(stat1.free_entries + 4 == stat2.free_entries);
  207. TEST_ASSERT_TRUE(stat1.namespace_count == 3);
  208. TEST_ASSERT_TRUE(stat1.total_entries == stat2.total_entries);
  209. TEST_ASSERT_TRUE(stat1.used_entries == 12);
  210. // amount valid pair in namespace 2
  211. size_t h3_count_entries;
  212. TEST_ESP_OK(nvs_get_used_entry_count(handle_3, &h3_count_entries));
  213. TEST_ASSERT_TRUE(h3_count_entries == 4);
  214. TEST_ASSERT_TRUE(stat1.used_entries == (h1_count_entries + h2_count_entries + h3_count_entries + stat1.namespace_count));
  215. nvs_close(handle_3);
  216. TEST_ESP_OK(nvs_flash_deinit());
  217. TEST_ESP_OK(nvs_flash_erase());
  218. }
  219. TEST_CASE("check for memory leaks in nvs_set_blob", "[nvs]")
  220. {
  221. esp_err_t err = nvs_flash_init();
  222. if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
  223. ESP_ERROR_CHECK(nvs_flash_erase());
  224. err = nvs_flash_init();
  225. }
  226. TEST_ESP_OK( err );
  227. for (int i = 0; i < 500; ++i) {
  228. nvs_handle_t my_handle;
  229. uint8_t key[20] = {0};
  230. TEST_ESP_OK( nvs_open("leak_check_ns", NVS_READWRITE, &my_handle) );
  231. TEST_ESP_OK( nvs_set_blob(my_handle, "key", key, sizeof(key)) );
  232. TEST_ESP_OK( nvs_commit(my_handle) );
  233. nvs_close(my_handle);
  234. printf("%d\n", esp_get_free_heap_size());
  235. }
  236. nvs_flash_deinit();
  237. printf("%d\n", esp_get_free_heap_size());
  238. /* heap leaks will be checked in unity_platform.c */
  239. }
  240. #ifdef CONFIG_NVS_ENCRYPTION
  241. TEST_CASE("check underlying xts code for 32-byte size sector encryption", "[nvs]")
  242. {
  243. uint8_t eky_hex[2 * NVS_KEY_SIZE] = { 0x11,0x11,0x11,0x11,0x11,0x11,0x11,0x11,
  244. 0x11,0x11,0x11,0x11,0x11,0x11,0x11,0x11,
  245. 0x11,0x11,0x11,0x11,0x11,0x11,0x11,0x11,
  246. 0x11,0x11,0x11,0x11,0x11,0x11,0x11,0x11,
  247. /* Tweak key below*/
  248. 0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,
  249. 0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,
  250. 0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,
  251. 0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22 };
  252. uint8_t ba_hex[16] = { 0x33,0x33,0x33,0x33,0x33,0x00,0x00,0x00,
  253. 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00 };
  254. uint8_t ptxt_hex[32] = { 0x44,0x44,0x44,0x44,0x44,0x44,0x44,0x44,
  255. 0x44,0x44,0x44,0x44,0x44,0x44,0x44,0x44,
  256. 0x44,0x44,0x44,0x44,0x44,0x44,0x44,0x44,
  257. 0x44,0x44,0x44,0x44,0x44,0x44,0x44,0x44 };
  258. uint8_t ctxt_hex[32] = { 0xe6,0x22,0x33,0x4f,0x18,0x4b,0xbc,0xe1,
  259. 0x29,0xa2,0x5b,0x2a,0xc7,0x6b,0x3d,0x92,
  260. 0xab,0xf9,0x8e,0x22,0xdf,0x5b,0xdd,0x15,
  261. 0xaf,0x47,0x1f,0x3d,0xb8,0x94,0x6a,0x85 };
  262. mbedtls_aes_xts_context ectx[1];
  263. mbedtls_aes_xts_context dctx[1];
  264. mbedtls_aes_xts_init(ectx);
  265. mbedtls_aes_xts_init(dctx);
  266. TEST_ASSERT_TRUE(!mbedtls_aes_xts_setkey_enc(ectx, eky_hex, 2 * NVS_KEY_SIZE * 8));
  267. TEST_ASSERT_TRUE(!mbedtls_aes_xts_setkey_enc(dctx, eky_hex, 2 * NVS_KEY_SIZE * 8));
  268. TEST_ASSERT_TRUE(!mbedtls_aes_crypt_xts(ectx, MBEDTLS_AES_ENCRYPT, 32, ba_hex, ptxt_hex, ptxt_hex));
  269. TEST_ASSERT_TRUE(!memcmp(ptxt_hex, ctxt_hex, 32));
  270. }
  271. TEST_CASE("Check nvs key partition APIs (read and generate keys)", "[nvs]")
  272. {
  273. nvs_sec_cfg_t cfg, cfg2;
  274. const esp_partition_t* key_part = esp_partition_find_first(
  275. ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS_KEYS, NULL);
  276. if (!esp_flash_encryption_enabled()) {
  277. TEST_IGNORE_MESSAGE("flash encryption disabled, skipping nvs_key partition related tests");
  278. }
  279. TEST_ESP_OK(esp_partition_erase_range(key_part, 0, key_part->size));
  280. TEST_ESP_ERR(ESP_ERR_NVS_KEYS_NOT_INITIALIZED, nvs_flash_read_security_cfg(key_part, &cfg));
  281. TEST_ESP_OK(nvs_flash_generate_keys(key_part, &cfg));
  282. TEST_ESP_OK(nvs_flash_read_security_cfg(key_part, &cfg2));
  283. TEST_ASSERT_TRUE(!memcmp(&cfg, &cfg2, sizeof(nvs_sec_cfg_t)));
  284. }
  285. TEST_CASE("test nvs apis with encryption enabled", "[nvs]")
  286. {
  287. if (!esp_flash_encryption_enabled()) {
  288. TEST_IGNORE_MESSAGE("flash encryption disabled, skipping nvs_api tests with encryption enabled");
  289. }
  290. const esp_partition_t* key_part = esp_partition_find_first(
  291. ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS_KEYS, NULL);
  292. assert(key_part && "partition table must have an NVS Key partition");
  293. const esp_partition_t* nvs_partition = esp_partition_find_first(
  294. ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS, NULL);
  295. assert(nvs_partition && "partition table must have an NVS partition");
  296. ESP_ERROR_CHECK( esp_partition_erase_range(key_part, 0, key_part->size) );
  297. bool done = false;
  298. do {
  299. ESP_ERROR_CHECK( esp_partition_erase_range(nvs_partition, 0, nvs_partition->size) );
  300. nvs_sec_cfg_t cfg;
  301. esp_err_t err = nvs_flash_read_security_cfg(key_part, &cfg);
  302. if(err == ESP_ERR_NVS_KEYS_NOT_INITIALIZED) {
  303. uint8_t value[4096] = {[0 ... 4095] = 0xff};
  304. TEST_ESP_OK(esp_partition_write(key_part, 0, value, sizeof(value)));
  305. TEST_ESP_ERR(ESP_ERR_NVS_KEYS_NOT_INITIALIZED, nvs_flash_read_security_cfg(key_part, &cfg));
  306. TEST_ESP_OK(nvs_flash_generate_keys(key_part, &cfg));
  307. } else {
  308. /* Second time key_partition exists already*/
  309. ESP_ERROR_CHECK(err);
  310. done = true;
  311. }
  312. TEST_ESP_OK(nvs_flash_secure_init(&cfg));
  313. nvs_handle_t handle_1;
  314. TEST_ESP_ERR(ESP_ERR_NVS_NOT_FOUND, nvs_open("namespace1", NVS_READONLY, &handle_1));
  315. TEST_ESP_OK(nvs_open("namespace1", NVS_READWRITE, &handle_1));
  316. TEST_ESP_OK(nvs_set_i32(handle_1, "foo", 0x12345678));
  317. TEST_ESP_OK(nvs_set_i32(handle_1, "foo", 0x23456789));
  318. nvs_handle_t handle_2;
  319. TEST_ESP_OK(nvs_open("namespace2", NVS_READWRITE, &handle_2));
  320. TEST_ESP_OK(nvs_set_i32(handle_2, "foo", 0x3456789a));
  321. const char* str = "value 0123456789abcdef0123456789abcdef";
  322. TEST_ESP_OK(nvs_set_str(handle_2, "key", str));
  323. int32_t v1;
  324. TEST_ESP_OK(nvs_get_i32(handle_1, "foo", &v1));
  325. TEST_ASSERT_TRUE(0x23456789 == v1);
  326. int32_t v2;
  327. TEST_ESP_OK(nvs_get_i32(handle_2, "foo", &v2));
  328. TEST_ASSERT_TRUE(0x3456789a == v2);
  329. char buf[strlen(str) + 1];
  330. size_t buf_len = sizeof(buf);
  331. size_t buf_len_needed;
  332. TEST_ESP_OK(nvs_get_str(handle_2, "key", NULL, &buf_len_needed));
  333. TEST_ASSERT_TRUE(buf_len_needed == buf_len);
  334. size_t buf_len_short = buf_len - 1;
  335. TEST_ESP_ERR(ESP_ERR_NVS_INVALID_LENGTH, nvs_get_str(handle_2, "key", buf, &buf_len_short));
  336. TEST_ASSERT_TRUE(buf_len_short == buf_len);
  337. size_t buf_len_long = buf_len + 1;
  338. TEST_ESP_OK(nvs_get_str(handle_2, "key", buf, &buf_len_long));
  339. TEST_ASSERT_TRUE(buf_len_long == buf_len);
  340. TEST_ESP_OK(nvs_get_str(handle_2, "key", buf, &buf_len));
  341. TEST_ASSERT_TRUE(0 == strcmp(buf, str));
  342. nvs_close(handle_1);
  343. nvs_close(handle_2);
  344. TEST_ESP_OK(nvs_flash_deinit());
  345. } while(!done);
  346. }
  347. TEST_CASE("test nvs apis for nvs partition generator utility with encryption enabled", "[nvs_part_gen]")
  348. {
  349. if (!esp_flash_encryption_enabled()) {
  350. TEST_IGNORE_MESSAGE("flash encryption disabled, skipping nvs_api tests with encryption enabled");
  351. }
  352. nvs_handle_t handle;
  353. nvs_sec_cfg_t xts_cfg;
  354. extern const char nvs_key_start[] asm("_binary_encryption_keys_bin_start");
  355. extern const char nvs_key_end[] asm("_binary_encryption_keys_bin_end");
  356. extern const char nvs_data_start[] asm("_binary_partition_encrypted_bin_start");
  357. extern const char sample_bin_start[] asm("_binary_sample_bin_start");
  358. const esp_partition_t* key_part = esp_partition_find_first(
  359. ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS_KEYS, NULL);
  360. const esp_partition_t* nvs_part = esp_partition_find_first(
  361. ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS, NULL);
  362. assert(key_part && "partition table must have a KEY partition");
  363. TEST_ASSERT_TRUE((nvs_key_end - nvs_key_start - 1) == SPI_FLASH_SEC_SIZE);
  364. assert(nvs_part && "partition table must have an NVS partition");
  365. printf("\n nvs_part size:%d\n", nvs_part->size);
  366. ESP_ERROR_CHECK(esp_partition_erase_range(key_part, 0, key_part->size));
  367. ESP_ERROR_CHECK( esp_partition_erase_range(nvs_part, 0, nvs_part->size) );
  368. for (int i = 0; i < key_part->size; i+= SPI_FLASH_SEC_SIZE) {
  369. ESP_ERROR_CHECK( esp_partition_write(key_part, i, nvs_key_start + i, SPI_FLASH_SEC_SIZE) );
  370. }
  371. for (int i = 0; i < nvs_part->size; i+= SPI_FLASH_SEC_SIZE) {
  372. ESP_ERROR_CHECK( esp_partition_write(nvs_part, i, nvs_data_start + i, SPI_FLASH_SEC_SIZE) );
  373. }
  374. esp_err_t err = nvs_flash_read_security_cfg(key_part, &xts_cfg);
  375. ESP_ERROR_CHECK(err);
  376. TEST_ESP_OK(nvs_flash_secure_init(&xts_cfg));
  377. TEST_ESP_OK(nvs_open("dummyNamespace", NVS_READONLY, &handle));
  378. uint8_t u8v;
  379. TEST_ESP_OK( nvs_get_u8(handle, "dummyU8Key", &u8v));
  380. TEST_ASSERT_TRUE(u8v == 127);
  381. int8_t i8v;
  382. TEST_ESP_OK( nvs_get_i8(handle, "dummyI8Key", &i8v));
  383. TEST_ASSERT_TRUE(i8v == -128);
  384. uint16_t u16v;
  385. TEST_ESP_OK( nvs_get_u16(handle, "dummyU16Key", &u16v));
  386. TEST_ASSERT_TRUE(u16v == 32768);
  387. uint32_t u32v;
  388. TEST_ESP_OK( nvs_get_u32(handle, "dummyU32Key", &u32v));
  389. TEST_ASSERT_TRUE(u32v == 4294967295);
  390. int32_t i32v;
  391. TEST_ESP_OK( nvs_get_i32(handle, "dummyI32Key", &i32v));
  392. TEST_ASSERT_TRUE(i32v == -2147483648);
  393. char buf[64] = {0};
  394. size_t buflen = 64;
  395. TEST_ESP_OK( nvs_get_str(handle, "dummyStringKey", buf, &buflen));
  396. TEST_ASSERT_TRUE(strncmp(buf, "0A:0B:0C:0D:0E:0F", buflen) == 0);
  397. uint8_t hexdata[] = {0x01, 0x02, 0x03, 0xab, 0xcd, 0xef};
  398. buflen = 64;
  399. TEST_ESP_OK( nvs_get_blob(handle, "dummyHex2BinKey", buf, &buflen));
  400. TEST_ASSERT_TRUE(memcmp(buf, hexdata, buflen) == 0);
  401. uint8_t base64data[] = {'1', '2', '3', 'a', 'b', 'c'};
  402. buflen = 64;
  403. TEST_ESP_OK( nvs_get_blob(handle, "dummyBase64Key", buf, &buflen));
  404. TEST_ASSERT_TRUE(memcmp(buf, base64data, buflen) == 0);
  405. uint8_t hexfiledata[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef};
  406. buflen = 64;
  407. TEST_ESP_OK( nvs_get_blob(handle, "hexFileKey", buf, &buflen));
  408. TEST_ASSERT_TRUE(memcmp(buf, hexfiledata, buflen) == 0);
  409. uint8_t base64filedata[] = {0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0xab, 0xcd, 0xef};
  410. buflen = 64;
  411. TEST_ESP_OK( nvs_get_blob(handle, "base64FileKey", buf, &buflen));
  412. TEST_ASSERT_TRUE(memcmp(buf, base64filedata, buflen) == 0);
  413. uint8_t strfiledata[64] = "abcdefghijklmnopqrstuvwxyz\0";
  414. buflen = 64;
  415. TEST_ESP_OK( nvs_get_str(handle, "stringFileKey", buf, &buflen));
  416. TEST_ASSERT_TRUE(memcmp(buf, strfiledata, buflen) == 0);
  417. char bin_data[5120];
  418. size_t bin_len = sizeof(bin_data);
  419. TEST_ESP_OK( nvs_get_blob(handle, "binFileKey", bin_data, &bin_len));
  420. TEST_ASSERT_TRUE(memcmp(bin_data, sample_bin_start, bin_len) == 0);
  421. nvs_close(handle);
  422. TEST_ESP_OK(nvs_flash_deinit());
  423. }
  424. #endif