CkoCert Objective-C Reference Documentation

CkoCert

Current Version: 9.5.0.73

Digital certificate component / class

Object Creation

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

Properties

AuthorityKeyId
@property (nonatomic, readonly, copy) NSString *AuthorityKeyId;
Introduced in version 9.5.0.40

The authority key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.35.

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

The version of the certificate (1, 2, or 3). A value of 0 indicates an error -- the most likely cause being that the certificate object is empty (i.e. was never loaded with a certificate). Note: This is not the version of the software, it is the version of the X.509 certificate object. The version of the Chilkat certificate software is indicated by the Version property.

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
Expired
@property (nonatomic, readonly) BOOL Expired;

Has a value of YES if the certificate or any certificate in the chain of authority has expired. (This information is not available when running on Windows 95/98 computers.)

top
ForClientAuthentication
@property (nonatomic, readonly) BOOL ForClientAuthentication;

YES if this certificate can be used for client authentication, otherwise NO.

top
ForCodeSigning
@property (nonatomic, readonly) BOOL ForCodeSigning;

YES if this certificate can be used for code signing, otherwise NO.

top
ForSecureEmail
@property (nonatomic, readonly) BOOL ForSecureEmail;

YES if this certificate can be used for sending secure email, otherwise NO.

top
ForServerAuthentication
@property (nonatomic, readonly) BOOL ForServerAuthentication;

YES if this certificate can be used for server authentication, otherwise NO.

top
ForTimeStamping
@property (nonatomic, readonly) BOOL ForTimeStamping;

YES if this certificate can be used for time stamping, otherwise NO.

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

Bitflags indicating the intended usages of the certificate. The flags are:
Digital Signature: 0x80
Non-Repudiation: 0x40
Key Encipherment: 0x20
Data Encipherment: 0x10
Key Agreement: 0x08
Certificate Signing: 0x04
CRL Signing: 0x02
Encipher-Only: 0x01

top
IsRoot
@property (nonatomic, readonly) BOOL IsRoot;

YES if this is the root certificate, otherwise NO.

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

The certificate issuer's country.

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

The certificate issuer's common name.

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

The issuer's full distinguished name.

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

The certificate issuer's email address.

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

The certificate issuer's locality, which could be a city, count, township, or other geographic region.

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

The certificate issuer's organization, which is typically the company name.

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

The certificate issuer's organizational unit, which is the unit within the organization.

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

The certificate issuer's state or province.

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
OcspUrl
@property (nonatomic, readonly, copy) NSString *OcspUrl;

If present in the certificate's extensions, returns the OCSP URL of the certificate. (The Online Certificate Status Protocol (OCSP) is an Internet protocol used for obtaining the revocation status of an X.509 digital certificate.)

top
Revoked
@property (nonatomic, readonly) BOOL Revoked;

YES if the certificate or any certificate in the chain of authority has been revoked. This information is not available when running on Windows 95/98 computers. Note: If this property is NO, it could mean that it was not able to check the revocation status. Because of this uncertainty, a CheckRevoked method has been added. It returns an integer indicating one of three possible states: 1 (revoked) , 0 (not revoked), -1 (unable to check revocation status).

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

The RFC-822 name of the certificate. (Also known as the Subject Alternative Name.)

If the certificate contains a list of Subject Alternative Names, such as a list of host names to be protected by a single SSL certificate, then this property will contain the comma separated list of names.

top
SelfSigned
@property (nonatomic, readonly) BOOL SelfSigned;

YES if this is a self-signed certificate, otherwise NO.

top
SerialDecimal
@property (nonatomic, readonly, copy) NSString *SerialDecimal;
Introduced in version 9.5.0.75

The certificate's serial number as a decimal string.

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

The certificate's serial number as a hexidecimal string.

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

Hexidecimal string of the SHA-1 thumbprint for the certificate.

top
SignatureVerified
@property (nonatomic, readonly) BOOL SignatureVerified;

Returns YES if the certificate and all certificates in the chain of authority have valid signatures, otherwise returns NO.

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

The certificate subject's country.

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

The certificate subject's common name.

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

The certificate subject's full distinguished name.

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

The certificate subject's email address.

top
SubjectKeyId
@property (nonatomic, readonly, copy) NSString *SubjectKeyId;
Introduced in version 9.5.0.40

The subject key identifier of the certificate in base64 string format. This is only present if the certificate contains the extension OID 2.5.29.14.

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

The certificate subject's locality, which could be a city, count, township, or other geographic region.

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

The certificate subject's organization, which is typically the company name.

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

The certificate subject's organizational unit, which is the unit within the organization.

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

The certificate subject's state or province.

top
TrustedRoot
@property (nonatomic, readonly) BOOL TrustedRoot;

Returns YES if the certificate has a trusted root authority, otherwise returns NO.

Note: As of version 9.5.0.41, the notion of what your application deems as trusted becomes more specific. The TrustedRoots class/object was added in v9.5.0.0. Prior to this, a certificate was considered to be anchored by a trusted root if the certificate chain could be established to a root (self-signed) certificate, AND if the root certificate was located somewhere in the Windows registry-based certificate stores. There are two problems with this: (1) it's a Windows-only solution. This property would always return NO on non-Windows systems, and (2) it might be considered not a strong enough set of conditions for trusting a root certificate.

As of version 9.5.0.41, this property pays attention to the new TrustedRoots class/object, which allows for an application to specificallly indicate which root certificates are to be trusted. Certificates may be added to the TrustedRoots object via the LoadCaCertsPem or AddCert methods, and then activated by calling the TrustedRoots.Activate method. The activated trusted roots are deemed to be trusted in any Chilkat API method/property that needs to make this determination. In addition, the TrustedRoots object has a property named TrustSystemCaRoots, which defaults to YES, which allows for backward compatibility. It will trust CA certificates stored in the Windows registry-based certificate stores, or if on Linux, will trust certificates found in /etc/ssl/certs/ca-certificates.crt.

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

The date (in RFC822 string format) that this certificate becomes (or became) valid. It is a GMT/UTC date that is returned.

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

The date (in RFC822 string format) that this certificate becomes (or became) invalid. It is a GMT/UTC date that is returned.

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

CheckRevoked
- (NSNumber *)CheckRevoked;

Returns 1 if the certificate has been revoked, 0 if not revoked, and -1 if unable to check the revocation status.

top
ExportCertDer
- (NSData *)ExportCertDer;

Exports the digital certificate to ASN.1 DER format.

Returns nil on failure

top
ExportCertDerBd
- (BOOL)ExportCertDerBd:(CkoBinData *)cerData;
Introduced in version 9.5.0.70

Exports the digital certificate in ASN.1 DER format to a BinData object.

Returns YES for success, NO for failure.

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

Exports the digital certificate to ASN.1 DER format binary file.

Returns YES for success, NO for failure.

top
ExportCertPem
- (NSString *)ExportCertPem;

Exports the digital certificate to an unencrypted PEM formatted string.

Returns nil on failure

More Information and Examples
top
ExportCertPemFile
- (BOOL)ExportCertPemFile:(NSString *)path;

Exports the digital certificate to an unencrypted PEM formatted file.

Returns YES for success, NO for failure.

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

Exports a certificate to an XML format where the XML tags are the names of the ASN.1 objects that compose the X.509 certificate. Binary data is either hex or base64 encoded. (The binary data for a "bits" ASN.1 tag is hex encoded, whereas for all other ASN.1 tags, such as "octets", it is base64.)

Returns nil on failure

top
ExportPrivateKey
- (CkoPrivateKey *)ExportPrivateKey;

Exports the certificate's private key.

Returns nil on failure

top
ExportPublicKey
- (CkoPublicKey *)ExportPublicKey;

Exports the certificate's public key.

Returns nil on failure

More Information and Examples
top
ExportToPfxBd
- (BOOL)ExportToPfxBd:(NSString *)password
    includeCertChain:(BOOL)includeCertChain
    pfxData:(CkoBinData *)pfxData;
Introduced in version 9.5.0.70

Exports the certificate and private key (if available) to pfxData. The password is what will be required to access the PFX contents at a later time. If includeCertChain is YES, then the certificates in the chain of authority are also included in the PFX.

Returns YES for success, NO for failure.

top
ExportToPfxData
- (NSData *)ExportToPfxData:(NSString *)password
    includeCertChain:(BOOL)includeCertChain;
Introduced in version 9.5.0.31

Exports the certificate and private key (if available) to an in-memory PFX image. The password is what will be required to access the PFX contents at a later time. If includeCertChain is YES, then the certificates in the chain of authority are also included in the PFX.

Returns nil on failure

top
FindIssuer
- (CkoCert *)FindIssuer;

Finds and returns the issuer certificate. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate. (The IsRoot property can be check to see if the certificate is a root (or self-issued) certificate.)

Returns nil on failure

top
GetCertChain
- (CkoCertChain *)GetCertChain;
Introduced in version 9.5.0.40

Returns a certficate chain object containing all the certificates (including this one), in the chain of authentication to the trusted root (if possible). If this certificate object was loaded from a PFX, then the certiicates contained in the PFX are automatically available for building the certificate chain. The UseCertVault method can be called to provide additional certificates that might be required to build the cert chain. Finally, the TrustedRoots object can be used to provide a way of making trusted root certificates available.

Note: Prior to v9.5.0.50, this method would fail if the certificate chain could not be completed to the root. Starting in v9.5.0.50, the incomplete certificate chain will be returned. The certificate chain's ReachesRoot property can be examined to see if the chain was completed to the root.

On Windows systems, the registry-based certificate stores are automatically consulted if needed to locate intermediate or root certificates in the chain.

Returns nil on failure

top
GetEncoded
- (NSString *)GetEncoded;

Returns a base64 encoded string representation of the certificate's binary DER format, which can be passed to SetFromEncoded to recreate the certificate object.

Returns nil on failure

top
GetExtensionAsXml
- (NSString *)GetExtensionAsXml:(NSString *)oid;
Introduced in version 9.5.0.49

Returns the certificate extension data in XML format (converted from ASN.1). The oid is an OID, such as the ones listed here: http://www.alvestrand.no/objectid/2.5.29.html

Note: In many cases, the data within the XML is returned base64 encoded. An application may need to take one further step to base64 decode the information contained within the XML.

Returns nil on failure

top
GetPrivateKeyPem
- (NSString *)GetPrivateKeyPem;

Exports the certificate's private key to a PEM string (if the private key is available).

Returns nil on failure

top
GetSpkiFingerprint
- (NSString *)GetSpkiFingerprint:(NSString *)hashAlg
    encoding:(NSString *)encoding;
Introduced in version 9.5.0.55

Returns the SPKI Fingerprint suitable for use in pinning. (See RFC 7469.) An SPKI Fingerprint is defined as the output of a known cryptographic hash algorithm whose input is the DER-encoded ASN.1 representation of the Subject Public Key Info (SPKI) of an X.509 certificate. The hashAlg specifies the hash algorithm and may be "sha256", "sha384", "sha512", "sha1", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding specifies the encoding, and may be "base64", "hex", or any of the encoding modes specified in the article at the link below.

Returns nil on failure

More Information and Examples
top
GetValidFromDt
- (CkoDateTime *)GetValidFromDt;

Returns the date/time this certificate becomes (or became) valid.

Returns nil on failure

top
GetValidToDt
- (CkoDateTime *)GetValidToDt;

Returns the date/time this certificate becomes (or became) invalid.

Returns nil on failure

top
HasPrivateKey
- (BOOL)HasPrivateKey;

Returns true if the private key is installed on the local system for the certificate.

top
LoadFromBase64
- (BOOL)LoadFromBase64:(NSString *)encodedCert;

Loads an ASN.1 or DER encoded certificate represented in a Base64 string.

Returns YES for success, NO for failure.

More Information and Examples
top
LoadFromBd
- (BOOL)LoadFromBd:(CkoBinData *)certBytes;
Introduced in version 9.5.0.70

Loads an X.509 certificate from the ASN.1 DER encoded bytes contained in certBytes.

Returns YES for success, NO for failure.

top
LoadFromBinary
- (BOOL)LoadFromBinary:(NSData *)data;

Loads an X.509 certificate from ASN.1 DER encoded bytes.

Returns YES for success, NO for failure.

top
LoadFromBinary2
- (BOOL)LoadFromBinary2:(NSData *)pByteData
    szByteData:(NSNumber *)szByteData;

The same as LoadFromBinary, but instead of using a CkByteData object, the pointer to the byte data and length (in number of bytes) are specified directly in the method arguments.

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

Loads a certificate from a .cer, .crt, .p7b, or .pem file. This method accepts certificates from files in any of the following formats:
1. DER encoded binary X.509 (.CER)
2. Base-64 encoded X.509 (.CER)
3. Cryptographic Message Syntax Standard - PKCS #7 Certificates (.P7B)
4. PEM format
This method decodes the certificate based on the contents if finds within the file, and not based on the file extension. If your certificate is in a file having a different extension, try loading it using this method before assuming it won't work. This method does not load .p12 or .pfx (PKCS #12) files.

Returns YES for success, NO for failure.

top
LoadPem
- (BOOL)LoadPem:(NSString *)strPem;
Introduced in version 9.5.0.49

Loads the certificate from a PEM string.

Returns YES for success, NO for failure.

top
LoadPfxBd
- (BOOL)LoadPfxBd:(CkoBinData *)pfxData
    password:(NSString *)password;
Introduced in version 9.5.0.70

Loads the certificate from the PFX contained in pfxData. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns YES for success, NO for failure.

top
LoadPfxData
- (BOOL)LoadPfxData:(NSData *)pfxData
    password:(NSString *)password;

Loads a PFX from an in-memory image of a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns YES for success, NO for failure.

top
LoadPfxData2
- (BOOL)LoadPfxData2:(NSData *)pByteData
    szByteData:(NSNumber *)szByteData
    password:(NSString *)password;

Loads a PFX from an in-memory image of a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns YES for success, NO for failure.

top
LoadPfxFile
- (BOOL)LoadPfxFile:(NSString *)path
    password:(NSString *)password;

Loads a PFX file. Note: If the PFX contains multiple certificates, the 1st certificate in the PFX is loaded.

Returns YES for success, NO for failure.

top
LoadTaskResult
- (BOOL)LoadTaskResult:(CkoTask *)task;
Introduced in version 9.5.0.52

Loads the certificate from a completed asynchronous task.

Returns YES for success, NO for failure.

top
PemFileToDerFile
- (BOOL)PemFileToDerFile:(NSString *)fromPath
    toPath:(NSString *)toPath;

Converts a PEM file to a DER 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
SaveToFile
- (BOOL)SaveToFile:(NSString *)path;

Saves a certificate object to a .cer file.

Returns YES for success, NO for failure.

top
SetFromEncoded
- (BOOL)SetFromEncoded:(NSString *)encodedCert;

Initializes the certificate object from a base64 encoded string representation of the certificate's binary DER format.

Returns YES for success, NO for failure.

top
SetPrivateKey
- (BOOL)SetPrivateKey:(CkoPrivateKey *)privKey;

Used to associate a private key with the certificate for subsequent (PKCS7) signature creation or decryption.

Returns YES for success, NO for failure.

top
SetPrivateKeyPem
- (BOOL)SetPrivateKeyPem:(NSString *)privKeyPem;

Same as SetPrivateKey, but the key is provided in unencrypted PEM format. (Note: The privKeyPem is not a file path, it is the actual PEM text.)

Returns YES for success, NO for failure.

top
UseCertVault
- (BOOL)UseCertVault:(CkoXmlCertVault *)vault;
Introduced in version 9.5.0.40

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains and verifying the certificate signature to the trusted root.

Returns YES for success, NO for failure.

top
VerifySignature
- (BOOL)VerifySignature;
Introduced in version 9.5.0.40

Verifies the certificate signature, as well as the signatures of all certificates in the chain of authentication to the trusted root. Returns YES if all signatures are verified to the trusted root. Otherwise returns NO.

top