X509CertStoreGetRegisteredCert (FUN) ¶ FUNCTION X509CertStoreGetRegisteredCert : RTS_IEC_HANDLE Get the certificate available for a registered use case. If not certificate is available RTS_INVALID_HANDLE will be returned. The following rules apply for selecting the certificate: Check if a certificate is configured by the user. (The thumb-print is pinned for component and index). Use this one if available, return error if not available. If no certificate is configured filter the available certificates by subject, key usage, extended key usage and a valid timestamp. Return error if list is empty. Split the available certificates by signed and self signed certificates. Prefer the signed certificates over the self signed certificates: Select the certificate with the longest period of validity. If some certificates have the same period of validity select the one with the strongest key. InOut: Scope Name Type Comment Return X509CertStoreGetRegisteredCert RTS_IEC_HANDLE Handle to the certificate. Use X509CertClose to close the certificate. Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. hUseCase RTS_IEC_HANDLE Handle to the registered use case. Retrieved using X509CertStoreRegister. pResult POINTER TO RTS_IEC_RESULT Pointer to error code
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpX509Cert Implementation ¶ Library Identification ¶ Placeholder: CmpX509Cert Implementation Default Resolution: CmpX509Cert Implementation, * (System) Namespace: CmpX509Cert_Implementation Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpX509Cert Implementation CmpX509Cert Interfaces ¶ Library Identification ¶ Name: CmpX509Cert Interfaces Version: newest Company: System Namespace: CmpX509Cert_Interfaces Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpX509Cert Interfaces, * (System)
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:59:16 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpX509Cert.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpX509Cert.clean.json version version 2.0.0.0 ProjectInformation IsCommonLibraryContainer bool True IsEndUserLibrary False Released True LastModificationDateTime date 20.04.2021, 15:59:16 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace Description See: Description DocFormat reStructuredText Placeholder CmpX509Cert Project CmpX509Cert Title CmpX509Cert Version version 3.5.17.0
CmpX509Cert Interfaces Library Documentation ¶ Company System Title CmpX509Cert Interfaces Version 3.5.19.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library contains data types to access the runtime certificate store and allow the handling of certificates in different formats Contents: ¶ CmpX509Cert Interfaces Constants Enums Structs Types Indices and tables ¶ 1 Based on CmpX509Cert_Itfs.library, last modified 02.03.2023, 11:04:13. LibDoc 4.4.0.0-b.27 The content file CmpX509Cert_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:04:15.
Constants ¶ KnownOIDs (GVL) X509CertKeyUsage (GVL)
CmpX509Cert Interfaces ¶ Constants KnownOIDs (GVL) X509CertKeyUsage (GVL) Enums RtsCertEncoding (Enum) RtsCertTrustLevel (Enum) RtsX509AltNameType (Enum) RtsX509CertCheckFlags (Enum) RtsX509CertFilterType (Enum) RtsX509VerifyFlags (Enum) Structs RtsOID (Struct) RtsX509AltName (Struct) RtsX509CertFilter (Struct) RtsX509CertInfo (Struct) RtsX509CertName (Struct) RtsX509ExKeyUsage (Struct) RtsX509NameEntry (Struct) Types RtsOIDStore (Union) RtsX509AltNameStore (Union) RtsX509CertFilterContent (Union)
KnownOIDs (GVL) ¶ Cannot be exportet until CDS-48228 is fixed {attribute ‘m4export’} InOut: Scope Name Type Initial Comment Constant RTS_OID_COUNTRY_NAME STRING ‘2.5.4.6’ OID used in certificate subject and issuer fields RTS_OID_ORGANIZATION_NAME STRING ‘2.5.4.10’ RTS_OID_ORGANIZATIONAL_UNIT_NAME STRING ‘2.5.4.11’ RTS_OID_COMMON_NAME STRING ‘2.5.4.3’ RTS_OID_LOCALITY_NAME STRING ‘2.5.4.7’ RTS_OID_STATE_OR_PROVINCE_NAME STRING ‘2.5.4.8’ RTS_OID_TITLE STRING ‘2.5.4.12’ RTS_OID_GIVEN_NAME STRING ‘2.5.4.42’ RTS_OID_INITIALS STRING ‘2.5.4.43’ RTS_OID_SUR_NAME STRING ‘2.5.4.4’ RTS_OID_DOMAIN_COMPONENT STRING ‘0.9.2342.19200300.100.1.25’ RTS_OID_RSA_EMAILADDR STRING ‘1.2.840.113549.1.9.1’ RTS_OID_STREET_ADDRESS STRING ‘2.5.4.9’ RTS_OID_RSA_UNSTRUCTNAME STRING ‘1.2.840.113549.1.9.2’ RTS_OID_RSA_UNSTRUCTADDR STRING ‘1.2.840.113549.1.9.8’ RTS_OID_DEVICE_SERIAL_NUMBER STRING ‘2.5.4.5’ RTS_OID_TLS_WEBSERVER_AUTHENTICATION STRING ‘1.3.6.1.5.5.7.3.1’ RTS_OID_TLS_WEBCLIENT_AUTHENTICATION STRING ‘1.3.6.1.5.5.7.3.2’
X509CertKeyUsage (GVL) ¶ Cannot be exported until CDS-48228 is fixed {attribute ‘m4export’} InOut: Scope Name Type Initial Constant RTS_KEY_USAGE_DIGITAL_SIGNATURE UDINT 16#1 RTS_KEY_USAGE_DIGITAL_SIGNATURE_STR STRING ‘Digital Signature’ RTS_KEY_USAGE_NON_REPUDIATION UDINT 16#2 RTS_KEY_USAGE_NON_REPUDIATION_STR STRING ‘Non Repudiation’ RTS_KEY_USAGE_ENCIPHERMENT UDINT 16#4 RTS_KEY_USAGE_ENCIPHERMENT_STR STRING ‘Key Encipherment’ RTS_KEY_USAGE_DATA_ENCIPHERMENT UDINT 16#8 RTS_KEY_USAGE_DATA_ENCIPHERMENT_STR STRING ‘Data Encipherment’ RTS_KEY_USAGE_KEY_AGREEMENT UDINT 16#10 RTS_KEY_USAGE_KEY_AGREEMENT_STR STRING ‘Key Agreement’ RTS_KEY_USAGE_CERTIFICATE_SIGN UDINT 16#20 RTS_KEY_USAGE_CERTIFICATE_SIGN_STR STRING ‘Certificate Sign’ RTS_KEY_USAGE_CRL_SIGN UDINT 16#40 RTS_KEY_USAGE_CRL_SIGN_STR STRING ‘CRL Sign’ RTS_KEY_USAGE_ENCIPHER_ONLY UDINT 16#80 RTS_KEY_USAGE_ENCIPHER_ONLY_STR STRING ‘Encipher Only’ RTS_KEY_USAGE_DECIPHER_ONLY UDINT 16#100 RTS_KEY_USAGE_DECIPHER_ONLY_STR STRING ‘Decipher Only’
Enums ¶ RtsCertEncoding (Enum) RtsCertTrustLevel (Enum) RtsX509AltNameType (Enum) RtsX509CertCheckFlags (Enum) RtsX509CertFilterType (Enum) RtsX509VerifyFlags (Enum)
RtsCertEncoding (ENUM) ¶ TYPE RtsCertEncoding : Attributes: qualified_only InOut: Name Initial ASN1 0 BASE64
