src/edu/internet2/middleware/shibboleth/utils/HandleRepositorySecretGenerator.java

   1 /*
   2  * The Shibboleth License, Version 1.
   3  * Copyright (c) 2002
   4  * University Corporation for Advanced Internet Development, Inc.
   5  * All rights reserved
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * Redistributions of source code must retain the above copyright notice, this
  12  * list of conditions and the following disclaimer.
  13  *
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution, if any, must include
  17  * the following acknowledgment: "This product includes software developed by
  18  * the University Corporation for Advanced Internet Development
  19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
  20  * may appear in the software itself, if and wherever such third-party
  21  * acknowledgments normally appear.
  22  *
  23  * Neither the name of Shibboleth nor the names of its contributors, nor
  24  * Internet2, nor the University Corporation for Advanced Internet Development,
  25  * Inc., nor UCAID may be used to endorse or promote products derived from this
  26  * software without specific prior written permission. For written permission,
  27  * please contact shibboleth@shibboleth.org
  28  *
  29  * Products derived from this software may not be called Shibboleth, Internet2,
  30  * UCAID, or the University Corporation for Advanced Internet Development, nor
  31  * may Shibboleth appear in their name, without prior written permission of the
  32  * University Corporation for Advanced Internet Development.
  33  *
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
  39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
  40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
  42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  */
  49
  50 package edu.internet2.middleware.shibboleth.utils;
  51
  52 import java.io.FileOutputStream;
  53 import java.io.IOException;
  54 import java.security.GeneralSecurityException;
  55 import java.security.InvalidKeyException;
  56 import java.security.KeyStore;
  57 import java.security.KeyStoreException;
  58 import java.security.NoSuchAlgorithmException;
  59 import java.security.SecureRandom;
  60 import java.security.cert.CertificateException;
  61 import java.security.spec.InvalidKeySpecException;
  62
  63 import javax.crypto.SecretKey;
  64 import javax.crypto.SecretKeyFactory;
  65 import javax.crypto.spec.DESedeKeySpec;
  66
  67 import sun.misc.BASE64Encoder;
  68 import org.apache.tools.ant.BuildException;
  69 import org.apache.tools.ant.Task;
  70
  71 /**
  72  * Generates a Triple DES key and sticks it in the default location for use by
  73  * the <code>CryptoHandleRepository</code>
  74  *
  75  * @author Walter Hoehn (wassa@columbia.edu)
  76  */
  77 public class HandleRepositorySecretGenerator extends Task {
  78
  79         private String keyStorePath;
  80         private String keyStorePassword;
  81         private String keyStoreKeyAlias;
  82         private String keyStoreKeyPassword;
  83
  84         public void execute() throws BuildException {
  85                 try {
  86                         if (keyStorePath == null
  87                                 || keyStorePassword == null
  88                                 || keyStoreKeyAlias == null
  89                                 || keyStoreKeyPassword == null) {
  90                                 throw new BuildException("Missing required parameter.");
  91                         }
  92                         log("Generating secret.");
  93                         SecretKeyFactory keyFactory = SecretKeyFactory.getInstance("DESede");
  94                         byte[] pseudoRand = new byte[24];
  95                         new SecureRandom().nextBytes(pseudoRand);
  96                         SecretKey secret = keyFactory.generateSecret(new DESedeKeySpec(pseudoRand));
  97
  98                         log("Writing keystore.");
  99                         KeyStore keyStore = KeyStore.getInstance("JCEKS");
 100                         keyStore.load(null, keyStorePassword.toCharArray());
 101                         keyStore.setKeyEntry(keyStoreKeyAlias, secret, keyStoreKeyPassword.toCharArray(), null);
 102                         keyStore.store(new FileOutputStream(keyStorePath), keyStorePassword.toCharArray());
 103
 104                 } catch (GeneralSecurityException e) {
 105                         throw new BuildException("Unable to generate secret: " + e);
 106                 } catch (IOException e) {
 107                         throw new BuildException("Unable to store secret in keystore: " + e);
 108                 }
 109         }
 110
 111         /**
 112          * Sets the keyStoreKeyAlias.
 113          * @param keyStoreKeyAlias The keyStoreKeyAlias to set
 114          */
 115         public void setKeyStoreKeyAlias(String keyStoreKeyAlias) {
 116                 this.keyStoreKeyAlias = keyStoreKeyAlias;
 117         }
 118
 119         /**
 120          * Sets the keyStoreKeyPassword.
 121          * @param keyStoreKeyPassword The keyStoreKeyPassword to set
 122          */
 123         public void setKeyStoreKeyPassword(String keyStoreKeyPassword) {
 124                 this.keyStoreKeyPassword = keyStoreKeyPassword;
 125         }
 126
 127         /**
 128          * Sets the keyStorePassword.
 129          * @param keyStorePassword The keyStorePassword to set
 130          */
 131         public void setKeyStorePassword(String keyStorePassword) {
 132                 this.keyStorePassword = keyStorePassword;
 133         }
 134
 135         /**
 136          * Sets the keyStorePath.
 137          * @param keyStorePath The keyStorePath to set
 138          */
 139         public void setKeyStorePath(String keyStorePath) {
 140                 this.keyStorePath = keyStorePath;
 141         }
 142
 143 }