Rsa React Native Reference Documentation

Rsa

Current Version: 11.6.1

Chilkat.Rsa

Encrypt, decrypt, sign, verify, and generate RSA keys.

Use Chilkat.Rsa when an application needs direct RSA cryptographic operations. It can encrypt data with a public key, decrypt with a private key, create RSA signatures, verify signatures, sign precomputed hashes, verify signed hashes, and generate RSA key pairs. It also works with keys supplied directly as PrivateKey or PublicKey objects, or indirectly through certificates.

RSA encryption

Encrypt data with a public key for workflows where only the matching private key should be able to decrypt the result.

RSA decryption

Decrypt RSA-encrypted data using a private key, including keys loaded directly or accessed through a certificate.

Sign and verify data

Create and verify RSA signatures over data using the hash algorithm and padding mode required by the application or protocol.

Sign precomputed hashes

Sign or verify already-computed message digests when the hashing step is performed separately or by another component.

Generate RSA keys

Generate RSA key pairs for applications that need new public/private key material.

Certificate-backed keys

Use RSA keys associated with certificates, including non-exportable private keys in smart cards, USB tokens, Windows stores, or Apple Keychain.

Common pattern: Load or generate the RSA key material, configure the padding, hash, charset, and encoding options needed by the protocol, then call the method matching the operation: encrypt, decrypt, sign, verify, sign-hash, or verify-hash. Use Chilkat.Rsa for direct RSA operations; use higher-level classes such as Crypt2, Jws, Jwt, or Mime when the RSA operation is part of a larger format or protocol.

For an extended overview, see Rsa 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, Rsa } 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 rsa = new Rsa()
// ... the native object is released when `rsa` is garbage collected, or now with rsa.dispose()

new Rsa()

Creates the underlying native Chilkat object. Rsa 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 {
  rsa.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // Rsa.someMethod(...): <reason>
  console.log(rsa.lastErrorText)   // the full Chilkat log of the failed call
}

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

Properties

Charset

// read/write
charset: string

This property specifies the character encoding used to represent text as bytes for encryption, decryption, signing, and signature validation. By default, it uses the computer's ANSI charset, such as Windows-1252 for locales like the United States, United Kingdom, Western Europe, Australia, and New Zealand.

Most applications are advised to set this property to UTF-8. Chilkat plans to change its default to UTF-8 in a future major version to align with current standards. The current default of ANSI stems from a time when UTF-8 was not widely adopted.

More Information and Examples

How Charset Affects RSA ANSI Charset Explained Charset Considerations when RSA Encrypting Strings

Rsa React Native Reference Documentation

Rsa

Current Version: 11.6.1

Encrypt, decrypt, sign, verify, and generate RSA keys.

RSA encryption

RSA decryption

Sign and verify data

Sign precomputed hashes

Generate RSA keys

Certificate-backed keys

Object Creation

Errors

Properties

Charset

DebugLogFilePath

EncodingMode

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

LittleEndian

NoUnpad

NumBits

OaepHash

OaepLabel

OaepMgfHash

PkcsPadding

PssSaltLen

UncommonOptions

VerboseLogging

Version

Methods

DecryptBd

DecryptStringENC

EncryptBd

EncryptStringENC

GenKey

SetX509Cert

SignBd

SignHashENC

SignRawBd

SignStringENC

SnkToXml

UsePrivateKey

UsePublicKey

VerifyBd

VerifyHashENC

VerifyRawBd

VerifyStringENC