X509CertIsAuthority (FUN) ¶ FUNCTION X509CertIsAuthority : BOOL Check if the given certificate is certificate autority. Typically this is indicated by the corresponding key usage. Some older ca certificates may be identified by other means. InOut: Scope Name Type Comment Return X509CertIsAuthority BOOL Input hCert RTS_IEC_HANDLE Handle of to certificate. pResult POINTER TO RTS_IEC_RESULT Pointer to error code. ERR_OK if everything went fine, ERR_PARAMETER if hCert was invalid. Output pathLen DINT The maximum path length of the CA. -1 if there is no limit. Only valid, if the function returned TRUE
X509CertIsDateValid (FUN) ¶ FUNCTION X509CertIsDateValid : BOOL Check if a certificate has a valid date (notbefore and notafter is in the current time period) InOut: Scope Name Type Comment Return X509CertIsDateValid BOOL True if the certificate date is valid Input hCert RTS_IEC_HANDLE Handle of to certificate. pResult POINTER TO RTS_IEC_RESULT Pointer to error code. ERR_OK: Everything went fine, ERR_PARAMETER: hCert was invalid
X509CertIsSelfSigned (FUN) ¶ FUNCTION X509CertIsSelfSigned : BOOL Check if a certificate is selfsigned of is signed by a CA authority InOut: Scope Name Type Comment Return X509CertIsSelfSigned BOOL True if the certificate is self signed, False if the certificate is signed by a CA. Input hCert RTS_IEC_HANDLE Handle of to certificate. pResult POINTER TO RTS_IEC_RESULT Pointer to error code. ERR_OK if everything went fine, ERR_PARAMETER if hCert was invalid.
X509CertKeyClose (FUN) ¶ FUNCTION X509CertKeyClose : RTS_IEC_RESULT Release a PRIVATE OR PUBLIC key with THIS FUNCTION. THIS FUNCTION indicates that this key is not needed anymore and allows to clean up ressources used by this key InOut: Scope Name Type Comment Return X509CertKeyClose RTS_IEC_RESULT Result of the operation Input pKey POINTER TO RtsCryptoKey Pointer to the key
X509ParseCertificate (FUN) ¶ FUNCTION X509ParseCertificate : RTS_IEC_HANDLE Parse a certificate which is located in the memory (e.g received FROM a communication partner). Once parsed the certificate is stored in a temporary store. Use the function X509CertClose to close the certificate. InOut: Scope Name Type Comment Return X509ParseCertificate RTS_IEC_HANDLE Handle to the parsed certificate. Input pCert POINTER TO RtsByteString Binary encoded certificate. encoding RtsCertEncoding Encoding of the certificate. pResult POINTER TO RTS_IEC_RESULT Result of the operation
CMS ¶ X509CertCmsDecrypt (Function) X509CertCmsVerify (Function)
X509CertCmsDecrypt (FUN) ¶ FUNCTION X509CertCmsDecrypt : RTS_IEC_RESULT Decrypt a CMS container. InOut: Scope Name Type Comment Return X509CertCmsDecrypt RTS_IEC_RESULT ERR_OK if the container was successfully decrypted. ERR_PARAMETER if the given parameters are not consistent. Input hCertStore RTS_IEC_HANDLE Handle to the certificate store. hRecipientCert RTS_IEC_HANDLE Handle to the recipients certificate. A private key of the certificate has to be available. Though the certificate has to be located in the “own” store. pCms POINTER TO RtsByteString Pointer to a byte string storing the CMS container. encoding RtsCertEncoding Encoding of the CMS container. pOutData POINTER TO RtsByteString Pointer to a byte string where to store the extracted data.
UserMgrUserRemove (FUN) ¶ FUNCTION UserMgrUserRemove : RTS_IEC_RESULT Remove user from the user database InOut: Scope Name Type Comment Return UserMgrUserRemove RTS_IEC_RESULT Error code ERR_OK: User could be removed ERR_PARAMETER: Invalid parameter. pszUser empty ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars
UserMgrUserRemoveInfoFromAllUsers (FUN) ¶ FUNCTION UserMgrUserRemoveInfoFromAllUsers : DWORD Removes a specific cache value from all logged in users. InOut: Scope Name Type Comment Return UserMgrUserRemoveInfoFromAllUsers DWORD ERR_OK: Removing cache value successful ERR_NO_OBJECT: No cache value with this key available ERR_FAILED: Removing cache value failed Input key __XWORD Key of the cache value.
UserMgrUserRemoveInfoFromUser (FUN) ¶ FUNCTION UserMgrUserRemoveInfoFromUser : DWORD Removes a specific cache value from an user. InOut: Scope Name Type Comment Return UserMgrUserRemoveInfoFromUser DWORD ERR_OK: Removing cache value successful ERR_NO_OBJECT: No cache value with this key available ERR_FAILED: Removing cache value failed Input hUser RTS_IEC_HANDLE Handle to authorized user key __XWORD Key of the cache value.