CkoXmlCertVault Objective-C Reference Documentation

CkoXmlCertVault

Current Version: 9.5.0.73

Contains a collection of certificates and PFX files saved in an XML format.

Object Creation

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

Properties

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
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
MasterPassword
@property (nonatomic, copy) NSString *MasterPassword;
Introduced in version 9.5.0.40

The master password for the vault. Certificates are stored unencrypted, but private keys are stored 256-bit AES encrypted using the individual PFX passwords. The PFX passwords are stored 256-bit AES encrypted using the master password. The master password is required to acces any of the private keys stored within the XML vault.

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

AddCert
- (BOOL)AddCert:(CkoCert *)cert;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns YES for success, NO for failure.

top
AddCertBinary
- (BOOL)AddCertBinary:(NSData *)certBytes;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault from any binary format, such as DER.

Returns YES for success, NO for failure.

top
AddCertChain
- (BOOL)AddCertChain:(CkoCertChain *)certChain;
Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns YES for success, NO for failure.

top
AddCertEncoded
- (BOOL)AddCertEncoded:(NSString *)encodedBytes
    encoding:(NSString *)encoding;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault where certificate is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by encoding.

Returns YES for success, NO for failure.

top
AddCertFile
- (BOOL)AddCertFile:(NSString *)path;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns YES for success, NO for failure.

top
AddCertString
- (BOOL)AddCertString:(NSString *)certData;
Introduced in version 9.5.0.40

Adds a certificate from any string representation format such as PEM.

Returns YES for success, NO for failure.

top
AddPemFile
- (BOOL)AddPemFile:(NSString *)path
    password:(NSString *)password;
Introduced in version 9.5.0.40

Adds the contents of a PEM file to the XML vault. The PEM file may be encrypted, and it may contain one or more certificates and/or private keys. The password is optional and only required if the PEM file contains encrypted content that requires a password.

Returns YES for success, NO for failure.

top
AddPfx
- (BOOL)AddPfx:(CkoPfx *)pfx;
Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns YES for success, NO for failure.

top
AddPfxBinary
- (BOOL)AddPfxBinary:(NSData *)pfxBytes
    password:(NSString *)password;
Introduced in version 9.5.0.40

Adds a PFX to the XML vault where PFX is passed directly from in-memory binary bytes.

Returns YES for success, NO for failure.

top
AddPfxEncoded
- (BOOL)AddPfxEncoded:(NSString *)encodedBytes
    encoding:(NSString *)encoding
    password:(NSString *)password;

Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by encoding.

Returns YES for success, NO for failure.

top
AddPfxFile
- (BOOL)AddPfxFile:(NSString *)path
    password:(NSString *)password;
Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns YES for success, NO for failure.

top
GetXml
- (NSString *)GetXml;
Introduced in version 9.5.0.40

Returns the contents of the cert vault as an XML string.

Returns nil on failure

top
LoadXml
- (BOOL)LoadXml:(NSString *)xml;
Introduced in version 9.5.0.40

Loads from an XML string.

Returns YES for success, NO for failure.

top
LoadXmlFile
- (BOOL)LoadXmlFile:(NSString *)path;
Introduced in version 9.5.0.40

Loads from an XML file.

Returns YES for success, NO for 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
SaveXml
- (BOOL)SaveXml:(NSString *)path;
Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns YES for success, NO for failure.

top