Key Handling ¶ CryptoKeyExit (Function) CryptoKeyInit (Function)
CryptoKeyExit (FUN) ¶ FUNCTION CryptoKeyExit : RTS_IEC_RESULT InOut: Scope Name Type Return CryptoKeyExit RTS_IEC_RESULT Input pKey POINTER TO RtsCryptoKey
CryptoKeyInit (FUN) ¶ FUNCTION CryptoKeyInit : RTS_IEC_RESULT InOut: Scope Name Type Return CryptoKeyInit RTS_IEC_RESULT Input pKey POINTER TO RtsCryptoKey key RtsCryptoKeyStorage keyType RtsCryptoKeyType
Symmetric Cryptography ¶ CryptoGenerateHash (Function) CryptoHMACSign (Function) CryptoHMACVerify (Function) CryptoSymmetricDecrypt (Function) CryptoSymmetricEncrypt (Function)
CryptoGenerateHash (FUN) ¶ FUNCTION CryptoGenerateHash : RTS_IEC_RESULT Calculate the message digest of the given data. InOut: Scope Name Type Comment Return CryptoGenerateHash RTS_IEC_RESULT Result of the operation Input hAlgo RTS_IEC_HANDLE Handle to the algorithm. pData POINTER TO RtsByteString Data to calculate the message digest. pHash POINTER TO RtsByteString Calculated message digest.
CryptoHMACSign (FUN) ¶ FUNCTION CryptoHMACSign : RTS_IEC_RESULT Generate a hashed message authentication code (HMAC) OF the given data AND key. InOut: Scope Name Type Comment Return CryptoHMACSign RTS_IEC_RESULT Result of the operation Input hAlgo RTS_IEC_HANDLE Handle to the algorithm. pData POINTER TO RtsByteString Data to calculate the HMAC. key RtsCryptoKey Key to be used for the HMAC calcuation pSignature POINTER TO RtsByteString Calculated HMAC
CryptoHMACVerify (FUN) ¶ FUNCTION CryptoHMACVerify : RTS_IEC_RESULT Verify a recieved hashed message authentication code (HMAC). InOut: Scope Name Type Comment Return CryptoHMACVerify RTS_IEC_RESULT Function returns ERR_OK if the HMAC is valid. Input hAlgo RTS_IEC_HANDLE Handle to the algorithm. pData POINTER TO RtsByteString Data to calculate the HMAC. key RtsCryptoKey Key to be used for the HMAC calcuation pSignature POINTER TO RtsByteString Recieved HMAC
CryptoSymmetricDecrypt (FUN) ¶ FUNCTION CryptoSymmetricDecrypt : RTS_IEC_RESULT Perform a symmetric decryption using the algorithm handle. InOut: Scope Name Type Comment Return CryptoSymmetricDecrypt RTS_IEC_RESULT Result of the operation Input hAlgo RTS_IEC_HANDLE Handle to the algorithm. pCipherText POINTER TO RtsByteString Data to be decrypted key RtsCryptoKey Key to decrypt the data. Has to be a KeyType_Key key. pInitVector POINTER TO RtsByteString Init vector of the decrypt. xEnablePadding BOOL Enables padding. If this is not enabled the ciphertext length has to match a multiple of the block length. pPlainText POINTER TO RtsByteString Decrypted data.
CryptoSymmetricEncrypt (FUN) ¶ FUNCTION CryptoSymmetricEncrypt : RTS_IEC_RESULT Perform a symmetric encryption using the algorithm handle. InOut: Scope Name Type Comment Return CryptoSymmetricEncrypt RTS_IEC_RESULT Result of the operation Input hAlgo RTS_IEC_HANDLE Handle to the algorithm. pPlainText POINTER TO RtsByteString Data to be encrypted key RtsCryptoKey Key to encrypt the data. Has to be a KeyType_Key key. pInitVector POINTER TO RtsByteString Init vector of the ecryption xEnablePadding BOOL Enables padding. If this is not enabled the plaintext length has to match a multiple of the block length. pCipherText POINTER TO RtsByteString Encrypted data.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 01.04.2022, 08:12:33 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpCrypto Implementation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpCrypto Implementation.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False Released True SourceLibrary False LastModificationDateTime date 01.04.2022, 08:12:33 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpCrypto Implementation Project CmpCrypto Implementation Title CmpCrypto Implementation Version version 3.5.18.0