Csr C Reference Documentation

Csr

Current Version: 9.5.0.73

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

HCkCsr instance = CkCsr_Create();
// ...
CkCsr_Dispose(instance);
HCkCsr CkCsr_Create(void);

Creates an instance of the HCkCsr object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkCsr_Dispose(HCkCsr handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCsr_Dispose.

Properties

CommonName
void CkCsr_getCommonName(HCkCsr cHandle, HCkString retval);
void CkCsr_putCommonName(HCkCsr cHandle, const char *newVal);
const char *CkCsr_commonName(HCkCsr cHandle);
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
void CkCsr_getCompany(HCkCsr cHandle, HCkString retval);
void CkCsr_putCompany(HCkCsr cHandle, const char *newVal);
const char *CkCsr_company(HCkCsr cHandle);
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
void CkCsr_getCompanyDivision(HCkCsr cHandle, HCkString retval);
void CkCsr_putCompanyDivision(HCkCsr cHandle, const char *newVal);
const char *CkCsr_companyDivision(HCkCsr cHandle);
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
void CkCsr_getCountry(HCkCsr cHandle, HCkString retval);
void CkCsr_putCountry(HCkCsr cHandle, const char *newVal);
const char *CkCsr_country(HCkCsr cHandle);
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
void CkCsr_getDebugLogFilePath(HCkCsr cHandle, HCkString retval);
void CkCsr_putDebugLogFilePath(HCkCsr cHandle, const char *newVal);
const char *CkCsr_debugLogFilePath(HCkCsr cHandle);

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
void CkCsr_getEmailAddress(HCkCsr cHandle, HCkString retval);
void CkCsr_putEmailAddress(HCkCsr cHandle, const char *newVal);
const char *CkCsr_emailAddress(HCkCsr cHandle);
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
LastErrorHtml
void CkCsr_getLastErrorHtml(HCkCsr cHandle, HCkString retval);
const char *CkCsr_lastErrorHtml(HCkCsr cHandle);

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
void CkCsr_getLastErrorText(HCkCsr cHandle, HCkString retval);
const char *CkCsr_lastErrorText(HCkCsr cHandle);

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
void CkCsr_getLastErrorXml(HCkCsr cHandle, HCkString retval);
const char *CkCsr_lastErrorXml(HCkCsr cHandle);

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
BOOL CkCsr_getLastMethodSuccess(HCkCsr cHandle);
void CkCsr_putLastMethodSuccess(HCkCsr cHandle, BOOL newVal);
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.

top
Locality
void CkCsr_getLocality(HCkCsr cHandle, HCkString retval);
void CkCsr_putLocality(HCkCsr cHandle, const char *newVal);
const char *CkCsr_locality(HCkCsr cHandle);
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
State
void CkCsr_getState(HCkCsr cHandle, HCkString retval);
void CkCsr_putState(HCkCsr cHandle, const char *newVal);
const char *CkCsr_state(HCkCsr cHandle);
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
Utf8
BOOL CkCsr_getUtf8(HCkCsr cHandle);
void CkCsr_putUtf8(HCkCsr cHandle, BOOL newVal);

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.

top
VerboseLogging
BOOL CkCsr_getVerboseLogging(HCkCsr cHandle);
void CkCsr_putVerboseLogging(HCkCsr cHandle, BOOL newVal);

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.

top
Version
void CkCsr_getVersion(HCkCsr cHandle, HCkString retval);
const char *CkCsr_version(HCkCsr cHandle);

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

top

Methods

GenCsrBd
BOOL CkCsr_GenCsrBd(HCkCsr cHandle, HCkPrivateKey privKey, HCkBinData 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.

top
GenCsrPem
BOOL CkCsr_GenCsrPem(HCkCsr cHandle, HCkPrivateKey privKey, HCkString outStr);
const char *CkCsr_genCsrPem(HCkCsr cHandle, HCkPrivateKey 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.

top
GetSubjectField
BOOL CkCsr_GetSubjectField(HCkCsr cHandle, const char *oid, HCkString outStr);
const char *CkCsr_getSubjectField(HCkCsr cHandle, const char *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.

top
LoadCsrPem
BOOL CkCsr_LoadCsrPem(HCkCsr cHandle, const char *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.

More Information and Examples
top
SaveLastError
BOOL CkCsr_SaveLastError(HCkCsr cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top
SetSubjectField
BOOL CkCsr_SetSubjectField(HCkCsr cHandle, const char *oid, const char *value, const char *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.

top