From da68de98bc58a3176ed3162336a4e888a7bc7c99 Mon Sep 17 00:00:00 2001 From: "Endi S. Dewata" Date: Mon, 15 Feb 2016 05:27:19 +0100 Subject: [PATCH] Added CLI to manage certs in PKCS #12 file. New CLIs have been added to create an empty PKCS #12 file, to add a new certificate and its key from NSS database, and to remove a certificate from the PKCS #12 file. https://fedorahosted.org/pki/ticket/1742 --- .../com/netscape/cmstools/pkcs12/PKCS12CLI.java | 1 + .../netscape/cmstools/pkcs12/PKCS12CertAddCLI.java | 154 +++++++++++++++++++++ .../netscape/cmstools/pkcs12/PKCS12CertCLI.java | 2 + .../cmstools/pkcs12/PKCS12CertRemoveCLI.java | 149 ++++++++++++++++++++ .../netscape/cmstools/pkcs12/PKCS12CreateCLI.java | 134 ++++++++++++++++++ .../src/netscape/security/pkcs/PKCS12Util.java | 8 ++ 6 files changed, 448 insertions(+) create mode 100644 base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertAddCLI.java create mode 100644 base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertRemoveCLI.java create mode 100644 base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CreateCLI.java diff --git a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CLI.java b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CLI.java index b841ec0ee16ebdf3d3a66e1fe1fbdc0d4971b909..fca1234fd6ad9c7d361696ec7ba8b41994034ef1 100644 --- a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CLI.java +++ b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CLI.java @@ -30,6 +30,7 @@ public class PKCS12CLI extends CLI { super("pkcs12", "PKCS #12 utilities", parent); addModule(new PKCS12CertCLI(this)); + addModule(new PKCS12CreateCLI(this)); addModule(new PKCS12ExportCLI(this)); addModule(new PKCS12ImportCLI(this)); addModule(new PKCS12KeyCLI(this)); diff --git a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertAddCLI.java b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertAddCLI.java new file mode 100644 index 0000000000000000000000000000000000000000..653a4a874623ac7fada6733c535031e1cb3af408 --- /dev/null +++ b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertAddCLI.java @@ -0,0 +1,154 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2016 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- + +package com.netscape.cmstools.pkcs12; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.util.logging.Level; +import java.util.logging.Logger; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.Option; +import org.apache.commons.cli.ParseException; +import org.mozilla.jss.util.Password; + +import com.netscape.cmstools.cli.CLI; +import com.netscape.cmstools.cli.MainCLI; + +import netscape.security.pkcs.PKCS12; +import netscape.security.pkcs.PKCS12Util; + +/** + * @author Endi S. Dewata + */ +public class PKCS12CertAddCLI extends CLI { + + public PKCS12CertAddCLI(PKCS12CertCLI certCLI) { + super("add", "Add certificate into PKCS #12 file", certCLI); + + createOptions(); + } + + public void printHelp() { + formatter.printHelp(getFullName() + " [OPTIONS...]", options); + } + + public void createOptions() { + Option option = new Option(null, "pkcs12", true, "PKCS #12 file"); + option.setArgName("path"); + options.addOption(option); + + option = new Option(null, "pkcs12-password", true, "PKCS #12 password"); + option.setArgName("password"); + options.addOption(option); + + option = new Option(null, "pkcs12-password-file", true, "PKCS #12 password file"); + option.setArgName("path"); + options.addOption(option); + + options.addOption(null, "no-trust-flags", false, "Do not include trust flags"); + + options.addOption("v", "verbose", false, "Run in verbose mode."); + options.addOption(null, "debug", false, "Run in debug mode."); + options.addOption(null, "help", false, "Show help message."); + } + + public void execute(String[] args) throws Exception { + + CommandLine cmd = null; + + try { + cmd = parser.parse(options, args); + } catch (ParseException e) { + System.err.println("Error: " + e.getMessage()); + printHelp(); + System.exit(-1); + } + + if (cmd.hasOption("help")) { + printHelp(); + System.exit(0); + } + + if (cmd.hasOption("verbose")) { + Logger.getLogger("org.dogtagpki").setLevel(Level.INFO); + Logger.getLogger("com.netscape").setLevel(Level.INFO); + Logger.getLogger("netscape").setLevel(Level.INFO); + + } else if (cmd.hasOption("debug")) { + Logger.getLogger("org.dogtagpki").setLevel(Level.FINE); + Logger.getLogger("com.netscape").setLevel(Level.FINE); + Logger.getLogger("netscape").setLevel(Level.FINE); + } + + String[] cmdArgs = cmd.getArgs(); + + if (cmdArgs.length == 0) { + System.err.println("Error: Missing certificate nickname."); + printHelp(); + System.exit(-1); + } + + String nickname = cmdArgs[0]; + + String filename = cmd.getOptionValue("pkcs12"); + + if (filename == null) { + System.err.println("Error: Missing PKCS #12 file."); + printHelp(); + System.exit(-1); + } + + String passwordString = cmd.getOptionValue("pkcs12-password"); + + if (passwordString == null) { + + String passwordFile = cmd.getOptionValue("pkcs12-password-file"); + if (passwordFile != null) { + try (BufferedReader in = new BufferedReader(new FileReader(passwordFile))) { + passwordString = in.readLine(); + } + } + } + + if (passwordString == null) { + System.err.println("Error: Missing PKCS #12 password."); + printHelp(); + System.exit(-1); + } + + Password password = new Password(passwordString.toCharArray()); + + boolean trustFlagsEnabled = !cmd.hasOption("no-trust-flags"); + + try { + PKCS12Util util = new PKCS12Util(); + util.setTrustFlagsEnabled(trustFlagsEnabled); + + PKCS12 pkcs12 = util.loadFromFile(filename, password); + util.loadCertFromNSS(pkcs12, nickname); + util.storeIntoFile(pkcs12, filename, password); + + } finally { + password.clear(); + } + + MainCLI.printMessage("Added certificate \"" + nickname + "\""); + } +} diff --git a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertCLI.java b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertCLI.java index a83fbac4f7cd1ef523480368557e9042fdaa461c..13595f51ad7d71ce6012b2e450c09988ad513c8e 100644 --- a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertCLI.java +++ b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertCLI.java @@ -31,7 +31,9 @@ public class PKCS12CertCLI extends CLI { public PKCS12CertCLI(PKCS12CLI parent) { super("cert", "PKCS #12 certificate management commands", parent); + addModule(new PKCS12CertAddCLI(this)); addModule(new PKCS12CertFindCLI(this)); + addModule(new PKCS12CertRemoveCLI(this)); } public static void printCertInfo(PKCS12CertInfo certInfo) throws Exception { diff --git a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertRemoveCLI.java b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertRemoveCLI.java new file mode 100644 index 0000000000000000000000000000000000000000..9dbf767ef1365b9dc9b933fc57bc243e268cc0c6 --- /dev/null +++ b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CertRemoveCLI.java @@ -0,0 +1,149 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2016 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- + +package com.netscape.cmstools.pkcs12; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.util.logging.Level; +import java.util.logging.Logger; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.Option; +import org.apache.commons.cli.ParseException; +import org.mozilla.jss.util.Password; + +import com.netscape.cmstools.cli.CLI; +import com.netscape.cmstools.cli.MainCLI; + +import netscape.security.pkcs.PKCS12; +import netscape.security.pkcs.PKCS12Util; + +/** + * @author Endi S. Dewata + */ +public class PKCS12CertRemoveCLI extends CLI { + + public PKCS12CertRemoveCLI(PKCS12CertCLI certCLI) { + super("del", "Remove certificate from PKCS #12 file", certCLI); + + createOptions(); + } + + public void printHelp() { + formatter.printHelp(getFullName() + " [OPTIONS...]", options); + } + + public void createOptions() { + Option option = new Option(null, "pkcs12", true, "PKCS #12 file"); + option.setArgName("path"); + options.addOption(option); + + option = new Option(null, "pkcs12-password", true, "PKCS #12 password"); + option.setArgName("password"); + options.addOption(option); + + option = new Option(null, "pkcs12-password-file", true, "PKCS #12 password file"); + option.setArgName("path"); + options.addOption(option); + + options.addOption("v", "verbose", false, "Run in verbose mode."); + options.addOption(null, "debug", false, "Run in debug mode."); + options.addOption(null, "help", false, "Show help message."); + } + + public void execute(String[] args) throws Exception { + + CommandLine cmd = null; + + try { + cmd = parser.parse(options, args); + } catch (ParseException e) { + System.err.println("Error: " + e.getMessage()); + printHelp(); + System.exit(-1); + } + + if (cmd.hasOption("help")) { + printHelp(); + System.exit(0); + } + + if (cmd.hasOption("verbose")) { + Logger.getLogger("org.dogtagpki").setLevel(Level.INFO); + Logger.getLogger("com.netscape").setLevel(Level.INFO); + Logger.getLogger("netscape").setLevel(Level.INFO); + + } else if (cmd.hasOption("debug")) { + Logger.getLogger("org.dogtagpki").setLevel(Level.FINE); + Logger.getLogger("com.netscape").setLevel(Level.FINE); + Logger.getLogger("netscape").setLevel(Level.FINE); + } + + String[] cmdArgs = cmd.getArgs(); + + if (cmdArgs.length == 0) { + System.err.println("Error: Missing certificate nickname."); + printHelp(); + System.exit(-1); + } + + String nickname = cmdArgs[0]; + + String filename = cmd.getOptionValue("pkcs12"); + + if (filename == null) { + System.err.println("Error: Missing PKCS #12 file."); + printHelp(); + System.exit(-1); + } + + String passwordString = cmd.getOptionValue("pkcs12-password"); + + if (passwordString == null) { + + String passwordFile = cmd.getOptionValue("pkcs12-password-file"); + if (passwordFile != null) { + try (BufferedReader in = new BufferedReader(new FileReader(passwordFile))) { + passwordString = in.readLine(); + } + } + } + + if (passwordString == null) { + System.err.println("Error: Missing PKCS #12 password."); + printHelp(); + System.exit(-1); + } + + Password password = new Password(passwordString.toCharArray()); + + try { + PKCS12Util util = new PKCS12Util(); + + PKCS12 pkcs12 = util.loadFromFile(filename, password); + pkcs12.removeCertInfoByNickname(nickname); + util.storeIntoFile(pkcs12, filename, password); + + } finally { + password.clear(); + } + + MainCLI.printMessage("Deleted certificate \"" + nickname + "\""); + } +} diff --git a/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CreateCLI.java b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CreateCLI.java new file mode 100644 index 0000000000000000000000000000000000000000..1adc6545661f26fd66385b652e975b905ef7a8ee --- /dev/null +++ b/base/java-tools/src/com/netscape/cmstools/pkcs12/PKCS12CreateCLI.java @@ -0,0 +1,134 @@ +// --- BEGIN COPYRIGHT BLOCK --- +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; version 2 of the License. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License along +// with this program; if not, write to the Free Software Foundation, Inc., +// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +// +// (C) 2016 Red Hat, Inc. +// All rights reserved. +// --- END COPYRIGHT BLOCK --- +package com.netscape.cmstools.pkcs12; + +import java.io.BufferedReader; +import java.io.FileReader; +import java.util.logging.Level; +import java.util.logging.Logger; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.Option; +import org.mozilla.jss.util.Password; + +import com.netscape.cmstools.cli.CLI; +import com.netscape.cmstools.cli.MainCLI; + +import netscape.security.pkcs.PKCS12; +import netscape.security.pkcs.PKCS12Util; + +/** + * Tool for creating an empty PKCS #12 file + */ +public class PKCS12CreateCLI extends CLI { + + public PKCS12CreateCLI(PKCS12CLI certCLI) { + super("create", "Create an empty PKCS #12 file", certCLI); + + createOptions(); + } + + public void printHelp() { + formatter.printHelp(getFullName() + " [OPTIONS...]", options); + } + + public void createOptions() { + Option option = new Option(null, "pkcs12", true, "PKCS #12 file"); + option.setArgName("path"); + options.addOption(option); + + option = new Option(null, "pkcs12-password", true, "PKCS #12 password"); + option.setArgName("password"); + options.addOption(option); + + option = new Option(null, "pkcs12-password-file", true, "PKCS #12 password file"); + option.setArgName("path"); + options.addOption(option); + + options.addOption("v", "verbose", false, "Run in verbose mode."); + options.addOption(null, "debug", false, "Run in debug mode."); + options.addOption(null, "help", false, "Show help message."); + } + + public void execute(String[] args) throws Exception { + + CommandLine cmd = null; + + try { + cmd = parser.parse(options, args, true); + } catch (Exception e) { + System.err.println("Error: " + e.getMessage()); + printHelp(); + System.exit(-1); + } + + if (cmd.hasOption("help")) { + printHelp(); + System.exit(0); + } + + if (cmd.hasOption("verbose")) { + Logger.getLogger("org.dogtagpki").setLevel(Level.INFO); + Logger.getLogger("com.netscape").setLevel(Level.INFO); + Logger.getLogger("netscape").setLevel(Level.INFO); + + } else if (cmd.hasOption("debug")) { + Logger.getLogger("org.dogtagpki").setLevel(Level.FINE); + Logger.getLogger("com.netscape").setLevel(Level.FINE); + Logger.getLogger("netscape").setLevel(Level.FINE); + } + + String filename = cmd.getOptionValue("pkcs12"); + + if (filename == null) { + System.err.println("Error: Missing PKCS #12 file."); + printHelp(); + System.exit(-1); + } + + String passwordString = cmd.getOptionValue("pkcs12-password"); + + if (passwordString == null) { + + String passwordFile = cmd.getOptionValue("pkcs12-password-file"); + if (passwordFile != null) { + try (BufferedReader in = new BufferedReader(new FileReader(passwordFile))) { + passwordString = in.readLine(); + } + } + } + + if (passwordString == null) { + System.err.println("Error: Missing PKCS #12 password."); + printHelp(); + System.exit(-1); + } + + Password password = new Password(passwordString.toCharArray()); + + try { + PKCS12Util util = new PKCS12Util(); + PKCS12 pkcs12 = new PKCS12(); + util.storeIntoFile(pkcs12, filename, password); + } finally { + password.clear(); + } + + MainCLI.printMessage("PKCS #12 file created"); + } +} diff --git a/base/util/src/netscape/security/pkcs/PKCS12Util.java b/base/util/src/netscape/security/pkcs/PKCS12Util.java index 679cb828be36c43b7523ac6a5b4c07e98d9435ff..d139a091de16b12d9a994c93289774f6e9ade0b6 100644 --- a/base/util/src/netscape/security/pkcs/PKCS12Util.java +++ b/base/util/src/netscape/security/pkcs/PKCS12Util.java @@ -249,6 +249,14 @@ public class PKCS12Util { return pkcs12; } + public void loadCertFromNSS(PKCS12 pkcs12, String nickname) throws Exception { + + CryptoManager cm = CryptoManager.getInstance(); + X509Certificate cert = cm.findCertByNickname(nickname); + + loadCertAndKeyFromNSS(pkcs12, cert); + } + public void loadCertAndKeyFromNSS(PKCS12 pkcs12, X509Certificate cert) throws Exception { String nickname = cert.getNickname(); -- 2.4.3