JavaKeyStore PowerBuilder Reference Documentation
JavaKeyStore
Current Version: 11.6.0
Chilkat.JavaKeyStore
Read Java keystore data into memory, inspect or modify its contents, and
save the updated keystore when changes are complete.
Work with private keys stored under aliases, including their associated
certificate chains and entry-specific passwords.
Add, retrieve, and manage trusted certificate entries used for trust
stores, TLS validation, and Java-based security configuration.
Store and retrieve symmetric secret keys when the keystore is used for
application key material in addition to certificates.
Import private-key entries from PFX/P12 and export or convert keystore
contents to PEM, PFX, or JWK Set format.
Enumerate aliases, locate entries, rename or manage entry names, and
organize keys and certificates by application-specific identifiers.
For an extended overview, see
JavaKeyStore Class Overview.
Load, inspect, modify, convert, and save Java keystore data.
Chilkat.JavaKeyStore is the Chilkat class for working with Java
keystore data. It supports private-key entries with aliases and certificate
chains, trusted certificate entries, and secret-key entries. It can load and
save keystores, import private-key entries from PFX, add trusted certificates
and symmetric keys, retrieve private keys and certificate chains, manage
aliases, change private-key passwords, and convert keystore contents to PEM,
PFX, or JWK Set format.
Load and save keystores
Private-key entries
Trusted certificates
Secret-key entries
Import and convert
Alias management
JavaKeyStore when the data is
organized as a Java keystore; use Cert, PrivateKey,
Pfx, or TrustedRoots when working directly with
individual certificate or key objects.
Object Creation
oleobject loo_JavaKeyStore
integer li_rc
loo_JavaKeyStore = create oleobject
li_rc = loo_JavaKeyStore.ConnectToNewObject("Chilkat.JavaKeyStore")
if li_rc < 0 then
destroy loo_JavaKeyStore
MessageBox("Error","Connecting to COM object failed")
return
end if
// ... use loo_JavaKeyStore ...
destroy loo_JavaKeyStorePowerBuilder uses the Chilkat ActiveX through an oleobject: declare the variable, create it, connect it to the Chilkat class with ConnectToNewObject, and destroy it when finished. A negative return code from ConnectToNewObject means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.
Objects returned by methods (such as an HttpResponse or JsonObject) are also oleobject variables and must likewise be destroyed. A method that fails to return an object returns null; test with IsNull(). In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always oleobject.
To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as ConnectToNewObject("Chilkat.JavaKeyStore.11") for Chilkat v11.*.*.
Members typed blob exchange binary data as a Variant byte array. The PowerBuilder examples instead use the BinData-based alternatives (methods ending in Bd), which keep binary data inside Chilkat objects.
Properties
DebugLogFilePath
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
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
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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumPrivateKeys
Returns the number of private-key entries currently contained in the keystore. Each private-key entry has an alias, a protected private key, and an associated certificate chain. Valid private-key indexes range from 0 through NumPrivateKeys - 1.
PrivateKeyAt and PrivateKeyOf. It is distinct from the store password used when loading or saving the complete keystore.NumSecretKeys
Returns the number of symmetric secret-key entries currently contained in the keystore. Examples include AES, HMAC, Blowfish, and ChaCha key material. Valid indexes range from 0 through NumSecretKeys - 1.
NumTrustedCerts
Returns the number of trusted-certificate entries currently contained in the keystore. Each entry contains one certificate and an alias. Valid indexes range from 0 through NumTrustedCerts - 1.
RequireCompleteChain
Controls whether a complete certificate chain is required when a private-key entry is added. The default is 1AddPrivateKey and AddPfx fail if Chilkat cannot build the chain through the issuing certificates to a root or self-signed certificate. When set to 0
UseCertVault to make additional certificates available for chain construction. Trusted CA roots supplied through Chilkat trusted-root facilities may also help complete the chain. This property affects chain construction while adding entries; it does not perform application trust-policy validation.VerboseLogging
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
Controls validation of the keystore-level integrity digest when a JKS or JCEKS store is loaded. The default is 1
When set to 0
Version
Methods
AddPfx
Imports the private-key entries found in the Pfx object supplied in pfx. One Java keystore private-key entry is added for each private key in the PFX/PKCS #12 data. Certificates from the PFX are used to construct the certificate chain associated with each imported private key.
alias specifies the alias for the first imported private key. If it is empty, Chilkat chooses an alias in this order:
- The subject common name of the private key certificate.
- The subject email address.
- The PKCS #12 friendly-name attribute.
- The certificate serial number.
If the PFX contains additional private keys, their aliases are chosen automatically using the same preference order. password becomes the entry password used to protect the imported private keys in the Java keystore.
AddTrustedCert separately when a certificate should become an explicit trust entry.RequireCompleteChain is enabled, the method fails when any imported private-key chain cannot be completed. UseCertVault can supply additional issuer certificates.Returns 1 for success, 0 for failure.
topAddPrivateKey
Adds a private-key entry using the certificate in cert. The Cert object must have access to its associated private key. Chilkat obtains that private key and builds the certificate chain beginning with cert.
alias is the entry alias. If it is empty, Chilkat chooses an alias from the certificate in this order: subject common name, subject email address, then certificate serial number. password is the password used to protect the private key inside the keystore.
RequireCompleteChain is enabled, the method fails unless the chain can be completed. Use UseCertVault when additional issuer certificates are needed.Returns 1 for success, 0 for failure.
topAddSecretKey
Adds a symmetric secret-key entry. encodedKeyBytes contains the key bytes encoded as text, and encoding names that encoding, such as hex, base64, or base64url. algorithm records the key algorithm, such as AES, HMAC_SHA256, or CHACHA. alias is the alias, and password is the password used to protect the key entry.
The algorithm value describes the intended key type; it does not transform the supplied key bytes. For example, a 128-bit AES key is supplied as exactly 16 decoded bytes and algorithm is set to AES.
PBEWithMD5AndTripleDES mechanism defined by that format. Use this format when interoperability requires JCEKS, and protect both the entry password and the resulting file.Returns 1 for success, 0 for failure.
AddTrustedCert
Adds cert as a trusted-certificate entry under the alias supplied in alias. A trusted-certificate entry contains the certificate only; it does not contain a private key or a certificate chain.
Returns 1 for success, 0 for failure.
CertChainAt
Loads certChain with the certificate chain belonging to the private-key entry at zero-based index index. Valid indexes range from 0 through NumPrivateKeys - 1. The first certificate contains the public key corresponding to the private key; subsequent certificates are issuing certificates toward the root.
Returns 1 for success, 0 for failure.
topCertChainOf
Searches the private-key entries for an alias equal to alias and loads the matching certificate chain into certChain. caseSensitive controls whether the alias comparison is case-sensitive. The first certificate in the chain contains the public key corresponding to the private key.
Returns 1 for success, 0 for failure.
topChangePassword
Changes the password protecting the private-key entry at index. Indexing begins at 0. oldPassword is the current entry password and newPassword is the new entry password.
Returns 1 for success, 0 for failure.
GetPrivateKeyAlias
Returns the alias of the private-key entry at index. Indexing begins at 0; valid indexes range from 0 through NumPrivateKeys - 1.
Returns null on failure
GetSecretKey
Recovers the secret-key entry at index and returns its raw key bytes encoded using encoding. password is the password protecting that entry. Indexing begins at 0. Common output encodings include hex, base64, and base64url.
Returns null on failure
GetSecretKeyAlias
Returns the alias of the secret-key entry at index. Indexing begins at 0; valid indexes range from 0 through NumSecretKeys - 1.
Returns null on failure
GetTrustedCertAlias
Returns the alias of the trusted-certificate entry at index. Indexing begins at 0; valid indexes range from 0 through NumTrustedCerts - 1.
Returns null on failure
LoadBd
Loads a JKS or JCEKS keystore from the bytes currently contained in bd. password is the store password used for integrity verification when VerifyKeyedDigest is enabled.
Returns 1 for success, 0 for failure.
topLoadBinary
Loads a JKS or JCEKS keystore from the serialized bytes in jksData. password is the store password used for store-level integrity verification when VerifyKeyedDigest is enabled.
Returns 1 for success, 0 for failure.
topLoadEncoded
Decodes the serialized keystore text in jksEncData using the binary encoding named by encoding, then loads the resulting JKS or JCEKS bytes. Common encodings include base64, hex, and base64url. password is the store password used for integrity verification.
encoding describes how binary keystore bytes are represented as text. It does not name the keystore format and does not protect the data cryptographically.Returns 1 for success, 0 for failure.
topLoadFile
Loads a JKS or JCEKS keystore from the file at path. password is the store password used to verify the keystore-level integrity digest when VerifyKeyedDigest is enabled.
Chilkat.Pfx when the input is a .p12 or .pfx container.Returns 1 for success, 0 for failure.
LoadJwkSet
Loads supported keys from the JWK Set in jwkSet into this Java keystore object. password is used to protect imported private-key and secret-key entries. A JWK kid value is used as the entry alias when present.
jwkSet should contain a JSON object with a keys array. Private asymmetric JWKs contain private parameters such as d; symmetric JWKs use kty: "oct" and contain the key in k. Treat the input as sensitive whenever it contains private or symmetric key material.Returns 1 for success, 0 for failure.
PrivateKeyAt
Loads privKey with the private key at zero-based index index. password is the password protecting that private-key entry. Valid indexes range from 0 through NumPrivateKeys - 1.
password is not necessarily the password used to load the complete keystore. Java keystores can protect each private-key entry with a different password.Returns 1 for success, 0 for failure.
topPrivateKeyOf
Searches the private-key entries for an alias equal to alias and loads the matching private key into privKey. password is the password protecting that key entry, and caseSensitive controls whether the alias comparison is case-sensitive.
Returns 1 for success, 0 for failure.
topRemoveEntry
Removes an entry selected by type and zero-based index. entryType uses the following documented values:
entryType | Entry selected |
|---|---|
1 | Trusted-certificate entry; index indexes the trusted-certificate list. |
2 | Private-key entry; index indexes the private-key list. |
index is an index within the selected entry category, not an index across all entries in the keystore.
ToFile, ToBd, or another To* method to persist the updated keystore.Returns 1 for success, 0 for failure.
topSetAlias
Changes the alias of an entry selected by type and zero-based index. entryType uses the following documented values:
entryType | Entry selected |
|---|---|
1 | Trusted-certificate entry; index indexes the trusted-certificate list. |
2 | Private-key entry; index indexes the private-key list. |
alias is the new alias. The index is relative to the selected category, not the complete set of keystore entries.
Returns 1 for success, 0 for failure.
topToBd
Serializes the current Java keystore and writes the complete JKS or JCEKS file image to bd. password is the store password used to create the keystore-level integrity digest.
password does not automatically change those entry passwords.Returns 1 for success, 0 for failure.
topToBinary
Serializes the current Java keystore and returns the complete JKS or JCEKS file image as bytes. password is the store password used to create the keystore-level integrity digest.
Returns a zero-length byte array (as a Variant) on failure.
topToEncodedString
Serializes the current Java keystore and returns the resulting JKS or JCEKS bytes encoded as text using encoding. Common choices include base64, hex, and base64url. password is the store password used to create the keystore-level integrity digest.
Returns null on failure
ToFile
Serializes the current Java keystore and writes the complete JKS or JCEKS file image to path. password is the store password used to create the keystore-level integrity digest.
ChangePassword for private-key entries when needed.Returns 1 for success, 0 for failure.
ToJwkSet
Exports supported private-key and secret-key entries as a JSON Web Key Set and writes the JSON to sbJwkSet. password is used to recover protected key entries. Each exported JWK receives a kid value derived from the keystore alias.
d or symmetric parameter k contains secret key material. Protect the resulting JSON as carefully as the original keystore and do not log or transmit it over an untrusted channel.Returns 1 for success, 0 for failure.
ToPemObj
Converts the keystore material supported by the Pem class and loads the result into pemObj. password is used to decrypt private-key entries during the conversion.
Pem object receives the converted material in memory. Its own export methods and properties control whether later PEM text is encrypted and how it is formatted. Treat unencrypted private-key PEM as sensitive data.Returns 1 for success, 0 for failure.
topToPfxObj
Converts the certificates and recoverable private-key entries in the Java keystore and loads the result into pfxObj. password is used to decrypt private-key entries during the conversion.
password is an input password for recovering the Java keystore entries. It is not automatically the password that will protect a later serialized PFX; use the destination Pfx export method to choose the PFX password.Returns 1 for success, 0 for failure.
topTrustedCertAt
Loads cert with the trusted certificate at the zero-based index index. Valid indexes range from 0 through NumTrustedCerts - 1. The returned certificate is the single certificate stored in the trust entry and has no private key merely by virtue of being trusted.
Returns 1 for success, 0 for failure.
topTrustedCertOf
Searches the trusted-certificate entries for an alias equal to alias and loads the matching certificate into cert. caseSensitive controls whether the alias comparison is case-sensitive.
Returns 1 for success, 0 for failure.
topUseCertVault
Adds vault to the certificate sources Chilkat searches when it needs issuer certificates to build a private-key certificate chain. This is useful before calling AddPrivateKey or AddPfx when the supplied certificate material does not already contain the complete chain.
Returns 1 for success, 0 for failure.
topDeprecated
FindCertChain
CertChainOf instead.Returns the certificate chain belonging to the private-key entry whose alias matches alias. caseSensitive controls whether alias matching is case-sensitive. The first certificate in the returned chain corresponds to the private key.
Returns null on failure
FindPrivateKey
PrivateKeyOf instead.Returns the private key belonging to the entry whose alias matches alias. password is the entry password used to recover the key, and caseSensitive controls whether alias matching is case-sensitive.
Returns null on failure
FindTrustedCert
TrustedCertOf instead.Returns the trusted certificate whose alias matches alias. caseSensitive controls whether alias matching is case-sensitive.
Returns null on failure
GetCertChain
CertChainAt instead.Returns the certificate chain for the private-key entry at index. Indexing begins at 0, and the valid range is determined by NumPrivateKeys. The first certificate in the chain corresponds to the private key.
Returns null on failure
GetPrivateKey
PrivateKeyAt instead.Returns the private key for the entry at index. password is the password protecting that private-key entry. Indexing begins at 0.
Returns null on failure
GetTrustedCert
TrustedCertAt instead.Returns the trusted certificate at index. Indexing begins at 0; the valid range is determined by NumTrustedCerts.
Returns null on failure
ToPem
ToPemObj instead.Converts the keystore material supported by the Pem class and returns a new Pem object. password is used to decrypt private-key entries during the conversion.
Pem object is an in-memory representation; its later serialization settings determine how PEM output is formatted or encrypted.Returns null on failure