test_nvs.c 21 KB

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