---
product: Chilkat
product_version: 11.7.0
language: phpext
language_label: PHP Extension
class: Cert
class_name: CkCert
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/phpCkCertRef.html
---
# Chilkat Cert — PHP Extension — v11.7.0

> Chilkat 11.7.0 · language=phpext · class=Cert (CkCert)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Cert.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/guide.md`.

## Purpose

**Load, inspect, validate, and use X.509 certificates throughout Chilkat.**

`Chilkat.Cert` is the central certificate object used throughout Chilkat for TLS, S/MIME, PKCS7/CMS, PDF signing, XML signing, code signing, decryption, certificate stores, smart cards, HSMs, PKCS#11, and cloud-based signing. It provides a broad set of features for loading certificates, inspecting certificate fields, checking validity, accessing private keys, building chains, checking revocation status, exporting certificate data, and diagnosing certificate-related problems.

**Load certificates**

Load public certificates from PEM, DER, Base64, files, strings, binary data, certificate stores, PFX/P12 files, smart cards, and other sources.

**Inspect certificate details**

Read subject and issuer fields, serial numbers, fingerprints, validity dates, key usage, extensions, SAN values, and other X.509 information.

**Private key access**

Work with certificates backed by private keys from PFX/P12 files, OS certificate stores, smart cards, HSMs, PKCS#11 modules, or cloud signing providers.

**Trust and validation**

Build and inspect certificate chains, verify signatures, check expiration, examine trust-related information, and work with revocation data.

**Use across Chilkat**

Pass `Cert` objects to other Chilkat classes for TLS client authentication, S/MIME, signing, encryption, decryption, and verification.

**Export and diagnostics**

Export certificate data in common formats and use detailed diagnostic output to troubleshoot loading, validation, private-key, chain, or store problems.

**Common pattern:** Use certificate-only formats such as PEM or DER when only the public certificate is needed. Use PFX/P12, an OS certificate store, smart-card loading, PKCS#11 linking, HSM integration, or cloud-signing configuration when a private key operation is required.

For an extended overview, see [Cert Class Overview](https://www.chilkatsoft.com/cert_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```php
$obj = new CkCert();
```

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PHP Extension.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string debugLogFilePath(); void put_DebugLogFilePath(string strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `(read-only) string lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `(read-only) string lastErrorText();` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `(read-only) string lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess() void put_LastMethodSuccess(bool boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `Utf8` | `bool get_Utf8() void put_Utf8(bool boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `bool get_VerboseLogging() void put_VerboseLogging(bool boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `(read-only) string version();` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AuthorityKeyId` | property, read-only | `(read-only) string authorityKeyId();` |
| `AvoidWindowsPkAccess` | property, read/write | `bool get_AvoidWindowsPkAccess() void put_AvoidWindowsPkAccess(bool boolVal);` |
| `CertVersion` | property, read-only | `(read-only) int get_CertVersion()` |
| `Expired` | property, read-only | `(read-only) bool get_Expired()` |
| `ExtendedKeyUsage` | property, read-only | `(read-only) string extendedKeyUsage();` |
| `ForClientAuthentication` | property, read-only | `(read-only) bool get_ForClientAuthentication()` |
| `ForCodeSigning` | property, read-only | `(read-only) bool get_ForCodeSigning()` |
| `ForSecureEmail` | property, read-only | `(read-only) bool get_ForSecureEmail()` |
| `ForServerAuthentication` | property, read-only | `(read-only) bool get_ForServerAuthentication()` |
| `ForTimeStamping` | property, read-only | `(read-only) bool get_ForTimeStamping()` |
| `IntendedKeyUsage` | property, read-only | `(read-only) int get_IntendedKeyUsage()` |
| `IsRoot` | property, read-only | `(read-only) bool get_IsRoot()` |
| `IssuerC` | property, read-only | `(read-only) string issuerC();` |
| `IssuerCN` | property, read-only | `(read-only) string issuerCN();` |
| `IssuerDN` | property, read-only | `(read-only) string issuerDN();` |
| `IssuerE` | property, read-only | `(read-only) string issuerE();` |
| `IssuerL` | property, read-only | `(read-only) string issuerL();` |
| `IssuerO` | property, read-only | `(read-only) string issuerO();` |
| `IssuerOU` | property, read-only | `(read-only) string issuerOU();` |
| `IssuerS` | property, read-only | `(read-only) string issuerS();` |
| `OcspUrl` | property, read-only | `(read-only) string ocspUrl();` |
| `PrivateKeyExportable` | property, read-only | `(read-only) bool get_PrivateKeyExportable()` |
| `Revoked` | property, read-only | `(read-only) bool get_Revoked()` |
| `Rfc822Name` | property, read-only | `(read-only) string rfc822Name();` |
| `SelfSigned` | property, read-only | `(read-only) bool get_SelfSigned()` |
| `SerialDecimal` | property, read-only | `(read-only) string serialDecimal();` |
| `SerialNumber` | property, read-only | `(read-only) string serialNumber();` |
| `Sha1Thumbprint` | property, read-only | `(read-only) string sha1Thumbprint();` |
| `SignatureVerified` | property, read-only | `(read-only) bool get_SignatureVerified()` |
| `SmartCardFailReason` | property, read-only | `(read-only) int get_SmartCardFailReason()` |
| `SmartCardNoDialog` | property, read/write | `bool get_SmartCardNoDialog() void put_SmartCardNoDialog(bool boolVal);` |
| `SmartCardPin` | property, read/write | `string smartCardPin(); void put_SmartCardPin(string strVal);` |
| `SubjectAlternativeName` | property, read-only | `(read-only) string subjectAlternativeName();` |
| `SubjectC` | property, read-only | `(read-only) string subjectC();` |
| `SubjectCN` | property, read-only | `(read-only) string subjectCN();` |
| `SubjectDN` | property, read-only | `(read-only) string subjectDN();` |
| `SubjectE` | property, read-only | `(read-only) string subjectE();` |
| `SubjectKeyId` | property, read-only | `(read-only) string subjectKeyId();` |
| `SubjectL` | property, read-only | `(read-only) string subjectL();` |
| `SubjectO` | property, read-only | `(read-only) string subjectO();` |
| `SubjectOU` | property, read-only | `(read-only) string subjectOU();` |
| `SubjectS` | property, read-only | `(read-only) string subjectS();` |
| `TrustedRoot` | property, read-only | `(read-only) bool get_TrustedRoot()` |
| `UncommonOptions` | property, read/write | `string uncommonOptions(); void put_UncommonOptions(string strVal);` |
| `ValidFromStr` | property, read-only | `(read-only) string validFromStr();` |
| `ValidToStr` | property, read-only | `(read-only) string validToStr();` |
| `BuildCertChain` | method | `bool BuildCertChain(CkCertChain $certChain);` |
| `CheckRevoked` | method | `int CheckRevoked();` |
| `CheckSmartCardPin` | method | `int CheckSmartCardPin();` |
| `ExportCertDerBd` | method | `bool ExportCertDerBd(CkBinData $cerData);` |
| `ExportCertDerFile` | method | `bool ExportCertDerFile(string $path);` |
| `ExportCertPem` | method | `bool ExportCertPem(CkString outStr); string exportCertPem();` |
| `ExportCertPemFile` | method | `bool ExportCertPemFile(string $path);` |
| `ExportCertXml` | method | `bool ExportCertXml(CkString outStr); string exportCertXml();` |
| `ExportToPfxBd` | method | `bool ExportToPfxBd(string $password, bool $includeCertChain, CkBinData $pfxData);` |
| `ExportToPfxFile` | method | `bool ExportToPfxFile(string $pfxFilename, string $pfxPassword, bool $bIncludeCertChain);` |
| `FindIssuer` | method | `CkCert FindIssuer();` |
| `GetEncoded` | method | `bool GetEncoded(CkString outStr); string getEncoded();` |
| `GetExtensionAsText` | method | `bool GetExtensionAsText(string $oid, CkString outStr); string getExtensionAsText(string oid);` |
| `GetExtensionAsXml` | method | `bool GetExtensionAsXml(string $oid, CkString outStr); string getExtensionAsXml(string oid);` |
| `GetExtensionBd` | method | `bool GetExtensionBd(string $oid, CkBinData $bd);` |
| `GetIssuer` | method | `bool GetIssuer(CkCert $issuer);` |
| `GetPrivateKey` | method | `bool GetPrivateKey(CkPrivateKey $privKey);` |
| `GetPrivateKeyPem` | method | `bool GetPrivateKeyPem(CkString outStr); string getPrivateKeyPem();` |
| `GetPubKeyDer` | method | `bool GetPubKeyDer(bool $preferPkcs1, CkBinData $bd);` |
| `GetPublicKey` | method | `bool GetPublicKey(CkPublicKey $pubKey);` |
| `GetSignature` | method | `bool GetSignature(CkBinData $bd);` |
| `GetSpkiFingerprint` | method | `bool GetSpkiFingerprint(string $hashAlg, string $encoding, CkString outStr); string getSpkiFingerprint(string hashAlg, string encoding);` |
| `GetSubjectPart` | method | `bool GetSubjectPart(string $partNameOrOid, CkString outStr); string getSubjectPart(string partNameOrOid);` |
| `HashOf` | method | `bool HashOf(string $part, string $hashAlg, string $encoding, CkString outStr); string hashOf(string part, string hashAlg, string encoding);` |
| `HasPrivateKey` | method | `bool HasPrivateKey();` |
| `IsEcdsa` | method | `bool IsEcdsa();` |
| `IsRsa` | method | `bool IsRsa();` |
| `LinkPkcs11` | method | `bool LinkPkcs11(CkPkcs11 $session);` |
| `LoadByCommonName` | method | `bool LoadByCommonName(string $cn);` |
| `LoadByEmailAddress` | method | `bool LoadByEmailAddress(string $emailAddress);` |
| `LoadByIssuerAndSerialNumber` | method | `bool LoadByIssuerAndSerialNumber(string $issuerCN, string $serialNumber);` |
| `LoadBySubjectOid` | method | `bool LoadBySubjectOid(string $oid, string $value);` |
| `LoadByThumbprint` | method | `bool LoadByThumbprint(string $thumbprint, string $encoding);` |
| `LoadFromBase64` | method | `bool LoadFromBase64(string $encodedCert);` |
| `LoadFromBd` | method | `bool LoadFromBd(CkBinData $certBytes);` |
| `LoadFromFile` | method | `bool LoadFromFile(string $path);` |
| `LoadFromSmartcard` | method | `bool LoadFromSmartcard(string $certSpec);` |
| `LoadPem` | method | `bool LoadPem(string $strPem);` |
| `LoadPfxBd` | method | `bool LoadPfxBd(CkBinData $pfxData, string $password);` |
| `LoadPfxFile` | method | `bool LoadPfxFile(string $pfxPath, string $password);` |
| `LoadTaskResult` | method | `bool LoadTaskResult(CkTask $task);` |
| `PemFileToDerFile` | method | `bool PemFileToDerFile(string $fromPath, string $toPath);` |
| `SaveToFile` | method | `bool SaveToFile(string $path);` |
| `SetCloudSigner` | method | `bool SetCloudSigner(CkJsonObject $json);` |
| `SetFromEncoded` | method | `bool SetFromEncoded(string $encodedCert);` |
| `SetPrivateKey` | method | `bool SetPrivateKey(CkPrivateKey $privKey);` |
| `SetPrivateKeyPem` | method | `bool SetPrivateKeyPem(string $privKeyPem);` |
| `Unload` | method | `bool Unload();` |
| `UploadToCloud` | method | `bool UploadToCloud(CkJsonObject $jsonIn, CkJsonObject $jsonOut);` |
| `UseCertVault` | method | `bool UseCertVault(CkXmlCertVault $vault);` |
| `VerifySignature` | method | `bool VerifySignature();` |
| `X509PKIPathv1` | method | `bool X509PKIPathv1(CkString outStr); string x509PKIPathv1();` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Cert.AuthorityKeyId

`Chilkat 11.7.0 · phpext · Cert · AuthorityKeyId · property · read-only · since 9.5.0.40`

```php
(read-only)

string authorityKeyId();
```

The authority key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.35.

### Cert.AvoidWindowsPkAccess

`Chilkat 11.7.0 · phpext · Cert · AvoidWindowsPkAccess · property · read/write`

```php
bool get_AvoidWindowsPkAccess()

void put_AvoidWindowsPkAccess(bool boolVal);
```

Applies only when running on a Microsoft Windows operating system. If `true`, then any method that returns a certificate will not try to also access the associated private key, assuming one exists. This is useful if the certificate was installed with high-security such that a private key access would trigger the Windows OS to display a security warning dialog. The default value of this property is `false`.

### Cert.CertVersion

`Chilkat 11.7.0 · phpext · Cert · CertVersion · property · read-only`

```php
(read-only)

int get_CertVersion()
```

The version of the certificate (1, 2, or 3). A value of 0 indicates an error -- the most likely cause being that the certificate object is empty (i.e. was never loaded with a certificate). Note: This is not the version of the software, it is the version of the X.509 certificate object. The version of the Chilkat certificate software is indicated by the Version property.

### Cert.Expired

`Chilkat 11.7.0 · phpext · Cert · Expired · property · read-only`

```php
(read-only)

bool get_Expired()
```

Has a value of `true` if the certificate or any certificate in the chain of authority has expired. (This information is not available when running on Windows 95/98 computers.)

### Cert.ExtendedKeyUsage

`Chilkat 11.7.0 · phpext · Cert · ExtendedKeyUsage · property · read-only · since 9.5.0.85`

```php
(read-only)

string extendedKeyUsage();
```

Returns a string containing a comma separated list of keywords with the extended key usages of the certificate. The list of possible extended key usages are:

- serverAuth - TLS WWW server authentication
- clientAuth - TLS WWW client authentication
- codeSigning - Signing of downloadable executable code
- emailProtection - Email protection
- timeStamping - Binding the hash of an object to a time
- OCSPSigning - Signing OCSP responses

### Cert.ForClientAuthentication

`Chilkat 11.7.0 · phpext · Cert · ForClientAuthentication · property · read-only`

```php
(read-only)

bool get_ForClientAuthentication()
```

`true` if this certificate can be used for client authentication, otherwise `false`.

### Cert.ForCodeSigning

`Chilkat 11.7.0 · phpext · Cert · ForCodeSigning · property · read-only`

```php
(read-only)

bool get_ForCodeSigning()
```

`true` if this certificate can be used for code signing, otherwise `false`.

### Cert.ForSecureEmail

`Chilkat 11.7.0 · phpext · Cert · ForSecureEmail · property · read-only`

```php
(read-only)

bool get_ForSecureEmail()
```

`true` if this certificate can be used for sending secure email, otherwise `false`.

### Cert.ForServerAuthentication

`Chilkat 11.7.0 · phpext · Cert · ForServerAuthentication · property · read-only`

```php
(read-only)

bool get_ForServerAuthentication()
```

`true` if this certificate can be used for server authentication, otherwise `false`.

### Cert.ForTimeStamping

`Chilkat 11.7.0 · phpext · Cert · ForTimeStamping · property · read-only`

```php
(read-only)

bool get_ForTimeStamping()
```

`true` if this certificate can be used for time stamping, otherwise `false`.

### Cert.IntendedKeyUsage

`Chilkat 11.7.0 · phpext · Cert · IntendedKeyUsage · property · read-only`

```php
(read-only)

int get_IntendedKeyUsage()
```

Bitflags indicating the intended usages of the certificate. The flags are:  
Digital Signature: 0x80  
Non-Repudiation: 0x40  
Key Encipherment: 0x20  
Data Encipherment: 0x10  
Key Agreement: 0x08  
Certificate Signing: 0x04  
CRL Signing: 0x02  
Encipher-Only: 0x01

### Cert.IsRoot

`Chilkat 11.7.0 · phpext · Cert · IsRoot · property · read-only`

```php
(read-only)

bool get_IsRoot()
```

`true` if this is the root certificate, otherwise `false`.

### Cert.IssuerC

`Chilkat 11.7.0 · phpext · Cert · IssuerC · property · read-only`

```php
(read-only)

string issuerC();
```

The certificate issuer's country.

### Cert.IssuerCN

`Chilkat 11.7.0 · phpext · Cert · IssuerCN · property · read-only`

```php
(read-only)

string issuerCN();
```

The certificate issuer's common name.

### Cert.IssuerDN

`Chilkat 11.7.0 · phpext · Cert · IssuerDN · property · read-only`

```php
(read-only)

string issuerDN();
```

The issuer's full distinguished name.

### Cert.IssuerE

`Chilkat 11.7.0 · phpext · Cert · IssuerE · property · read-only`

```php
(read-only)

string issuerE();
```

The certificate issuer's email address.

### Cert.IssuerL

`Chilkat 11.7.0 · phpext · Cert · IssuerL · property · read-only`

```php
(read-only)

string issuerL();
```

The certificate issuer's locality, which could be a city, count, township, or other geographic region.

### Cert.IssuerO

`Chilkat 11.7.0 · phpext · Cert · IssuerO · property · read-only`

```php
(read-only)

string issuerO();
```

The certificate issuer's organization, which is typically the company name.

### Cert.IssuerOU

`Chilkat 11.7.0 · phpext · Cert · IssuerOU · property · read-only`

```php
(read-only)

string issuerOU();
```

The certificate issuer's organizational unit, which is the unit within the organization.

### Cert.IssuerS

`Chilkat 11.7.0 · phpext · Cert · IssuerS · property · read-only`

```php
(read-only)

string issuerS();
```

The certificate issuer's state or province.

### Cert.OcspUrl

`Chilkat 11.7.0 · phpext · Cert · OcspUrl · property · read-only`

```php
(read-only)

string ocspUrl();
```

If present in the certificate's extensions, returns the OCSP URL of the certificate. (The Online Certificate Status Protocol (OCSP) is an Internet protocol used for obtaining the revocation status of an X.509 digital certificate.)

### Cert.PrivateKeyExportable

`Chilkat 11.7.0 · phpext · Cert · PrivateKeyExportable · property · read-only`

```php
(read-only)

bool get_PrivateKeyExportable()
```

(Relevant only when running on a Microsoft Windows operating system.) Indicates whether the private key was installed with security settings that allow it to be re-exported.

### Cert.Revoked

`Chilkat 11.7.0 · phpext · Cert · Revoked · property · read-only`

```php
(read-only)

bool get_Revoked()
```

**Deprecated:** This property does not check the revocation status of the certificate, and always returns `false`. Do not use it to decide whether a certificate is revoked.

To check whether a certificate has been revoked, call `CheckRevoked` (Windows only), which returns 1 (revoked), 0 (not revoked), or -1 (unable to check). Applications on any operating system can also send an OCSP request to the certificate's `OcspUrl`, if the certificate has one.

(A property cannot do this work because checking revocation can require contacting a CRL distribution point or an OCSP responder over the network, which can take a long time. In some programming languages, properties are evaluated at design time in the IDE.)

**Note:** Chilkat does not check certificate revocation status during the TLS handshake. Settings such as `RequireSslCertVerify` verify signatures, expiration, and the chain to a trusted root, but not revocation. To reject a revoked server certificate, the application must check it after connecting.

### Cert.Rfc822Name

`Chilkat 11.7.0 · phpext · Cert · Rfc822Name · property · read-only`

```php
(read-only)

string rfc822Name();
```

The RFC822 name of the certificate. (The RFC822 name is one part of the Subject Alternative Name extension of a certificate, if it exists. It is often the only part of the SAN.)

If the certificate contains a list of RFC822 names then this property will return the comma separated list of names.

Starting in Chilkat v9.5.0.85, to get the complete Subject Alternative Name extension as XML, use the SubjectAlternativeName property.

### Cert.SelfSigned

`Chilkat 11.7.0 · phpext · Cert · SelfSigned · property · read-only`

```php
(read-only)

bool get_SelfSigned()
```

`true` if this is a self-signed certificate, otherwise `false`.

### Cert.SerialDecimal

`Chilkat 11.7.0 · phpext · Cert · SerialDecimal · property · read-only · since 9.5.0.75`

```php
(read-only)

string serialDecimal();
```

The certificate's serial number as a decimal string.

### Cert.SerialNumber

`Chilkat 11.7.0 · phpext · Cert · SerialNumber · property · read-only`

```php
(read-only)

string serialNumber();
```

The certificate's serial number as a hexidecimal string.

### Cert.Sha1Thumbprint

`Chilkat 11.7.0 · phpext · Cert · Sha1Thumbprint · property · read-only`

```php
(read-only)

string sha1Thumbprint();
```

Hexidecimal string of the SHA-1 thumbprint for the certificate. (This is the SHA1 hash of the binary DER representation of the entire X.509 certificate.)

### Cert.SignatureVerified

`Chilkat 11.7.0 · phpext · Cert · SignatureVerified · property · read-only`

```php
(read-only)

bool get_SignatureVerified()
```

Returns `true` if the certificate and all certificates in the chain of authority have valid signatures, otherwise returns `false`.

### Cert.SmartCardFailReason

`Chilkat 11.7.0 · phpext · Cert · SmartCardFailReason · property · read-only · since 10.1.0`

```php
(read-only)

int get_SmartCardFailReason()
```

Set after calling LoadFromSmartcard. Possible values are:

- 0 - No failure. The call to LoadFromSmartcard was successful.
- 1 - No smartcard or USB token was detected.
- 2 - The SmartCardPin was provided and the PIN login failed. (Note: Chilkat only PIN authenticates if PKCS11 was the chosen means for communicating with the smartcard.)
- 3 - The certificate matching the specified criteria was not found.
- 99 - Some other undefined failure. Consult the LastErrorText for more information.

### Cert.SmartCardNoDialog

`Chilkat 11.7.0 · phpext · Cert · SmartCardNoDialog · property · read/write · since 9.5.0.77`

```php
bool get_SmartCardNoDialog()

void put_SmartCardNoDialog(bool boolVal);
```

If set to `true`, then no dialog will automatically popup if the SmartCardPin is incorrect. Instead, the method requiring the private key on the smart card will fail. The default value of this property is `false`, which means that if the SmartCardPin property is incorrect, a dialog with prompt will be displayed.

### Cert.SmartCardPin

`Chilkat 11.7.0 · phpext · Cert · SmartCardPin · property · read/write · since 9.5.0.75`

```php
string smartCardPin();

void put_SmartCardPin(string strVal);
```

Can be set to the PIN value for a certificate / private key stored on a smart card.

### Cert.SubjectAlternativeName

`Chilkat 11.7.0 · phpext · Cert · SubjectAlternativeName · property · read-only · since 9.5.0.85`

```php
(read-only)

string subjectAlternativeName();
```

The subject alternative name (SAN) name of the certificate returned as XML. See the examples linked below.

### Cert.SubjectC

`Chilkat 11.7.0 · phpext · Cert · SubjectC · property · read-only`

```php
(read-only)

string subjectC();
```

The certificate subject's country.

### Cert.SubjectCN

`Chilkat 11.7.0 · phpext · Cert · SubjectCN · property · read-only`

```php
(read-only)

string subjectCN();
```

The certificate subject's common name.

### Cert.SubjectDN

`Chilkat 11.7.0 · phpext · Cert · SubjectDN · property · read-only`

```php
(read-only)

string subjectDN();
```

The certificate subject's full distinguished name.

### Cert.SubjectE

`Chilkat 11.7.0 · phpext · Cert · SubjectE · property · read-only`

```php
(read-only)

string subjectE();
```

The certificate subject's email address.

### Cert.SubjectKeyId

`Chilkat 11.7.0 · phpext · Cert · SubjectKeyId · property · read-only · since 9.5.0.40`

```php
(read-only)

string subjectKeyId();
```

The subject key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.14.

### Cert.SubjectL

`Chilkat 11.7.0 · phpext · Cert · SubjectL · property · read-only`

```php
(read-only)

string subjectL();
```

The certificate subject's locality, which could be a city, count, township, or other geographic region.

### Cert.SubjectO

`Chilkat 11.7.0 · phpext · Cert · SubjectO · property · read-only`

```php
(read-only)

string subjectO();
```

The certificate subject's organization, which is typically the company name.

### Cert.SubjectOU

`Chilkat 11.7.0 · phpext · Cert · SubjectOU · property · read-only`

```php
(read-only)

string subjectOU();
```

The certificate subject's organizational unit, which is the unit within the organization.

### Cert.SubjectS

`Chilkat 11.7.0 · phpext · Cert · SubjectS · property · read-only`

```php
(read-only)

string subjectS();
```

The certificate subject's state or province.

### Cert.TrustedRoot

`Chilkat 11.7.0 · phpext · Cert · TrustedRoot · property · read-only`

```php
(read-only)

bool get_TrustedRoot()
```

Returns `true` if the certificate has a trusted root authority, otherwise returns `false`.

Note: As of version 9.5.0.41, the notion of what your application deems as trusted becomes more specific. The TrustedRoots class/object was added in v9.5.0.0. Prior to this, a certificate was considered to be anchored by a trusted root if the certificate chain could be established to a root (self-signed) certificate, AND if the root certificate was located somewhere in the Windows registry-based certificate stores. There are two problems with this: (1) it's a Windows-only solution. This property would always return `false` on non-Windows systems, and (2) it might be considered not a strong enough set of conditions for trusting a root certificate.

As of version 9.5.0.41, this property pays attention to the new TrustedRoots class/object, which allows for an application to specificallly indicate which root certificates are to be trusted. Certificates may be added to the TrustedRoots object via the LoadCaCertsPem or AddCert methods, and then activated by calling the TrustedRoots.Activate method. The activated trusted roots are deemed to be trusted in any Chilkat API method/property that needs to make this determination. In addition, the TrustedRoots object has a property named TrustSystemCaRoots, which defaults to `true`, which allows for backward compatibility. It will trust CA certificates stored in the Windows registry-based certificate stores, or if on Linux, will trust certificates found in /etc/ssl/certs/ca-certificates.crt.

### Cert.UncommonOptions

`Chilkat 11.7.0 · phpext · Cert · UncommonOptions · property · read/write · since 9.5.0.87`

```php
string uncommonOptions();

void put_UncommonOptions(string strVal);
```

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty. Possible comma separated keywords can include:

- `CheckRevokedCacheOnly`: Added in `v11.2.0`. In the `CheckRevoked` method, prevents network access and only checks the cached revocation information on the local computer.

### Cert.ValidFromStr

`Chilkat 11.7.0 · phpext · Cert · ValidFromStr · property · read-only`

```php
(read-only)

string validFromStr();
```

The date (in RFC822 string format) that this certificate becomes (or became) valid. It is a GMT/UTC date that is returned.

### Cert.ValidToStr

`Chilkat 11.7.0 · phpext · Cert · ValidToStr · property · read-only`

```php
(read-only)

string validToStr();
```

The date (in RFC822 string format) that this certificate expires. It is a GMT/UTC date that is returned.

## Methods

### Cert.BuildCertChain

`Chilkat 11.7.0 · phpext · Cert · BuildCertChain · method · since 11.0.0`

```php
bool BuildCertChain(CkCertChain $certChain);
```

Builds the certificate chain in `certChain` containing all the certificates (including this one), in the chain of authentication to the trusted root (if possible). If this certificate object was loaded from a PFX, then the certiicates contained in the PFX are automatically available for building the certificate chain. The UseCertVault method can be called to provide additional certificates that might be required to build the cert chain. Finally, the TrustedRoots object can be used to provide a way of making trusted root certificates available.

Note: Returns `true` even if certificate chain is not completed to the root. The certificate chain's ReachesRoot property can be examined to see if the chain was completed to the root.

On Windows systems, the registry-based certificate stores are automatically consulted if needed to locate intermediate or root certificates in the chain. Chilkat searches certificate stores in the following order. See [System Store Locations](https://docs.microsoft.com/en-us/windows/desktop/seccrypto/system-store-locations) for more information.

1. Current-User `CA` Certificate Store
2. Local-Machine `CA` Certificate Store
3. Current-User `Root` Certificate Store
4. Local-Machine `Root` Certificate Store
5. Current-User `MY` Certificate Store
6. Local-Machine `MY` Certificate Store
7. Current-User `ADDRESSBOOK` Certificate Store (if it exists)
8. Local-Machine `ADDRESSBOOK` Certificate Store (if it exists)

Returns true for success, false for failure.

### Cert.CheckRevoked

`Chilkat 11.7.0 · phpext · Cert · CheckRevoked · method`

```php
int CheckRevoked();
```

Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.

**Note:** This method is only implemented on Windows systems. It uses the underlying Microsoft CertVerifyRevocation Platform SDK function to check the revocation status of a certificate. (Search `CertVerifyRevocation` to get information about it.) Starting in `v11.2.0`, the keyword `"CheckRevokedCacheOnly"` can be included in the `UncommonOptions` to prevent the Microsoft revocation handler from accessing any network based resources for revocation checking. In other words, just check the cached revocation information on the local computer.

`CertVerifyRevocation` can use the certificate's CRL distribution points as well as OCSP. If it returns -1, see the `LastErrorText`. One cause is that the issuing intermediate CA certificate is not present in the Windows certificate store.

Non-Windows (and Windows) applications can send an OCSP request as shown in the example below. Note that some CAs publish revocation status only through CRLs, not OCSP. For example, Let's Encrypt removed the OCSP URL from its certificates in May 2025 and shut down its OCSP responders in August 2025, so an OCSP request is not possible for current Let's Encrypt certificates.

### Cert.CheckSmartCardPin

`Chilkat 11.7.0 · phpext · Cert · CheckSmartCardPin · method · since 9.5.0.77`

```php
int CheckSmartCardPin();
```

Verifies that the SmartCardPin property setting is correct. Returns 1 if correct, 0 if incorrect, and -1 if unable to check because the underlying CSP does not support the functionality.

### Cert.ExportCertDerBd

`Chilkat 11.7.0 · phpext · Cert · ExportCertDerBd · method · since 9.5.0.70`

```php
bool ExportCertDerBd(CkBinData $cerData);
```

Exports the digital certificate in ASN.1 DER format to a BinData object.

Returns true for success, false for failure.

### Cert.ExportCertDerFile

`Chilkat 11.7.0 · phpext · Cert · ExportCertDerFile · method`

```php
bool ExportCertDerFile(string $path);
```

Exports the digital certificate to ASN.1 DER format binary file.

Returns true for success, false for failure.

### Cert.ExportCertPem

`Chilkat 11.7.0 · phpext · Cert · ExportCertPem · method`

```php
bool ExportCertPem(CkString outStr);

string exportCertPem();
```

Exports the digital certificate to an unencrypted PEM formatted string.

Returns true for success, false for failure.

### Cert.ExportCertPemFile

`Chilkat 11.7.0 · phpext · Cert · ExportCertPemFile · method`

```php
bool ExportCertPemFile(string $path);
```

Exports the digital certificate to an unencrypted PEM formatted file.

Returns true for success, false for failure.

### Cert.ExportCertXml

`Chilkat 11.7.0 · phpext · Cert · ExportCertXml · method`

```php
bool ExportCertXml(CkString outStr);

string exportCertXml();
```

Exports a certificate to an XML format where the XML tags are the names of the ASN.1 objects that compose the X.509 certificate. Binary data is either hex or base64 encoded. (The binary data for a `bits` ASN.1 tag is hex encoded, whereas for all other ASN.1 tags, such as `octets`, it is base64.)

Returns true for success, false for failure.

### Cert.ExportToPfxBd

`Chilkat 11.7.0 · phpext · Cert · ExportToPfxBd · method · since 9.5.0.70`

```php
bool ExportToPfxBd(string $password, bool $includeCertChain, CkBinData $pfxData);
```

Exports the certificate and private key (if available) to `pfxData`. The `password` is what will be required to access the PFX contents at a later time. If `includeCertChain` is `true`, then the certificates in the chain of authority are also included in the PFX.

Returns true for success, false for failure.

### Cert.ExportToPfxFile

`Chilkat 11.7.0 · phpext · Cert · ExportToPfxFile · method`

```php
bool ExportToPfxFile(string $pfxFilename, string $pfxPassword, bool $bIncludeCertChain);
```

Exports the certificate and private key (if available) to a PFX (.pfx or .p12) file. The output PFX is secured using the `pfxPassword`. If `bIncludeCertChain` is `true`, then the certificates in the chain of authority are also included in the PFX output file.

Returns true for success, false for failure.

### Cert.FindIssuer

`Chilkat 11.7.0 · phpext · Cert · FindIssuer · method`

```php
CkCert FindIssuer();
```

Finds and returns the issuer certificate. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate. (The IsRoot property can be check to see if the certificate is a root (or self-issued) certificate.)

Returns `null` on failure

### Cert.GetEncoded

`Chilkat 11.7.0 · phpext · Cert · GetEncoded · method`

```php
bool GetEncoded(CkString outStr);

string getEncoded();
```

Returns a base64 encoded string representation of the certificate's binary DER format, which can be passed to SetFromEncoded to recreate the certificate object.

Returns true for success, false for failure.

### Cert.GetExtensionAsText

`Chilkat 11.7.0 · phpext · Cert · GetExtensionAsText · method · since 9.5.0.89`

```php
bool GetExtensionAsText(string $oid, CkString outStr);

string getExtensionAsText(string oid);
```

Returns the certificate extension data as a string. This method should only be called for those extensions with text values NOT stored as binary ASN.1. In most cases, applications should call GetExtensionAsXml because most extensions contain ASN.1 values that need to be decoded..

Returns true for success, false for failure.

### Cert.GetExtensionAsXml

`Chilkat 11.7.0 · phpext · Cert · GetExtensionAsXml · method · since 9.5.0.49`

```php
bool GetExtensionAsXml(string $oid, CkString outStr);

string getExtensionAsXml(string oid);
```

Returns the certificate extension data in XML format (converted from ASN.1). The `oid` is an OID, such as the ones listed here: http://www.alvestrand.no/objectid/2.5.29.html

Note: In many cases, the data within the XML is returned base64 encoded. An application may need to take one further step to base64 decode the information contained within the XML.

Returns true for success, false for failure.

### Cert.GetExtensionBd

`Chilkat 11.7.0 · phpext · Cert · GetExtensionBd · method · since 9.5.0.96`

```php
bool GetExtensionBd(string $oid, CkBinData $bd);
```

Returns the certificate extension data specified by `oid` in `bd`.

Returns true for success, false for failure.

### Cert.GetIssuer

`Chilkat 11.7.0 · phpext · Cert · GetIssuer · method · since 11.0.0`

```php
bool GetIssuer(CkCert $issuer);
```

Finds and returns the issuer certificate in `issuer`. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate. (The IsRoot property can be check to see if the certificate is a root (or self-issued) certificate.)

Returns true for success, false for failure.

### Cert.GetPrivateKey

`Chilkat 11.7.0 · phpext · Cert · GetPrivateKey · method · since 11.0.0`

```php
bool GetPrivateKey(CkPrivateKey $privKey);
```

Loads the `privKey` with the certificate's private key, if it exists. Returns `false` if the certificate has no associated private key.

Returns true for success, false for failure.

### Cert.GetPrivateKeyPem

`Chilkat 11.7.0 · phpext · Cert · GetPrivateKeyPem · method`

```php
bool GetPrivateKeyPem(CkString outStr);

string getPrivateKeyPem();
```

Exports the certificate's private key to a PEM string (if the private key is available).

Returns true for success, false for failure.

### Cert.GetPubKeyDer

`Chilkat 11.7.0 · phpext · Cert · GetPubKeyDer · method · since 9.5.0.92`

```php
bool GetPubKeyDer(bool $preferPkcs1, CkBinData $bd);
```

Loads the `bd` with the certificate's public key in ASN.1 DER format. If the key type (such as RSA) supports both PKCS1 and PKCS8 formats, then `preferPkcs1` selects which format to return.

Returns true for success, false for failure.

### Cert.GetPublicKey

`Chilkat 11.7.0 · phpext · Cert · GetPublicKey · method · since 11.0.0`

```php
bool GetPublicKey(CkPublicKey $pubKey);
```

Loads the `pubKey` with the certificate's public key.

Returns true for success, false for failure.

### Cert.GetSignature

`Chilkat 11.7.0 · phpext · Cert · GetSignature · method · since 9.5.0.92`

```php
bool GetSignature(CkBinData $bd);
```

Loads the `bd` with the certificate's signature.

Returns true for success, false for failure.

### Cert.GetSpkiFingerprint

`Chilkat 11.7.0 · phpext · Cert · GetSpkiFingerprint · method · since 9.5.0.55`

```php
bool GetSpkiFingerprint(string $hashAlg, string $encoding, CkString outStr);

string getSpkiFingerprint(string hashAlg, string encoding);
```

**Full documentation for this method (same in every language):** [List of Chilkat Encoding Modes](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Returns the SPKI Fingerprint suitable for use in pinning. (See RFC 7469.) An SPKI Fingerprint is defined as the output of a known cryptographic hash algorithm whose input is the DER-encoded ASN.1 representation of the Subject Public Key Info (SPKI) of an X.509 certificate. The `hashAlg` specifies the hash algorithm and may be `sha256`, `sha384`, `sha512`, `sha1`, `md2`, `md5`, `haval`, `ripemd128`, `ripemd160`,`ripemd256`, or `ripemd320`. The `encoding` specifies the encoding, and may be `base64`, `hex`, or any of the encoding modes specified in the article at the link below.

Returns true for success, false for failure.

### Cert.GetSubjectPart

`Chilkat 11.7.0 · phpext · Cert · GetSubjectPart · method · since 9.5.0.85`

```php
bool GetSubjectPart(string $partNameOrOid, CkString outStr);

string getSubjectPart(string partNameOrOid);
```

Returns a part of the certificate's subject by name or OID. The `partNameOrOid` can be a part name, such as `CN`, `O`, `OU`, `E`, `S`, `L`, `C`, or `SERIALNUMBER`, or it can be an OID such as `2.5.4.3`.

Returns true for success, false for failure.

### Cert.HashOf

`Chilkat 11.7.0 · phpext · Cert · HashOf · method · since 9.5.0.75`

```php
bool HashOf(string $part, string $hashAlg, string $encoding, CkString outStr);

string hashOf(string part, string hashAlg, string encoding);
```

Returns an encoded hash of a particular part of the certificate. The `part` may be one of the following:

- IssuerDN
- IssuerPublicKey
- SubjectDN
- SubjectPublicKey

The `hashAlg` is the name of the hash algorithm, such as `sha1`, `sha256`, `sha384`, `sha512`, `md5`, etc. The `encoding` is the format to return, such as `hex`, `base64`, etc.

Returns true for success, false for failure.

### Cert.HasPrivateKey

`Chilkat 11.7.0 · phpext · Cert · HasPrivateKey · method`

```php
bool HasPrivateKey();
```

Returns `true` if a private key associated with the certificate is available.

### Cert.IsEcdsa

`Chilkat 11.7.0 · phpext · Cert · IsEcdsa · method · since 10.1.0`

```php
bool IsEcdsa();
```

Returns `true` if certificate is ECDSA-based (i.e. has an ECDSA key).

### Cert.IsRsa

`Chilkat 11.7.0 · phpext · Cert · IsRsa · method · since 10.1.0`

```php
bool IsRsa();
```

Returns `true` if certificate is RSA-based (i.e. has an RSA key).

### Cert.LinkPkcs11

`Chilkat 11.7.0 · phpext · Cert · LinkPkcs11 · method · since 9.5.0.96`

```php
bool LinkPkcs11(CkPkcs11 $session);
```

Links to the certificate's private key located on an HSM (smart card, token, or cloud HSM). Once linked, the certificate can be used for signing where the signing occurs on the HSM. See the example below for more detailed information.

Returns true for success, false for failure.

### Cert.LoadByCommonName

`Chilkat 11.7.0 · phpext · Cert · LoadByCommonName · method`

```php
bool LoadByCommonName(string $cn);
```

This method searches for a certificate with the specified common name (CN) on different operating systems. - On `Windows`, it searches the `Local Machine` and `Current User` certificate stores. - On `macOS` and `iOS`, it searches the Default and System `Keychains`. If the certificate is found, it is loaded and ready for use.

Note: Chilkat v10.0.0 or later is needed for Apple Keychain.

Returns true for success, false for failure.

### Cert.LoadByEmailAddress

`Chilkat 11.7.0 · phpext · Cert · LoadByEmailAddress · method`

```php
bool LoadByEmailAddress(string $emailAddress);
```

This method searches for a certificate with the specified email address on different operating systems. - On `Windows`, it searches the `Local Machine` and `Current User` certificate stores. - On `macOS` and `iOS`, it searches the Default and System `Keychains`. If the certificate is found, it is loaded and ready for use.

Note: Chilkat v10.0.0 or later is needed for Apple Keychain.

Returns true for success, false for failure.

### Cert.LoadByIssuerAndSerialNumber

`Chilkat 11.7.0 · phpext · Cert · LoadByIssuerAndSerialNumber · method`

```php
bool LoadByIssuerAndSerialNumber(string $issuerCN, string $serialNumber);
```

This method searches for a certificate with the specified issuer common name (`issuerCN`) and serial number (`serialNumber`) on different operating systems. - On `Windows`, it searches the `Local Machine` and `Current User` certificate stores. - On `macOS` and `iOS`, it searches the Default and System `Keychains`. If the certificate is found, it is loaded and ready for use.

Note: Chilkat v10.0.0 or later is needed for Apple Keychain.

Returns true for success, false for failure.

### Cert.LoadBySubjectOid

`Chilkat 11.7.0 · phpext · Cert · LoadBySubjectOid · method · since 9.5.0.85`

```php
bool LoadBySubjectOid(string $oid, string $value);
```

**Full documentation for this method (same in every language):** [Common Certificate Subject OIDs](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/cert_subject_oids.md)

This method searches for a certificate containing a subject part matching the `oid` and `value`. On `Windows`, it searches the `Local Machine` and `Current User` certificate stores. - On `macOS` and `iOS`, it searches the Default and System `Keychains`. If the certificate is found, it is loaded and ready for use.

Note: Chilkat v10.0.0 or later is needed for Apple Keychain.

Returns true for success, false for failure.

### Cert.LoadByThumbprint

`Chilkat 11.7.0 · phpext · Cert · LoadByThumbprint · method · since 9.5.0.83`

```php
bool LoadByThumbprint(string $thumbprint, string $encoding);
```

This method searches for a certificate with the specified `thumbprint`. The `thumbprint` is passed as a string using the encoding specified by `encoding` (such as `base64`, `hex`, etc.).

On `Windows`, it searches the `Local Machine` and `Current User` certificate stores. - On `macOS` and `iOS`, it searches the Default and System `Keychains`. If the certificate is found, it is loaded and ready for use.

Note: Chilkat v10.0.0 or later is needed for Apple Keychain.

Returns true for success, false for failure.

### Cert.LoadFromBase64

`Chilkat 11.7.0 · phpext · Cert · LoadFromBase64 · method`

```php
bool LoadFromBase64(string $encodedCert);
```

Loads an ASN.1 or DER encoded certificate represented in a Base64 string.

Returns true for success, false for failure.

### Cert.LoadFromBd

`Chilkat 11.7.0 · phpext · Cert · LoadFromBd · method · since 9.5.0.70`

```php
bool LoadFromBd(CkBinData $certBytes);
```

Loads an X.509 certificate from data contained in `certBytes`.

**Note:** The `certBytes` may contain the certificate in any format. It can be binary DER (ASN.1), PEM, Base64, etc. Chilkat will automatically detect the format.

Returns true for success, false for failure.

### Cert.LoadFromFile

`Chilkat 11.7.0 · phpext · Cert · LoadFromFile · method`

```php
bool LoadFromFile(string $path);
```

Loads a certificate from a .cer, .crt, .p7b, or .pem file. This method accepts certificates from files in any of the following formats:  
1\. DER encoded binary X.509 (.CER)  
2\. Base-64 encoded X.509 (.CER)  
3\. Cryptographic Message Syntax Standard - PKCS #7 Certificates (.P7B)  
4\. PEM format  
This method decodes the certificate based on the contents if finds within the file, and not based on the file extension. If your certificate is in a file having a different extension, try loading it using this method before assuming it won't work. This method does not load .p12 or .pfx (PKCS #12) files.

Returns true for success, false for failure.

### Cert.LoadFromSmartcard

`Chilkat 11.7.0 · phpext · Cert · LoadFromSmartcard · method · since 9.5.0.77`

```php
bool LoadFromSmartcard(string $certSpec);
```

**Important:** It's important to set the SmartCardPin property **before** calling this method.

Loads a certificate and its associated private key (if available) from a connected USB token or smart card. This function works on Windows, Linux, MacOS, iOS, and Alpine Linux. If multiple USB tokens and/or smartcards are connected to the system, then each will be searched and the first matching certificate will be loaded.

The `certSpec` can have the following formats and values:

- **Empty String**: Passing the empty string is the most common way to call this function. Pass the empty string when only one HSM (USB token or smart card) is connected to the system, and it contains only one certificate with a private key. The HSM can contain other certificates, but Chilkat will automatically choose and load the certificate that has the associated private key also located on the HSM.
- **cn=\<cert subject common name>**: Finds and loads the certificate having the specified subject common name (CN).
- **subjectdn_withtags=\<distinguished name with tags>**: Finds and loads the certificate having the specified DN with tags. For example, subjectdn_withtags=C=US, O=Example Corporation, OU=IT Department, CN=www.example.com
- **subjectdn=\<distinguished name without tags>**: Finds and loads the certificate having the specified DN without tags. For example, subjectdn=US, California, San Francisco, Example Corp, Engineering, www.example.com, support@example.com
- **issuercn=\<subject hex serial:issuer common name>**: Finds and loads the certificate having the specified hex serial number and an issuer with the specified common name. For example, `01020304: Let's Encrypt Authority X1`
- **serial=\<hex serial number>**: Finds and loads the certificate having the specified hexidecimal serial number.
- **thumbprint=\<hex SHA1 thumbprint>**: Finds and loads the certificate having the specified hexidecimal SHA1 thumbprint.
- **policyoid=\<certificate policy OID>**: Finds and loads the certificate having a policy OID equal to the specified value, such as 2.16.840.1.101.2.1.11.39.
- **o=\<subject organization>**: Finds and loads the certificate having the `O` subject part equal to the specified value.
- **c=\<subject country>**: Finds and loads the certificate having the `C` subject part equal to the specified value.
- **l=\<subject locality>**: Finds and loads the certificate having the `L` subject part equal to the specified value.
- **ou=\<subject organizational unit>**: Finds and loads the certificate having the `OU` subject part equal to the specified value.
- **st=\<subject state>**: Finds and loads the certificate having the `ST` subject part equal to the specified value.
- **e=\<subject email>**: Finds and loads the certificate having the `E` subject part equal to the specified value.

On Windows systems, `certSpec` can specify a CSP (Cryptographic Service Provider) name, such as `YubiHSM Key Storage Provider.` This option is retained for legacy support, as Chilkat initially handled USB tokens and smartcards only on Windows via CSPs. Chilkat now supports HSMs across multiple platforms (Windows, Linux, macOS, iOS, Alpine Linux) and uses various methods to communicate with HSMs, including PKCS11, macOS Keychain services, Windows ScMinidriver, MsCNG, and legacy Windows CryptoAPI. Chilkat automatically detects the HSM make/model and selects the optimal communication method.

Some possible CSP values are:

- Microsoft Smart Card Key Storage Provider
- Microsoft Base Smart Card Crypto Provider
- Bit4id Universal Middleware Provider
- YubiHSM Key Storage Provider (starting in v9.5.0.83)
- SafeSign Standard Cryptographic Service Provider
- SafeSign Standard RSA and AES Cryptographic Service Provider
- eToken Base Cryptographic Provider
- cryptoCertum3 CSP
- FTSafe ePass1000 RSA Cryptographic Service Provider
- SecureStoreCSP
- EnterSafe ePass2003 CSP v2.0
- Gemalto Classic Card CSP
- PROXKey CSP India V1.0
- PROXKey CSP India V2.0
- TRUST KEY CSP V1.0
- Watchdata Brazil CSP V1.0
- Luna Cryptographic Services for Microsoft Windows
- Luna SChannel Cryptographic Services for Microsoft Windows
- Safenet RSA Full Cryptographic Provider
- nCipher Enhanced Cryptographic Provider
- MySmartLogon NFC CSP
- NFC Connector Enterprise
- ActivClient Cryptographic Service Provider
- EnterSafe ePass2003 CSP v1.0
- Oberthur Card Systems Cryptographic Provider
- Athena ASECard Crypto CSP
- many others...

Returns true for success, false for failure.

### Cert.LoadPem

`Chilkat 11.7.0 · phpext · Cert · LoadPem · method · since 9.5.0.49`

```php
bool LoadPem(string $strPem);
```

Loads the certificate from a PEM string.

Returns true for success, false for failure.

### Cert.LoadPfxBd

`Chilkat 11.7.0 · phpext · Cert · LoadPfxBd · method · since 9.5.0.70`

```php
bool LoadPfxBd(CkBinData $pfxData, string $password);
```

Loads the certificate from the PFX contained in `pfxData`. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns true for success, false for failure.

### Cert.LoadPfxFile

`Chilkat 11.7.0 · phpext · Cert · LoadPfxFile · method`

```php
bool LoadPfxFile(string $pfxPath, string $password);
```

Loads a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns true for success, false for failure.

### Cert.LoadTaskResult

`Chilkat 11.7.0 · phpext · Cert · LoadTaskResult · method · since 9.5.0.52`

```php
bool LoadTaskResult(CkTask $task);
```

Loads the certificate from a completed asynchronous task.

Returns true for success, false for failure.

### Cert.PemFileToDerFile

`Chilkat 11.7.0 · phpext · Cert · PemFileToDerFile · method`

```php
bool PemFileToDerFile(string $fromPath, string $toPath);
```

Converts a PEM file to a DER file.

Returns true for success, false for failure.

### Cert.SaveToFile

`Chilkat 11.7.0 · phpext · Cert · SaveToFile · method`

```php
bool SaveToFile(string $path);
```

Saves a certificate object to a .cer file.

Returns true for success, false for failure.

### Cert.SetCloudSigner

`Chilkat 11.7.0 · phpext · Cert · SetCloudSigner · method · since 9.5.0.96`

```php
bool SetCloudSigner(CkJsonObject $json);
```

Provides information for a cloud signing service to do the signing via a remote signing server. Current supported services are AWS KMS, Azure Key Vault, and ARSS (Aruba Remote Signing Service). See the examples below.

Returns true for success, false for failure.

Async variant: `SetCloudSignerAsync` — same arguments, returns a `Task` (see Async variants below).

### Cert.SetFromEncoded

`Chilkat 11.7.0 · phpext · Cert · SetFromEncoded · method`

```php
bool SetFromEncoded(string $encodedCert);
```

Initializes the certificate object from a base64 encoded string representation of the certificate's binary DER format.

Returns true for success, false for failure.

### Cert.SetPrivateKey

`Chilkat 11.7.0 · phpext · Cert · SetPrivateKey · method`

```php
bool SetPrivateKey(CkPrivateKey $privKey);
```

Used to associate a private key with the certificate for subsequent (PKCS7) signature creation or decryption.

Returns true for success, false for failure.

### Cert.SetPrivateKeyPem

`Chilkat 11.7.0 · phpext · Cert · SetPrivateKeyPem · method`

```php
bool SetPrivateKeyPem(string $privKeyPem);
```

Same as SetPrivateKey, but the key is provided in unencrypted PEM format. (Note: The `privKeyPem` is not a file path, it is the actual PEM text.)

Returns true for success, false for failure.

### Cert.Unload

`Chilkat 11.7.0 · phpext · Cert · Unload · method · since 11.0.0`

```php
bool Unload();
```

Unload the certificate, which could mean closing a PKCS11 session if the certificate was loaded from a smart card.

Returns true for success, false for failure.

### Cert.UploadToCloud

`Chilkat 11.7.0 · phpext · Cert · UploadToCloud · method · since 9.5.0.96`

```php
bool UploadToCloud(CkJsonObject $jsonIn, CkJsonObject $jsonOut);
```

This is an open-ended method to accomodate uploading the private key to a cloud service, such as AWS KMS, or Azure Key Vault. For details, see the examples below.

Returns true for success, false for failure.

Async variant: `UploadToCloudAsync` — same arguments, returns a `Task` (see Async variants below).

### Cert.UseCertVault

`Chilkat 11.7.0 · phpext · Cert · UseCertVault · method · since 9.5.0.40`

```php
bool UseCertVault(CkXmlCertVault $vault);
```

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains and verifying the certificate signature to the trusted root.

Returns true for success, false for failure.

### Cert.VerifySignature

`Chilkat 11.7.0 · phpext · Cert · VerifySignature · method · since 9.5.0.40`

```php
bool VerifySignature();
```

Verifies the certificate signature, as well as the signatures of all certificates in the chain of authentication to the trusted root. Returns `true` if all signatures are verified to the trusted root. Otherwise returns `false`.

### Cert.X509PKIPathv1

`Chilkat 11.7.0 · phpext · Cert · X509PKIPathv1 · method · since 9.5.0.77`

```php
bool X509PKIPathv1(CkString outStr);

string x509PKIPathv1();
```

Returns the base64 representation of an X509PKIPathv1 containing just the calling certificate. This is typically used in an X.509 Binary Security Token. It is a PKIPath that contains an ordered list of X.509 public certificates packaged in a PKIPath. The X509PKIPathv1 token type may be used to represent a certificate path. (This is sometimes used in XAdES signatures.)

Returns true for success, false for failure.

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```php
CkTask SetCloudSignerAsync(CkJsonObject $json);
CkTask UploadToCloudAsync(CkJsonObject $jsonIn, CkJsonObject $jsonOut);
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `ExportCertDer` | method | before 11.6.1 | — |
| `ExportPrivateKey` | method | before 11.6.1 | — |
| `ExportPublicKey` | method | before 11.6.1 | — |
| `ExportToPfxData` | method | before 11.6.1 | — |
| `GetCertChain` | method | before 11.6.1 | `BuildCertChain` |
| `GetValidFromDt` | method | before 11.6.1 | — |
| `GetValidToDt` | method | before 11.6.1 | — |
| `LoadFromBinary` | method | before 11.6.1 | — |
| `LoadPfxData` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/BinData.md), [`CertChain`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/CertChain.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/JsonObject.md), [`Pkcs11`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/Pkcs11.md), [`PrivateKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/PrivateKey.md), [`PublicKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/PublicKey.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/Task.md), [`XmlCertVault`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/classes/XmlCertVault.md)