File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:04:15 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpX509Cert_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpX509Cert_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 02.03.2023, 11:04:13 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpX509Cert_Itfs Title CmpX509Cert Interfaces Version version 3.5.19.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpCrypto Interfaces ¶ Library Identification ¶ Name: CmpCrypto Interfaces Version: newest Company: System Namespace: CmpCrypto_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpCrypto Interfaces, * (System) CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) SysSocket Interfaces ¶ Library Identification ¶ Name: SysSocket Interfaces Version: newest Company: System Namespace: SysSocket_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSocket Interfaces, * (System) SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)
X509CertStoreRemoveCert (FUN) ¶ FUNCTION X509CertStoreRemoveCert : RTS_IEC_RESULT Remove the certificate from the store. InOut: Scope Name Type Comment Return X509CertStoreRemoveCert RTS_IEC_RESULT Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. hBackend RTS_IEC_HANDLE Handle to the back-end where to store the generated certificate. RTS_INVALID_HANDLE should be used if no back- end is specified. hCert RTS_IEC_HANDLE Handle of the certificate to remove. xRemovePrivateKey BOOL Select if the private key of the certificate should be deleted too. If the certificate is renewed the same private key the key shouldn’t be deleted.
X509CertStoreSearchGetNext (FUN) ¶ FUNCTION X509CertStoreSearchGetNext : RTS_IEC_HANDLE Search for the given certificate in the cert store. InOut: Scope Name Type Comment Return X509CertStoreSearchGetNext RTS_IEC_HANDLE Handle to the next certificate matching the filter criteria. Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. hCert RTS_IEC_HANDLE Handle of the last found certificate. pFilters POINTER TO RtsX509CertFilter Pointer to array of filters to be applied. ui32NumOfFilters UDINT Number of applied filters. pResult POINTER TO RTS_IEC_RESULT
X509CertStoreUnregister (FUN) ¶ FUNCTION X509CertStoreUnregister : RTS_IEC_RESULT Unregister the component from the certificate store. This disables certificate generation for that specific use case. InOut: Scope Name Type Comment Return X509CertStoreUnregister RTS_IEC_RESULT Input hCertStore RTS_IEC_HANDLE Handle of to certificate store hRegisteredComponent RTS_IEC_HANDLE Handle to the entry retrieved by X509CertStoreRegister
X509CertVerify (FUN) ¶ FUNCTION X509CertVerify : RTS_IEC_RESULT Verify the given certificate. This verify checks only if the certificate itself is trusted using the certificates in the store. The verify checks if the certificate was added to the untrusted certs list. No subjects, key usages or other fields are verified. This has to be done by the application using this function. If the verify should use CRL to verify the certificates set the setting VerifyUseCRL to 1. This is disabled by default. InOut: Scope Name Type Comment Return X509CertVerify RTS_IEC_RESULT Result of the verification. Refer to ERR_CERT_ … error codes Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. hCert RTS_IEC_HANDLE Certificate to verify.
X509CertVerify2 (FUN) ¶ FUNCTION X509CertVerify2 : RTS_IEC_RESULT Verify the given certificate. THIS verify checks only IF the certificate itself is trusted using the certificates in the store. The verify checks if the certificate was added to the untrusted certs list. No subjects, key usages or other fields are verified. This has to be done by the application using this function. This is disabled by default. InOut: Scope Name Type Comment Return X509CertVerify2 RTS_IEC_RESULT Result of certificate validation. One of the ERR_CERT_ … error codes. Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. hCert RTS_IEC_HANDLE Certificate to verify. validationTimestamp SYSTIME The time-stamp used to verify the certificate. Same timebase as UtcHighresGet. If 0 the current time will be used. verificationFlags RtsX509VerifyFlags Flags to configure the verification process. See RTSX509VERIFYFLAGS for details.
UtilityFunctions ¶ RtsOIDClear (Function) RtsOIDCreate (Function) RtsOIDGetID (Function) RtsOIDGetName (Function) X509CertInfoExit (Function) X509CertInfoInit (Function)
RtsOIDClear (FUN) ¶ FUNCTION RtsOIDClear : RTS_IEC_RESULT Clear an OID InOut: Scope Name Type Comment Return RtsOIDClear RTS_IEC_RESULT Result of the operation Input oid POINTER TO RtsOID
RtsOIDCreate (FUN) ¶ FUNCTION RtsOIDCreate : RTS_IEC_RESULT Create an RtsOID based on a given ID. InOut: Scope Name Type Comment Return RtsOIDCreate RTS_IEC_RESULT Result of the operation. Input id POINTER TO STRING OID as string in dottet format. E.g. (1.2.3.4.5.6.7.8.9.0) oid POINTER TO RtsOID Pointer to an OID to fill up.