javax.crypto.interfaces

Interface PBEKey

All Superinterfaces:
Key, SecretKey, Serializable

public interface PBEKey
extends SecretKey

Interface to a password-derived key for password-based encryption (PBE). Applications working with a SecretKey that is known to be a password-based key can safely cast such keys to this interface.
Since:
1.4

Field Summary

static long
serialVersionUID
Compatible with JDK1.4.

Fields inherited from interface java.security.Key

serialVersionUID

Fields inherited from interface javax.crypto.SecretKey

serialVersionUID

Method Summary

int
getIterationCount()
Retruns the iteration count, or 0 if not specified.
char[]
getPassword()
Returns a copy of the password as a character array.
byte[]
getSalt()
Returns a copy of the salt.

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded, getFormat

Field Details

serialVersionUID

public static final long serialVersionUID
Compatible with JDK1.4.
Field Value:
-1430015993304333921L

Method Details

getIterationCount

public int getIterationCount()
Retruns the iteration count, or 0 if not specified.
Returns:
The iteration count.

getPassword

public char[] getPassword()
Returns a copy of the password as a character array. It is the caller's responsibility to zero-out the password when it is no longer in use.

Although it is not specified in the documentation, implementations should not copy or clone the password array, but rather return the reference to the array itself, so the caller has the ability to erase the password.

Returns:
The password.

getSalt

public byte[] getSalt()
Returns a copy of the salt. It is the caller's responsibility to zero-out the salt when it is no longer in use.

Although it is not specified in the documentation, implementations should not copy or clone the salt array, but rather return the reference to the array itself, so the caller has the ability to erase the salt.

Returns:
The salt.

PBEKey.java -- A key derived from a password. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.