Rsa Chilkat2 PHP Reference Documentation

Rsa

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

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

use Chilkat2\Rsa;

try {
    $rsa = new Rsa();
    // ... use $rsa ...
} catch (\Chilkat2\Exception $e) {
    echo $e->getClass(), '::', $e->getMethod(), " failed\n";
    echo $e->getMessage(), "\n";              // the LastErrorText of the failed call
}

public function __construct(array $properties = [])

Creates the object. The optional array sets properties in order, as if assigned one by one (new Rsa(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.

There is no close(): PHP frees the object when its last reference goes (unset($rsa), $rsa = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyRsa extends \Chilkat2\Rsa); objects cannot be cloned or serialized.

public bool $RaiseError;

When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.

Errors

Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\Rsa') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.

Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.

Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.

Properties

Charset

public string $Charset;

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 Chilkat2 PHP Reference Documentation

Rsa

Current Version: 11.7.0

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