The CryptEncrypt function is used to encrypt data. The algorithm used to encrypt the data is designated by the key held by the CSP module, which is referenced by the hKey parameter.
BOOL CRYPTFUNC CryptEncrypt(
HCRYPTKEY hKey, | |
HCRYPTHASH hHash, | |
BOOL Final, | |
DWORD dwFlags, | |
BYTE *pbData, | |
DWORD *pdwDataLen, | |
DWORD dwBufLen | |
); |
This key specifies the encryption algorithm that is used.
If no hash is to be done, this parameter must be zero.
The size of this buffer is specified by dwBufLen. The number of bytes of data to be encrypted is specified by pdwDataLen.
This parameter can be NULL if all you are doing is determining the number of
bytes required for the returned data.
If the buffer specified by pbData is not large enough to hold the data, the function returns the ERROR_MORE_DATA error code (through GetLastError) and stores the required buffer size, in bytes, into the variable pointed to by pdwDataLen.
If pbData is NULL, then no error is returned, and the function stores the size of the data, in bytes, in the variable pointed to be pdwDataLen. This lets an application determine the correct buffer size unambiguously.
When a block cipher is used, this data length must be a multiple of the block
size, unless this is the final section of data to be encrypted and the Final
flag is TRUE.
Note that, depending on the algorithm used, the encrypted text can be slightly larger than the original plaintext. In this case, the pbData buffer needs to be sized accordingly.
As a rule, if a stream cipher is used the ciphertext will be the same size as the plaintext. If a block cipher is used, the ciphertext will be up to a “block length” larger than the plaintext.
If data is to be hashed and encrypted simultaneously, a handle to a hash object can be passed in the hHash parameter. The hash value will be updated with the plaintext passed in. This option is useful when generating signed and encrypted text.
Prior to calling CryptEncrypt, the application should obtain a handle to the hash object by calling the CryptCreateHash function. Once the encryption is complete, the hash value can be obtained through the CryptGetHashParam function or the hash can be signed using the CryptSignHash function.
When a large amount of data needs to be encrypted, it can be done in sections. This is done by calling CryptEncrypt repeatedly. The Final parameter should be set to TRUE only on the last invocation of CryptEncrypt, so the encryption engine can properly finish the encryption process. The following extra actions are performed when Final is TRUE:
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To retrieve extended error information, use the GetLastError function.
The following table lists the error codes most commonly returned by the GetLastError function. The error codes prefaced by “NTE” are generated by the particular CSP you are using.
Error |
Description |
ERROR_INVALID_HANDLE |
One of the parameters specifies an invalid handle. |
ERROR_INVALID_PARAMETER |
One of the parameters contains an invalid value. This is most often an illegal pointer. |
NTE_BAD_ALGID |
The hKey session key specifies an algorithm that this CSP does not support. |
NTE_BAD_DATA |
The data to be encrypted is invalid. For example, when a block cipher is used and the Final flag is FALSE, the value specified by pdwDataLen must be a multiple of the block size. |
NTE_BAD_FLAGS |
The dwFlags parameter is nonzero. |
NTE_BAD_HASH |
The hHash parameter contains an invalid handle. |
NTE_BAD_KEY |
The hKey parameter does not contain a valid handle to a key. |
NTE_BAD_LEN |
The size of the output buffer is too small to hold the generated ciphertext. |
NTE_BAD_UID |
The CSP context that was specified when the key was created cannot be found. |
NTE_DOUBLE_ENCRYPT |
The application attempted to encrypt the same data twice. |
NTE_FAIL |
The function failed in some unexpected way. |
NTE_NO_MEMORY |
The CSP ran out of memory during the operation. |
See “Encryption Example” in the section Encrypting and Decrypting Data.
CryptCreateHash, CryptDecrypt, CryptGenKey, CryptGetHashParam, CryptImportKey, CryptSignHash
file: /Techref/os/win/api/win32/func/src/f12_3.htm, 10KB, , updated: 2000/4/7 11:19, local time: 2024/11/27 20:39,
3.145.34.51:LOG IN
|
©2024 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions? <A HREF="http://massmind.org/Techref/os/win/api/win32/func/src/f12_3.htm"> CryptEncrypt Release 2]</A> |
Did you find what you needed? |
Welcome to massmind.org! |
Welcome to massmind.org! |
.