Xbase++

Add Private Key to Java Keystore

See more Java KeyStore (JKS) Examples

Adds a private key to an existing Java keystore. Xbase++

LOCAL nSuccess
LOCAL oJks
LOCAL cJksPassword
LOCAL cJksPath
LOCAL oCert
LOCAL oCertVault
LOCAL oPrivKey
LOCAL cAlias
LOCAL oPfx

nSuccess := 0

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

oJks := CreateObject("Chilkat.JavaKeyStore")

cJksPassword := "myJksPassword"
cJksPath := "/someDir/keyStore.jks"

//  Load the Java keystore from a file.
nSuccess := oJks:LoadFile(cJksPassword, cJksPath)
IF (nSuccess != 1)
    ? oJks:LastErrorText
    oJks:destroy()
    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:
oCert := CreateObject("Chilkat.Cert")

//  Chilkat will automatically determine the format of the cert file and load it correctly.
nSuccess := oCert:LoadFromFile("/mycerts/alice.crt")
IF (nSuccess != 1)
    ? oCert:LastErrorText
    oJks:destroy()
    oCert:destroy()
    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.
oCertVault := CreateObject("Chilkat.XmlCertVault")
nSuccess := oCertVault:AddCertFile("/mycerts/ca.crt")
IF (nSuccess != 1)
    ? oCertVault:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    RETURN
ENDIF

nSuccess := oCert:UseCertVault(oCertVault)
IF (nSuccess != 1)
    ? oCert:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    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).
oPrivKey := CreateObject("Chilkat.PrivateKey")
nSuccess := oPrivKey:LoadPemFile("/mycerts/alice.key")
IF (nSuccess != 1)
    ? oPrivKey:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

//  Provide the certificate object with the private key:
nSuccess := oCert:SetPrivateKey(oPrivKey)
IF (nSuccess != 1)
    ? oCert:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

//  Our certificate object now contains all that we need to add it as a private key entry
//  to the Java keystore:
cAlias := "alice"
nSuccess := oJks:AddPrivateKey(oCert, cAlias, cJksPassword)
IF (nSuccess != 1)
    ? oJks:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    RETURN
ENDIF

//  Write the updated JKS, which contains the new private key entry w/ certificate chain.
nSuccess := oJks:ToFile(cJksPassword, cJksPath)
IF (nSuccess != 1)
    ? oJks:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    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.
oPfx := CreateObject("Chilkat.Pfx")

nSuccess := oPfx:LoadPfxFile("/myPfxFiles/my.pfx", "pfxPassword")
IF (nSuccess != 1)
    ? oPfx:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    oPfx:destroy()
    RETURN
ENDIF

//  This is easy -- simply add the PFX to the JKS
cAlias := "bob"
nSuccess := oJks:AddPfx(oPfx, cAlias, cJksPassword)
IF (nSuccess != 1)
    ? oJks:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    oPfx:destroy()
    RETURN
ENDIF

//  Write the updated JKS, which contains the new private key entry w/ certificate chain
//  that came from the PFX.
nSuccess := oJks:ToFile(cJksPassword, cJksPath)
IF (nSuccess != 1)
    ? oJks:LastErrorText
    oJks:destroy()
    oCert:destroy()
    oCertVault:destroy()
    oPrivKey:destroy()
    oPfx:destroy()
    RETURN
ENDIF

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

oJks:destroy()
oCert:destroy()
oCertVault:destroy()
oPrivKey:destroy()
oPfx:destroy()