1 /* PBEKey.java -- A key derived from a password. 2 Copyright (C) 2004 Free Software Foundation, Inc. 3 4 This file is part of GNU Classpath. 5 6 GNU Classpath is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License as published by 8 the Free Software Foundation; either version 2, or (at your option) 9 any later version. 10 11 GNU Classpath is distributed in the hope that it will be useful, but 12 WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 General Public License for more details. 15 16 You should have received a copy of the GNU General Public License 17 along with GNU Classpath; see the file COPYING. If not, write to the 18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 19 02110-1301 USA. 20 21 Linking this library statically or dynamically with other modules is 22 making a combined work based on this library. Thus, the terms and 23 conditions of the GNU General Public License cover the whole 24 combination. 25 26 As a special exception, the copyright holders of this library give you 27 permission to link this library with independent modules to produce an 28 executable, regardless of the license terms of these independent 29 modules, and to copy and distribute the resulting executable under 30 terms of your choice, provided that you also meet, for each linked 31 independent module, the terms and conditions of the license of that 32 module. An independent module is a module which is not derived from 33 or based on this library. If you modify this library, you may extend 34 this exception to your version of the library, but you are not 35 obligated to do so. If you do not wish to do so, delete this 36 exception statement from your version. */ 37 38 39 package javax.crypto.interfaces; 40 41 import javax.crypto.SecretKey; 42 43 /** 44 * Interface to a password-derived key for password-based encryption 45 * (PBE). Applications working with a {@link javax.crypto.SecretKey} 46 * that is known to be a password-based key can safely cast such keys to 47 * this interface. 48 * 49 * @author Casey Marshall (csm@gnu.org) 50 * @since 1.4 51 */ 52 public interface PBEKey extends SecretKey 53 { 54 /** Compatible with JDK1.4. */ 55 long serialVersionUID = -1430015993304333921L; 56 57 /** 58 * Retruns the iteration count, or 0 if not specified. 59 * 60 * @return The iteration count. 61 */ getIterationCount()62 int getIterationCount(); 63 64 /** 65 * Returns a copy of the password as a character array. It is the 66 * caller's responsibility to zero-out the password when it is no 67 * longer in use. 68 * 69 * <p>Although it is not specified in the documentation, 70 * implementations should not copy or clone the password array, but 71 * rather return the reference to the array itself, so the caller has 72 * the ability to erase the password. 73 * 74 * @return The password. 75 */ getPassword()76 char[] getPassword(); 77 78 /** 79 * Returns a copy of the salt. It is the caller's responsibility to 80 * zero-out the salt when it is no longer in use. 81 * 82 * <p>Although it is not specified in the documentation, 83 * implementations should not copy or clone the salt array, but 84 * rather return the reference to the array itself, so the caller has 85 * the ability to erase the salt. 86 * 87 * @return The salt. 88 */ getSalt()89 byte[] getSalt(); 90 } 91