Lua

Add Private Key to Java Keystore

See more Java KeyStore (JKS) Examples

Adds a private key to an existing Java keystore. Lua

local chilkat = require("chilkat")

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

local jks = chilkat.JavaKeyStore.new()

local jksPassword = "myJksPassword"
local jksPath = "/someDir/keyStore.jks"

-- Load the Java keystore from a file.
local success = jks:load_file(jksPassword, jksPath)
if not success then
    print(jks.last_error_text)
    return
end

-- 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:
local cert = chilkat.Cert.new()

-- Chilkat will automatically determine the format of the cert file and load it correctly.
success = cert:load_from_file("/mycerts/alice.crt")
if not success then
    print(cert.last_error_text)
    return
end

-- 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.
local certVault = chilkat.XmlCertVault.new()
success = certVault:add_cert_file("/mycerts/ca.crt")
if not success then
    print(certVault.last_error_text)
    return
end

success = cert:use_cert_vault(certVault)
if not success then
    print(cert.last_error_text)
    return
end

-- 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).
local privKey = chilkat.PrivateKey.new()
success = privKey:load_pem_file("/mycerts/alice.key")
if not success then
    print(privKey.last_error_text)
    return
end

-- Provide the certificate object with the private key:
success = cert:set_private_key(privKey)
if not success then
    print(cert.last_error_text)
    return
end

-- Our certificate object now contains all that we need to add it as a private key entry
-- to the Java keystore:
local alias = "alice"
success = jks:add_private_key(cert, alias, jksPassword)
if not success then
    print(jks.last_error_text)
    return
end

-- Write the updated JKS, which contains the new private key entry w/ certificate chain.
success = jks:to_file(jksPassword, jksPath)
if not success then
    print(jks.last_error_text)
    return
end

print("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.
local pfx = chilkat.Pfx.new()

success = pfx:load_pfx_file("/myPfxFiles/my.pfx", "pfxPassword")
if not success then
    print(pfx.last_error_text)
    return
end

-- This is easy -- simply add the PFX to the JKS
alias = "bob"
success = jks:add_pfx(pfx, alias, jksPassword)
if not success then
    print(jks.last_error_text)
    return
end

-- Write the updated JKS, which contains the new private key entry w/ certificate chain
-- that came from the PFX.
success = jks:to_file(jksPassword, jksPath)
if not success then
    print(jks.last_error_text)
    return
end

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