CkCsr Perl Reference Documentation
CkCsr
Current Version: 10.1.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
Object Creation
$obj = chilkat::CkCsr->new();
Properties
CommonName
# $ckStr is a CkString
$csr->get_CommonName($ckStr);
$strVal = $csr->commonName();
$csr->put_CommonName($strVal);
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
# $ckStr is a CkString
$csr->get_Company($ckStr);
$strVal = $csr->company();
$csr->put_Company($strVal);
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
# $ckStr is a CkString
$csr->get_CompanyDivision($ckStr);
$strVal = $csr->companyDivision();
$csr->put_CompanyDivision($strVal);
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
# $ckStr is a CkString
$csr->get_Country($ckStr);
$strVal = $csr->country();
$csr->put_Country($strVal);
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
# $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:
- 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
# $ckStr is a CkString
$csr->get_EmailAddress($ckStr);
$strVal = $csr->emailAddress();
$csr->put_EmailAddress($strVal);
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
# $ckStr is a CkString
$csr->get_HashAlgorithm($ckStr);
$strVal = $csr->hashAlgorithm();
$csr->put_HashAlgorithm($strVal);
The hash algorithm to be used when creating the CSR. The default is SHA256. Can be set to SHA1, SHA384, SHA256, or SHA512.
topLastErrorHtml
# $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.
topLastErrorText
# $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.
LastErrorXml
# $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.
topLastMethodSuccess
$boolVal = $csr->get_LastMethodSuccess();
$csr->put_LastMethodSuccess($boolVal);
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.
topLocality
# $ckStr is a CkString
$csr->get_Locality($ckStr);
$strVal = $csr->locality();
$csr->put_Locality($strVal);
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
# $ckStr is a CkString
$csr->get_MgfHashAlg($ckStr);
$strVal = $csr->mgfHashAlg();
$csr->put_MgfHashAlg($strVal);
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".
topPssPadding
$boolVal = $csr->get_PssPadding();
$csr->put_PssPadding($boolVal);
If _CKTRUE_, and if the private key is RSA, then uses RSASSA-PSS padding for the signature.
topState
# $ckStr is a CkString
$csr->get_State($ckStr);
$strVal = $csr->state();
$csr->put_State($strVal);
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
$boolVal = $csr->get_Utf8();
$csr->put_Utf8($boolVal);
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
$boolVal = $csr->get_VerboseLogging();
$csr->put_VerboseLogging($boolVal);
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.
topVersion
Methods
AddSan
# $sanValue is a string
$status = $csr->AddSan($sanType, $sanValue);
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.
topGenCsrBd
# $csrData is a CkBinData
$status = $csr->GenCsrBd($privKey, $csrData);
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.
GenCsrPem
# $outStr is a CkString (output)
$status = $csr->GenCsrPem($privKey, $outStr);
$retStr = $csr->genCsrPem($privKey);
Generate a CSR and return it as a PEM string. The privKey can be an RSA or ECDSA private key.
Returns 1 for success, 0 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 1 for success, 0 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 1 for success, 0 for failure.
topGetSubjectField
# $outStr is a CkString (output)
$status = $csr->GetSubjectField($oid, $outStr);
$retStr = $csr->getSubjectField($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 1 for success, 0 for failure.
LoadCsrPem
$status = $csr->LoadCsrPem($csrPemStr);
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.
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 1 for success, 0 for failure.
SetSubjectField
# $value is a string
# $asnType is a string
$status = $csr->SetSubjectField($oid, $value, $asnType);
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.
topVerifyCsr
Verify the signature in the CSR. Return 1 if the signature is valid.
Returns 1 for success, 0 for failure.
top