X509CertStoreOpen (FUN) ¶ FUNCTION X509CertStoreOpen : RTS_IEC_HANDLE Open the certificate store. InOut: Scope Name Type Comment Return X509CertStoreOpen RTS_IEC_HANDLE Handle to the certificate store Input componentID UDINT ID of the component opening the certificate store. pResult POINTER TO RTS_IEC_RESULT Result of the operation.

X509CertStoreRegister (FUN) ¶ FUNCTION X509CertStoreRegister : RTS_IEC_HANDLE Register your certificate at the certificate store. This has to be done in order to allow the user the view the different configured certificates and to generate missing certificates or to renew outdated certificates. Register the same information you are using in the X509CertStoreSearch function. InOut: Scope Name Type Comment Return X509CertStoreRegister RTS_IEC_HANDLE Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. cmpID UDINT Component ID which registered the certificate pCertInfo POINTER TO RtsX509CertInfo Certificate information to be registered. Should match the information needed to use the Search function. pResult POINTER TO RTS_IEC_RESULT Pointer to error code

CmpX509Cert Implementation Library Documentation ¶ Company System Title CmpX509Cert Implementation Version 3.5.19.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder CmpX509Cert Implementation Description 1 ¶ This library contains the functions to access the runtime certificate store and allow the handling of certificates in different formats Contents: ¶ BasicCertificateHandling X509CertCheckHost (Function) X509CertCheckIP (Function) X509CertClose (Function) X509CertGetBinary (Function) X509CertGetContent (Function) X509CertGetPublicKey (Function) X509CertGetThumbprint (Function) X509CertHasExtendedKeyUsage (Function) X509CertHasKeyUsage (Function) X509CertIsAuthority (Function) X509CertIsDateValid (Function) X509CertIsSelfSigned (Function) X509CertKeyClose (Function) X509ParseCertificate (Function) CMS X509CertCmsDecrypt (Function) X509CertCmsVerify (Function) CertificateStore X509CertCreateCSR (Function) X509CertCreateSelfSigned (Function) X509CertGetPrivateKey (Function) X509CertStoreAddCert (Function) X509CertStoreClose (Function) X509CertStoreGetFirstCert (Function) X509CertStoreGetNextCert (Function) X509CertStoreGetRegisteredCert (Function) X509CertStoreOpen (Function) X509CertStoreRegister (Function) X509CertStoreRemoveCert (Function) X509CertStoreSearchGetFirst (Function) X509CertStoreSearchGetNext (Function) X509CertStoreUnregister (Function) X509CertVerify (Function) X509CertVerify2 (Function) UtilityFunctions RtsOIDClear (Function) RtsOIDCreate (Function) RtsOIDGetID (Function) RtsOIDGetName (Function) X509CertInfoExit (Function) X509CertInfoInit (Function) Indices and tables ¶ 1 Based on CmpX509Cert Implementation.library, last modified 02.03.2023, 11:03:42. LibDoc 4.4.0.0-b.27 The content file CmpX509Cert Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:03:44.

BasicCertificateHandling ¶ X509CertCheckHost (Function) X509CertCheckIP (Function) X509CertClose (Function) X509CertGetBinary (Function) X509CertGetContent (Function) X509CertGetPublicKey (Function) X509CertGetThumbprint (Function) X509CertHasExtendedKeyUsage (Function) X509CertHasKeyUsage (Function) X509CertIsAuthority (Function) X509CertIsDateValid (Function) X509CertIsSelfSigned (Function) X509CertKeyClose (Function) X509ParseCertificate (Function)

X509CertCheckHost (FUN) ¶ FUNCTION X509CertCheckHost : BOOL Check if a certificate is bound to a specific host name. Both subject and subject alternative names are checked. InOut: Scope Name Type Comment Return X509CertCheckHost BOOL True if the host name is part of the certificate. Input hCert RTS_IEC_HANDLE Handle of to certificate. pHost POINTER TO STRING Hostname to check. flags RtsX509CertCheckFlags Flags how to check for the host name. Values of the enumeration can be combined. pResult POINTER TO RTS_IEC_RESULT Pointer to the error code. ERR_PARAMETER: hCert is invalid, ERR_OK: everything went fine.

X509CertCheckIP (FUN) ¶ FUNCTION X509CertCheckIP : BOOL Check if a certificate is bound to a specific IP Address. InOut: Scope Name Type Comment Return X509CertCheckIP BOOL True if the IP is part of the certificate. Input hCert RTS_IEC_HANDLE Handle of to certificate. pIP POINTER TO SysSocket_Interfaces.INADDR IP adress to check in network byte order flags RtsX509CertCheckFlags Flags how to check for the IP address. Values of the enumeration can be combined. pResult POINTER TO RTS_IEC_RESULT Pointer to the error code. ERR_PARAMETER: hCert is invalid, ERR_OK: everything went fine.

X509CertClose (FUN) ¶ FUNCTION X509CertClose : RTS_IEC_RESULT Close the certificate. InOut: Scope Name Type Comment Return X509CertClose RTS_IEC_RESULT Result of the operation. Input hCert RTS_IEC_HANDLE Handle of to certificate.

X509CertGetBinary (FUN) ¶ FUNCTION X509CertGetBinary : RTS_IEC_RESULT Get the certificate in a binary encoded format. Use the encoding parameter to set the needed format. InOut: Scope Name Type Comment Return X509CertGetBinary RTS_IEC_RESULT Result of the operation. Input hCert RTS_IEC_HANDLE Handle of the certificate of intrest. encoding RtsCertEncoding How to encode the certificate. pCert POINTER TO RtsByteString Buffer where to store the certificate. If the bytestring contains a NULL memory pointer the function will write the needed bufferlength to the pCert->ui32Length member.

X509CertGetContent (FUN) ¶ FUNCTION X509CertGetContent : RTS_IEC_RESULT Get some common content from the certificate. InOut: Scope Name Type Comment Return X509CertGetContent RTS_IEC_RESULT Result of the operation. Input hCert RTS_IEC_HANDLE Handle of the certificate of intrest. pCertContent POINTER TO RtsX509CertInfo Pointer where to store the information.

X509CertGetPublicKey (FUN) ¶ FUNCTION X509CertGetPublicKey : RTS_IEC_RESULT Get the PUBLIC key FROM the certificate. The format of this key is an implementation detail and has to match the expected format of the asymmetric functions of the CmpCrpyotItf. The key data is opaque for the user of the keys. If the keys are needed in a defined exchange format use the CryptoKeyExport function of the CmpCryptoItf. InOut: Scope Name Type Comment Return X509CertGetPublicKey RTS_IEC_RESULT Result of the operation. Input hCert RTS_IEC_HANDLE Handle of the certificate of intrest. pPublicKey POINTER TO RtsCryptoKey Pointer to the crypto key storing the public key.