Csr Unicode C++ Reference Documentation
CkCsrW
Current Version: 10.1.2
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
// Local variable on the stack CkCsrW obj; // Dynamically allocate/delete CkCsrW *pObj = new CkCsrW(); // ... delete pObj;
Properties
CommonName
const wchar_t *commonName(void);
void put_CommonName(const wchar_t *str);
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
const wchar_t *company(void);
void put_Company(const wchar_t *str);
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
const wchar_t *companyDivision(void);
void put_CompanyDivision(const wchar_t *str);
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
const wchar_t *country(void);
void put_Country(const wchar_t *str);
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
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
EmailAddress
const wchar_t *emailAddress(void);
void put_EmailAddress(const wchar_t *str);
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
const wchar_t *hashAlgorithm(void);
void put_HashAlgorithm(const wchar_t *str);
The hash algorithm to be used when creating the CSR. The default is SHA256. Can be set to SHA1, SHA384, SHA256, or SHA512.
topLastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void put_LastMethodSuccess(bool newVal);
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topLocality
const wchar_t *locality(void);
void put_Locality(const wchar_t *str);
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
const wchar_t *mgfHashAlg(void);
void put_MgfHashAlg(const wchar_t *str);
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 put_PssPadding(bool newVal);
If _CKTRUE_, and if the private key is RSA, then uses RSASSA-PSS padding for the signature.
topState
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.
topVerboseLogging
void put_VerboseLogging(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 wchar_t *genCsrPem(CkPrivateKeyW &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 wchar_t *getSubjectField(const wchar_t *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