You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by ml...@apache.org on 2006/06/15 13:12:16 UTC
svn commit: r414558 - in
/incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool:
KeyStoreLoaderSaver.java KeytoolException.java KeytoolParameters.java
Author: mloenko
Date: Thu Jun 15 04:12:15 2006
New Revision: 414558
URL: http://svn.apache.org/viewvc?rev=414558&view=rev
Log:
applied patch from HARMONY-598
Keytool - added keystore loading, keytool-specific exception type, misc
Added:
incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeyStoreLoaderSaver.java
incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolException.java
Modified:
incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolParameters.java
Added: incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeyStoreLoaderSaver.java
URL: http://svn.apache.org/viewvc/incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeyStoreLoaderSaver.java?rev=414558&view=auto
==============================================================================
--- incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeyStoreLoaderSaver.java (added)
+++ incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeyStoreLoaderSaver.java Thu Jun 15 04:12:15 2006
@@ -0,0 +1,166 @@
+/*
+ * Copyright 2006 The Apache Software Foundation or its licensors, as applicable
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.apache.harmony.tools.keytool;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.security.KeyStore;
+import java.security.KeyStoreException;
+import java.security.NoSuchAlgorithmException;
+import java.security.NoSuchProviderException;
+import java.security.cert.CertificateException;
+
+/**
+ * Class for loading keystores, saving ang changing the main keystore password.
+ */
+public class KeyStoreLoaderSaver {
+
+ /**
+ * Creates an instance of class KeyStore and loads a keystore to it.
+ * param.getStorePass() is used to check the integrity of the keystore. If
+ * the password is not set in param, the integrity is not checked. If the
+ * path to the store is not defined an empty keystore is created.
+ *
+ * @param param - KeytoolParameters object which is used to get path to the
+ * store and password to unlock it or check its integrity.
+ * @throws NoSuchAlgorithmException
+ * @throws CertificateException
+ * @throws FileNotFoundException
+ * @throws IOException
+ * @throws KeyStoreException
+ * @throws KeytoolException
+ * @throws NoSuchProviderException
+ */
+ static void loadStore(KeytoolParameters param)
+ throws NoSuchAlgorithmException, CertificateException,
+ FileNotFoundException, IOException, KeyStoreException,
+ NoSuchProviderException, KeytoolException {
+
+ // If the path to the store is not specified, try to open
+ // the store using the default path.
+ if (param.getStorePath() == null) {
+ param.setStorePath(KeytoolParameters.defaultKeystorePath);
+ }
+ KeyStore keyStore;
+ if (new File(param.getStorePath()).exists()) {
+ // load an existing store
+ keyStore = loadStore(param.getStorePath(), param.getStoreType(),
+ param.getStorePass(), param.getProvider());
+ } else {
+ // create a new store if it doesn't exist
+ keyStore = loadStore(null, param.getStoreType(), param
+ .getStorePass(), param.getProvider());
+ param.setNeedSaveKS(true);
+ }
+ param.setKeyStore(keyStore);
+ }
+
+ /**
+ * Creates an instance of class KeyStore and loads a keystore of the
+ * specified type to it. If the type is not specified the default one is
+ * used. Password storePass is used to check the integrity of the keystore.
+ * If the password is null, the integrity is not checked. If the path to the
+ * store is not defined, an empty keystore is created.
+ *
+ * @param path
+ * @param storeType
+ * @param storePass
+ * @param providerName
+ * @return
+ * @throws FileNotFoundException
+ * @throws KeyStoreException
+ * @throws NoSuchAlgorithmException
+ * @throws CertificateException
+ * @throws IOException
+ * @throws NoSuchProviderException
+ * @throws KeytoolException
+ */
+ static KeyStore loadStore(String path, String storeType, char[] storePass,
+ String providerName) throws FileNotFoundException,
+ KeyStoreException, NoSuchAlgorithmException, CertificateException,
+ IOException, NoSuchProviderException, KeytoolException {
+
+ FileInputStream fis;
+ // if the path is given, make a FileInputStream on it
+ if (path != null) {
+ File ksFile = new File(path);
+ if (ksFile.length() == 0) {
+ throw new KeytoolException("Keystore file exists but is empty");
+ }
+ fis = new FileInputStream(ksFile);
+ } else { // if the path is not given, a new keystore will be created
+ fis = null;
+ }
+
+ // Set the store type to default if it is not given.
+ // The default value is set up in java.security file.
+ String checkedStoreType = (storeType != null) ? storeType : KeyStore
+ .getDefaultType();
+ KeyStore keyStore;
+ // if the provider name is not set
+ if (providerName == null) {
+ keyStore = KeyStore.getInstance(checkedStoreType);
+ } else {
+ try {
+ keyStore = KeyStore.getInstance(storeType, providerName);
+ } catch (NoSuchProviderException e) {
+ throw (NoSuchProviderException) new NoSuchProviderException(
+ "The provider " + providerName
+ + " is not found in the environment.")
+ .initCause(e);
+ }
+ }
+
+ try {
+ // try to load the keystore
+ keyStore.load(fis, storePass);
+ } catch (NoSuchAlgorithmException e) {
+ throw new NoSuchAlgorithmException(
+ "Failed to find the algorithm to check the keystore integrity",
+ e);
+ } catch (CertificateException e) {
+ throw new CertificateException(
+ "Failed to load a certificate from the keystore. ", e);
+ } catch (IOException e) {
+ throw (IOException) new IOException("Failed to load the keystore. ")
+ .initCause(e);
+ }
+ return keyStore;
+ }
+
+ /**
+ * Saves the keystore to the file and protects its integrity with password.
+ *
+ * @param param
+ */
+ static void saveStore(KeytoolParameters param) {
+ // TODO
+ throw new RuntimeException("The method is not implemented yet.");
+ }
+
+ /**
+ * Changes the keystore password to the new one.
+ *
+ * @param param
+ */
+ static void storePasswd(KeytoolParameters param) {
+ // TODO
+ throw new RuntimeException("The method is not implemented yet.");
+ }
+}
Added: incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolException.java
URL: http://svn.apache.org/viewvc/incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolException.java?rev=414558&view=auto
==============================================================================
--- incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolException.java (added)
+++ incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolException.java Thu Jun 15 04:12:15 2006
@@ -0,0 +1,57 @@
+/*
+ * Copyright 2006 The Apache Software Foundation or its licensors, as applicable
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package org.apache.harmony.tools.keytool;
+
+/**
+ * Class representing the exceptions specific for keytool.
+ */
+public class KeytoolException extends Exception {
+
+ /**
+ * serial version UID.
+ */
+ private static final long serialVersionUID = -2930629442696213997L;
+
+ /**
+ * Default constructor.
+ */
+ public KeytoolException() {
+ super();
+ }
+
+ /**
+ * @param msg - exception message to print
+ */
+ public KeytoolException(String msg) {
+ super(msg);
+ }
+
+ /**
+ * @param msg - exception message to print
+ * @param cause - throwable that caused this exception to be thrown
+ */
+ public KeytoolException(String msg, Throwable cause) {
+ super(msg, cause);
+ }
+
+ /**
+ * @param cause - throwable that caused this exception to be thrown
+ */
+ public KeytoolException(Throwable cause) {
+ super(cause);
+ }
+}
Modified: incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolParameters.java
URL: http://svn.apache.org/viewvc/incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolParameters.java?rev=414558&r1=414557&r2=414558&view=diff
==============================================================================
--- incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolParameters.java (original)
+++ incubator/harmony/enhanced/classlib/trunk/modules/tools/src/main/java/org/apache/harmony/tools/keytool/KeytoolParameters.java Thu Jun 15 04:12:15 2006
@@ -24,7 +24,6 @@
* given in command line.
*/
public class KeytoolParameters {
- // TODO
/**
* Default location of the keystore. Used when the value is not supplied by
* the user.
@@ -60,7 +59,7 @@
private String alias;
// algorithm name to get instance of KeyPairGenerator, KeyFactory, etc.
- private String keyAlg = "DSA";
+ private String keyAlg;
// digital signature algorithm
private String sigAlg;
@@ -71,8 +70,9 @@
// name of the file to import/export certificates
private String fileName;
- // alias to access an entry in certstore
- private String certAlias;
+ // alias to access the issuer's certificate (certificate which a newly
+ // generated certificate can be signed with)
+ private String issuerAlias;
// certstore to keep a CRL in
private String crlStore;
@@ -89,6 +89,9 @@
// new password to change the old one to
private char[] newPasswd;
+ // password to access the issuer's certificate (see issuerAlias)
+ private char [] issuerPass;
+
// size of the key to generate
private int keySize = 1024;
@@ -124,4 +127,482 @@
// command to perform
private Command command = Command.HELP;
+
+ /**
+ * The method sets the fields to default values. If there is no default
+ * value the field is set to null.
+ */
+ void setDefault() {
+ keyStore = null;
+ needSaveKS = false;
+ storePath = null;
+ storeType = KeyStore.getDefaultType();
+ provider = null;
+ storePass = null;
+ alias = null;
+ keyAlg = null;
+ keySize = 1024;
+ sigAlg = null;
+ dName = null;
+ keyPass = null;
+ newPasswd = null;
+ validity = 90;
+ fileName = null;
+ noPrompt = false;
+ trustCACerts = false;
+ rfc = false;
+ verbose = false;
+ isSecretKey = false;
+ issuerAlias = null;
+ X509version = 3;
+ certSerialNr = 0;
+ isKeyStore = true;
+ command = Command.HELP;
+ }
+
+ // getters and setters down here.
+ /**
+ * @return Returns the keystore to work with.
+ */
+ KeyStore getKeyStore() {
+ return keyStore;
+ }
+
+ /**
+ * @param keyStore
+ * The KeyStore to set as keystore worked with.
+ */
+ void setKeyStore(KeyStore keyStore) {
+ this.keyStore = keyStore;
+ }
+
+ /**
+ * @return Returns true if keystore is to be saved, false - otherwise.
+ */
+ public boolean isNeedSaveKS() {
+ return needSaveKS;
+ }
+
+ /**
+ * @param needSaveKS -
+ * if true keystore is to be saved, if false - it is not.
+ */
+ public void setNeedSaveKS(boolean needSaveKS) {
+ this.needSaveKS = needSaveKS;
+ }
+
+ /**
+ * @return Returns the alias used to access the keystore entry.
+ */
+ String getAlias() {
+ return alias;
+ }
+
+ /**
+ * @param alias
+ * The alias to access the keystore entry.
+ */
+ public void setAlias(String alias) {
+ this.alias = alias;
+ }
+
+ /**
+ * @return Returns the alias to access the issuer's certificate (certificate
+ * which a newly generated certificate can be signed with)
+ */
+ String getIssuerAlias() {
+ return issuerAlias;
+ }
+
+ /**
+ * @param issuerAlias
+ * The alias to access the issuer's certificate (certificate
+ * which a newly generated certificate can be signed with)
+ */
+ public void setIssuerAlias(String issuerAlias) {
+ this.issuerAlias = issuerAlias;
+ }
+
+ /**
+ * @return Returns the certstore path to keep CRLs in.
+ */
+ String getCrlStore() {
+ return crlStore;
+ }
+
+ /**
+ * @param crlStore
+ * certstore path to keep CRLs in.
+ */
+ public void setCrlStore(String crlStore) {
+ this.crlStore = crlStore;
+ }
+
+ /**
+ * @return Returns the destination alias to copy key pair to
+ */
+ String getDestAlias() {
+ return destAlias;
+ }
+
+ /**
+ * @param destAlias
+ * The destination alias to copy key pair to
+ */
+ public void setDestAlias(String destAlias) {
+ this.destAlias = destAlias;
+ }
+
+ /**
+ * @return Returns the certificate serial number
+ */
+ int getCertSerialNr() {
+ return certSerialNr;
+ }
+
+ /**
+ * @param certSerialNr
+ * The certificate serial number
+ */
+ public void setCertSerialNr(int certSerialNr) {
+ this.certSerialNr = certSerialNr;
+ }
+
+ /**
+ * @return Returns the command to perform
+ */
+ Command getCommand() {
+ return command;
+ }
+
+ /**
+ * @param command
+ * The command to perform
+ */
+ public void setCommand(Command command) {
+ this.command = command;
+ }
+
+ /**
+ * @return Returns the X.500 Distinguished Name to generate a certificate
+ */
+ String getDName() {
+ return dName;
+ }
+
+ /**
+ * @param name
+ * The X.500 Distinguished Name to generate a certificate
+ */
+ public void setDName(String name) {
+ dName = name;
+ }
+
+ /**
+ * @return Returns the name of the file to import/export certificates
+ */
+ String getFileName() {
+ return fileName;
+ }
+
+ /**
+ * @param fileName
+ * The name of the file to import/export certificates
+ */
+ public void setFileName(String fileName) {
+ this.fileName = fileName;
+ }
+
+ /**
+ * @return Returns true if the store to work with is a keystore, false - if
+ * a certstore
+ */
+ boolean isKeyStore() {
+ return isKeyStore;
+ }
+
+ /**
+ * @param isKeyStore
+ * set true if the store worked with is a keystore, false - if a
+ * certstore
+ */
+ void setIsKeyStore(boolean isKeyStore) {
+ this.isKeyStore = isKeyStore;
+ }
+
+ /**
+ * @return Returns the algorithm name to get instance of KeyPairGenerator,
+ * KeyFactory, etc.
+ */
+ String getKeyAlg() {
+ return keyAlg;
+ }
+
+ /**
+ * @param keyAlg
+ * algorithm name to get instance of KeyPairGenerator,
+ * KeyFactory, etc.
+ */
+ public void setKeyAlg(String keyAlg) {
+ this.keyAlg = keyAlg;
+ }
+
+ /**
+ * @return Returns the password to access the key entry
+ */
+ char[] getKeyPass() {
+ return keyPass;
+ }
+
+ /**
+ * @param keyPass
+ * password to access the key entry
+ */
+ public void setKeyPass(char[] keyPass) {
+ this.keyPass = keyPass;
+ }
+
+ /**
+ * @return Returns the size of the key to generate
+ */
+ int getKeySize() {
+ return keySize;
+ }
+
+ /**
+ * @param keySize
+ * The size of the key to generate
+ */
+ public void setKeySize(int keySize) {
+ this.keySize = keySize;
+ }
+
+ /**
+ * @return Returns the new password to change the old one to
+ */
+ char[] getNewPasswd() {
+ return newPasswd;
+ }
+
+ /**
+ * @param newPasswd
+ * The new password to change the old one to
+ */
+ public void setNewPasswd(char[] newPasswd) {
+ this.newPasswd = newPasswd;
+ }
+
+ /**
+ * @return password to access the issuer's certificate (certificate which a
+ * newly generated certificate can be signed with)
+ */
+ char[] getIssuerPass() {
+ return issuerPass;
+ }
+
+ /**
+ * @param issuerPass
+ * password to access the issuer's certificate (certificate which
+ * a newly generated certificate can be signed with)
+ */
+ public void setIssuerPass(char[] issuerPass) {
+ this.issuerPass = issuerPass;
+ }
+
+ /**
+ * @return Returns true if unspecified parameters should be prompted for,
+ * false - otherwise
+ */
+ boolean isNoPrompt() {
+ return noPrompt;
+ }
+
+ /**
+ * @param noPrompt
+ * Set true if unspecified parameters should be prompted for,
+ * false if not
+ */
+ public void setNoPrompt(boolean noPrompt) {
+ this.noPrompt = noPrompt;
+ }
+
+ /**
+ * @return Returns the name of the provider to use
+ */
+ String getProvider() {
+ return provider;
+ }
+
+ /**
+ * @param provider
+ * the name of the provider to use
+ */
+ public void setProvider(String provider) {
+ this.provider = provider;
+ }
+
+ /**
+ * @return Returns true if the certificate should be printed or exported in
+ * printable format, false - if in binary format
+ */
+ boolean isRfc() {
+ return rfc;
+ }
+
+ /**
+ * @param rfc
+ * set true if the certificate should be printed or exported in
+ * printable format, false - if in binary format
+ */
+ public void setRfc(boolean rfc) {
+ this.rfc = rfc;
+ }
+
+ /**
+ * @return Returns true if a secret key should be generated, false - if a
+ * key pair.
+ */
+ boolean isSecretKey() {
+ return isSecretKey;
+ }
+
+ /**
+ * @param isSecretKey
+ * set true if a secret key should be generated, false - if a key
+ * pair.
+ */
+ public void setSecretKey(boolean secretKey) {
+ this.isSecretKey = secretKey;
+ }
+
+ /**
+ * @return Returns the digital signature algorithm
+ */
+ String getSigAlg() {
+ return sigAlg;
+ }
+
+ /**
+ * @param sigAlg
+ * The digital signature algorithm to set.
+ */
+ public void setSigAlg(String sigAlg) {
+ this.sigAlg = sigAlg;
+ }
+
+ /**
+ * @return Returns the password to access the store
+ */
+ char[] getStorePass() {
+ return storePass;
+ }
+
+ /**
+ * @param storePass
+ * The password to access the store
+ */
+ public void setStorePass(char[] storePass) {
+ this.storePass = storePass;
+ }
+
+ /**
+ * @return Returns the type of the store
+ */
+ String getStoreType() {
+ return storeType;
+ }
+
+ /**
+ * @param storeType
+ * The type of the store to set.
+ */
+ public void setStoreType(String storeType) {
+ this.storeType = storeType;
+ }
+
+ /**
+ * @return Returns true if the certificates from cacerts file should be
+ * considered for the chain of trust, false - if not
+ */
+ boolean isTrustCACerts() {
+ return trustCACerts;
+ }
+
+ /**
+ * @param trustCACerts
+ * set true if the certificates from cacerts file should be
+ * considered for the chain of trust, false - if not.
+ */
+ public void setTrustCACerts(boolean trustCACerts) {
+ this.trustCACerts = trustCACerts;
+ }
+
+ /**
+ * @return Returns the validity period of the generated certificate in days
+ * from the current moment
+ */
+ int getValidity() {
+ return validity;
+ }
+
+ /**
+ * @param validity
+ * The validity period of the generated certificate in days from
+ * the current moment
+ */
+ public void setValidity(int validity) {
+ this.validity = validity;
+ }
+
+ /**
+ * @return Returns true if the keytool should print the detailed information
+ * on the operation, false - if not
+ */
+ boolean isVerbose() {
+ return verbose;
+ }
+
+ /**
+ * @param verbose
+ * set true if the keytool should print the detailed information
+ * on the operation, false - if not
+ */
+ public void setVerbose(boolean verbose) {
+ this.verbose = verbose;
+ }
+
+ /**
+ * @return Returns the X.509 protocol version to use when generating a
+ * certificate
+ */
+ int getX509version() {
+ return X509version;
+ }
+
+ /**
+ * @param x509version
+ * The X.509 protocol version to use when generating a
+ * certificate
+ */
+ public void setX509version(int x509version) {
+ X509version = x509version;
+ }
+
+ /**
+ * @return Returns path to the keystore or certstore depending on a command.
+ */
+ String getStorePath() {
+ return storePath;
+ }
+
+ /**
+ * @param storePath
+ * The path to the keystore or certstore (depending on a
+ * command).
+ */
+ public void setStorePath(String storePath) {
+ this.storePath = storePath;
+ }
+
}
+