Sample code for 30+ languages & platforms
Dart

Add Private Key to Java Keystore

See more Java KeyStore (JKS) Examples

Adds a private key to an existing Java keystore.

Chilkat Dart Downloads

Dart
import 'package:chilkat/chilkat.dart';

void main() {
  // This requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final jks = CkJavaKeyStore();

  final jksPassword = 'myJksPassword';
  final jksPath = '/someDir/keyStore.jks';

  // Load the Java keystore from a file.
  try {
    jks.loadFile(jksPassword, jksPath);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // 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:
  final cert = CkCert();

  // Chilkat will automatically determine the format of the cert file and load it correctly.
  try {
    cert.loadFromFile('/mycerts/alice.crt');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // 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.
  final certVault = CkXmlCertVault();
  try {
    certVault.addCertFile('/mycerts/ca.crt');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    cert.useCertVault(certVault);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // 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).
  final privKey = CkPrivateKey();
  try {
    privKey.loadPemFile('/mycerts/alice.key');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Provide the certificate object with the private key:
  try {
    cert.setPrivateKey(privKey);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Our certificate object now contains all that we need to add it as a private key entry
  // to the Java keystore:
  var alias = 'alice';
  try {
    jks.addPrivateKey(cert, alias, jksPassword);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Write the updated JKS, which contains the new private key entry w/ certificate chain.
  try {
    jks.toFile(jksPassword, jksPath);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  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.
  final pfx = CkPfx();

  try {
    pfx.loadPfxFile('/myPfxFiles/my.pfx', 'pfxPassword');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // This is easy -- simply add the PFX to the JKS
  alias = 'bob';
  try {
    jks.addPfx(pfx, alias, jksPassword);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Write the updated JKS, which contains the new private key entry w/ certificate chain
  // that came from the PFX.
  try {
    jks.toFile(jksPassword, jksPath);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Added new private key entry (from PFX) to the JKS!');
}