Sample code for 30+ languages & platforms
Lianja

Add Private Key to Java Keystore

See more Java KeyStore (JKS) Examples

Adds a private key to an existing Java keystore.

Chilkat Lianja Downloads

Lianja
llSuccess = .F.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loJks = createobject("CkJavaKeyStore")

lcJksPassword = "myJksPassword"
lcJksPath = "/someDir/keyStore.jks"

// Load the Java keystore from a file.
llSuccess = loJks.LoadFile(lcJksPassword,lcJksPath)
if (llSuccess <> .T.) then
    ? loJks.LastErrorText
    release loJks
    return
endif

// A JKS private key entry consists of both the private key,
// it's associated certificate (which contains the matching public key
// within the X.509 of the certificate), and the certificates in the
// chain of authentication to the root.
// 
// Therefore, to add a private key entry to a JKS requires
// a Chilkat certificate object that has a private key and which also
// has the certificate chain (up to the root) available.

// There are many ways to get a Chilkat certificate object
// that contains (within it) the private key and the certificate chain
// This example will show two possibilities:
// (1) Where the cert and issuing root are provided in PEM format in .crt files,
// and the private key is also provided in unencrypted PEM format (.key file).
// (2) Where the cert, private key, and issuing root are provided in a single PFX.

// First for the .crt / .key files:
loCert = createobject("CkCert")

// Chilkat will automatically determine the format of the cert file and load it correctly.
llSuccess = loCert.LoadFromFile("/mycerts/alice.crt")
if (llSuccess <> .T.) then
    ? loCert.LastErrorText
    release loJks
    release loCert
    return
endif

// Certificates required for building the chain of authentication can be
// added to an XML certificate vault object, and then provided as
// a source for obtaining certs when building the chain.
loCertVault = createobject("CkXmlCertVault")
llSuccess = loCertVault.AddCertFile("/mycerts/ca.crt")
if (llSuccess <> .T.) then
    ? loCertVault.LastErrorText
    release loJks
    release loCert
    release loCertVault
    return
endif

llSuccess = loCert.UseCertVault(loCertVault)
if (llSuccess <> .T.) then
    ? loCert.LastErrorText
    release loJks
    release loCert
    release loCertVault
    return
endif

// Now provide the associated private key to the certificate object.
// The Chilkat private key class provides methods for loading from many formats (both
// encrypted and unencrypted).
loPrivKey = createobject("CkPrivateKey")
llSuccess = loPrivKey.LoadPemFile("/mycerts/alice.key")
if (llSuccess <> .T.) then
    ? loPrivKey.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    return
endif

// Provide the certificate object with the private key:
llSuccess = loCert.SetPrivateKey(loPrivKey)
if (llSuccess <> .T.) then
    ? loCert.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    return
endif

// Our certificate object now contains all that we need to add it as a private key entry
// to the Java keystore:
lcAlias = "alice"
llSuccess = loJks.AddPrivateKey(loCert,lcAlias,lcJksPassword)
if (llSuccess <> .T.) then
    ? loJks.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    return
endif

// Write the updated JKS, which contains the new private key entry w/ certificate chain.
llSuccess = loJks.ToFile(lcJksPassword,lcJksPath)
if (llSuccess <> .T.) then
    ? loJks.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    return
endif

? "Added new private key entry (from .crt and .key files) to the JKS!"

// Now let's add a new private key entry from a PFX that contains a single
// private key with associated cert and cert chain.
loPfx = createobject("CkPfx")

llSuccess = loPfx.LoadPfxFile("/myPfxFiles/my.pfx","pfxPassword")
if (llSuccess <> .T.) then
    ? loPfx.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    release loPfx
    return
endif

// This is easy -- simply add the PFX to the JKS
lcAlias = "bob"
llSuccess = loJks.AddPfx(loPfx,lcAlias,lcJksPassword)
if (llSuccess <> .T.) then
    ? loJks.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    release loPfx
    return
endif

// Write the updated JKS, which contains the new private key entry w/ certificate chain
// that came from the PFX.
llSuccess = loJks.ToFile(lcJksPassword,lcJksPath)
if (llSuccess <> .T.) then
    ? loJks.LastErrorText
    release loJks
    release loCert
    release loCertVault
    release loPrivKey
    release loPfx
    return
endif

? "Added new private key entry (from PFX) to the JKS!"


release loJks
release loCert
release loCertVault
release loPrivKey
release loPfx