sjero.net Git - linphone/blob - p2pproxy/dependencies-src/jxse-src-2.5/impl/src/net/jxta/impl/membership/pse/KeyStoreManager.java

   1 /*
   2  * Copyright (c) 2001-2007 Sun Microsystems, Inc.  All rights reserved.
   3  *
   4  *  The Sun Project JXTA(TM) Software License
   5  *
   6  *  Redistribution and use in source and binary forms, with or without
   7  *  modification, are permitted provided that the following conditions are met:
   8  *
   9  *  1. Redistributions of source code must retain the above copyright notice,
  10  *     this list of conditions and the following disclaimer.
  11  *
  12  *  2. Redistributions in binary form must reproduce the above copyright notice,
  13  *     this list of conditions and the following disclaimer in the documentation
  14  *     and/or other materials provided with the distribution.
  15  *
  16  *  3. The end-user documentation included with the redistribution, if any, must
  17  *     include the following acknowledgment: "This product includes software
  18  *     developed by Sun Microsystems, Inc. for JXTA(TM) technology."
  19  *     Alternately, this acknowledgment may appear in the software itself, if
  20  *     and wherever such third-party acknowledgments normally appear.
  21  *
  22  *  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
  23  *     not be used to endorse or promote products derived from this software
  24  *     without prior written permission. For written permission, please contact
  25  *     Project JXTA at http://www.jxta.org.
  26  *
  27  *  5. Products derived from this software may not be called "JXTA", nor may
  28  *     "JXTA" appear in their name, without prior written permission of Sun.
  29  *
  30  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  31  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  32  *  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
  33  *  MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  35  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  36  *  OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  37  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  38  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  39  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  *
  41  *  JXTA is a registered trademark of Sun Microsystems, Inc. in the United
  42  *  States and other countries.
  43  *
  44  *  Please see the license information page at :
  45  *  <http://www.jxta.org/project/www/license.html> for instructions on use of
  46  *  the license in source files.
  47  *
  48  *  ====================================================================
  49  *
  50  *  This software consists of voluntary contributions made by many individuals
  51  *  on behalf of Project JXTA. For more information on Project JXTA, please see
  52  *  http://www.jxta.org.
  53  *
  54  *  This license is based on the BSD license adopted by the Apache Foundation.
  55  */
  56
  57 package net.jxta.impl.membership.pse;
  58
  59
  60 import java.io.IOException;
  61 import java.security.KeyStore;
  62 import java.security.KeyStoreException;
  63
  64
  65 /**
  66  * Abstracts the management of KeyStores. This is commonly used to abstract the
  67  * location of the KeyStore and the details of creating, loading, saving and
  68  * deleting the KeyStore.
  69  * <p/>
  70  * <p/>Applications should not assume that accesses to KeyStoreManager are
  71  * thread safe. All access to the KeyStoreManager should be externally
  72  * synchronized on the KeyStoreManager object.
  73  */
  74 public interface KeyStoreManager {
  75
  76     /**
  77      * Returns <tt>true</tt> if the KeyStore has been initialized (created).
  78      * Since this method does not provide a passphrase it is really only useful
  79      * for determining if a new KeyStore needs to be created.
  80      *
  81      * @return <tt>true</tt> if the KeyStore has been previously initialized
  82      *         otherwise <tt>false</tt>.
  83      * @throws KeyStoreException If the KeyStore is protected by a store
  84      *                           password that has not been set.
  85      */
  86     boolean isInitialized() throws KeyStoreException;
  87
  88     /**
  89      * Returns <tt>true</tt> if the Keystore has been initialized (created).
  90      * This method also ensures that the provided passphrase is valid for the
  91      * keystore.
  92      *
  93      * @param password The KeyStore passphrase.
  94      * @return <tt>true</tt> if the Keystore has been initialized otherwise
  95      *         <tt>false</tt>.
  96      * @throws KeyStoreException If an incorrect KeyStore password is provided.
  97      */
  98     boolean isInitialized(char[] password) throws KeyStoreException;
  99
 100     /**
 101      * Create the KeyStore using the specified KeyStore passphrase.
 102      *
 103      * @param password The KeyStore passphrase.
 104      * @throws KeyStoreException If an incorrect KeyStore passphrase is provided.
 105      * @throws IOException       If there is a problem creating the KeyStore.
 106      */
 107     void createKeyStore(char[] password) throws IOException, KeyStoreException;
 108
 109     /**
 110      * Load the KeyStore.
 111      *
 112      * @param password The KeyStore passphrase.
 113      * @throws KeyStoreException If an incorrect KeyStore password is provided.
 114      * @throws IOException       If there is a problem loading the KeyStore.
 115      * @return the keystore
 116      */
 117     KeyStore loadKeyStore(char[] password) throws IOException, KeyStoreException;
 118
 119     /**
 120      * Save the provided KeyStore using the specified KeyStore passphrase.
 121      *
 122      * @param store    The KeyStore to save.
 123      * @param password The encryption passphrase for the keystore.
 124      * @throws IOException       Thrown for errors writing the keystore.
 125      * @throws KeyStoreException Thrown for errors with the provided key or key store.
 126      */
 127     void saveKeyStore(KeyStore store, char[] password) throws IOException, KeyStoreException;
 128
 129     /**
 130      * Erase the KeyStore. Some KeyStore implementations may not allow the
 131      * KeyStore container itself to be erased and in some cases specific
 132      * certificates and keys may be unerasable. All implementations should
 133      * erase all user provided certificates and keys.
 134      *
 135      * @throws IOException If there is a problem erasing the KeyStore or the
 136      *                     KeyStore cannot be erased.
 137      */
 138     void eraseKeyStore() throws IOException;
 139 }