gnu.javax.crypto.key

Class GnuSecretKey

Implemented Interfaces:
Key, Serializable

public class GnuSecretKey
extends Object
implements Key

A secret key composed of a sequence of raw, unformatted octets. This class is analogous to the SecretKeySpec class, but is provided for platforms that do not or cannot contain that class.

Fields inherited from interface java.security.Key

serialVersionUID

Constructor Summary

GnuSecretKey(byte[] key, int offset, int length, String algorithm)
Creates a new secret key from a portion of a byte array.
GnuSecretKey(byte[] key, String algorithm)
Creates a new secret key.

Method Summary

boolean
equals(Object o)
String
getAlgorithm()
Returns the algorithm name, if any.
byte[]
getEncoded()
Returns the encoded key, which is merely the byte array this class was created with.
String
getFormat()
Returns the string "RAW".
String
toString()

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GnuSecretKey

public GnuSecretKey(byte[] key,
                    int offset,
                    int length,
                    String algorithm)
Creates a new secret key from a portion of a byte array.
Parameters:
key - The raw, secret key.
offset - The offset at which the key begins.
length - The number of bytes that comprise the key.
algorithm - The algorithm name, which can be null or empty.

GnuSecretKey

public GnuSecretKey(byte[] key,
                    String algorithm)
Creates a new secret key. The supplied byte array is copied by this constructor.
Parameters:
key - The raw, secret key.
algorithm - The algorithm name, which can be null or empty.

Method Details

equals

public boolean equals(Object o)
Overrides:
equals in interface Object

getAlgorithm

public String getAlgorithm()
Returns the algorithm name, if any.
Specified by:
getAlgorithm in interface Key
Returns:
The algorithm name.

getEncoded

public byte[] getEncoded()
Returns the encoded key, which is merely the byte array this class was created with. A reference to the internal byte array is returned, so the caller can delete this key from memory by modifying the returned array.
Specified by:
getEncoded in interface Key
Returns:
The raw key.

getFormat

public String getFormat()
Returns the string "RAW".
Specified by:
getFormat in interface Key
Returns:
The string "RAW".

toString

public String toString()
Overrides:
toString in interface Object

GnuSecretKey.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a 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 of the License, 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; if not, write to the Free Software Foundation, Inc., 51 Franklin St, 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.