Csr Delphi DLL Reference Documentation

Csr

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

Create/Dispose

var
myObject: HCkCsr;

begin
myObject := CkCsr_Create();

// ...

CkCsr_Dispose(myObject);
end;

function CkCsr_Create: HCkCsr; stdcall;

Creates an instance of the HCkCsr object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkCsr_Dispose(handle: HCkCsr); stdcall;

Objects created by calling CkCsr_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

CommonName

procedure CkCsr_getCommonName(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putCommonName(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__commonName(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

Company

procedure CkCsr_getCompany(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putCompany(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__company(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

CompanyDivision

procedure CkCsr_getCompanyDivision(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putCompanyDivision(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__companyDivision(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

Country

procedure CkCsr_getCountry(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putCountry(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__country(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

DebugLogFilePath

procedure CkCsr_getDebugLogFilePath(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putDebugLogFilePath(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__debugLogFilePath(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

EmailAddress

procedure CkCsr_getEmailAddress(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putEmailAddress(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__emailAddress(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

HashAlgorithm

procedure CkCsr_getHashAlgorithm(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putHashAlgorithm(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__hashAlgorithm(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorHtml

procedure CkCsr_getLastErrorHtml(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
function CkCsr__lastErrorHtml(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkCsr_getLastErrorText(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
function CkCsr__lastErrorText(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkCsr_getLastErrorXml(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
function CkCsr__lastErrorXml(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkCsr_getLastMethodSuccess(objHandle: HCkCsr): wordbool; stdcall;
procedure CkCsr_putLastMethodSuccess(objHandle: HCkCsr; newPropVal: wordbool); stdcall;

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

Locality

procedure CkCsr_getLocality(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putLocality(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__locality(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

MgfHashAlg

procedure CkCsr_getMgfHashAlg(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putMgfHashAlg(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__mgfHashAlg(objHandle: HCkCsr): PWideChar; stdcall;

Introduced in version 9.5.0.83

If the private key is RSA and PssPadding equals True (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".

See the notes about PWideChar memory ownership and validity.

PssPadding

function CkCsr_getPssPadding(objHandle: HCkCsr): wordbool; stdcall;
procedure CkCsr_putPssPadding(objHandle: HCkCsr; newPropVal: wordbool); stdcall;

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

procedure CkCsr_getState(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
procedure CkCsr_putState(objHandle: HCkCsr; newPropVal: PWideChar); stdcall;
function CkCsr__state(objHandle: HCkCsr): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkCsr_getVerboseLogging(objHandle: HCkCsr): wordbool; stdcall;
procedure CkCsr_putVerboseLogging(objHandle: HCkCsr; newPropVal: wordbool); stdcall;

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

Version

procedure CkCsr_getVersion(objHandle: HCkCsr; outPropVal: HCkString); stdcall;
function CkCsr__version(objHandle: HCkCsr): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddSan

function CkCsr_AddSan(objHandle: HCkCsr;
sanType: PWideChar;
sanValue: PWideChar): wordbool; stdcall;

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 True for success, False for failure.

GenCsrBd

function CkCsr_GenCsrBd(objHandle: HCkCsr;
privKey: HCkPrivateKey;
csrData: HCkBinData): wordbool; stdcall;

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 True for success, False for failure.

More Information and Examples

Renew a DigiCert Certificate from an EST-enabled profile

GenCsrPem

function CkCsr_GenCsrPem(objHandle: HCkCsr;
    privKey: HCkPrivateKey;
    outStr: HCkString): wordbool; stdcall;
function CkCsr__genCsrPem(objHandle: HCkCsr;
    privKey: HCkPrivateKey): PWideChar; stdcall;

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 True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

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 CkCsr_GetExtensionRequest(objHandle: HCkCsr;
extensionReqXml: HCkXml): wordbool; stdcall;

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 True for success, False for failure.

More Information and Examples

CSR Get Extension Request

GetPublicKey

function CkCsr_GetPublicKey(objHandle: HCkCsr;
pubkey: HCkPublicKey): wordbool; stdcall;

Introduced in version 9.5.0.76

Returns the CSR's public key in the pubkey.

Returns True for success, False for failure.

GetSans

function CkCsr_GetSans(objHandle: HCkCsr;
sans: HCkStringTable): wordbool; stdcall;

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 True for success, False for failure.

GetSubjectField

function CkCsr_GetSubjectField(objHandle: HCkCsr;
    oid: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkCsr__getSubjectField(objHandle: HCkCsr;
    oid: PWideChar): PWideChar; stdcall;

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 True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Generate CSR with Uncommon Fields

LoadCsrPem

function CkCsr_LoadCsrPem(objHandle: HCkCsr;
csrPemStr: PWideChar): wordbool; stdcall;

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 True for success, False for failure.

More Information and Examples

Load a CSR and Examine the Contents

SetExtensionRequest

function CkCsr_SetExtensionRequest(objHandle: HCkCsr;
extensionReqXml: HCkXml): wordbool; stdcall;

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 True for success, False for failure.

More Information and Examples

Generate a CSR containing an Extension Request

SetSubjectField

function CkCsr_SetSubjectField(objHandle: HCkCsr;
    oid: PWideChar;
    value: PWideChar;
    asnType: PWideChar): wordbool; stdcall;

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 True for success, False for failure.

VerifyCsr

function CkCsr_VerifyCsr(objHandle: HCkCsr): wordbool; stdcall;

Introduced in version 9.5.0.83

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

Returns True for success, False for failure.