CkoRsa Objective-C Reference Documentation

CkoRsa

Current Version: 9.5.0.73

RSA encryption component / library. Encrypt and decrypt byte arrays and strings. Generate public/private key pairs from 384 to 4096 bits in length. Import and export RSA keys. Import keys from SNK files. Input/output in raw binary, base64, hex encoding, quoted-printable, URL-encoding, etc.

Object Creation

CkoRsa *obj = [[CkoRsa alloc] init];

Properties

Charset
@property (nonatomic, copy) NSString *Charset;

This property only applies when encrypting, decrypting, signing, or verifying signatures for strings. When encrypting strings, the input string is first converted to this charset before encrypting.

When decrypting, the decrypted data is interpreted as a string with this charset encoding and converted to the appropriate return. For example, ActiveX's returning strings always return Unicode (2 bytes/char). Java strings are utf-8. Chilkat C++ strings are ANSI or utf-8. .NET strings are Unicode.

The default value of this property is the ANSI charset of the local computer.

When signing string data, the input string is first converted to this charset before being hashed and signed. When verifying the signature for string data, the input string is first converted to this charset before the verification process begins.

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EncodingMode
@property (nonatomic, copy) NSString *EncodingMode;

Encoding mode to be used in methods ending in "ENC", such as EncryptStringENC. Valid EncodingModes are "base64", "hex", "url", or "quoted-printable" (or "qp"). Encryption methods ending in "ENC" will return encrypted data as a string encoded according to this property's value. Decryption methods ending in "ENC" accept an encoded string as specified by this property. The string is first decoded and then decrypted. The default value is "base64".

This property also applies to the "ENC" methods for creating and verifying digital signatures.

More Information and Examples
top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *LastErrorHtml;

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *LastErrorText;

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *LastErrorXml;

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LittleEndian
@property (nonatomic) BOOL LittleEndian;

The default value is NO, which means that signatures and encrypted output will be created using the big endian byte ordering. A value of YES will produce little-endian output, which is what Microsoft's Crypto API produces.

Important: Prior to v9.5.0.49, this property behaved the opposite as it should for encryption. When updating from an older version of Chilkat to v9.5.0.49 or greater, the following change is required:

  • If the application did NOT explicity set the LittleEndian property, then no change is required for encryption/decryption. If signatures were being created or verified, then explicitly set this property to YES.
  • If the application explicitly set this property, then reverse the setting ONLY if doing encryption/decryption. No changes are required if doing signature creation/verification.

top
NoUnpad
@property (nonatomic) BOOL NoUnpad;

If YES, skips unpadding when decrypting. The default is NO. This property value is typically left unchanged.

top
NumBits
@property (nonatomic, readonly, copy) NSNumber *NumBits;

The number of bits of the key generated or imported into this RSA encryption object. Keys ranging in size from 384 bits to 4096 bits can be generated by calling GenerateKey. A public or private key may be imported by calling ImportPublicKey or ImportPrivateKey. A key must be available either via GenerateKey or import before any of the encrypt/decrypt methods may be called.

top
OaepHash
@property (nonatomic, copy) NSString *OaepHash;
Introduced in version 9.5.0.48

Selects the hash algorithm for use within OAEP padding. The valid choices are "sha1", "sha256", "sha384", "sha512", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The default is "sha1".

top
OaepMgfHash
@property (nonatomic, copy) NSString *OaepMgfHash;
Introduced in version 9.5.0.71

Selects the MGF (mask generation) hash algorithm for use within OAEP padding. The valid choices are "sha1", "sha256", "sha384", "sha512", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The default is "sha1".

top
OaepPadding
@property (nonatomic) BOOL OaepPadding;

Controls whether Optimal Asymmetric Encryption Padding (OAEP) is used for the padding scheme (for encrypting/decrypting). If set to NO, PKCS1 v1.5 padding is used. If set to YES, PKCS1 v2.0 (OAEP) padding is used.

Important: The OAEP padding algorithm uses randomly generated bytes. Therefore, the RSA result will be different each time, even if all of the other inputs are identical. For example, if you RSA encrypt or sign the same data using the same key 100 times, the output will appear different each time, but they are all valid.

When creating digital signatures, this property controls whether RSA-PSS or PKCS1 v1.5 is used. If YES, then the RSA-PSS signature scheme is used. The default value of this property is NO.

More Information and Examples
top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

Version of the component/library, such as "9.5.0.63"

top

Methods

DecryptBytes
- (NSData *)DecryptBytes:(NSData *)bData
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Decrypts byte data using the RSA encryption algorithm. usePrivateKey should be set to YES if the private key is to be used for decrypting. Otherwise it should be set to NO if the public key is to be used for decrypting.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
DecryptBytesENC
- (NSData *)DecryptBytesENC:(NSString *)str
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Same as DecryptBytes, except the input is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
DecryptString
- (NSString *)DecryptString:(NSData *)bData
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Decrypts encrypted string data and returns an unencrypted string. usePrivateKey should be set to YES if the private key is to be used for decrypting. Otherwise it should be set to NO if the public key is to be used. The Charset property controls how the component interprets the decrypted string. Depending on the programming language, strings are returned to the application as Unicode, utf-8, or ANSI. Internal to DecryptString, the decrypted string is automatically converted from the charset specified by the Charset property to the encoding required by the calling programming language.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
DecryptStringENC
- (NSString *)DecryptStringENC:(NSString *)str
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Same as DecryptString, except the input is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
EncryptBytes
- (NSData *)EncryptBytes:(NSData *)bData
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Encrypts byte data using the RSA encryption algorithm. usePrivateKey should be set to YES if the private key is to be used for encrypting. Otherwise it should be set to NO if the public key is to be used for encrypting.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
EncryptBytesENC
- (NSString *)EncryptBytesENC:(NSData *)bData
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Same as EncryptBytes, except the output is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
EncryptString
- (NSData *)EncryptString:(NSString *)str
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Encrypts a string using the RSA encryption algorithm. usePrivateKey should be set to YES if the private key is to be used for encrypting. Otherwise it should be set to NO if the public key is to be used for encrypting. The string is first converted (if necessary) to the character encoding specified by the Charset property before encrypting. The encrypted bytes are returned.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

More Information and Examples
top
EncryptStringENC
- (NSString *)EncryptStringENC:(NSString *)str
    bUsePrivateKey:(BOOL)bUsePrivateKey;

Same as EncryptString, except the output is an encoded string. The encoding is specified by the EncodingMode property, which can have values such as "base64", "hex", "quoted-printable", "url", etc.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO.

Returns nil on failure

top
ExportPrivateKey
- (NSString *)ExportPrivateKey;

Exports the private-key of an RSA key pair to XML format. This is typically called after generating a new RSA key via the GenerateKey method.

Returns nil on failure

top
ExportPrivateKeyObj
- (CkoPrivateKey *)ExportPrivateKeyObj;
Introduced in version 9.5.0.40

Exports the private-key to a private key object. This is typically called after generating a new RSA key via the GenerateKey method. Once the private key object is obtained, it may be saved in a variety of different formats.

Returns nil on failure

More Information and Examples
top
ExportPublicKey
- (NSString *)ExportPublicKey;

Exports the public-key of an RSA key pair to XML format. This is typically called after generating a new RSA key via the GenerateKey method.

Returns nil on failure

top
ExportPublicKeyObj
- (CkoPublicKey *)ExportPublicKeyObj;
Introduced in version 9.5.0.40

Exports the public key to a public key object. Once the public key object is obtained, it may be saved in a variety of different formats.

Returns nil on failure

More Information and Examples
top
GenerateKey
- (BOOL)GenerateKey:(NSNumber *)numBits;

Generates a new RSA public/private key pair. The number of bits can range from 512 to 8192. Typical key lengths are 1024, 2048, or 4096 bits. After successful generation, the public/private parts of the key can be exported to XML via the ExportPrivateKey and ExportPublicKey methods.

Note: Prior to version 9.5.0.49, the max key size was 4096 bits. Generating an 8192-bit RSA key takes a considerable amount of time and CPU processing power. There are no event callbacks or progress monitoring for RSA key generation. Calling this will block the thread until it returns.

Returns YES for success, NO for failure.

More Information and Examples
top
ImportPrivateKey
- (BOOL)ImportPrivateKey:(NSString *)strXml;

Imports a private key from XML format. After successful import, the private key can be used to encrypt or decrypt. A private key (by definition) contains both private and public parts. This is because the public key consist of modulus and exponent. The private key consists of modulus, exponent, P, Q, DP, DQ, InverseQ, and D using base64 representation:

<RSAKeyValue>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
  <P>...</P>
  <Q>...</Q>
  <DP>...</DP>
  <DQ>...</DQ>
  <InverseQ>...</InverseQ>
  <D>...</D>
</RSAKeyValue>

Important: The Rsa object can contain either a private key or a public key, but not both. Importing a private key overwrites the existing key regardless of whether the type of key is public or private.

Returns YES for success, NO for failure.

top
ImportPrivateKeyObj
- (BOOL)ImportPrivateKeyObj:(CkoPrivateKey *)key;
Introduced in version 9.5.0.40

Imports a private key from a private key object. The imported private key is used in methods that sign or decrypt.

Returns YES for success, NO for failure.

top
ImportPublicKey
- (BOOL)ImportPublicKey:(NSString *)strXml;

Imports a public key from XML format. After successful import, the public key can be used to encrypt or decrypt.

Note: Importing a public key overwrites the key that is currently contained in this object - even if it's a private key.

A public key consists of modulus and exponent using base64 representation:

<RSAKeyValue>
  <Modulus>...</Modulus>
  <Exponent>...</Exponent>
</RSAKeyValue>

Important: The Rsa object can contain either a private key or a public key, but not both. Importing a private key overwrites the existing key regardless of whether the type of key is public or private.

Returns YES for success, NO for failure.

top
ImportPublicKeyObj
- (BOOL)ImportPublicKeyObj:(CkoPublicKey *)key;
Introduced in version 9.5.0.40

Imports a public key from a public key object. The imported public key is used in methods that encrypt data or verify signatures.

Returns YES for success, NO for failure.

More Information and Examples
top
OpenSslSignBytes
- (NSData *)OpenSslSignBytes:(NSData *)data;

Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature bytes.

Returns nil on failure

top
OpenSslSignBytesENC
- (NSString *)OpenSslSignBytesENC:(NSData *)data;

Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data consists of binary bytes, and returns the signature as a string encoded according to the EncodingMode property (base64, hex, etc.).

Returns nil on failure

top
OpenSslSignString
- (NSData *)OpenSslSignString:(NSString *)str;

Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature bytes.

Returns nil on failure

top
OpenSslSignStringENC
- (NSString *)OpenSslSignStringENC:(NSString *)str;

Duplicates OpenSSL's rsautl utility for creating RSA signatures. Input data is a string, and returns the signature as a string encoded according to the EncodingMode property (base64, hex, etc.).

Returns nil on failure

top
OpenSslVerifyBytes
- (NSData *)OpenSslVerifyBytes:(NSData *)signature;

Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data consists of the raw signature bytes and returns the original bytes.

Returns nil on failure

top
OpenSslVerifyBytesENC
- (NSData *)OpenSslVerifyBytesENC:(NSString *)str;

Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data is a signature string encoded according to the EncodingMode property (base64, hex, etc.). Returns the original bytes.

Returns nil on failure

top
OpenSslVerifyString
- (NSString *)OpenSslVerifyString:(NSData *)data;

Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data consists of the raw signature bytes and returns the original string.

Returns nil on failure

top
OpenSslVerifyStringENC
- (NSString *)OpenSslVerifyStringENC:(NSString *)str;

Duplicates OpenSSL's rsautl utility for verifying RSA signatures and recovering the original data. Input data is a signature string encoded according to the EncodingMode property (base64, hex, etc.). Returns the original string.

Returns nil on failure

top
SaveLastError
- (BOOL)SaveLastError:(NSString *)path;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns YES for success, NO for failure.

top
SetX509Cert
- (BOOL)SetX509Cert:(CkoCert *)cert
    usePrivateKey:(BOOL)usePrivateKey;
Introduced in version 9.5.0.73

Provides the private or public key indirectly through a certificate. This method is especially useful on Windows computers where the private key is installed as non-exportable (such as on a hardware token).

Returns YES for success, NO for failure.

top
SignBytes
- (NSData *)SignBytes:(NSData *)bData
    hashAlg:(NSString *)hashAlg;

Creates an RSA digital signature by hashing binaryData and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".

Important: If trying to match OpenSSL results, set the LittleEndian property = NO. (The LittleEndian property should also be set to NO to match Amazon web services, such as CloudFront.)

A private key is required to create a digital signature.

An error is indicated when a byte array of 0 length is returned.

Returns nil on failure

top
SignBytesENC
- (NSString *)SignBytesENC:(NSData *)bData
    hashAlg:(NSString *)hashAlg;

Creates an RSA digital signature by hashing binaryData and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1". The digital signature is returned as an encoded string, where the encoding is specified by the EncodingMode property.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO. (The LittleEndian property should also be set to NO to match Amazon web services, such as CloudFront.)

A private key is required to create a digital signature.

An error is indicated when null reference is returned.

Returns nil on failure

top
SignHash
- (NSData *)SignHash:(NSData *)hashBytes
    hashAlg:(NSString *)hashAlg;

The same as the SignBytes method, except the hash to be signed is passed directly.

Returns nil on failure

top
SignHashENC
- (NSString *)SignHashENC:(NSString *)encodedHash
    hashAlg:(NSString *)hashAlg;

The same as SignBytesENC except the hash is passed directly.

Returns nil on failure

top
SignString
- (NSData *)SignString:(NSString *)str
    hashAlg:(NSString *)hashAlg;

Creates an RSA digital signature by hashing strToBeHashed and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".

Important: If trying to match OpenSSL results, set the LittleEndian property = NO. (The LittleEndian property should also be set to NO to match Amazon web services, such as CloudFront.)

A private key is required to create a digital signature.

An error is indicated when a byte array of 0 length is returned.

Returns nil on failure

top
SignStringENC
- (NSString *)SignStringENC:(NSString *)str
    hashAlg:(NSString *)hashAlg;

Creates an RSA digital signature by hashing strToBeHashed and then signing the hash. The hash algorithm is specified by hashAlgorithm, which may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1". The digital signature is returned as an encoded string, where the encoding is specified by the EncodingMode property.

Important: If trying to match OpenSSL results, set the LittleEndian property = NO. (The LittleEndian property should also be set to NO to match Amazon web services, such as CloudFront.)

A private key is required to create a digital signature.

An error is indicated when null reference is returned.

Returns nil on failure

top
SnkToXml
- (NSString *)SnkToXml:(NSString *)snkPath;

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

Returns nil on failure

top
UnlockComponent
- (BOOL)UnlockComponent:(NSString *)unlockCode;

Unlocks the component. This must be called once prior to calling any other method.

Returns YES for success, NO for failure.

top
VerifyBytes
- (BOOL)VerifyBytes:(NSData *)bData
    hashAlg:(NSString *)hashAlg
    sigData:(NSData *)sigData;

Verifies an RSA digital signature. Returns YES if the signature is valid for the originalData. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".

top
VerifyBytesENC
- (BOOL)VerifyBytesENC:(NSData *)bData
    hashAlg:(NSString *)hashAlg
    encodedSig:(NSString *)encodedSig;

Verifies an RSA digital signature. Returns YES if the signature is valid for the originalData. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".

The encodedSig is a digital signature encoded according to the EncodingMode property (i.e. base64, hex, etc.).

top
VerifyHash
- (BOOL)VerifyHash:(NSData *)hashBytes
    hashAlg:(NSString *)hashAlg
    sigBytes:(NSData *)sigBytes;

The same as VerifyBytes except the hash of the original data is passed directly.

top
VerifyHashENC
- (BOOL)VerifyHashENC:(NSString *)encodedHash
    hashAlg:(NSString *)hashAlg
    encodedSig:(NSString *)encodedSig;

The same as VerifyBytesENC except the hash of the original data is passed directly.

top
VerifyPrivateKey
- (BOOL)VerifyPrivateKey:(NSString *)xml;

Returns YES if the XML contains a valid RSA private key. Otherwise returns NO.

Returns YES for success, NO for failure.

top
VerifyString
- (BOOL)VerifyString:(NSString *)str
    hashAlg:(NSString *)hashAlg
    sigData:(NSData *)sigData;

Verifies an RSA digital signature. Returns YES if the signature is valid for the originalString. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".

top
VerifyStringENC
- (BOOL)VerifyStringENC:(NSString *)str
    hashAlg:(NSString *)hashAlg
    sig:(NSString *)sig;

Verifies an RSA digital signature. Returns YES if the signature is valid for the originalString. The hashAlgorithm may be "SHA-1", "MD5", "MD2", "SHA-256", "SHA-384", or "SHA-512". The recommended hash algorithm is "SHA-1".

The encodedSig is a digital signature encoded according to the EncodingMode property (i.e. base64, hex, etc.).

top