001/* PBEKey.java -- A key derived from a password. 002 Copyright (C) 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.crypto.interfaces; 040 041import javax.crypto.SecretKey; 042 043/** 044 * Interface to a password-derived key for password-based encryption 045 * (PBE). Applications working with a {@link javax.crypto.SecretKey} 046 * that is known to be a password-based key can safely cast such keys to 047 * this interface. 048 * 049 * @author Casey Marshall (csm@gnu.org) 050 * @since 1.4 051 */ 052public interface PBEKey extends SecretKey 053{ 054 /** Compatible with JDK1.4. */ 055 long serialVersionUID = -1430015993304333921L; 056 057 /** 058 * Retruns the iteration count, or 0 if not specified. 059 * 060 * @return The iteration count. 061 */ 062 int getIterationCount(); 063 064 /** 065 * Returns a copy of the password as a character array. It is the 066 * caller's responsibility to zero-out the password when it is no 067 * longer in use. 068 * 069 * <p>Although it is not specified in the documentation, 070 * implementations should not copy or clone the password array, but 071 * rather return the reference to the array itself, so the caller has 072 * the ability to erase the password. 073 * 074 * @return The password. 075 */ 076 char[] getPassword(); 077 078 /** 079 * Returns a copy of the salt. It is the caller's responsibility to 080 * zero-out the salt when it is no longer in use. 081 * 082 * <p>Although it is not specified in the documentation, 083 * implementations should not copy or clone the salt array, but 084 * rather return the reference to the array itself, so the caller has 085 * the ability to erase the salt. 086 * 087 * @return The salt. 088 */ 089 byte[] getSalt(); 090}