Csr ActiveX Reference Documentation

Csr

Current Version: 9.5.0.97

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

This class is introduced in Chilkat v9.5.0.65

Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Csr")

(AutoIt)
$obj = ObjCreate("Chilkat_9_5_0.Csr")

(Visual Basic 6.0)
Dim obj As New ChilkatCsr

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Csr")

(Delphi)
obj := TChilkatCsr.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Csr')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Csr")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Csr', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Csr");

Properties

CommonName
CommonName As String
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.

top
Company
Company As String
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.

top
CompanyDivision
CompanyDivision As String
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.

top
Country
Country As String
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.

top
DebugLogFilePath
DebugLogFilePath As String

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
EmailAddress
EmailAddress As String
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.

top
HashAlgorithm
HashAlgorithm As String
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.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

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).

top
LastErrorHtml
LastErrorHtml As String (read-only)

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
LastErrorText As String (read-only)

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
LastErrorXml As String (read-only)

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
LastMethodSuccess As Long

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.

top
LastStringResult
LastStringResult As String (read-only)

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).

top
LastStringResultLen
LastStringResultLen As Long (read-only)

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

top
Locality
Locality As String
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.

top
MgfHashAlg
MgfHashAlg As String
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".

top
PssPadding
PssPadding As Long
Introduced in version 9.5.0.83

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

top
State
State As String
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.

top
VerboseLogging
VerboseLogging As Long

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.

top
Version
Version As String (read-only)

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

top

Methods

AddSan
AddSan(sanType As String, sanValue As String) As Long
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.

top
GenCsrBd
GenCsrBd(privKey As PrivateKey, csrData As ChilkatBinData) As Long
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.

top
GenCsrPem
GenCsrPem(privKey As PrivateKey) As String
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 Nothing on failure

More Information and Examples
(AutoIt) Generate Key and Certificate Signing Request (CSR)(Classic ASP) Generate Key and Certificate Signing Request (CSR)(PowerBuilder) Generate Key and Certificate Signing Request (CSR)(SQL Server) Generate Key and Certificate Signing Request (CSR)(VBScript) Generate Key and Certificate Signing Request (CSR)(Visual Basic 6.0) Generate Key and Certificate Signing Request (CSR)(Visual FoxPro) Generate Key and Certificate Signing Request (CSR)(AutoIt) Generate CSR from Pre-Existing Private Key(Classic ASP) Generate CSR from Pre-Existing Private Key(PowerBuilder) Generate CSR from Pre-Existing Private Key(SQL Server) Generate CSR from Pre-Existing Private Key(VBScript) Generate CSR from Pre-Existing Private Key(Visual Basic 6.0) Generate CSR from Pre-Existing Private Key(Visual FoxPro) Generate CSR from Pre-Existing Private Key(AutoIt) Generate a CSR with SAN (Subject Alternative Name) Extension(Classic ASP) Generate a CSR with SAN (Subject Alternative Name) Extension(PowerBuilder) Generate a CSR with SAN (Subject Alternative Name) Extension(SQL Server) Generate a CSR with SAN (Subject Alternative Name) Extension(VBScript) Generate a CSR with SAN (Subject Alternative Name) Extension(Visual Basic 6.0) Generate a CSR with SAN (Subject Alternative Name) Extension(Visual FoxPro) Generate a CSR with SAN (Subject Alternative Name) Extension(AutoIt) Duplicate CSR Created by OpenSSL with Config.cnf(Classic ASP) Duplicate CSR Created by OpenSSL with Config.cnf(PowerBuilder) Duplicate CSR Created by OpenSSL with Config.cnf(SQL Server) Duplicate CSR Created by OpenSSL with Config.cnf(VBScript) Duplicate CSR Created by OpenSSL with Config.cnf(Visual Basic 6.0) Duplicate CSR Created by OpenSSL with Config.cnf(Visual FoxPro) Duplicate CSR Created by OpenSSL with Config.cnf
top
GetExtensionRequest
GetExtensionRequest(extensionReqXml As ChilkatXml) As Long
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.

top
GetPublicKey
GetPublicKey(pubkey As PublicKey) As Long
Introduced in version 9.5.0.76

Returns the CSR's public key in the pubkey.

Returns 1 for success, 0 for failure.

top
GetSans
GetSans(sans As ChilkatStringTable) As Long
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.

top
GetSubjectField
GetSubjectField(oid As String) As String
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 Nothing on failure

top
LoadCsrPem
LoadCsrPem(csrPemStr As String) As Long
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.

top
SetExtensionRequest
SetExtensionRequest(extensionReqXml As ChilkatXml) As Long
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.

top
SetSubjectField
SetSubjectField(oid As String, value As String, asnType As String) As Long
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.

top
VerifyCsr
VerifyCsr() As Long
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.

top