Csr Tcl Reference Documentation
Csr
Current Version: 11.5.0
Chilkat.Csr
Generate certificate signing requests using RSA or ECDSA private keys
and the subject fields required by the certificate authority.
Set common X.509 subject fields such as common name, organization,
organizational unit, locality, state, country, and email address.
Add custom subject attributes by object identifier when a certificate
authority or application profile requires nonstandard fields.
Include DNS names, IP addresses, email addresses, URIs, or other SAN
entries needed for modern TLS and identity certificates.
Request certificate extensions that the issuing CA may include in the
final certificate.
Load an existing CSR, extract its public key, inspect requested names and
fields, and verify that the CSR signature is valid.
For an extended overview, see
Csr Class Overview.
Create, load, inspect, and verify Certificate Signing Requests.
Chilkat.Csr is the Chilkat class for working with Certificate
Signing Requests. It can create CSRs from RSA or ECDSA private keys, set
common certificate subject fields, add custom subject fields by OID, include
Subject Alternative Names, request certificate extensions, export CSRs in
PEM or DER format, load existing CSRs, extract the public key, inspect SAN
values, and verify the CSR signature.
Create CSRs
Subject fields
Custom OID fields
Subject Alternative Names
Extension requests
Inspect and verify
Object Creation
# 'this' is not a keyword in Tcl. It can freely be used as a variable name. set this [new CkCsr]
Properties
CommonName
# ckStr is a CkString
CkCsr_get_CommonName $this $ckStr
set strVal [CkCsr_get_commonName $this]
CkCsr_put_CommonName $this $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
CkCsr_get_Company $this $ckStr
set strVal [CkCsr_get_company $this]
CkCsr_put_Company $this $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
CkCsr_get_CompanyDivision $this $ckStr
set strVal [CkCsr_get_companyDivision $this]
CkCsr_put_CompanyDivision $this $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
CkCsr_get_Country $this $ckStr
set strVal [CkCsr_get_country $this]
CkCsr_put_Country $this $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
CkCsr_get_DebugLogFilePath $this $ckStr
set strVal [CkCsr_get_debugLogFilePath $this]
CkCsr_put_DebugLogFilePath $this $strVal
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
# ckStr is a CkString
CkCsr_get_EmailAddress $this $ckStr
set strVal [CkCsr_get_emailAddress $this]
CkCsr_put_EmailAddress $this $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
CkCsr_get_HashAlgorithm $this $ckStr
set strVal [CkCsr_get_hashAlgorithm $this]
CkCsr_put_HashAlgorithm $this $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
CkCsr_get_LastErrorHtml $this $ckStr
set strVal [CkCsr_get_lastErrorHtml $this]
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
# ckStr is a CkString
CkCsr_get_LastErrorText $this $ckStr
set strVal [CkCsr_get_lastErrorText $this]
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
# ckStr is a CkString
CkCsr_get_LastErrorXml $this $ckStr
set strVal [CkCsr_get_lastErrorXml $this]
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
set boolVal [CkCsr_get_LastMethodSuccess $this]
CkCsr_put_LastMethodSuccess $this $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Locality
# ckStr is a CkString
CkCsr_get_Locality $this $ckStr
set strVal [CkCsr_get_locality $this]
CkCsr_put_Locality $this $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
CkCsr_get_MgfHashAlg $this $ckStr
set strVal [CkCsr_get_mgfHashAlg $this]
CkCsr_put_MgfHashAlg $this $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.
PssPadding
set boolVal [CkCsr_get_PssPadding $this]
CkCsr_put_PssPadding $this $boolVal
If _CKTRUE_, and if the private key is RSA, then uses RSASSA-PSS padding for the signature.
topState
# ckStr is a CkString
CkCsr_get_State $this $ckStr
set strVal [CkCsr_get_state $this]
CkCsr_put_State $this $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
set boolVal [CkCsr_get_Utf8 $this]
CkCsr_put_Utf8 $this $boolVal
When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.
VerboseLogging
set boolVal [CkCsr_get_VerboseLogging $this]
CkCsr_put_VerboseLogging $this $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.
Version
# ckStr is a CkString
CkCsr_get_Version $this $ckStr
set strVal [CkCsr_get_version $this]
Methods
AddSan
# sanValue is a string
set status [CkCsr_AddSan $this $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
set status [CkCsr_GenCsrBd $this $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)
set status [CkCsr_GenCsrPem $this $privKey $outStr]
set retStr [CkCsr_genCsrPem $this $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
set status [CkCsr_GetExtensionRequest $this $extensionReqXml]
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
set status [CkCsr_GetPublicKey $this $pubkey]
GetSans
set status [CkCsr_GetSans $this $sans]
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)
set status [CkCsr_GetSubjectField $this $oid $outStr]
set retStr [CkCsr_getSubjectField $this $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
set status [CkCsr_LoadCsrPem $this $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
set status [CkCsr_SetExtensionRequest $this $extensionReqXml]
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
set status [CkCsr_SetSubjectField $this $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