CI: add typos job (#1693)

baloo · web-flow · commit cf1d4d303484 · 2025-03-03T15:03:19.000-08:00
diff --git a/.github/workflows/workspace.yml b/.github/workflows/workspace.yml
@@ -44,3 +44,9 @@ jobs:
           toolchain: stable
           components: rustfmt
       - run: cargo fmt --all -- --check
+
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@v1.30.0
diff --git a/.typos.toml b/.typos.toml
@@ -0,0 +1,21 @@
+[files]
+extend-exclude = [
+    ".git/",
+    "const-oid/oiddbgen/*.txt",
+    "const-oid/oiddbgen/ldap-parameters-3.csv",
+    "const-oid/src/db/generated.rs",
+    "der/src/asn1/context_specific.rs",
+    "pem-rfc7468/README.md",
+    "pkcs12/tests/cert_tests.rs",
+    "x509-ocsp/tests/responses.rs",
+]
+
+[default.extend-identifiers]
+# typ stands for type, but it's a reversed identifier
+typ = "typ"
+
+[default.extend-words]
+# Certificate Ann
+"cann" = "cann"
+# encrypt-decrypt-encrypt 
+"EDE" = "EDE"
diff --git a/base32ct/src/encoding.rs b/base32ct/src/encoding.rs
@@ -270,15 +270,15 @@ mod tests {
     use crate::{Base32, Base32Unpadded, Encoding};
 
     struct LenData {
-        fourty_bit_groups_len: usize,
+        forty_bit_groups_len: usize,
         last_group_len: usize,
         padding_len: usize,
     }
 
     fn get_len_data(data_len: usize) -> LenData {
         // More information about the calculation can be found at
         // https://www.rfc-editor.org/rfc/rfc4648#section-6
-        let fourty_bit_groups_len = data_len / 5 * 8;
+        let forty_bit_groups_len = data_len / 5 * 8;
         let (last_group_len, padding_len) = match data_len % 5 {
             0 => (0, 0),
             1 => (2, 6),
@@ -289,7 +289,7 @@ mod tests {
         };
 
         LenData {
-            fourty_bit_groups_len,
+            forty_bit_groups_len,
             last_group_len,
             padding_len,
         }
@@ -303,14 +303,14 @@ mod tests {
         for _ in 0..10 {
             buf.push(b'a');
             let LenData {
-                fourty_bit_groups_len,
+                forty_bit_groups_len,
                 last_group_len,
                 padding_len: _,
             } = get_len_data(buf.len());
 
             assert_eq!(
                 Base32Unpadded::encoded_len(&buf),
-                fourty_bit_groups_len + last_group_len
+                forty_bit_groups_len + last_group_len
             );
         }
     }
@@ -323,14 +323,14 @@ mod tests {
         for _ in 0..10 {
             buf.push(b'a');
             let LenData {
-                fourty_bit_groups_len,
+                forty_bit_groups_len,
                 last_group_len,
                 padding_len,
             } = get_len_data(buf.len());
 
             assert_eq!(
                 Base32::encoded_len(&buf),
-                fourty_bit_groups_len + last_group_len + padding_len,
+                forty_bit_groups_len + last_group_len + padding_len,
             );
         }
     }
diff --git a/const-oid/oiddbgen/fips202.md b/const-oid/oiddbgen/fips202.md
@@ -8,7 +8,7 @@ This document lists the OIDs for
 - SHAKE128, and
 - SHAKE256.
 
-This file was manually created, as there exists no offical document that is easily parsable.
+This file was manually created, as there exists no official document that is easily parsable.
 The SHA-3 standard is specified in [FIPS 202](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf).
 It references [Computer Security Objects Register (CSOR)]
 (https://csrc.nist.gov/projects/computer-security-objects-register/algorithm-registration),
diff --git a/const-oid/oiddbgen/fips203.md b/const-oid/oiddbgen/fips203.md
@@ -5,7 +5,7 @@ This document lists the OIDs for
 - ML-KEM-768, and
 - ML-KEM-1024.
 
-This file was manually created, as there exists no offical document that is easily parsable.
+This file was manually created, as there exists no official document that is easily parsable.
 The ML-KEM standard is specified in [FIPS 203](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.203.pdf).
 The OIDs are defined in [Computer Security Objects Register (CSOR)]
 (https://csrc.nist.gov/projects/computer-security-objects-register/algorithm-registration),
diff --git a/const-oid/oiddbgen/fips204.md b/const-oid/oiddbgen/fips204.md
@@ -8,7 +8,7 @@ This document lists the OIDs for
 - HashML-DSA-65 with SHA512, and
 - HashML-DSA-87 with SHA512.
 
-This file was manually created, as there exists no offical document that is easily parsable.
+This file was manually created, as there exists no official document that is easily parsable.
 The ML-DSA standard is specified in [FIPS 204](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.204.pdf).
 The OIDs are defined in [Computer Security Objects Register (CSOR)]
 (https://csrc.nist.gov/projects/computer-security-objects-register/algorithm-registration),
diff --git a/const-oid/oiddbgen/fips205.md b/const-oid/oiddbgen/fips205.md
@@ -26,7 +26,7 @@ This document lists the OIDs for
 - HashSLH-DSA-SHAKE-256s-with-shake256, and
 - HashSLH-DSA-SHAKE-256f-with-shake256.
 
-This file was manually created, as there exists no offical document that is easily parsable.
+This file was manually created, as there exists no official document that is easily parsable.
 The SLH-DSA standard is specified in [FIPS 205](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.205.pdf).
 The OIDs are defined in [Computer Security Objects Register (CSOR)]
 (https://csrc.nist.gov/projects/computer-security-objects-register/algorithm-registration),
diff --git a/const-oid/oiddbgen/tcg-tpm.md b/const-oid/oiddbgen/tcg-tpm.md
@@ -3,7 +3,7 @@ Object Identifiers (OID) for TCG TPM
 
 This document lists the OIDs for TPM registered by the Trusted Computing Group.
 
-This file was manually created, as there exists no offical document that is easily parsable.
+This file was manually created, as there exists no official document that is easily parsable.
 
 tcgOrganization OBJECT IDENTIFIER ::= { joint-iso-ccitt(2) international-organizations(23) 133 }
 
diff --git a/der/src/asn1/real.rs b/der/src/asn1/real.rs
@@ -61,7 +61,7 @@ impl<'a> DecodeValue<'a> for f64 {
                 n_bytes[7 - pos] = *byte;
             }
             let n = u64::from_be_bytes(n_bytes);
-            // Multiply byt 2^F corresponds to just a left shift
+            // Multiply byte 2^F corresponds to just a left shift
             let mantissa = n << scaling_factor;
             // Create the f64
             Ok(encode_f64(sign, exponent, mantissa))
@@ -838,7 +838,7 @@ mod tests {
     #[test]
     fn validation_cases() {
         // Caveat: these test cases are validated on the ASN.1 playground: https://asn1.io/asn1playground/ .
-        // The test case consists in inputing the bytes in the "decode" field and checking that the decoded
+        // The test case consists in inputting the bytes in the "decode" field and checking that the decoded
         // value corresponds to the one encoded here.
         // This tool encodes _all_ values that are non-zero in the ISO 6093 NR3 representation.
         // This does not seem to perfectly adhere to the ITU specifications, Special Cases section.
diff --git a/der_derive/src/attributes.rs b/der_derive/src/attributes.rs
@@ -101,7 +101,7 @@ pub(crate) struct FieldAttrs {
     /// where encoding is omitted per DER and to omit the encoding per DER
     pub default: Option<Path>,
 
-    /// Shold we add `&` before `self.field_name`?
+    /// Should we add `&` before `self.field_name`?
     pub should_deref: bool,
 
     /// Is this field "extensible", i.e. preceded by the `...` extensibility marker?
diff --git a/pem-rfc7468/tests/decode.rs b/pem-rfc7468/tests/decode.rs
@@ -20,8 +20,8 @@ fn binary_example() {
 }
 
 #[test]
-fn pkcs1_example_with_preceeding_junk() {
-    let pem = include_bytes!("examples/pkcs1_with_preceeding_junk.pem");
+fn pkcs1_example_with_preceding_junk() {
+    let pem = include_bytes!("examples/pkcs1_with_preceding_junk.pem");
     let mut buf = [0u8; 2048];
     let (label, decoded) = pem_rfc7468::decode(pem, &mut buf).unwrap();
     assert_eq!(label, "RSA PRIVATE KEY");
diff --git a/pem-rfc7468/tests/examples/pkcs1_with_preceding_junk.pem b/pem-rfc7468/tests/examples/pkcs1_with_preceding_junk.pem
diff --git a/x509-cert/src/certificate.rs b/x509-cert/src/certificate.rs
@@ -31,7 +31,7 @@ pub trait Profile: PartialEq + Debug + Eq + Clone + Copy + Default + 'static {
         }
     }
 
-    /// Adjustements to the time to run while serializing validity.
+    /// Adjustments to the time to run while serializing validity.
     /// See [RFC 5280 Section 4.1.2.5]:
     /// ```text
     /// CAs conforming to this profile MUST always encode certificate
