Android Open Source - ironcontrol-for-android Keystore Manager

From Project

Back to project page ironcontrol-for-android.
License

The source code is released under:
Apache License
If you think the Android project ironcontrol-for-android listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
Java Source Code

/*
 * #%L//from  ww w.  jav a  2  s.c  om
 * =====================================================
 *   _____                _     ____  _   _       _   _
 *  |_   _|_ __ _   _ ___| |_  / __ \| | | | ___ | | | |
 *    | | | '__| | | / __| __|/ / _` | |_| |/ __|| |_| |
 *    | | | |  | |_| \__ \ |_| | (_| |  _  |\__ \|  _  |
 *    |_| |_|   \__,_|___/\__|\ \__,_|_| |_||___/|_| |_|
 *                             \____/
 * 
 * =====================================================
 * 
 * Hochschule Hannover
 * (University of Applied Sciences and Arts, Hannover)
 * Faculty IV, Dept. of Computer Science
 * Ricklinger Stadtweg 118, 30459 Hannover, Germany
 * 
 * Email: trust@f4-i.fh-hannover.de
 * Website: http://trust.f4.hs-hannover.de/
 * 
 * This file is part of ironcontrol for android, version 1.0.1, implemented by the Trust@HsH research group at the Hochschule Hannover.
 * %%
 * Copyright (C) 2013 Trust@HsH
 * %%
 * 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.
 * #L%
 */
package de.hshannover.f4.trust.ironcontrol.logic;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.cert.Certificate;
import java.security.cert.CertificateException;
import java.security.cert.CertificateFactory;

import android.os.Environment;
import de.hshannover.f4.trust.ironcontrol.R;
import de.hshannover.f4.trust.ironcontrol.logger.Level;
import de.hshannover.f4.trust.ironcontrol.logger.Logger;
import de.hshannover.f4.trust.ironcontrol.logger.LoggerFactory;
import de.hshannover.f4.trust.ironcontrol.view.MainActivity;

/**
 * Class for connection management
 * @author Anton Saenko
 * @since 1.0
 */

public class KeystoreManager {

  private static final Logger logger = LoggerFactory.getLogger(KeystoreManager.class);
  private static String PATH_KEYSTORE_DIR = Environment.getExternalStorageDirectory().getPath() +"/ironcontrol/keystore";
  private static String PATH_CERT_DIR = Environment.getExternalStorageDirectory().getPath() +"/ironcontrol/certificates";
  private static String PATH_TO_DEF_KEYSTORE =  PATH_KEYSTORE_DIR +"/ironcontrol.bks";
  private static String PATH_TO_DEF_CERT =  PATH_KEYSTORE_DIR +"/ironcontrol.pem";
  private static File dirKeystore, dirCertificate, keystore, certificate;

  public static void checkANDcreateSDCardFolder(){
    if(isSDMounted()){
      dirKeystore = new File(PATH_KEYSTORE_DIR);
      keystore = new File(PATH_TO_DEF_KEYSTORE);
      certificate = new File(PATH_TO_DEF_CERT);
      dirCertificate = new File(PATH_CERT_DIR);
      if(!dirKeystore.exists()&& !dirKeystore.isDirectory()){
        dirKeystore.mkdirs();
        logger.log(Level.DEBUG, PATH_KEYSTORE_DIR + " created!");
      }
      if(!dirCertificate.exists()&& !dirCertificate.isDirectory()){
        dirCertificate.mkdirs();
        logger.log(Level.DEBUG, PATH_CERT_DIR + " created!");
      }
      if(!keystore.exists() || !certificate.exists()){
        copyDefaultToSD();
        logger.log(Level.DEBUG, PATH_TO_DEF_KEYSTORE +" crated !");
        logger.log(Level.DEBUG, PATH_TO_DEF_CERT +" crated !");
      }
    }else{
      logger.log(Level.WARN, Environment.getExternalStorageDirectory().toString() +"State: "+ Environment.getExternalStorageState() );
    }
  }

  /**
   * Read a Keystore.
   * 
   * @param pathToBKS    Path to keystore
   * @return KeyStore
   * 
   */
  static private KeyStore readBKS(String pathToBKS) {
    KeyStore ks = null;
    try {
      ks = KeyStore.getInstance("BKS");
      File bks  = new File(pathToBKS);
      FileInputStream in = new FileInputStream(bks);
      ks.load(in, "ironcontrol".toCharArray());
      in.close();
      logger.log(Level.DEBUG, "successful load tke keystore: " + pathToBKS);
    } catch (KeyStoreException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new KeyStoreException(e.getMessage(), e);
    } catch (FileNotFoundException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new FileNotFoundException(e.getMessage());
    } catch (NoSuchAlgorithmException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new NoSuchAlgorithmException(e.getMessage(), e);
    } catch (CertificateException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new CertificateException(e.getMessage(), e);
    } catch (IOException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new IOException(e.getMessage(), e);
    }

    return ks;

  }

  /**
   * Load a certificate.
   * 
   * @param pathToCertificate    Path to cerificate
   * @return Certificate
   */
  public static Certificate readCertificate(String pathToCertificate){
    CertificateFactory certf = null;
    Certificate cer = null;
    try {
      certf = CertificateFactory.getInstance("X.509");
      File file  = new File(pathToCertificate);
      FileInputStream in = new FileInputStream(file);
      cer = certf.generateCertificate(in);
      in.close();
      logger.log(Level.DEBUG, "successful loaded " + pathToCertificate);
    } catch (CertificateException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new CertificateException(e);
    } catch (FileNotFoundException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new FileNotFoundException();
    } catch (IOException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
      //throw new IOException(e);
    }



    return cer;

  }

  /**
   * Load a certificate.
   * 
   * @param Sting (path to cerificate)
   * 
   */
  private static Certificate readCertificatefromRAW(){
    CertificateFactory certf = null;
    Certificate cer = null;
    InputStream in;
    try {
      certf = CertificateFactory.getInstance("X.509");
      in = KeystoreManager.getCertificateFromRaw();
      cer = certf.generateCertificate(in);
      in.close();
      logger.log(Level.DEBUG, "successful load ironcontrol.pem from RAW");
    } catch (CertificateException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }  catch (IOException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }



    return cer;

  }

  /**
   * Save the Keystore as ironcontrol.pem.
   * 
   * @param KeyStore
   * @param Sting (path to cerificate)
   * 
   */
  private static void saveBKS(KeyStore ks, String mPath){
    File fileKS  = new File(mPath);
    if (!fileKS.exists()){
      try {
        fileKS.createNewFile();
      } catch (IOException e) {
        logger.log(Level.ERROR, e.getMessage(), e);
      }
    }
    FileOutputStream outKS = null;
    try {
      outKS = new FileOutputStream(fileKS);
    } catch (FileNotFoundException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }
    try {
      ks.store(outKS, "ironcontrol".toCharArray());
      outKS.close();
      logger.log(Level.DEBUG, "successful saved ironcontrol.bks on SD card");
    } catch (KeyStoreException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (NoSuchAlgorithmException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (CertificateException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (IOException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }
  }

  /**
   * Save the Keystore as ironcontrol.pem.
   * 
   * @param KeyStore
   * @param Sting (path to cerificate)
   * 
   */
  private static void copyDefaultToSD() {
    File fileKS  = new File(PATH_TO_DEF_KEYSTORE);
    File fileCert = new File(PATH_TO_DEF_CERT);
    Certificate defCert = null;
    KeyStore defKS = null;
    if (!fileKS.exists()){
      try {
        fileKS.createNewFile();
      } catch (IOException e) {
        logger.log(Level.ERROR, e.getMessage(), e);;
      }
    }
    if (!fileCert.exists()){
      try {
        fileCert.createNewFile();
      } catch (IOException e) {
        logger.log(Level.ERROR, e.getMessage(), e);

      }
    }
    FileOutputStream outKS = null;
    FileOutputStream outCert = null;
    defCert = readCertificatefromRAW();
    defKS = readBKSfromRAW();
    try {
      outKS = new FileOutputStream(fileKS);
      outCert = new FileOutputStream(fileCert);
    } catch (FileNotFoundException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }
    try {
      defKS.store(outKS, "ironcontrol".toCharArray());
      outCert.write(defCert.getEncoded());
      outKS.close();
      outCert.close();
      logger.log(Level.DEBUG, "successful saved ironcontrol.bks and ironcontrol.pem on SD card");
    } catch (KeyStoreException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (NoSuchAlgorithmException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (CertificateException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (IOException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }
  }


  /**
   * Load the deafault Keystore from RAW.
   * 
   * @return KeyStore
   * 
   */
  private static KeyStore readBKSfromRAW(){
    KeyStore ks = null;
    InputStream in = null;
    try {
      ks = KeyStore.getInstance("BKS");
      in = KeystoreManager.getKeystoreFromRaw();
      ks.load(in, "ironcontrol".toCharArray());
      logger.log(Level.DEBUG, "Load the default Keystore from RAW!");
      in.close();
    } catch (KeyStoreException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (FileNotFoundException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (NoSuchAlgorithmException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (CertificateException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    } catch (IOException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }
    return ks;

  }

  /**
   * Add a certificate to a keystore.
   * 
   */
  public static KeyStore addCerificateToBKS(String pathToCerificate, KeyStore kstore) {
    KeyStore ks = kstore;
    String alias = new File(pathToCerificate).getName();
    Certificate cert = readCertificate(pathToCerificate);
    try {
      if(!ks.isCertificateEntry(alias)){
        try {
          ks.setCertificateEntry(alias, cert);
          logger.log(Level.DEBUG, "The certificate <" + alias + "> was successful added!");
        } catch (KeyStoreException e) {
          logger.log(Level.ERROR, e.getMessage(), e);
          //throw new KeyStoreException(e.getMessage());
        }
      }else{
        logger.log(Level.DEBUG, "The certificate <" + alias + "> already exists! ");
      }
    } catch (KeyStoreException e) {
      logger.log(Level.ERROR, e.getMessage(), e);
    }
    return ks;
  }

  /**
   * Add all X509 certificates from SD card to deafault keystore.
   * 
   */
  public static void addAllCerificateToBKS() {
    File certStore = new File(PATH_CERT_DIR);
    String[] list = certStore.list();
    KeyStore ks = null;
    if(list.length > 0){
      ks = readBKS(getPATH_TO_KEYSTORE());
      for (String file : list) {
        try {
          if(!ks.isCertificateEntry(file)){
            ks = KeystoreManager.addCerificateToBKS(PATH_CERT_DIR + "/" + file, ks);
            logger.log(Level.DEBUG, "<"+file + "> successfully added");
          }
          logger.log(Level.DEBUG, "<"+file + "> already included");
        } catch (KeyStoreException e) {
          logger.log(Level.ERROR, e.getMessage(), e);
        }

      }
      saveBKS(ks, PATH_TO_DEF_KEYSTORE);
    }

  }

  /**
   * Get a path to the keystore on sd card
   * 
   * @return Sting (path)
   */
  public static String getPATH_TO_KEYSTORE(){
    return KeystoreManager.PATH_TO_DEF_KEYSTORE;
  }

  /**
   * Get the keystore from RAW as inputstream
   * 
   * @return Sting (path)
   */

  public static InputStream getKeystoreFromRaw(){
    InputStream inputStream = MainActivity.getContext().getResources().openRawResource(R.raw.ironcontrol_keystore);
    return inputStream;
  }

  /**
   * Get the certificate from RAW as inputstream
   * 
   * @return Sting (path)
   */

  public static InputStream getCertificateFromRaw(){
    InputStream inputStream = MainActivity.getContext().getResources().openRawResource(R.raw.ironcontrol_pem);
    return inputStream;
  }

  /**
   * Check if a sd-card mounted
   * 
   * @return booolean
   */
  public static boolean isSDMounted(){
    return Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED);

  }

}
Java Source Code List
