Merge pull request wolfSSL#78 from bigbrett/bugfix-hsmFreshenKey

hsmFreshenKey bugfix
jefferyq2 · Nov 10, 2024 · e5f49db · e5f49db
1 parent 18dc976
commit e5f49db
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 7 deletions.
diff --git a/src/wh_server_keystore.c b/src/wh_server_keystore.c
@@ -321,17 +321,33 @@ int hsmFreshenKey(whServerContext* server, whKeyId keyId, uint8_t** outBuf,
     int ret = 0;
     int foundIndex = -1;
     int foundBigIndex = -1;
-    whNvmMetadata meta[1];
+    whNvmMetadata tmpMeta[1];
 
     if (    (server == NULL) ||
             WH_KEYID_ISERASED(keyId)) {
         return WH_ERROR_BADARGS;
     }
 
-    ret = _FindInCache(server, keyId, &foundIndex, &foundBigIndex, outBuf, outMeta);
-    if (ret != 0) {
-        /* Not in cache.  Check if it is in the NVM */
-        ret = wh_Nvm_GetMetadata(server->nvm, keyId, meta);
+    ret = _FindInCache(server, keyId, &foundIndex, &foundBigIndex, outBuf,
+                       outMeta);
+    if (ret != WH_ERROR_OK) {
+        /* Not in cache. Check if it is in NVM */
+        ret = wh_Nvm_GetMetadata(server->nvm, keyId, tmpMeta);
+        if (ret == WH_ERROR_OK) {
+            /* Key found in NVM, get a free cache slot */
+            ret = hsmCacheFindSlotAndZero(server, tmpMeta->len, outBuf,
+                                          outMeta);
+            if (ret == WH_ERROR_OK) {
+                /* Read the key from NVM into the cache slot */
+                ret = wh_Nvm_Read(server->nvm, keyId, 0, tmpMeta->len, *outBuf);
+                if (ret == WH_ERROR_OK) {
+                    /* Copy the metadata to the cache slot if key read is
+                     * successful*/
+                    XMEMCPY((uint8_t*)*outMeta, (uint8_t*)tmpMeta,
+                            sizeof(whNvmMetadata));
+                }
+            }
+        }
     }
     return ret;
 }

diff --git a/tools/whnvmtool/.gitignore b/tools/whnvmtool/.gitignore
@@ -1,4 +1,4 @@
 whnvmtool
-whNvmImage.bin
-whNvmImage.hex
 test/test_whnvmtool
+*.bin
+*.hex
diff --git a/tools/whnvmtool/test/test_whnvmtool.c b/tools/whnvmtool/test/test_whnvmtool.c
@@ -1,3 +1,25 @@
+/*
+ * Copyright (C) 2024 wolfSSL Inc.
+ *
+ * This file is part of wolfHSM.
+ *
+ * wolfHSM is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfHSM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with wolfHSM.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/*
+ * tools/whnvmtool/test/test_whnvmtool.c
+ *
+ */
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdint.h>

diff --git a/tools/whnvmtool/whnvmtool.c b/tools/whnvmtool/whnvmtool.c
@@ -1,3 +1,25 @@
+/*
+ * Copyright (C) 2024 wolfSSL Inc.
+ *
+ * This file is part of wolfHSM.
+ *
+ * wolfHSM is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfHSM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with wolfHSM.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/*
+ * tools/whnvmtool/whnvmtool.c
+ *
+ */
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>