Merge pull request #101 from aidangarske/codespell-workflow

codespell.yml - CI github workflow

Author: douzzer

.github/workflows/codespell.yml

@@ -0,0 +1,47 @@
+name: Codespell test
+
+# START OF COMMON SECTION
+on:
+  push:
+    branches: [ 'master', 'main', 'release/**' ]
+  pull_request:
+    branches: [ '*' ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+# END OF COMMON SECTION
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - name: Checkout wolfProvider
+        uses: actions/checkout@v4
+
+      - name: Create exclude file if needed
+        run: |
+          if [ ! -f .codespellexcludelines ]; then
+            touch .codespellexcludelines
+          fi
+
+      - name: Run codespell
+        uses: codespell-project/[email protected]
+        with:
+          check_filenames: true
+          check_hidden: true
+          # Add comma separated list of words that occur multiple times that should be ignored (sorted alphabetically, case sensitive)
+          ignore_words_list: adin,addIn,aNULL,brunch,carryIn,chainG,ciph,cLen,cliKs,dout,emac,haveA,inCreated,inOut,inout,larg,LEAPYEAR,Merget,optionA,parm,parms,repid,rIn,userA,ser,siz,te,Te,toLen
+          # The exclude_file contains lines of code that should be ignored. This is useful for individual lines which have non-words that can safely be ignored.
+          exclude_file: '.codespellexcludelines'
+          # To skip files entirely from being processed, add it to the following list:
+          skip: '*.cproject,*.der,*.mtpj,*.pem,*.vcxproj,.git,*.launch,*.scfg,*.revoked,*.txt'
+
+      - name: Print errors
+        if: ${{ failure() }}
+        run: |
+          if [ -f test-suite.log ] ; then
+            cat test-suite.log
+          fi

README.md

@@ -56,7 +56,7 @@ The quickest method is to use the `scripts/build-wolfprovider.sh` script as foll
 ./scripts/build-wolfprovider.sh
 ```
 
-It will retreive the dependencies and compile them as necessary. To use other than the default (such as different releases) you can set various environment variables prior to calling the script:
+It will retrieve the dependencies and compile them as necessary. To use other than the default (such as different releases) you can set various environment variables prior to calling the script:
 
 ```
 OPENSSL_TAG=openssl-3.2.0 WOLFSSL_TAG=v5.7.2-stable WOLFPROV_DEBUG=1 scripts/build-wolfprovider.sh

autogen.sh

@@ -2,7 +2,7 @@
 #
 # autogen.sh
 #
-# Create configure and makfile stuff...
+# Create configure and makefile stuff...
 #
 
 autoreconf --install --force --verbose

include/wolfprovider/internal.h

@@ -103,7 +103,7 @@
 #define WP_RSA_DEFAULT_SALT_LEN     20
 
 /* These values are taken from ssl.h.
- * Can't include this header as it re-declares OpenSSL types.
+ * Can't include this header as it redeclares OpenSSL types.
  */
 /* Named Groups */
 enum {

src/wp_aes_aead.c

@@ -67,7 +67,7 @@ typedef struct wp_AeadCtx {
     /** Current state of IV/nonce.  */
     int ivState;
 
-    /** Initialized for encrpytion or decryption. */
+    /** Initialized for encryption or decryption. */
     unsigned int enc:1;
     /** IV/nonce has been generated. */
     unsigned int ivGen:1;
@@ -263,7 +263,7 @@ static int wp_aead_tls_init(wp_AeadCtx* ctx, unsigned char* aad, size_t aadLen)
  *
  * @param [in, out] ctx    AEAD context object.
  * @param [in]      in     More AAD data.
- * @parma [in]      inLen  Length of new AAD data.
+ * @param [in]      inLen  Length of new AAD data.
  * @return  1 on success.
  * @return  0 on failure.
  */
@@ -299,7 +299,7 @@ static int wp_aead_cache_aad(wp_AeadCtx *ctx, const unsigned char *in,
  *
  * @param [in, out] ctx    AEAD context object.
  * @param [in]      in     More AAD data.
- * @parma [in]      inLen  Length of new AAD data.
+ * @param [in]      inLen  Length of new AAD data.
  * @return  1 on success.
  * @return  0 on failure.
  */

src/wp_aes_block.c

@@ -813,7 +813,7 @@ static int wp_aes_block_set_ctx_params(wp_AesBlockCtx *ctx,
  * @param [in, out] ctx      AES block context object.
  * @param [in]      kBits    Number of bits in a valid key.
  * @param [in]      ivBits   Number of bits in a valid IV. 0 indicates no IV.
- * @parma [in]      mode     AES block mode: ECB or CBC.
+ * @param [in]      mode     AES block mode: ECB or CBC.
  * @return  1 on success.
  * @return  0 on failure.
  */

src/wp_aes_stream.c

@@ -381,7 +381,7 @@ static int wp_aes_stream_doit(wp_AesStreamCtx *ctx, unsigned char *out,
 #ifdef WP_HAVE_AESCFB
     if (ctx->mode == EVP_CIPH_CFB_MODE) {
         int rc;
- 
+
         XMEMCPY(&ctx->aes.reg, ctx->iv, ctx->ivLen);
         if (ctx->enc) {
             rc = wc_AesCfbEncrypt(&ctx->aes, out, in, (word32)inLen);
@@ -578,7 +578,7 @@ static int wp_aes_stream_set_ctx_params(wp_AesStreamCtx *ctx,
  * @param [in, out] ctx      AES stream context object.
  * @param [in]      kBits    Number of bits in a valid key.
  * @param [in]      ivBits   Number of bits in a valid IV. 0 indicates no IV.
- * @parma [in]      mode     AES stream mode: CTR.
+ * @param [in]      mode     AES stream mode: CTR.
  * @return  1 on success.
  * @return  0 on failure.
  */

src/wp_cmac.c

@@ -208,7 +208,7 @@ static int wp_cmac_init(wp_CmacCtx* macCtx, const unsigned char* key,
  * Update the MAC state with data.
  *
  * @param [in, out] macCtx   CMAC context object to update.
- * @parma [in]      data     Data to be MACed.
+ * @param [in]      data     Data to be MACed.
  * @param [in]      dataLen  Length of data in bytes.
  * @return  1 on success.
  * @return  0 on failure.

src/wp_des.c

@@ -778,7 +778,7 @@ static int wp_des3_block_set_ctx_params(wp_Des3BlockCtx *ctx,
  * @param [in, out] ctx      DES3 block context object.
  * @param [in]      kBits    Number of bits in a valid key.
  * @param [in]      ivBits   Number of bits in a valid IV. 0 indicates no IV.
- * @parma [in]      mode     DES3 block mode: ECB or CBC.
+ * @param [in]      mode     DES3 block mode: ECB or CBC.
  * @return  1 on success.
  * @return  0 on failure.
  */

src/wp_dh_exch.c

@@ -306,7 +306,7 @@ static int wp_dh_derive_secret(wp_DhCtx* ctx, unsigned char* secret,
  * Can put the DH secret through a KDF.
  *
  * @param [in]  ctx      DH key exchange context object.
- * @param [out] secert   Buffer to hold secret/key.
+ * @param [out] secret   Buffer to hold secret/key.
  * @param [out] secLen   Length of secret/key data in bytes.
  * @param [in]  secSize  Size of buffer in bytes.
  * @return 1 on success.