CertStore React Native Reference Documentation

CertStore

Current Version: 11.6.1

Chilkat.CertStore

Open, search, manage, and use certificate collections from many sources.

Chilkat.CertStore is the Chilkat class for working with collections of X.509 certificates. It can open and manage certificates from system stores, Apple Keychain, Windows registry or file stores, memory stores, PEM files, PFX/P12 files, and smart card or USB token devices. It supports loading, searching, iterating, adding, removing, and closing certificate stores, with platform-specific behavior for Windows and Apple Keychain.

Open certificate stores

Access certificates from Windows certificate stores, Apple Keychain, files, memory stores, PEM bundles, PFX/P12 files, and hardware tokens.

Search and retrieve certs

Find certificates by subject, issuer, serial number, thumbprint, email, private-key availability, or other identifying information.

Iterate collections

Enumerate certificates in a store and retrieve each certificate as a Chilkat.Cert object for inspection or use.

Add and remove certificates

Add certificates to writable stores, remove certificates where supported, and manage store contents from application code.

Private-key backed certs

Work with certificates that have associated private keys from PFX/P12, operating-system stores, smart cards, USB tokens, or other providers.

Use across Chilkat

Pass retrieved certificates to other Chilkat classes for TLS client authentication, S/MIME, signing, encryption, decryption, and verification.

Common pattern: Open the appropriate certificate store, search or iterate to find the needed certificate, retrieve it as a Chilkat.Cert, and then pass that certificate to the Chilkat class that needs it. Use certificate stores when the application should select from existing system, file-based, keychain, or hardware-backed certificates.

For an extended overview, see CertStore Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, CertStore } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const certStore = new CertStore()
// ... the native object is released when `certStore` is garbage collected, or now with certStore.dispose()

new CertStore()

Creates the underlying native Chilkat object. CertStore is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  certStore.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // CertStore.someMethod(...): <reason>
  console.log(certStore.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await certStore.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // CertStore.someMethodAsync: <reason>
}

Properties

AvoidWindowsPkAccess

// read/write
avoidWindowsPkAccess: boolean

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.

CertStore React Native Reference Documentation

CertStore

Current Version: 11.6.1

Open, search, manage, and use certificate collections from many sources.

Open certificate stores

Search and retrieve certs

Iterate collections

Add and remove certificates

Private-key backed certs

Use across Chilkat

Object Creation

Errors

Properties

AvoidWindowsPkAccess

DebugLogFilePath

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumCertificates

SmartCardPin

UncommonOptions

VerboseLogging

Version

Methods

AddCertificate

CloseCertStore

CreateFileStore

CreateMemoryStore

CreateRegistryStore

FindCert

GetCert

LoadPemFile

LoadPemStr

LoadPfxBd

LoadPfxFile

OpenCurrentUserStore

OpenFileStore

OpenLocalSystemStore

OpenRegistryStore

OpenSmartcard

OpenWindowsStore

RemoveCertificate