Add codespell to CI

Author: LinuxJedi

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+skip = *.git*,*.log,*.pdf,*.png,*.jpg,*.jpeg,*.svg,*.ico,*.woff*,*.ttf,*.eot,*.min.*,*.map,*.orig,*.rej,autom4te.cache,build-aux,*.in,*.m4,configure,libtool,compile_commands.json,config.*,*.diff,*.patch,out.txt,configure~,IDE
+exclude-file = .gitignore
+check-filenames =
+check-hidden =
+quiet-level = 2

.github/workflows/codespell.yml

@@ -0,0 +1,29 @@
+name: Codespell Check
+
+on:
+  push:
+    branches: [ 'master', 'main', 'release/**' ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    
+    - name: Install codespell
+      run: pip install codespell
+    
+    - name: Run codespell
+      run: |
+        echo "Running codespell to check for spelling errors..."
+        codespell . || (echo "❌ Spelling errors found. Please fix the issues above." && exit 1)
+        echo "✅ No spelling errors found!"

configure.ac

@@ -441,7 +441,7 @@ for option in $OPTION_FLAGS; do
             continue
         fi
 
-        # allow user to igonore system options
+        # allow user to ignore system options
         ignoresys=no
         if [[[ $noequalsign == _* ]]] ;
         then
@@ -475,7 +475,7 @@ for option in $DISABLE_DEFS; do
             continue
         fi
 
-        # allow user to igonore system options
+        # allow user to ignore system options
         ignoresys=no
         if [[[ $noequalsign == _* ]]] ;
         then
@@ -539,4 +539,3 @@ echo "   * RSA-OAEP:                   $ENABLED_RSAOAEP"
 echo "   * RSA-PSS:                    $ENABLED_RSAPSS"
 echo "   * DH:                         $ENABLED_DH"
 echo "   * ECC:                        $ENABLED_ECC"
-

examples/slot_info.c

@@ -139,7 +139,7 @@ static CK_RV pkcs11_slot_info(CK_SLOT_ID slotId)
     CHECK_CKR(ret, "Get Slot info");
 
     if (ret == CKR_OK) {
-        printf("Decription: %.64s\n", slotInfo.slotDescription);
+        printf("Description: %.64s\n", slotInfo.slotDescription);
         printf("Manufacturer Id: %.32s\n", slotInfo.manufacturerID);
         printf("Hardware Version: %2x.%02x\n", slotInfo.hardwareVersion.major,
             slotInfo.hardwareVersion.minor);

pre-commit.sh

@@ -6,7 +6,7 @@
 # save current config
 echo "\n\nSaving current config\n\n"
 cp config.status tmp.status
-cp wolfpkcs11/options.h tmp.options.h 
+cp wolfpkcs11/options.h tmp.options.h
 
 # stash modified files not part of this commit, don't test them
 echo "\n\nStashing any modified files not part of commit\n\n"
@@ -24,9 +24,9 @@ git stash pop -q
 # restore current config
 echo "\nRestoring current config\n"
 mv tmp.status config.status
-# don't show output incase error from above
+# don't show output in case error from above
 ./config.status >/dev/null 2>&1
-mv tmp.options.h wolfpkcs11/options.h 
+mv tmp.options.h wolfpkcs11/options.h
 make clean >/dev/null 2>&1
 make -j 8 >/dev/null 2>&1
 

src/slot.c

@@ -285,7 +285,7 @@ static CK_MECHANISM_TYPE mechanismList[] = {
 static int mechanismCnt = ((int)(sizeof(mechanismList)/sizeof(*mechanismList)));
 
 /**
- * Get list of supported mechanism fo for the slot.
+ * Get list of supported mechanisms for the slot.
  *
  * @param  slotID           [in]      Id of slot to use.
  * @param  pMechanismList   [in]      Array to hold mechanisms.
@@ -450,7 +450,7 @@ static CK_MECHANISM_INFO hmacSha512MechInfo = {
  *
  * @param  slotID  [in]  Id of slot to use.
  * @param  type    [in]  Mechanism type.
- * @param  pInfo   [in]  Mechnism information copied into it.
+ * @param  pInfo   [in]  Mechanism information copied into it.
  * @return  CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized.
  *          CKR_SLOT_ID_INVALID when no slot with id can be found.
  *          CKR_ARGUMENTS_BAD when pInfo is NULL.
@@ -939,7 +939,7 @@ CK_RV C_SetOperationState(CK_SESSION_HANDLE hSession,
  *          type.
  *          CKR_PIN_INCORRECT when PIN is wrong length or does not verify.
  *          CKR_OPERATION_NOT_INITIALIZED when using user type
- *          CKU_CONTEXT_SPECIFIC - uesr type not supported.
+ *          CKU_CONTEXT_SPECIFIC - user type not supported.
  *          CKR_USER_TYPE_INVALID when other user type is specified.
  *          CKR_OK on success.
  */

tests/pkcs11mtt.c

@@ -3724,7 +3724,7 @@ static CK_RV ecdh_test(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE privKey,
         if (outSz != (word32)sizeof_ecc_secret_256 ||
                                       memcmp(out, ecc_secret_256, outSz) != 0) {
             ret = -1;
-            CHECK_CKR(ret, "Secret compare with exepcted");
+            CHECK_CKR(ret, "Secret compare with expected");
         }
     }
     if (ret == CKR_OK) {
@@ -4444,7 +4444,7 @@ static CK_RV dh_test(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE privKey,
         if (outSz != (word32)sizeof_dh_2048_exp ||
                                          memcmp(out, dh_2048_exp, outSz) != 0) {
             ret = -1;
-            CHECK_CKR(ret, "Secret compare with exepcted");
+            CHECK_CKR(ret, "Secret compare with expected");
         }
     }
     if (ret == CKR_OK) {

tests/pkcs11test.c

@@ -4831,7 +4831,7 @@ static CK_RV ecdh_test(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE privKey,
         if (outSz != (word32)sizeof_ecc_secret_256 ||
                                       memcmp(out, ecc_secret_256, outSz) != 0) {
             ret = -1;
-            CHECK_CKR(ret, "Secret compare with exepcted");
+            CHECK_CKR(ret, "Secret compare with expected");
         }
     }
     if (ret == CKR_OK) {
@@ -5540,7 +5540,7 @@ static CK_RV dh_test(CK_SESSION_HANDLE session, CK_OBJECT_HANDLE privKey,
         if (outSz != (word32)sizeof_dh_2048_exp ||
                                          memcmp(out, dh_2048_exp, outSz) != 0) {
             ret = -1;
-            CHECK_CKR(ret, "Secret compare with exepcted");
+            CHECK_CKR(ret, "Secret compare with expected");
         }
     }
     if (ret == CKR_OK) {