TChilkatCsr Delphi ActiveX Reference Documentation

TChilkatCsr

Current Version: 10.0.0

Requires Chilkat Bundle License

A class for generating Certificate Signing Requests (CSR) or for reading an existing CSR.

This class is introduced in Chilkat v9.5.0.65

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).

Two things are required to use an ActiveX in Delphi:

The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
See also: ActiveX Registration Tutorial
The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
Check the "Generate Component Wrappers" checkbox.
Select a directory where the unit files (.pas and .dcr) should be generated.
Select "Create Unit" and then "Finish".
Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

Object Creation

var
obj: TChilkatCsr;
...
begin
obj := TChilkatCsr.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

CommonName

property CommonName: WideString

Introduced in version 9.5.0.65

The common name of the certificate to be generated. For SSL/TLS certificates, this would be the domain name. For email certificates this would be the email address.

It is the value for "CN" in the certificate's Subject's distinguished name (DN). (This is the value for OID "2.5.4.3")

This property is required for a CSR.

Company

property Company: WideString

Introduced in version 9.5.0.65

The company or organization name for the certificate to be generated.

It is the value for "O" in the certificate's Subject's distinguished name (DN). (This is the value for OID "2.5.4.10")

This property is optional. It may left empty.

CompanyDivision

property CompanyDivision: WideString

Introduced in version 9.5.0.65

The company division or organizational unit name for the certificate to be generated.

It is the value for "OU" in the certificate's Subject's distinguished name (DN). (This is the value for OID "2.5.4.11")

This property is optional. It may left empty.

Country

property Country: WideString

Introduced in version 9.5.0.65

The two-letter uppercase country abbreviation, such as "US", for the certificate to be generated.

It is the value for "C" in the certificate's Subject's distinguished name (DN). (This is the value for OID "2.5.4.6")

This property is optional. It may left empty.

DebugLogFilePath

property DebugLogFilePath: WideString

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:

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

More Information and Examples

Example showing how to use DebugLogFilePath.

EmailAddress

property EmailAddress: WideString

Introduced in version 9.5.0.65

The email address for the certificate to be generated.

It is the value for "E" in the certificate's Subject's distinguished name (DN). (This is the value for OID "1.2.840.113549.1.9.1")

This property is optional. It may left empty.

HashAlgorithm

property HashAlgorithm: WideString

Introduced in version 9.5.0.82

The hash algorithm to be used when creating the CSR. The default is SHA256. Can be set to SHA1, SHA384, SHA256, or SHA512.

LastBinaryResult

property LastBinaryResult: OleVariant readonly

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml

property LastErrorHtml: WideString readonly

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.

LastErrorText

property LastErrorText: WideString readonly

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

property LastErrorXml: WideString readonly

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.

LastMethodSuccess

property LastMethodSuccess: Integer

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult

property LastStringResult: WideString readonly

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

property LastStringResultLen: Integer readonly

The length, in characters, of the string contained in the LastStringResult property.

Locality

property Locality: WideString

Introduced in version 9.5.0.65

The locality (city or town) name for the certificate to be generated.

It is the value for "L" in the certificate's Subject's distinguished name (DN). (This is the value for OID "2.5.4.7")

This property is optional. It may left empty.

MgfHashAlg

property MgfHashAlg: WideString

Introduced in version 9.5.0.83

If the private key is RSA and PssPadding equals 1 (RSASSA-PSS padding is used for the RSA signature), then this property controls the MGF hash algorithm used in the RSASSA-PSS padding. The default is "sha256". Can be set to "sha256", "sha384", or "sha512".

PssPadding

property PssPadding: Integer

Introduced in version 9.5.0.83

If _CKTRUE_, and if the private key is RSA, then uses RSASSA-PSS padding for the signature.

State

property State: WideString

Introduced in version 9.5.0.65

The state or province for the certificate to be generated.

It is the value for "S" (or "ST") in the certificate's Subject's distinguished name (DN). (This is the value for OID "2.5.4.8")

This property is optional. It may left empty.

VerboseLogging

property VerboseLogging: Integer

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

Version

property Version: WideString readonly

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddSan

function AddSan(sanType: WideString; sanValue: WideString): Integer;

Introduced in version 9.5.0.84

Adds a SAN value (Subject Alternative Name) to the CSR to be generated. This method can be called multiple times -- one per subject alternative name to be added.

The sanType specifies the type of SAN, and can be one of the following strings:

otherName
rfc822Name
dnsName
x400Address
directoryName
ediPartyName
uniformResourceIndicator
IPAddress
registeredID

The sanValue is the value. For example, if the sanType is "dsnName", the sanValue might be "example.com". If the sanType is "IPAddress", then the sanValue might be "69.12.122.63".

Returns 1 for success, 0 for failure.

GenCsrBd

function GenCsrBd(privKey: TPrivateKey; csrData: TChilkatBinData): Integer;

Introduced in version 9.5.0.65

Generate a CSR and return the binary DER in csrData. The privKey can be an RSA or ECDSA private key.

Returns 1 for success, 0 for failure.

More Information and Examples

Renew a DigiCert Certificate from an EST-enabled profile

GenCsrPem

function GenCsrPem(privKey: TPrivateKey): WideString;

Introduced in version 9.5.0.65

Generate a CSR and return it as a PEM string. The privKey can be an RSA or ECDSA private key.

Returns a zero-length WideString on failure

More Information and Examples

Generate Key and Certificate Signing Request (CSR)Generate CSR from Pre-Existing Private Key Generate a CSR with SAN (Subject Alternative Name) Extension Duplicate CSR Created by OpenSSL with Config.cnf

GetExtensionRequest

function GetExtensionRequest(extensionReqXml: TChilkatXml): Integer;

Introduced in version 9.5.0.91

Gets the 1.2.840.113549.1.9.14 extensionRequest from the previously loaded CSR. The extensionReqXml will be loaded with the extension request XML if one exists.

Returns 1 for success, 0 for failure.

More Information and Examples

CSR Get Extension Request

GetPublicKey

function GetPublicKey(pubkey: TPublicKey): Integer;

Introduced in version 9.5.0.76

Returns the CSR's public key in the pubkey.

Returns 1 for success, 0 for failure.

GetSans

function GetSans(sans: TChilkatStringTable): Integer;

Introduced in version 9.5.0.91

Gets the SANS (Subject Alternative Names) of the currently loaded CSR. The information is written to the passed-in sans object.

Returns 1 for success, 0 for failure.

GetSubjectField

function GetSubjectField(oid: WideString): WideString;

Introduced in version 9.5.0.65

Gets a subject field by OID, such as "2.5.4.9". See http://www.alvestrand.no/objectid/2.5.4.html for OID values and meanings.

Returns a zero-length WideString on failure

More Information and Examples

Generate CSR with Uncommon Fields

LoadCsrPem

function LoadCsrPem(csrPemStr: WideString): Integer;

Introduced in version 9.5.0.65

Loads this CSR object with a CSR PEM. All properties are set to the values found within the CSR.

Returns 1 for success, 0 for failure.

More Information and Examples

Load a CSR and Examine the Contents

SetExtensionRequest

function SetExtensionRequest(extensionReqXml: TChilkatXml): Integer;

Introduced in version 9.5.0.91

Adds a 1.2.840.113549.1.9.14 extensionRequest to the CSR. The extensionReqXml contains the ASN.1 in XML format of the extension request to be added.

Returns 1 for success, 0 for failure.

More Information and Examples

Generate a CSR containing an Extension Request

SetSubjectField

function SetSubjectField(oid: WideString; value: WideString; asnType: WideString): Integer;

Introduced in version 9.5.0.65

Sets a subject field by OID, such as "2.5.4.9". See http://www.alvestrand.no/objectid/2.5.4.html for OID values and meanings.

The asnType can be "UTF8String", "IA5String", or "PrintableString". If you have no specific requirement, or don't know, choose "UTF8String".

Returns 1 for success, 0 for failure.

VerifyCsr

function VerifyCsr(): Integer;

Introduced in version 9.5.0.83

Verify the signature in the CSR. Return 1 if the signature is valid.

Returns 1 for success, 0 for failure.