gnu.java.security.key

Interface IKeyPairCodec

Known Implementing Classes:
DHKeyPairPKCS8Codec, DHKeyPairRawCodec, DHKeyPairX509Codec, DSSKeyPairPKCS8Codec, DSSKeyPairRawCodec, DSSKeyPairX509Codec, RSAKeyPairPKCS8Codec, RSAKeyPairRawCodec, RSAKeyPairX509Codec, SRPKeyPairRawCodec

public interface IKeyPairCodec

The visible methods of an object that knows how to encode and decode cryptographic asymmetric keypairs. Codecs are useful for (a) externalising public and private keys for storage and on-the-wire transmission, as well as (b) re-creating their internal Java representation from external sources.

Field Summary

static int
ASN1_FORMAT
Constant identifying the ASN.1 encoding format: a combined encoding of X.509 for public keys, and PKCS#8 for private ones.
static int
PKCS8_FORMAT
Constant identifying the PKCS#8 encoding format.
static int
RAW_FORMAT
Constant identifying the Raw encoding format.
static int
X509_FORMAT
Constant identifying the X.509 encoding format.

Method Summary

PrivateKey
decodePrivateKey(byte[] input)
Decodes an instance of an external private key into its native Java representation.
PublicKey
decodePublicKey(byte[] input)
Decodes an instance of an external public key into its native Java representation.
byte[]
encodePrivateKey(PrivateKey key)
Encodes an instance of a private key for storage or transmission purposes.
byte[]
encodePublicKey(PublicKey key)
Encodes an instance of a public key for storage or transmission purposes.
int
getFormatID()
Returns the unique identifier (within this library) of the format used to externalise public and private keys.

Field Details

ASN1_FORMAT

public static final int ASN1_FORMAT
Constant identifying the ASN.1 encoding format: a combined encoding of X.509 for public keys, and PKCS#8 for private ones.
Field Value:
4

PKCS8_FORMAT

public static final int PKCS8_FORMAT
Constant identifying the PKCS#8 encoding format.
Field Value:
3

RAW_FORMAT

public static final int RAW_FORMAT
Constant identifying the Raw encoding format.
Field Value:
1

X509_FORMAT

public static final int X509_FORMAT
Constant identifying the X.509 encoding format.
Field Value:
2

Method Details

decodePrivateKey

public PrivateKey decodePrivateKey(byte[] input)
Decodes an instance of an external private key into its native Java representation.
Parameters:
input - the source of the externalised key to decode.
Returns:
a concrete instance of a private key, reconstructed from the designated input.
Throws:
IllegalArgumentException - if the designated input does not contain a known representation of a private key for the format supported by the concrete codec.

decodePublicKey

public PublicKey decodePublicKey(byte[] input)
Decodes an instance of an external public key into its native Java representation.
Parameters:
input - the source of the externalised key to decode.
Returns:
a concrete instance of a public key, reconstructed from the designated input.
Throws:
IllegalArgumentException - if the designated input does not contain a known representation of a public key for the format supported by the concrete codec.

encodePrivateKey

public byte[] encodePrivateKey(PrivateKey key)
Encodes an instance of a private key for storage or transmission purposes.
Parameters:
key - the non-null key to encode.
Returns:
a byte sequence representing the encoding of the designated key according to the format supported by this codec.
Throws:
IllegalArgumentException - if the designated key is not supported by this codec.

encodePublicKey

public byte[] encodePublicKey(PublicKey key)
Encodes an instance of a public key for storage or transmission purposes.
Parameters:
key - the non-null key to encode.
Returns:
a byte sequence representing the encoding of the designated key according to the format supported by this codec.
Throws:
IllegalArgumentException - if the designated key is not supported by this codec.

getFormatID

public int getFormatID()
Returns the unique identifier (within this library) of the format used to externalise public and private keys.
Returns:
the identifier of the format, the object supports.

IKeyPairCodec.java -- Copyright 2001, 2002, 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.