JavaKeyStore Tcl Reference Documentation
JavaKeyStore
Current Version: 11.0.0
API to read, write, access, and update Java key stores (JKS format).
This class also supports the JCEKS format starting in Chilkat v9.5.0.66.
Object Creation
set myJavaKeyStore [new CkJavaKeyStore]
Properties
DebugLogFilePath
# ckStr is a CkString
CkJavaKeyStore_get_DebugLogFilePath $myJavaKeyStore $ckStr
set strVal [CkJavaKeyStore_get_debugLogFilePath $myJavaKeyStore]
CkJavaKeyStore_put_DebugLogFilePath $myJavaKeyStore $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.
LastErrorHtml
# ckStr is a CkString
CkJavaKeyStore_get_LastErrorHtml $myJavaKeyStore $ckStr
set strVal [CkJavaKeyStore_get_lastErrorHtml $myJavaKeyStore]
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
CkJavaKeyStore_get_LastErrorText $myJavaKeyStore $ckStr
set strVal [CkJavaKeyStore_get_lastErrorText $myJavaKeyStore]
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
CkJavaKeyStore_get_LastErrorXml $myJavaKeyStore $ckStr
set strVal [CkJavaKeyStore_get_lastErrorXml $myJavaKeyStore]
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 [CkJavaKeyStore_get_LastMethodSuccess $myJavaKeyStore]
CkJavaKeyStore_put_LastMethodSuccess $myJavaKeyStore $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.
NumPrivateKeys
set intVal [CkJavaKeyStore_get_NumPrivateKeys $myJavaKeyStore]
The number of private keys contained within the keystore. Each private key has an alias and certificate chain associated with it.
topNumSecretKeys
set intVal [CkJavaKeyStore_get_NumSecretKeys $myJavaKeyStore]
The number of secret keys (such as AES keys) contained within the keystore. Each secret key can have an alias associated with it.
NumTrustedCerts
set intVal [CkJavaKeyStore_get_NumTrustedCerts $myJavaKeyStore]
The number of trusted certificates contained within the keystore. Each certificate has an alias (identifying string) associated with it.
topRequireCompleteChain
set boolVal [CkJavaKeyStore_get_RequireCompleteChain $myJavaKeyStore]
CkJavaKeyStore_put_RequireCompleteChain $myJavaKeyStore $boolVal
If 1, then adding a private key to the JKS only succeeds if the certificate chain can be completed to the root certificate. A root certificate is either a trusted CA root or a self-signed certificate. If 0, then incomplete certificate chains are allowed. The default value is 1.
VerboseLogging
set boolVal [CkJavaKeyStore_get_VerboseLogging $myJavaKeyStore]
CkJavaKeyStore_put_VerboseLogging $myJavaKeyStore $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.
VerifyKeyedDigest
set boolVal [CkJavaKeyStore_get_VerifyKeyedDigest $myJavaKeyStore]
CkJavaKeyStore_put_VerifyKeyedDigest $myJavaKeyStore $boolVal
If 1, then the keystore's keyed digest is required to pass validation (password required) for any of the load methods (such as LoadFile, LoadBinary, or LoadEncoded). If 0, then a keystore may be loaded into memory without password validation (if a null or empty string is passed to the load method). The default value of this property is 1.
Version
# ckStr is a CkString
CkJavaKeyStore_get_Version $myJavaKeyStore $ckStr
set strVal [CkJavaKeyStore_get_version $myJavaKeyStore]
Methods
AddPfx
# alias is a string
# password is a string
set status [CkJavaKeyStore_AddPfx $pfx $alias $password]
Adds the contents of a PFX or PKCS #12 (.p12) to the Java keystore object. One JKS entry per private key found in the PKCS12 is added. The certs found within the PCKS12 are used to build the certificate chains for each private key. (A typical PFX file contains a single private key along with its associated certificate, and the certificates in the chain of authentication to the root CA cert.)
This method does not add trusted certificate entries to the JKS.
The specified alias is applied to the 1st private key found. If the alias is empty, then the alias is obtained from the cert/PFX in the following order of preference:
- Certificate's subject common name
- Certificate's subject email address
- Certificate's friendly name found in the PKCS9 attributes of the PKCS12
- Certificate's serial number
If multiple private keys are found in the PKCS12, then all but the first will automaticallly be assigned aliases using the preference just described.
The UseCertVault method may be called to provide additional certificates for the automatic construction of the certificate chains. If the RequireCompleteChain property is set to 1, then this method will fail if any certificate chain is not completed to the root. The TrustedRoots class may be used to provide a source for obtaining trusted CA roots if these are not already present within the PKCS12.
Returns 1 for success, 0 for failure.
topAddPrivateKey
# alias is a string
# password is a string
set status [CkJavaKeyStore_AddPrivateKey $cert $alias $password]
Adds a private key entry to the JKS. Both the private key and certificate chain are obtained from the certificate object that is passed in the 1st argument.
If the alias is empty, then the alias is automatically chosen based on the certificate's information, in the following order of preference:
- Certificate's subject common name
- Certificate's subject email address
- Certificate's serial number
The UseCertVault method may be called to provide additional certificates for the automatic construction of the certificate chains. If the RequireCompleteChain property is set to 1, then this method will fail if the certificate chain is not completed to the root. The TrustedRoots class may be used to provide a source for obtaining trusted CA roots.
Returns 1 for success, 0 for failure.
topAddSecretKey
# encoding is a string
# algorithm is a string
# alias is a string
# password is a string
set status [CkJavaKeyStore_AddSecretKey $encodedKeyBytes $encoding $algorithm $alias $password]
Adds a secret (symmetric) key entry to the JKS. This adds a symmetric key, which is simply a number of binary bytes (such as 16 bytes for a 128-bit AES key). The encodedKeyBytes provides the actual bytes of the symmetric key, in an encoded string form. The encoding indicates the encoding of encodedKeyBytes (such as "base64", "hex", "base64url", etc.) The algorithm describes the symmetric algorithm, such as "AES". The alias is the password used to seal (encrypt) the key bytes.
Note: The algorithm describes the usage of the encodedKeyBytes. For example, if encodedKeyBytes contains the 16 bytes of a 128-bit AES key, then algorithm should be set to "AES". The actual encryption algorithm used to seal the key within the JCEKS is PBEWithMD5AndTripleDES, which is part of the JCEKS specification.
Returns 1 for success, 0 for failure.
AddTrustedCert
Adds a trusted certificate to the Java keystore object.
Returns 1 for success, 0 for failure.
CertChainAt
# certChain is a CkCertChain
set status [CkJavaKeyStore_CertChainAt $index $certChain]
Returns in certChain the certificate chain for the Nth private key in the keystore, where the first private key is at index 0.
Returns 1 for success, 0 for failure.
topCertChainOf
# caseSensitive is a boolean
# certChain is a CkCertChain
set status [CkJavaKeyStore_CertChainOf $alias $caseSensitive $certChain]
Returns in certChain the certificate chain for the specified private key alias.
Returns 1 for success, 0 for failure.
topChangePassword
# oldPassword is a string
# newPassword is a string
set status [CkJavaKeyStore_ChangePassword $index $oldPassword $newPassword]
Changes the password for a private key.
Returns 1 for success, 0 for failure.
GetPrivateKeyAlias
# outStr is a CkString (output)
set status [CkJavaKeyStore_GetPrivateKeyAlias $index $outStr]
set retStr [CkJavaKeyStore_getPrivateKeyAlias $myJavaKeyStore $index]
Returns the Nth private key alias contained within the keystore. The 1st private key is at index 0.
Returns 1 for success, 0 for failure.
topGetSecretKey
# index is an integer
# encoding is a string
# outStr is a CkString (output)
set status [CkJavaKeyStore_GetSecretKey $password $index $encoding $outStr]
set retStr [CkJavaKeyStore_getSecretKey $myJavaKeyStore $password $index $encoding]
Returns the Nth secret key contained within the keystore. The 1st secret key is at index 0. The bytes of the secret key are returned in the specified encoding. (such as hex, base64, base64url, etc.)
Returns 1 for success, 0 for failure.
GetSecretKeyAlias
# outStr is a CkString (output)
set status [CkJavaKeyStore_GetSecretKeyAlias $index $outStr]
set retStr [CkJavaKeyStore_getSecretKeyAlias $myJavaKeyStore $index]
Returns the Nth secret key alias contained within the keystore. The 1st secret key is at index 0.
Returns 1 for success, 0 for failure.
GetTrustedCertAlias
# outStr is a CkString (output)
set status [CkJavaKeyStore_GetTrustedCertAlias $index $outStr]
set retStr [CkJavaKeyStore_getTrustedCertAlias $myJavaKeyStore $index]
Returns the Nth trusted certificate alias contained within the keystore. The 1st certificate is at index 0.
Returns 1 for success, 0 for failure.
topLoadBd
LoadBinary Deprecated
# jksData is a CkByteData
set status [CkJavaKeyStore_LoadBinary $password $jksData]
LoadEncoded
# jksEncData is a string
# encoding is a string
set status [CkJavaKeyStore_LoadEncoded $password $jksEncData $encoding]
Loads a Java keystore from an encoded string (such as base64, hex, etc.)
Returns 1 for success, 0 for failure.
topLoadFile
# path is a string
set status [CkJavaKeyStore_LoadFile $password $path]
Loads a Java keystore from a file.
Returns 1 for success, 0 for failure.
LoadJwkSet
# jwkSet is a CkJsonObject
set status [CkJavaKeyStore_LoadJwkSet $password $jwkSet]
Loads the Java KeyStore from a JSON Web Key (JWK) Set.
Returns 1 for success, 0 for failure.
PrivateKeyAt
# index is an integer
# privKey is a CkPrivateKey
set status [CkJavaKeyStore_PrivateKeyAt $password $index $privKey]
Returns in privKey the private key at index in the keystore, where the first key is at index 0.
Returns 1 for success, 0 for failure.
topPrivateKeyOf
# alias is a string
# caseSensitive is a boolean
# privKey is a CkPrivateKey
set status [CkJavaKeyStore_PrivateKeyOf $password $alias $caseSensitive $privKey]
Returns in privKey the private key associated with the given alias.
Returns 1 for success, 0 for failure.
topRemoveEntry
# index is an integer
set status [CkJavaKeyStore_RemoveEntry $entryType $index]
Removes the Nth trusted certificate or private key entry from the keystore. The entryType indicates whether it is a trusted root or private key entry (1 = trusted certificate entry, 2 = private key entry). The 1st entry is at index 0.
Returns 1 for success, 0 for failure.
topSetAlias
# index is an integer
# alias is a string
set status [CkJavaKeyStore_SetAlias $entryType $index $alias]
Sets the alias name for a trusted certificate or private key entry. The entryType indicates whether it is a trusted root or private key entry (1 = trusted certificate entry, 2 = private key entry). The 1st entry is at index 0.
Returns 1 for success, 0 for failure.
topToBd
Writes the key store to password. The bd is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns 1 for success, 0 for failure.
topToBinary Deprecated
# outBytes is a CkByteData (output)
set status [CkJavaKeyStore_ToBinary $password $outData]
Writes the key store to in-memory bytes. The password is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns 1 for success, 0 for failure.
topToEncodedString
# encoding is a string
# outStr is a CkString (output)
set status [CkJavaKeyStore_ToEncodedString $password $encoding $outStr]
set retStr [CkJavaKeyStore_toEncodedString $myJavaKeyStore $password $encoding]
Writes the key store to an encoded string. The encoding can be any encoding such as "base64" or "hex". The password is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns 1 for success, 0 for failure.
topToFile
# path is a string
set status [CkJavaKeyStore_ToFile $password $path]
Writes the key store to a file. The password is used for the keyed hash of the entire JKS file. (Each private key within the file may use different passwords, and these are provided when the private key is added via the AddPrivateKey method.)
Returns 1 for success, 0 for failure.
ToJwkSet
# sbJwkSet is a CkStringBuilder
set status [CkJavaKeyStore_ToJwkSet $password $sbJwkSet]
Returns the private keys in JSON JWK Set format. The JWK identifier (kid) will be set from the key alias in the store.
Returns 1 for success, 0 for failure.
ToPemObj
ToPfxObj
TrustedCertAt
Returns the Nth trusted certificate from the keystore in cert, with the 1st certificate at index 0.
Returns 1 for success, 0 for failure.
topTrustedCertOf
# caseSensitive is a boolean
# cert is a CkCert
set status [CkJavaKeyStore_TrustedCertOf $alias $caseSensitive $cert]
Finds and returns in cert the trusted certificate with the specified alias.
Returns 1 for success, 0 for failure.
topUseCertVault
Adds an XML certificate vault to the object's internal list of sources to be searched for certificates for help in building certificate chains to a root certificate.
Returns 1 for success, 0 for failure.
topDeprecated
FindCertChain
# caseSensitive is a boolean
set status [CkJavaKeyStore_FindCertChain $alias $caseSensitive]
Applications should instead call CertChainOf.
Returns the certificate chain for the specified private key alias.
Returns NULL on failure
FindPrivateKey
# alias is a string
# caseSensitive is a boolean
set status [CkJavaKeyStore_FindPrivateKey $password $alias $caseSensitive]
Applications should instead call PrivateKeyOf.
Returns the private key associated with the given alias.
Returns NULL on failure
FindTrustedCert
# alias is a string
# caseSensitive is a boolean
set ret_cert [CkJavaKeyStore_FindTrustedCert $alias $caseSensitive]
Applications should instead call TrustedCertOf.
Finds and returns the trusted certificate with the specified alias.
Returns NULL on failure
GetCertChain
set status [CkJavaKeyStore_GetCertChain $index]
Applications should instead call CertChainAt.
Returns the certificate chain for the Nth private key in the keystore, where the first private key is at index 0.
Returns NULL on failure
GetPrivateKey
# index is an integer
set status [CkJavaKeyStore_GetPrivateKey $password $index]
Applications should instead call PrivateKeyAt.
Returns the private key at index N in the keystore, where the first key is indexed as 0.
Returns NULL on failure
GetTrustedCert
set status [CkJavaKeyStore_GetTrustedCert $index]
Applications should instead call TrustedCertAt.
Returns the Nth trusted certificate contained within the keystore. The 1st certificate is at index 0.
Returns NULL on failure
ToPem
set status [CkJavaKeyStore_ToPem $password]
Applications should instead call ToPemObj.
Returns the Java KeyStore as a Pem object.
Returns NULL on failure
ToPfx
set status [CkJavaKeyStore_ToPfx $password]
Applications should instead call ToPfxObj.
Returns the Java KeyStore as a Pfx object.
Returns NULL on failure