CkCsr Ruby Reference Documentation

CkCsr

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

obj = Chilkat::CkCsr.new()

Properties

# strVal is a string
# ckStr is a CkString
csr.get_CommonName(ckStr);
strVal = csr.commonName();
csr.put_CommonName(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_Company(ckStr);
strVal = csr.company();
csr.put_Company(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_CompanyDivision(ckStr);
strVal = csr.companyDivision();
csr.put_CompanyDivision(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_Country(ckStr);
strVal = csr.country();
csr.put_Country(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_DebugLogFilePath(ckStr);
strVal = csr.debugLogFilePath();
csr.put_DebugLogFilePath(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_EmailAddress(ckStr);
strVal = csr.emailAddress();
csr.put_EmailAddress(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_LastErrorHtml(ckStr);
strVal = csr.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.

# strVal is a string
# ckStr is a CkString
csr.get_LastErrorText(ckStr);
strVal = csr.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.

Concept of LastErrorText

LastErrorText Standard Information

# strVal is a string
# ckStr is a CkString
csr.get_LastErrorXml(ckStr);
strVal = csr.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.

# boolVal is a boolean
boolVal = csr.get_LastMethodSuccess();
csr.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

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.

# strVal is a string
# ckStr is a CkString
csr.get_Locality(ckStr);
strVal = csr.locality();
csr.put_Locality(strVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_State(ckStr);
strVal = csr.state();
csr.put_State(strVal);

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.

# boolVal is a boolean
boolVal = csr.get_Utf8();
csr.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

# boolVal is a boolean
boolVal = csr.get_VerboseLogging();
csr.put_VerboseLogging(boolVal);

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.

# strVal is a string
# ckStr is a CkString
csr.get_Version(ckStr);
strVal = csr.version();

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

Methods

# privKey is a CkPrivateKey
# csrData is a CkBinData
status = csr.GenCsrBd(privKey, csrData);

Introduced in version 9.5.0.65

Generate a CSR and return the binary DER in csrData.

Returns true for success, false for failure.

# privKey is a CkPrivateKey
# outStr is a CkString (output)
status = csr.GenCsrPem(privKey, outStr);
retStr = csr.genCsrPem(privKey);

Introduced in version 9.5.0.65

Generate a CSR and return it as a PEM string.

Returns true for success, false for failure.

Generate Key and Certificate Signing Request (CSR)

Generate CSR from Pre-Existing Private Key

# oid is a string
# outStr is a CkString (output)
status = csr.GetSubjectField(oid, outStr);
retStr = csr.getSubjectField(oid);

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.

# csrPemStr is a string
status = csr.LoadCsrPem(csrPemStr);

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.

Load a CSR and Examine the Contents

# path is a string
status = csr.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

# oid is a string
# value is a string
# asnType is a string
status = csr.SetSubjectField(oid, value, asnType);

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.