]> git.proxmox.com Git - mirror_edk2.git/blobdiff - NetworkPkg/IpSecDxe/IpSecCryptIo.h
NetworkPkg: Fix typos in comments
[mirror_edk2.git] / NetworkPkg / IpSecDxe / IpSecCryptIo.h
index 0e106af0f0f46f7caac5fbd49dadf1e88dd0a229..0ef83eb4cab4ab1a1be475fec6b6bb0cd970086b 100644 (file)
@@ -104,7 +104,7 @@ BOOLEAN
   );\r
 \r
 /**\r
-  Prototype of HMAC finallization.\r
+  Prototype of HMAC finalization.\r
   Terminate a HMAC message digest operation and output the message digest.\r
 \r
   If Context is NULL, then ASSERT().\r
@@ -139,7 +139,7 @@ UINTN
 \r
 /**\r
   Prototype of Block Cipher initiation.\r
-  Intializes the user-supplied key as the specifed context (key materials) for both\r
+  Initializes the user-supplied key as the specified context (key materials) for both\r
   encryption and decryption operations.\r
 \r
   If Context is NULL, then ASSERT().\r
@@ -165,7 +165,7 @@ BOOLEAN
   Encrypts plaintext message with the specified cipher.\r
 \r
   If Context is NULL, then ASSERT().\r
-  if InData is NULL, then ASSERT().\r
+  If InData is NULL, then ASSERT().\r
   If Size of input data is not multiple of Cipher algorithm related block size,\r
   then ASSERT().\r
 \r
@@ -193,7 +193,7 @@ BOOLEAN
   Decrypts cipher message with specified cipher.\r
 \r
   If Context is NULL, then ASSERT().\r
-  if InData is NULL, then ASSERT().\r
+  If InData is NULL, then ASSERT().\r
   If Size of input data is not a multiple of a certaion block size , then ASSERT().\r
 \r
   @param[in]      Context      The specified Context.\r
@@ -256,7 +256,7 @@ BOOLEAN
 \r
   This function performs 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
-  Context should be already correctly intialized by HashInit(), and should not be finalized\r
+  Context should be already correctly initialized by HashInit(), and should not be finalized\r
   by HashFinal(). Behavior with invalid context is undefined.\r
 \r
   If Context is NULL, then ASSERT().\r
@@ -285,7 +285,7 @@ BOOLEAN
   This function completes hash computation and retrieves the digest value into\r
   the specified memory. After this function has been called, the context cannot\r
   be used again.\r
-  context should be already correctly intialized by HashInit(), and should not be\r
+  context should be already correctly initialized by HashInit(), and should not be\r
   finalized by HashFinal(). Behavior with invalid context is undefined.\r
 \r
   If Context is NULL, then ASSERT().\r
@@ -339,13 +339,13 @@ typedef struct _ENCRYPT_ALGORITHM {
   //\r
   CRYPTO_CIPHER_ENCRYPT        CipherEncrypt;\r
   //\r
-  // The Function pointer of Cipher Decrption.\r
+  // The Function pointer of Cipher Decryption.\r
   //\r
   CRYPTO_CIPHER_DECRYPT        CipherDecrypt;\r
 } ENCRYPT_ALGORITHM;\r
 \r
 //\r
-// The struct used to store the information and operation of Autahentication algorithm.\r
+// The struct used to store the information and operation of Authentication algorithm.\r
 //\r
 typedef struct _AUTH_ALGORITHM {\r
   //\r
@@ -383,7 +383,7 @@ typedef struct _AUTH_ALGORITHM {
 } AUTH_ALGORITHM;\r
 \r
 //\r
-// The struct used to store the informatino and operation of Hash algorithm.\r
+// The struct used to store the information and operation of Hash algorithm.\r
 //\r
 typedef struct _HASH_ALGORITHM {\r
   //\r
@@ -421,7 +421,7 @@ typedef struct _HASH_ALGORITHM {
 } HASH_ALGORITHM;\r
 \r
 /**\r
-  Get the IV size of specified encryption alogrithm.\r
+  Get the IV size of specified encryption algorithm.\r
 \r
   @param[in]  AlgorithmId          The encryption algorithm ID.\r
 \r
@@ -434,7 +434,7 @@ IpSecGetEncryptIvLength (
   );\r
 \r
 /**\r
-  Get the block size of specified encryption alogrithm.\r
+  Get the block size of specified encryption algorithm.\r
 \r
   @param[in]  AlgorithmId          The encryption algorithm ID.\r
 \r
@@ -447,7 +447,7 @@ IpSecGetEncryptBlockSize (
   );\r
 \r
 /**\r
-  Get the required key length of the specified encryption alogrithm.\r
+  Get the required key length of the specified encryption algorithm.\r
 \r
   @param[in]  AlgorithmId          The encryption algorithm ID.\r
 \r
@@ -460,7 +460,7 @@ IpSecGetEncryptKeyLength (
   );\r
 \r
 /**\r
-  Get the ICV size of the specified Authenticaion alogrithm.\r
+  Get the ICV size of the specified Authentication algorithm.\r
 \r
   @param[in]  AlgorithmId          The Authentication algorithm ID.\r
 \r
@@ -475,7 +475,7 @@ IpSecGetIcvLength (
 /**\r
   Get the HMAC digest length by the specified Algorithm ID.\r
 \r
-  @param[in]  AlgorithmId  The specified Alogrithm ID.\r
+  @param[in]  AlgorithmId  The specified Algorithm ID.\r
 \r
   @return The digest length of the specified Authentication Algorithm ID.\r
 \r
@@ -505,14 +505,14 @@ IpSecGenerateIv (
   Encrypt the buffer.\r
 \r
   This function calls relevant encryption interface from CryptoLib according to\r
-  the input alogrithm ID. The InData should be multiple of block size. This function\r
+  the input algorithm ID. The InData should be multiple of block size. This function\r
   doesn't perform the padding. If it has the Ivec data, the length of it should be\r
   same with the block size. The block size is different from the different algorithm.\r
 \r
-  @param[in]       AlgorithmId    The Alogrithem identification defined in RFC.\r
+  @param[in]       AlgorithmId    The Algorithm identification defined in RFC.\r
   @param[in]       Key            Pointer to the buffer containing encrypting key.\r
   @param[in]       KeyBits        The length of the key in bits.\r
-  @param[in]       Ivec           Point to the buffer containning the Initializeion\r
+  @param[in]       Ivec           Point to the buffer containing the Initialization\r
                                   Vector (IV) data.\r
   @param[in]       InData         Point to the buffer containing the data to be\r
                                   encrypted.\r
@@ -540,14 +540,14 @@ IpSecCryptoIoEncrypt (
   Decrypts the buffer.\r
 \r
   This function calls relevant Decryption interface from CryptoLib according to\r
-  the input alogrithm ID. The InData should be multiple of block size. This function\r
+  the input algorithm ID. The InData should be multiple of block size. This function\r
   doesn't perform the padding. If it has the Ivec data, the length of it should be\r
   same with the block size. The block size is different from the different algorithm.\r
 \r
-  @param[in]       AlgorithmId    The Alogrithem identification defined in RFC.\r
+  @param[in]       AlgorithmId    The Algorithm identification defined in RFC.\r
   @param[in]       Key            Pointer to the buffer containing encrypting key.\r
   @param[in]       KeyBits        The length of the key in bits.\r
-  @param[in]       Ivec           Point to the buffer containning the Initializeion\r
+  @param[in]       Ivec           Point to the buffer containing the Initialization\r
                                   Vector (IV) data.\r
   @param[in]       InData         Point to the buffer containing the data to be\r
                                   decrypted.\r
@@ -575,9 +575,9 @@ IpSecCryptoIoDecrypt (
   Digests the Payload with key and store the result into the OutData.\r
 \r
   This function calls relevant Hmac interface from CryptoLib according to\r
-  the input alogrithm ID. It computes all datas from InDataFragment and output\r
+  the input algorithm ID. It computes all datas from InDataFragment and output\r
   the result into the OutData buffer. If the OutDataSize is larger than the related\r
-  HMAC alogrithm output size, return EFI_INVALID_PARAMETER.\r
+  HMAC algorithm output size, return EFI_INVALID_PARAMETER.\r
   \r
   @param[in]      AlgorithmId     The authentication Identification.\r
   @param[in]      Key             Pointer of the authentication key.\r
@@ -609,9 +609,9 @@ IpSecCryptoIoHmac (
   Digests the Payload and store the result into the OutData.\r
 \r
   This function calls relevant Hash interface from CryptoLib according to\r
-  the input alogrithm ID. It computes all datas from InDataFragment and output\r
+  the input algorithm ID. It computes all datas from InDataFragment and output\r
   the result into the OutData buffer. If the OutDataSize is larger than the related\r
-  Hash alogrithm output size, return EFI_INVALID_PARAMETER.\r
+  Hash algorithm output size, return EFI_INVALID_PARAMETER.\r
 \r
   @param[in]      AlgorithmId     The authentication Identification.\r
   @param[in]      InDataFragment  A list contains all data to be authenticated.\r
@@ -640,14 +640,14 @@ IpSecCryptoIoHash (
   Generates the Diffie-Hellman public key.\r
 \r
   This function first initiate a DHContext, then call the DhSetParameter() to set\r
-  the prime and primelenght, at end call the DhGenerateKey() to generates random\r
+  the prime and primelength, at end call the DhGenerateKey() to generates random\r
   secret exponent, and computes the public key. The output returned via parameter\r
   PublicKey and PublicKeySize. DH context is updated accordingly. If the PublicKey\r
   buffer is too small to hold the public key, EFI_INVALID_PARAMETER is returned\r
   and PublicKeySize is set to the required buffer size to obtain the public key.\r
 \r
   @param[in, out] DhContext       Pointer to the DH context.\r
-  @param[in]      Generator       Vlaue of generator.\r
+  @param[in]      Generator       Value of generator.\r
   @param[in]      PrimeLength     Length in bits of prime to be generated.\r
   @param[in]      Prime           Pointer to the buffer to receive the generated\r
                                   prime number.\r
@@ -656,7 +656,7 @@ IpSecCryptoIoHash (
                                   For out, the size of data returned in PublicKey\r
                                   buffer in bytes.\r
 \r
-  @retval EFI_SUCCESS             The operation perfoms successfully.\r
+  @retval EFI_SUCCESS             The operation performs successfully.\r
   @retval Otherwise               The operation is failed.\r
 \r
 **/\r
@@ -684,7 +684,7 @@ IpSecCryptoIoDhGetPublicKey (
                                     For out, the size of data returned in Key\r
                                     buffer in bytes.\r
 \r
-  @retval EFI_SUCCESS              The operation perfoms successfully.\r
+  @retval EFI_SUCCESS              The operation performs successfully.\r
   @retval Otherwise                The operation is failed.\r
 \r
 **/\r
@@ -702,7 +702,7 @@ IpSecCryptoIoDhComputeKey (
 \r
   @param[in, out]     DhContext         Pointer to the DH context to be freed.\r
 \r
-  @retval EFI_SUCCESS              The operation perfoms successfully.\r
+  @retval EFI_SUCCESS              The operation performs successfully.\r
   @retval EFI_INVALID_PARAMETER    The DhContext is NULL.\r
   \r
 **/\r
@@ -717,9 +717,9 @@ IpSecCryptoIoFreeDh (
   If the Random Generator wasn't initiated, initiate it first, then call RandomBytes.\r
 \r
   @param[out]  OutBuffer        Pointer to buffer to receive random value.\r
-  @param[in]   Bytes            Size of randome bytes to generate.\r
+  @param[in]   Bytes            Size of random bytes to generate.\r
 \r
-  @retval EFI_SUCCESS              The operation perfoms successfully.\r
+  @retval EFI_SUCCESS              The operation performs successfully.\r
   @retval Otherwise                The operation is failed.\r
 \r
 **/\r
@@ -762,9 +762,9 @@ IpSecCryptoIoAuthDataWithCertificate (
   @param[in]     CertLen         The size of Certificate in bytes.\r
   @param[in]     InCa            Pointer to the CA certificate\r
   @param[in]     CaLen           The size of CA certificate in bytes.\r
-  @param[in]     InData          Pointer to octect message hash to be checked.\r
+  @param[in]     InData          Pointer to octet message hash to be checked.\r
   @param[in]     InDataSize      Size of the message hash in bytes.\r
-  @param[in]     Singnature      The pointer to the RSA PKCS1-V1_5 signature to be verifed.\r
+  @param[in]     Singnature      The pointer to the RSA PKCS1-V1_5 signature to be verified.\r
   @param[in]     SigSize         Size of signature in bytes.\r
 \r
   @retval  TRUE   Valid signature encoded in PKCS1-v1_5.\r