---
product: Chilkat
product_version: 11.7.0
language: tcl
language_label: Tcl
class: Rsa
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/tclRsaRef.html
---
# Chilkat Rsa — Tcl — v11.7.0

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

## Purpose

**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](https://www.chilkatsoft.com/rsa_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkRsa]
```

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 Tcl.

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 # ckStr is a CkString CkRsa_get_DebugLogFilePath $this $ckStr set strVal [CkRsa_get_debugLogFilePath $this] CkRsa_put_DebugLogFilePath $this $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` | `string # ckStr is a CkString CkRsa_get_LastErrorHtml $this $ckStr set strVal [CkRsa_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkRsa_get_LastErrorText $this $ckStr set strVal [CkRsa_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkRsa_get_LastErrorXml $this $ckStr set strVal [CkRsa_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkRsa_get_LastMethodSuccess $this] CkRsa_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkRsa_get_Utf8 $this] CkRsa_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkRsa_get_VerboseLogging $this] CkRsa_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkRsa_get_Version $this $ckStr set strVal [CkRsa_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Charset` | property, read/write | `string # ckStr is a CkString CkRsa_get_Charset $this $ckStr set strVal [CkRsa_get_charset $this] CkRsa_put_Charset $this $strVal` |
| `EncodingMode` | property, read/write | `string # ckStr is a CkString CkRsa_get_EncodingMode $this $ckStr set strVal [CkRsa_get_encodingMode $this] CkRsa_put_EncodingMode $this $strVal` |
| `LittleEndian` | property, read/write | `boolean 1/0 set boolVal [CkRsa_get_LittleEndian $this] CkRsa_put_LittleEndian $this $boolVal` |
| `NoUnpad` | property, read/write | `boolean 1/0 set boolVal [CkRsa_get_NoUnpad $this] CkRsa_put_NoUnpad $this $boolVal` |
| `NumBits` | property, read-only | `integer set intVal [CkRsa_get_NumBits $this]` |
| `OaepHash` | property, read/write | `string # ckStr is a CkString CkRsa_get_OaepHash $this $ckStr set strVal [CkRsa_get_oaepHash $this] CkRsa_put_OaepHash $this $strVal` |
| `OaepLabel` | property, read/write | `string # ckStr is a CkString CkRsa_get_OaepLabel $this $ckStr set strVal [CkRsa_get_oaepLabel $this] CkRsa_put_OaepLabel $this $strVal` |
| `OaepMgfHash` | property, read/write | `string # ckStr is a CkString CkRsa_get_OaepMgfHash $this $ckStr set strVal [CkRsa_get_oaepMgfHash $this] CkRsa_put_OaepMgfHash $this $strVal` |
| `PkcsPadding` | property, read/write | `boolean 1/0 set boolVal [CkRsa_get_PkcsPadding $this] CkRsa_put_PkcsPadding $this $boolVal` |
| `PssSaltLen` | property, read/write | `integer set intVal [CkRsa_get_PssSaltLen $this] CkRsa_put_PssSaltLen $this $intVal` |
| `UncommonOptions` | property, read/write | `string # ckStr is a CkString CkRsa_get_UncommonOptions $this $ckStr set strVal [CkRsa_get_uncommonOptions $this] CkRsa_put_UncommonOptions $this $strVal` |
| `DecryptBd` | method | `# bd is a CkBinData # usePrivateKey is a boolean set status [CkRsa_DecryptBd $this $bd $usePrivateKey]` |
| `DecryptStringENC` | method | `# str is a string # usePrivateKey is a boolean # outStr is a CkString (output) set status [CkRsa_DecryptStringENC $this $str $usePrivateKey $outStr] set retStr [CkRsa_decryptStringENC $this $str $usePrivateKey]` |
| `EncryptBd` | method | `# bd is a CkBinData # usePrivateKey is a boolean set status [CkRsa_EncryptBd $this $bd $usePrivateKey]` |
| `EncryptStringENC` | method | `# str is a string # bUsePrivateKey is a boolean # outStr is a CkString (output) set status [CkRsa_EncryptStringENC $this $str $bUsePrivateKey $outStr] set retStr [CkRsa_encryptStringENC $this $str $bUsePrivateKey]` |
| `GenKey` | method | `# numBits is an integer # privKey is a CkPrivateKey set status [CkRsa_GenKey $this $numBits $privKey]` |
| `SetX509Cert` | method | `# cert is a CkCert # usePrivateKey is a boolean set status [CkRsa_SetX509Cert $this $cert $usePrivateKey]` |
| `SignBd` | method | `# bdData is a CkBinData # hashAlgorithm is a string # bdSig is a CkBinData set status [CkRsa_SignBd $this $bdData $hashAlgorithm $bdSig]` |
| `SignHashENC` | method | `# encodedHash is a string # hashAlg is a string # outStr is a CkString (output) set status [CkRsa_SignHashENC $this $encodedHash $hashAlg $outStr] set retStr [CkRsa_signHashENC $this $encodedHash $hashAlg]` |
| `SignRawBd` | method | `# bd is a CkBinData set status [CkRsa_SignRawBd $this $bd]` |
| `SignStringENC` | method | `# strToBeHashed is a string # hashAlgorithm is a string # outStr is a CkString (output) set status [CkRsa_SignStringENC $this $strToBeHashed $hashAlgorithm $outStr] set retStr [CkRsa_signStringENC $this $strToBeHashed $hashAlgorithm]` |
| `SnkToXml` | method | `# filename is a string # outStr is a CkString (output) set status [CkRsa_SnkToXml $this $filename $outStr] set retStr [CkRsa_snkToXml $this $filename]` |
| `UsePrivateKey` | method | `# privKey is a CkPrivateKey set status [CkRsa_UsePrivateKey $this $privKey]` |
| `UsePublicKey` | method | `# pubKey is a CkPublicKey set status [CkRsa_UsePublicKey $this $pubKey]` |
| `VerifyBd` | method | `# bdData is a CkBinData # hashAlgorithm is a string # bdSig is a CkBinData set status [CkRsa_VerifyBd $this $bdData $hashAlgorithm $bdSig]` |
| `VerifyHashENC` | method | `# encodedHash is a string # hashAlg is a string # encodedSig is a string set status [CkRsa_VerifyHashENC $this $encodedHash $hashAlg $encodedSig]` |
| `VerifyRawBd` | method | `# bd is a CkBinData set status [CkRsa_VerifyRawBd $this $bd]` |
| `VerifyStringENC` | method | `# originalString is a string # hashAlgorithm is a string # encodedSig is a string set status [CkRsa_VerifyStringENC $this $originalString $hashAlgorithm $encodedSig]` |

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

## Properties

### Rsa.Charset

`Chilkat 11.7.0 · tcl · Rsa · Charset · property · read/write`

```tcl
string
# ckStr is a CkString

CkRsa_get_Charset $this $ckStr

set strVal [CkRsa_get_charset $this]

CkRsa_put_Charset $this $strVal
```

**Full documentation for this property (same in every language):** [How Charset Affects RSA](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/how_charset_affects_rsa.md) · [ANSI Charset Explained](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/ansi_charset_explained.md)

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.

### Rsa.EncodingMode

`Chilkat 11.7.0 · tcl · Rsa · EncodingMode · property · read/write`

```tcl
string
# ckStr is a CkString

CkRsa_get_EncodingMode $this $ckStr

set strVal [CkRsa_get_encodingMode $this]

CkRsa_put_EncodingMode $this $strVal
```

This property defines the encoding for methods ending in `ENC`, such as EncryptStringENC. Valid modes include `base64`, `hex`, `hex_lower`, and more. The encoding mode applies to signatures, encrypted data, and hashes used in or returned by a method.

### Rsa.LittleEndian

`Chilkat 11.7.0 · tcl · Rsa · LittleEndian · property · read/write`

```tcl
boolean 1/0
set boolVal [CkRsa_get_LittleEndian $this]

CkRsa_put_LittleEndian $this $boolVal
```

When creating RSA signatures, this property determines the endianness: set it to `1` for little-endian signatures and `0` for big-endian signatures.

See also:

- [RSA Signatures and Endianness](https://cknotes.com/rsa-signatures-and-endianness/)

### Rsa.NoUnpad

`Chilkat 11.7.0 · tcl · Rsa · NoUnpad · property · read/write`

```tcl
boolean 1/0
set boolVal [CkRsa_get_NoUnpad $this]

CkRsa_put_NoUnpad $this $boolVal
```

If `1`, skips unpadding when decrypting. The default is `0`. This property value is typically left unchanged.

### Rsa.NumBits

`Chilkat 11.7.0 · tcl · Rsa · NumBits · property · read-only`

```tcl
integer
set intVal [CkRsa_get_NumBits $this]
```

The bit length, such as 2048, of the imported or generated RSA key.

### Rsa.OaepHash

`Chilkat 11.7.0 · tcl · Rsa · OaepHash · property · read/write · since 9.5.0.48`

```tcl
string
# ckStr is a CkString

CkRsa_get_OaepHash $this $ckStr

set strVal [CkRsa_get_oaepHash $this]

CkRsa_put_OaepHash $this $strVal
```

Selects the hash algorithm for use within OAEP padding for encryption. The valid choices are `sha256`, `sha384`, `sha512`, or `sha1`.

The default is SHA1. You'll likely want to change this to to SHA256. The next major version of Chilkat (11.0.0) will change the default to SHA256.

See also:

- [More Information about RSA OAEP Padding for Encryption](https://cknotes.com/more-information-about-rsa-oaep-padding-for-encryption/)

### Rsa.OaepLabel

`Chilkat 11.7.0 · tcl · Rsa · OaepLabel · property · read/write · since 9.5.0.95`

```tcl
string
# ckStr is a CkString

CkRsa_get_OaepLabel $this $ckStr

set strVal [CkRsa_get_oaepLabel $this]

CkRsa_put_OaepLabel $this $strVal
```

The optional RSA encryption OAEP label is a hex representation of the label bytes used for encrypting with OAEP padding. Typically, this is left empty (0 bytes) unless there's a specific requirement to set it.

See also:

- [More Information about RSA OAEP Padding for Encryption](https://cknotes.com/more-information-about-rsa-oaep-padding-for-encryption/)

### Rsa.OaepMgfHash

`Chilkat 11.7.0 · tcl · Rsa · OaepMgfHash · property · read/write · since 9.5.0.71`

```tcl
string
# ckStr is a CkString

CkRsa_get_OaepMgfHash $this $ckStr

set strVal [CkRsa_get_oaepMgfHash $this]

CkRsa_put_OaepMgfHash $this $strVal
```

Selects the MGF (mask generation) hash algorithm for use within OAEP padding for encryption. The valid choices are `sha256`, `sha384`, `sha512`, or `sha1`.

Note: This property should typically be set to the same value as the OaepHash property. Many software implementations are not able to handle cases where the MGF hash is different than the OAEP hash.

The default is SHA1. You'll likely want to change this to to SHA256. The next major version of Chilkat (11.0.0) will change the default to SHA256.

See also:

- [More Information about RSA OAEP Padding for Encryption](https://cknotes.com/more-information-about-rsa-oaep-padding-for-encryption/)

### Rsa.PkcsPadding

`Chilkat 11.7.0 · tcl · Rsa · PkcsPadding · property · read/write · since 11.0.0`

```tcl
boolean 1/0
set boolVal [CkRsa_get_PkcsPadding $this]

CkRsa_put_PkcsPadding $this $boolVal
```

This property controls padding for both signing and encryption. The default value is true, which is to use PKCS#1 v1.5 padding. If set to false, then PSS padding is used for signatures and OAEP padding is used for encryption.

This property replaces the deprecated `OaepPadding` property. Until the OaepPadding property is removed, setting this property will automatically set OaepPadding to the opposite, and vice-versa. This is to maintain backward compatibility until applications can switch to using this new property.

### Rsa.PssSaltLen

`Chilkat 11.7.0 · tcl · Rsa · PssSaltLen · property · read/write · since 9.5.0.80`

```tcl
integer
set intVal [CkRsa_get_PssSaltLen $this]

CkRsa_put_PssSaltLen $this $intVal
```

When using RSASSA-PSS padding for signatures, you can choose the PSS salt length. By default, the salt length is set to -1, which uses the length of the hash function. For instance, with the SHA256 hash function, the salt length will be 32 bytes. You can specify a different salt length, like 20 bytes, if needed, but it's generally recommended to keep the default setting.

### Rsa.UncommonOptions

`Chilkat 11.7.0 · tcl · Rsa · UncommonOptions · property · read/write · since 10.1.0`

```tcl
string
# ckStr is a CkString

CkRsa_get_UncommonOptions $this $ckStr

set strVal [CkRsa_get_uncommonOptions $this]

CkRsa_put_UncommonOptions $this $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.

## Methods

### Rsa.DecryptBd

`Chilkat 11.7.0 · tcl · Rsa · DecryptBd · method · since 9.5.0.76`

```tcl
# bd is a CkBinData

# usePrivateKey is a boolean

set status [CkRsa_DecryptBd $this $bd  $usePrivateKey]
```

RSA decrypts the contents of `bd`. `usePrivateKey` should be set to `1` if the private key is to be used for decrypting. Otherwise it should be set to `0` if (in rare cases) the public key is to be used for decrypting.

**Important:** If trying to match OpenSSL results, set the LittleEndian property = `0`.

Returns 1 for success, 0 for failure.

See also:

- [RSA Encryption Maximum Number of Bytes](https://cknotes.com/rsa-encryption-maximum-number-of-bytes/)

### Rsa.DecryptStringENC

`Chilkat 11.7.0 · tcl · Rsa · DecryptStringENC · method`

```tcl
# str is a string

# usePrivateKey is a boolean

# outStr is a CkString (output)

set status [CkRsa_DecryptStringENC $this $str  $usePrivateKey $outStr]

set retStr [CkRsa_decryptStringENC $this $str $usePrivateKey]
```

Decrypts `str` with the RSA algorithm. `str` is the encoded form of the encrypted binary data. The EncodingMode property defines `str`'s encoding. The Charset property specifies the byte representation for interpreting the decrypted text. Set `usePrivateKey` to `1` to use the private key for decryption; otherwise, set `usePrivateKey` to `0` to use the public key (used rarely). Returns the decrypted string.

**Important:** If trying to match OpenSSL results, set the LittleEndian property = `0`.

Returns 1 for success, 0 for failure.

### Rsa.EncryptBd

`Chilkat 11.7.0 · tcl · Rsa · EncryptBd · method · since 9.5.0.76`

```tcl
# bd is a CkBinData

# usePrivateKey is a boolean

set status [CkRsa_EncryptBd $this $bd  $usePrivateKey]
```

RSA encrypts the contents of `bd`. Set `usePrivateKey` to `0` to use the public key for encrypting; otherwise, set it to `1` to use the private key (in rare cases).

**Important:** If trying to match OpenSSL results, set the LittleEndian property = `0`.

**Note:** The public key's role is to make encryption accessible to anyone while ensuring that only the private key holder can decrypt the messages. The public key is designed to be widely distributed so anyone can use it to encrypt messages intended for the owner of the private key.

Returns 1 for success, 0 for failure.

See also:

- [RSA Encryption Maximum Number of Bytes](https://cknotes.com/rsa-encryption-maximum-number-of-bytes/)

### Rsa.EncryptStringENC

`Chilkat 11.7.0 · tcl · Rsa · EncryptStringENC · method`

```tcl
# str is a string

# bUsePrivateKey is a boolean

# outStr is a CkString (output)

set status [CkRsa_EncryptStringENC $this $str  $bUsePrivateKey $outStr]

set retStr [CkRsa_encryptStringENC $this $str $bUsePrivateKey]
```

Encrypts `str` with the RSA algorithm. The Charset property specifies the byte representation of the string that is encrypted. Set `bUsePrivateKey` to `0` to use the public key for encrypting; otherwise, set it to `1` to use the private key (in rare cases). The encrypted data is returned in the format specified by the EncodingMode property.

**Important:** If trying to match OpenSSL results, set the LittleEndian property = `0`.

**Note:** The public key's role is to make encryption accessible to anyone while ensuring that only the private key holder can decrypt the messages. The public key is designed to be widely distributed so anyone can use it to encrypt messages intended for the owner of the private key.

Returns 1 for success, 0 for failure.

### Rsa.GenKey

`Chilkat 11.7.0 · tcl · Rsa · GenKey · method · since 11.0.0`

```tcl
# numBits is an integer

# privKey is a CkPrivateKey

set status [CkRsa_GenKey $this $numBits  $privKey]
```

Generates a new RSA key and stores it in `privKey`. `numBits` specifies the key length, which can range from 512 to 8192 bits. Common key lengths are 1024, 2048, or 4096 bits.

Note: Generating an 8192-bit key may take a significant amount of time. The method does not support event callbacks or progress monitoring and will block the thread until completion.

Returns 1 for success, 0 for failure.

### Rsa.SetX509Cert

`Chilkat 11.7.0 · tcl · Rsa · SetX509Cert · method · since 9.5.0.73`

```tcl
# cert is a CkCert

# usePrivateKey is a boolean

set status [CkRsa_SetX509Cert $this $cert  $usePrivateKey]
```

Provides the private or public key indirectly through a certificate. This method is used when the private key is inaccessible, such as when stored on a smart card, USB token, in the Windows registry (marked as non-exportable), or in the Apple Keychain.

Returns 1 for success, 0 for failure.

### Rsa.SignBd

`Chilkat 11.7.0 · tcl · Rsa · SignBd · method · since 9.5.0.77`

```tcl
# bdData is a CkBinData

# hashAlgorithm is a string

# bdSig is a CkBinData

set status [CkRsa_SignBd $this $bdData  $hashAlgorithm  $bdSig]
```

Generates an RSA digital signature by first hashing the contents of `bdData` with the hash algorithm specified by `hashAlgorithm`, which can be `sha256`, `sha384`, `sha512`, or `sha1`. The resulting signature is written to `bdSig`.

Note: It is important to be aware of endianness. Make sure the LittleEndian property is set according to your specific needs.

Returns 1 for success, 0 for failure.

### Rsa.SignHashENC

`Chilkat 11.7.0 · tcl · Rsa · SignHashENC · method`

```tcl
# encodedHash is a string

# hashAlg is a string

# outStr is a CkString (output)

set status [CkRsa_SignHashENC $this $encodedHash  $hashAlg $outStr]

set retStr [CkRsa_signHashENC $this $encodedHash $hashAlg]
```

This function creates an RSA digital signature for the hash provided in `encodedHash`, which should be encoded according to the EncodingMode setting (e.g., base64 if EncodingMode = `base64`). `hashAlg` specifies the hash algorithm and can be `sha256`, `sha384`, `sha512`, or `sha1`. The function returns the signature encoded as specified by EncodingMode.

Returns 1 for success, 0 for failure.

### Rsa.SignRawBd

`Chilkat 11.7.0 · tcl · Rsa · SignRawBd · method · since 11.0.0`

```tcl
# bd is a CkBinData

set status [CkRsa_SignRawBd $this $bd]
```

This is legacy low-level raw RSA that duplicates the (now deprecated) `OpenSSL` `rsautl` utility. It directly signs raw data rather than signing a hash of the data. PKCS#1 v1.5 padding is always used. The data to be signed is passed in `bd`, and on return the content of `bd` is replaced with the RSA signed data.

Note: It is possible to validate and recover the original data by calling `VerifyRawBd`.

Returns 1 for success, 0 for failure.

### Rsa.SignStringENC

`Chilkat 11.7.0 · tcl · Rsa · SignStringENC · method`

```tcl
# strToBeHashed is a string

# hashAlgorithm is a string

# outStr is a CkString (output)

set status [CkRsa_SignStringENC $this $strToBeHashed  $hashAlgorithm $outStr]

set retStr [CkRsa_signStringENC $this $strToBeHashed $hashAlgorithm]
```

Generates an RSA digital signature by first hashing `strToBeHashed` with the hash algorithm specified by `hashAlgorithm`, which can be `sha256`, `sha384`, `sha512`, or `sha1`. Returns the signature encoded based on the EncodingMode property.

**Note:** It is important to be aware of endianness. Make sure the LittleEndian property is set according to your specific needs.

**Note:** It is recommended to set the Charset property equal to `utf-8` before signing strings.

Returns 1 for success, 0 for failure.

### Rsa.SnkToXml

`Chilkat 11.7.0 · tcl · Rsa · SnkToXml · method`

```tcl
# filename is a string

# outStr is a CkString (output)

set status [CkRsa_SnkToXml $this $filename $outStr]

set retStr [CkRsa_snkToXml $this $filename]
```

Imports a .snk file to an XML document that can be imported via the ImportPrivateKey method.

Returns 1 for success, 0 for failure.

### Rsa.UsePrivateKey

`Chilkat 11.7.0 · tcl · Rsa · UsePrivateKey · method · since 11.0.0`

```tcl
# privKey is a CkPrivateKey

set status [CkRsa_UsePrivateKey $this $privKey]
```

Imports a private key from `privKey` to use for signing or decrypting.

Returns 1 for success, 0 for failure.

### Rsa.UsePublicKey

`Chilkat 11.7.0 · tcl · Rsa · UsePublicKey · method · since 11.0.0`

```tcl
# pubKey is a CkPublicKey

set status [CkRsa_UsePublicKey $this $pubKey]
```

Imports a public key from `pubKey` to use for encrypting or signature verification.

Returns 1 for success, 0 for failure.

### Rsa.VerifyBd

`Chilkat 11.7.0 · tcl · Rsa · VerifyBd · method · since 9.5.0.77`

```tcl
# bdData is a CkBinData

# hashAlgorithm is a string

# bdSig is a CkBinData

set status [CkRsa_VerifyBd $this $bdData  $hashAlgorithm  $bdSig]
```

Verifies the RSA signature passed in `bdSig` against the original data passed in `bdData`. The original data passed in `bdData` is hashed using the hash algorithm passed in `hashAlgorithm` (such as `sha256`, `sha384`, `sha512`, or `sha1`). Returns `1` if the signature is validated, and `0` if not.

Note: Knowing the exact hash algorithm used to create the signature is not required. If the signature is not validated using the hash algorithm specified in `hashAlgorithm`, Chilkat will automatically try validating using the other supported algorithms and return success if any validate.

Returns 1 for success, 0 for failure.

### Rsa.VerifyHashENC

`Chilkat 11.7.0 · tcl · Rsa · VerifyHashENC · method`

```tcl
# encodedHash is a string

# hashAlg is a string

# encodedSig is a string

set status [CkRsa_VerifyHashENC $this $encodedHash  $hashAlg  $encodedSig]
```

Validates an RSA signature provided in `encodedSig` against the hash of the original data in `encodedHash`. Returns `1` if validation is successful, otherwise returns `0`. `hashAlg` specifies the hash algorithm used for `encodedHash`, such as `sha256`, `sha384`, `sha512`, or `sha1`. Ensure the hash's size (e.g., 32 bytes for sha256, 48 bytes for sha384, 64 bytes for sha512, 20 bytes for sha1) matches that of `encodedHash`.

Both `encodedHash` and `encodedSig` should be encoded according to the EncodingMode property (e.g., base64 if EncodingMode = `base64`)

Returns 1 for success, 0 for failure.

### Rsa.VerifyRawBd

`Chilkat 11.7.0 · tcl · Rsa · VerifyRawBd · method · since 11.0.0`

```tcl
# bd is a CkBinData

set status [CkRsa_VerifyRawBd $this $bd]
```

This is legacy low-level raw RSA that duplicates the (now deprecated) `OpenSSL` `rsautl` utility. It validates signed raw data and recovers the original data. The RSA signature to be verified is passed in `bd`, and on return the content of `bd` is replaced with the original data.

Returns 1 for success, 0 for failure.

### Rsa.VerifyStringENC

`Chilkat 11.7.0 · tcl · Rsa · VerifyStringENC · method`

```tcl
# originalString is a string

# hashAlgorithm is a string

# encodedSig is a string

set status [CkRsa_VerifyStringENC $this $originalString  $hashAlgorithm  $encodedSig]
```

Verifies the encoded RSA signature passed in `encodedSig` against the original data passed in `originalString`. The original data passed in `originalString` is hashed using the hash algorithm passed in `hashAlgorithm` (such as `sha256`, `sha384`, `sha512`, or `sha1`). Returns `1` if the signature is validated, and `0` if not.

The signature passed in `encodedSig` should be encoded according to the EncodingMode property (e.g., base64 if EncodingMode = `base64`)

Note: Knowing the exact hash algorithm used to create the signature is not required. If the signature is not validated using the hash algorithm specified in `hashAlgorithm`, Chilkat will automatically try validating using the other supported algorithms and return success if any validate.

Returns 1 for success, 0 for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `OaepPadding` | property | before 11.6.1 | — |
| `DecryptBytes` | method | before 11.6.1 | — |
| `DecryptBytesENC` | method | before 11.6.1 | — |
| `DecryptString` | method | before 11.6.1 | — |
| `EncryptBytes` | method | before 11.6.1 | — |
| `EncryptBytesENC` | method | before 11.6.1 | — |
| `EncryptString` | method | before 11.6.1 | — |
| `ExportPrivateKey` | method | before 11.6.1 | — |
| `ExportPrivateKeyObj` | method | before 11.6.1 | — |
| `ExportPublicKey` | method | before 11.6.1 | — |
| `ExportPublicKeyObj` | method | before 11.6.1 | — |
| `GenerateKey` | method | before 11.6.1 | `GenKey` |
| `ImportPrivateKey` | method | before 11.6.1 | `UsePrivateKey` |
| `ImportPrivateKeyObj` | method | before 11.6.1 | `UsePrivateKey` |
| `ImportPublicKey` | method | before 11.6.1 | `UsePublicKey` |
| `ImportPublicKeyObj` | method | before 11.6.1 | `UsePublicKey` |
| `OpenSslSignBd` | method | before 11.6.1 | `SignRawBd` |
| `OpenSslSignBytes` | method | before 11.6.1 | `SignRawBd` |
| `OpenSslSignBytesENC` | method | before 11.6.1 | `SignRawBd` |
| `OpenSslSignString` | method | before 11.6.1 | `SignRawBd` |
| `OpenSslSignStringENC` | method | before 11.6.1 | `SignRawBd` |
| `OpenSslVerifyBd` | method | before 11.6.1 | `VerifyRawBd` |
| `OpenSslVerifyBytes` | method | before 11.6.1 | `VerifyRawBd` |
| `OpenSslVerifyBytesENC` | method | before 11.6.1 | `VerifyRawBd` |
| `OpenSslVerifyString` | method | before 11.6.1 | `VerifyRawBd` |
| `OpenSslVerifyStringENC` | method | before 11.6.1 | `VerifyRawBd` |
| `SignBytes` | method | before 11.6.1 | — |
| `SignBytesENC` | method | before 11.6.1 | — |
| `SignHash` | method | before 11.6.1 | — |
| `SignString` | method | before 11.6.1 | — |
| `VerifyBytes` | method | before 11.6.1 | — |
| `VerifyBytesENC` | method | before 11.6.1 | — |
| `VerifyHash` | method | before 11.6.1 | — |
| `VerifyString` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/BinData.md), [`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/Cert.md), [`PrivateKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/PrivateKey.md), [`PublicKey`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/PublicKey.md)