Csr C Reference Documentation
Csr
Current Version: 10.0.0
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);
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.
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_putCommonName(HCkCsr cHandle, const char *newVal);
const char *CkCsr_commonName(HCkCsr cHandle);
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.
topCompany
void CkCsr_putCompany(HCkCsr cHandle, const char *newVal);
const char *CkCsr_company(HCkCsr cHandle);
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.
topCompanyDivision
void CkCsr_putCompanyDivision(HCkCsr cHandle, const char *newVal);
const char *CkCsr_companyDivision(HCkCsr cHandle);
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.
topCountry
void CkCsr_putCountry(HCkCsr cHandle, const char *newVal);
const char *CkCsr_country(HCkCsr cHandle);
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.
topDebugLogFilePath
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:
- 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.
EmailAddress
void CkCsr_putEmailAddress(HCkCsr cHandle, const char *newVal);
const char *CkCsr_emailAddress(HCkCsr cHandle);
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.
topHashAlgorithm
void CkCsr_putHashAlgorithm(HCkCsr cHandle, const char *newVal);
const char *CkCsr_hashAlgorithm(HCkCsr cHandle);
The hash algorithm to be used when creating the CSR. The default is SHA256. Can be set to SHA1, SHA384, SHA256, or SHA512.
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
void CkCsr_putLastMethodSuccess(HCkCsr cHandle, BOOL newVal);
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.
topLocality
void CkCsr_putLocality(HCkCsr cHandle, const char *newVal);
const char *CkCsr_locality(HCkCsr cHandle);
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.
topMgfHashAlg
void CkCsr_putMgfHashAlg(HCkCsr cHandle, const char *newVal);
const char *CkCsr_mgfHashAlg(HCkCsr cHandle);
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".
topPssPadding
void CkCsr_putPssPadding(HCkCsr cHandle, BOOL newVal);
If _CKTRUE_, and if the private key is RSA, then uses RSASSA-PSS padding for the signature.
topState
void CkCsr_putState(HCkCsr cHandle, const char *newVal);
const char *CkCsr_state(HCkCsr cHandle);
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.
topUtf8
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.
topVerboseLogging
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.
topVersion
Methods
AddSan
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.
topGenCsrBd
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.
GenCsrPem
const char *CkCsr_genCsrPem(HCkCsr cHandle, HCkPrivateKey privKey);
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.
GetExtensionRequest
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.
GetPublicKey
GetSans
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.
topGetSubjectField
const char *CkCsr_getSubjectField(HCkCsr cHandle, const char *oid);
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.
LoadCsrPem
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.
SetExtensionRequest
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.
SetSubjectField
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.
topVerifyCsr
Verify the signature in the CSR. Return TRUE if the signature is valid.
Returns TRUE for success, FALSE for failure.
top