]> git.proxmox.com Git - mirror_edk2.git/blobdiff - CryptoPkg/Include/Library/BaseCryptLib.h
CryptoPkg: Fix typos in comments
[mirror_edk2.git] / CryptoPkg / Include / Library / BaseCryptLib.h
index 67837aec1dd284ff93bb3eab406d60fa490e64f5..45dac3b4c10c4ad1f9de1c8309530c8107fe96dd 100644 (file)
@@ -140,7 +140,7 @@ Md4Duplicate (
 \r
   This function performs MD4 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  MD4 context should be already correctly intialized by Md4Init(), and should not be finalized\r
+  MD4 context should be already correctly initialized by Md4Init(), and should not be finalized\r
   by Md4Final(). Behavior with invalid context is undefined.\r
 \r
   If Md4Context is NULL, then return FALSE.\r
@@ -169,7 +169,7 @@ Md4Update (
   This function completes MD4 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the MD4 context cannot\r
   be used again.\r
-  MD4 context should be already correctly intialized by Md4Init(), and should not be\r
+  MD4 context should be already correctly initialized by Md4Init(), and should not be\r
   finalized by Md4Final(). Behavior with invalid MD4 context is undefined.\r
 \r
   If Md4Context is NULL, then return FALSE.\r
@@ -280,7 +280,7 @@ Md5Duplicate (
 \r
   This function performs MD5 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  MD5 context should be already correctly intialized by Md5Init(), and should not be finalized\r
+  MD5 context should be already correctly initialized by Md5Init(), and should not be finalized\r
   by Md5Final(). Behavior with invalid context is undefined.\r
 \r
   If Md5Context is NULL, then return FALSE.\r
@@ -309,7 +309,7 @@ Md5Update (
   This function completes MD5 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the MD5 context cannot\r
   be used again.\r
-  MD5 context should be already correctly intialized by Md5Init(), and should not be\r
+  MD5 context should be already correctly initialized by Md5Init(), and should not be\r
   finalized by Md5Final(). Behavior with invalid MD5 context is undefined.\r
 \r
   If Md5Context is NULL, then return FALSE.\r
@@ -420,7 +420,7 @@ Sha1Duplicate (
 \r
   This function performs SHA-1 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  SHA-1 context should be already correctly intialized by Sha1Init(), and should not be finalized\r
+  SHA-1 context should be already correctly initialized by Sha1Init(), and should not be finalized\r
   by Sha1Final(). Behavior with invalid context is undefined.\r
 \r
   If Sha1Context is NULL, then return FALSE.\r
@@ -449,7 +449,7 @@ Sha1Update (
   This function completes SHA-1 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the SHA-1 context cannot\r
   be used again.\r
-  SHA-1 context should be already correctly intialized by Sha1Init(), and should not be\r
+  SHA-1 context should be already correctly initialized by Sha1Init(), and should not be\r
   finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.\r
 \r
   If Sha1Context is NULL, then return FALSE.\r
@@ -555,7 +555,7 @@ Sha256Duplicate (
 \r
   This function performs SHA-256 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  SHA-256 context should be already correctly intialized by Sha256Init(), and should not be finalized\r
+  SHA-256 context should be already correctly initialized by Sha256Init(), and should not be finalized\r
   by Sha256Final(). Behavior with invalid context is undefined.\r
 \r
   If Sha256Context is NULL, then return FALSE.\r
@@ -582,7 +582,7 @@ Sha256Update (
   This function completes SHA-256 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the SHA-256 context cannot\r
   be used again.\r
-  SHA-256 context should be already correctly intialized by Sha256Init(), and should not be\r
+  SHA-256 context should be already correctly initialized by Sha256Init(), and should not be\r
   finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.\r
 \r
   If Sha256Context is NULL, then return FALSE.\r
@@ -686,7 +686,7 @@ Sha384Duplicate (
 \r
   This function performs SHA-384 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  SHA-384 context should be already correctly intialized by Sha384Init(), and should not be finalized\r
+  SHA-384 context should be already correctly initialized by Sha384Init(), and should not be finalized\r
   by Sha384Final(). Behavior with invalid context is undefined.\r
 \r
   If Sha384Context is NULL, then return FALSE.\r
@@ -713,7 +713,7 @@ Sha384Update (
   This function completes SHA-384 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the SHA-384 context cannot\r
   be used again.\r
-  SHA-384 context should be already correctly intialized by Sha384Init(), and should not be\r
+  SHA-384 context should be already correctly initialized by Sha384Init(), and should not be\r
   finalized by Sha384Final(). Behavior with invalid SHA-384 context is undefined.\r
 \r
   If Sha384Context is NULL, then return FALSE.\r
@@ -817,7 +817,7 @@ Sha512Duplicate (
 \r
   This function performs SHA-512 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  SHA-512 context should be already correctly intialized by Sha512Init(), and should not be finalized\r
+  SHA-512 context should be already correctly initialized by Sha512Init(), and should not be finalized\r
   by Sha512Final(). Behavior with invalid context is undefined.\r
 \r
   If Sha512Context is NULL, then return FALSE.\r
@@ -844,7 +844,7 @@ Sha512Update (
   This function completes SHA-512 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the SHA-512 context cannot\r
   be used again.\r
-  SHA-512 context should be already correctly intialized by Sha512Init(), and should not be\r
+  SHA-512 context should be already correctly initialized by Sha512Init(), and should not be\r
   finalized by Sha512Final(). Behavior with invalid SHA-512 context is undefined.\r
 \r
   If Sha512Context is NULL, then return FALSE.\r
@@ -961,7 +961,7 @@ HmacMd5Duplicate (
 \r
   This function performs HMAC-MD5 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  HMAC-MD5 context should be already correctly intialized by HmacMd5Init(), and should not be\r
+  HMAC-MD5 context should be already correctly initialized by HmacMd5Init(), and should not be\r
   finalized by HmacMd5Final(). Behavior with invalid context is undefined.\r
 \r
   If HmacMd5Context is NULL, then return FALSE.\r
@@ -990,7 +990,7 @@ HmacMd5Update (
   This function completes HMAC-MD5 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the HMAC-MD5 context cannot\r
   be used again.\r
-  HMAC-MD5 context should be already correctly intialized by HmacMd5Init(), and should not be\r
+  HMAC-MD5 context should be already correctly initialized by HmacMd5Init(), and should not be\r
   finalized by HmacMd5Final(). Behavior with invalid HMAC-MD5 context is undefined.\r
 \r
   If HmacMd5Context is NULL, then return FALSE.\r
@@ -1079,7 +1079,7 @@ HmacSha1Duplicate (
 \r
   This function performs HMAC-SHA1 digest on a data buffer of the specified size.\r
   It can be called multiple times to compute the digest of long or discontinuous data streams.\r
-  HMAC-SHA1 context should be already correctly intialized by HmacSha1Init(), and should not\r
+  HMAC-SHA1 context should be already correctly initialized by HmacSha1Init(), and should not\r
   be finalized by HmacSha1Final(). Behavior with invalid context is undefined.\r
 \r
   If HmacSha1Context is NULL, then return FALSE.\r
@@ -1108,7 +1108,7 @@ HmacSha1Update (
   This function completes HMAC-SHA1 hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the HMAC-SHA1 context cannot\r
   be used again.\r
-  HMAC-SHA1 context should be already correctly intialized by HmacSha1Init(), and should\r
+  HMAC-SHA1 context should be already correctly initialized by HmacSha1Init(), and should\r
   not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.\r
 \r
   If HmacSha1Context is NULL, then return FALSE.\r
@@ -1811,14 +1811,14 @@ RsaFree (
   This function sets the tag-designated RSA key component into the established\r
   RSA context from the user-specified non-negative integer (octet string format\r
   represented in RSA PKCS#1).\r
-  If BigNumber is NULL, then the specified key componenet in RSA context is cleared.\r
+  If BigNumber is NULL, then the specified key component in RSA context is cleared.\r
 \r
   If RsaContext is NULL, then return FALSE.\r
 \r
   @param[in, out]  RsaContext  Pointer to RSA context being set.\r
   @param[in]       KeyTag      Tag of RSA key component being set.\r
   @param[in]       BigNumber   Pointer to octet integer buffer.\r
-                               If NULL, then the specified key componenet in RSA\r
+                               If NULL, then the specified key component in RSA\r
                                context is cleared.\r
   @param[in]       BnSize      Size of big number buffer in bytes.\r
                                If BigNumber is NULL, then it is ignored.\r
@@ -1910,7 +1910,7 @@ RsaGenerateKey (
   NOTE: This function performs integrity checks on all the RSA key material, so\r
         the RSA key structure must contain all the private key data.\r
 \r
-  This function validates key compoents of RSA context in following aspects:\r
+  This function validates key components of RSA context in following aspects:\r
   - Whether p is a prime\r
   - Whether q is a prime\r
   - Whether n = p * q\r
@@ -2256,16 +2256,16 @@ Pkcs5HashPassword (
   in a ContentInfo structure.\r
 \r
   If P7Data, CertStack, StackLength, TrustedCert or CertLength is NULL, then\r
-  return FALSE. If P7Length overflow, then return FAlSE.\r
+  return FALSE. If P7Length overflow, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in]  P7Data       Pointer to the PKCS#7 message to verify.\r
   @param[in]  P7Length     Length of the PKCS#7 message in bytes.\r
   @param[out] CertStack    Pointer to Signer's certificates retrieved from P7Data.\r
-                           It's caller's responsiblity to free the buffer.\r
+                           It's caller's responsibility to free the buffer.\r
   @param[out] StackLength  Length of signer's certificates in bytes.\r
   @param[out] TrustedCert  Pointer to a trusted certificate from Signer's certificates.\r
-                           It's caller's responsiblity to free the buffer.\r
+                           It's caller's responsibility to free the buffer.\r
   @param[out] CertLength   Length of the trusted certificate in bytes.\r
 \r
   @retval  TRUE            The operation is finished successfully.\r
@@ -2307,10 +2307,10 @@ Pkcs7FreeSigners (
   @param[in]  P7Data            Pointer to the PKCS#7 message.\r
   @param[in]  P7Length          Length of the PKCS#7 message in bytes.\r
   @param[out] SignerChainCerts  Pointer to the certificates list chained to signer's\r
-                                certificate. It's caller's responsiblity to free the buffer.\r
+                                certificate. It's caller's responsibility to free the buffer.\r
   @param[out] ChainLength       Length of the chained certificates list buffer in bytes.\r
   @param[out] UnchainCerts      Pointer to the unchained certificates lists. It's caller's\r
-                                responsiblity to free the buffer.\r
+                                responsibility to free the buffer.\r
   @param[out] UnchainLength     Length of the unchained certificates list buffer in bytes.\r
 \r
   @retval  TRUE         The operation is finished successfully.\r
@@ -2369,12 +2369,12 @@ Pkcs7Sign (
   );\r
 \r
 /**\r
-  Verifies the validility of a PKCS#7 signed data as described in "PKCS #7:\r
+  Verifies the validity of a PKCS#7 signed data as described in "PKCS #7:\r
   Cryptographic Message Syntax Standard". The input signed data could be wrapped\r
   in a ContentInfo structure.\r
 \r
   If P7Data, TrustedCert or InData is NULL, then return FALSE.\r
-  If P7Length, CertLength or DataLength overflow, then return FAlSE.\r
+  If P7Length, CertLength or DataLength overflow, then return FALSE.\r
   If this interface is not supported, then return FALSE.\r
 \r
   @param[in]  P7Data       Pointer to the PKCS#7 message to verify.\r
@@ -2406,7 +2406,7 @@ Pkcs7Verify (
   data could be wrapped in a ContentInfo structure.\r
 \r
   If P7Data, Content, or ContentSize is NULL, then return FALSE. If P7Length overflow,\r
-  then return FAlSE. If the P7Data is not correctly formatted, then return FALSE.\r
+  then return FALSE. If the P7Data is not correctly formatted, then return FALSE.\r
 \r
   Caution: This function may receive untrusted input. So this function will do\r
            basic check for PKCS#7 data structure.\r
@@ -2414,7 +2414,7 @@ Pkcs7Verify (
   @param[in]   P7Data       Pointer to the PKCS#7 signed data to process.\r
   @param[in]   P7Length     Length of the PKCS#7 signed data in bytes.\r
   @param[out]  Content      Pointer to the extracted content from the PKCS#7 signedData.\r
-                            It's caller's responsiblity to free the buffer.\r
+                            It's caller's responsibility to free the buffer.\r
   @param[out]  ContentSize  The size of the extracted content in bytes.\r
 \r
   @retval     TRUE          The P7Data was correctly formatted for processing.\r
@@ -2431,7 +2431,7 @@ Pkcs7GetAttachedContent (
   );\r
 \r
 /**\r
-  Verifies the validility of a PE/COFF Authenticode Signature as described in "Windows\r
+  Verifies the validity of a PE/COFF Authenticode Signature as described in "Windows\r
   Authenticode Portable Executable Signature Format".\r
 \r
   If AuthData is NULL, then return FALSE.\r
@@ -2444,7 +2444,7 @@ Pkcs7GetAttachedContent (
   @param[in]  TrustedCert  Pointer to a trusted/root certificate encoded in DER, which\r
                            is used for certificate chain verification.\r
   @param[in]  CertSize     Size of the trusted certificate in bytes.\r
-  @param[in]  ImageHash    Pointer to the original image file hash value. The procudure\r
+  @param[in]  ImageHash    Pointer to the original image file hash value. The procedure\r
                            for calculating the image hash value is described in Authenticode\r
                            specification.\r
   @param[in]  HashSize     Size of Image hash value in bytes.\r
@@ -2466,7 +2466,7 @@ AuthenticodeVerify (
   );\r
 \r
 /**\r
-  Verifies the validility of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode\r
+  Verifies the validity of a RFC3161 Timestamp CounterSignature embedded in PE/COFF Authenticode\r
   signature.\r
 \r
   If AuthData is NULL, then return FALSE.\r
@@ -2545,7 +2545,7 @@ DhFree (
   @param[in]       PrimeLength  Length in bits of prime to be generated.\r
   @param[out]      Prime        Pointer to the buffer to receive the generated prime number.\r
 \r
-  @retval TRUE   DH pamameter generation succeeded.\r
+  @retval TRUE   DH parameter generation succeeded.\r
   @retval FALSE  Value of Generator is not supported.\r
   @retval FALSE  PRNG fails to generate random prime number with PrimeLength.\r
   @retval FALSE  This interface is not supported.\r
@@ -2575,7 +2575,7 @@ DhGenerateParameter (
   @param[in]       PrimeLength  Length in bits of prime to be generated.\r
   @param[in]       Prime        Pointer to the prime number.\r
 \r
-  @retval TRUE   DH pamameter setting succeeded.\r
+  @retval TRUE   DH parameter setting succeeded.\r
   @retval FALSE  Value of Generator is not supported.\r
   @retval FALSE  Value of Generator is not suitable for the Prime.\r
   @retval FALSE  Value of Prime is not a prime number.\r
@@ -2696,7 +2696,7 @@ RandomSeed (
   If this interface is not supported, then return FALSE.\r
 \r
   @param[out]  Output  Pointer to buffer to receive random value.\r
-  @param[in]   Size    Size of randome bytes to generate.\r
+  @param[in]   Size    Size of random bytes to generate.\r
 \r
   @retval TRUE   Pseudorandom byte stream generated successfully.\r
   @retval FALSE  Pseudorandom number generator fails to generate due to lack of entropy.\r