Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

gnu.javax.crypto.key.dh

Class DHKeyPairRawCodec

Implemented Interfaces:
IKeyPairCodec
public class DHKeyPairRawCodec
extends Object
implements IKeyPairCodec
An object that implements the IKeyPairCodec operations for the Raw format to use with Diffie-Hellman keypairs.

Fields inherited from interface gnu.java.security.key.IKeyPairCodec

ASN1_FORMAT, PKCS8_FORMAT, RAW_FORMAT, X509_FORMAT

Method Summary

PrivateKey
decodePrivateKey(byte[] k)
Decodes an instance of an external private key into its native Java representation.
PublicKey
decodePublicKey(byte[] k)
Decodes an instance of an external public key into its native Java representation.
byte[]
encodePrivateKey(PrivateKey key)
Returns the encoded form of the designated Diffie-Hellman private key according to the Raw format supported by this library.
byte[]
encodePublicKey(PublicKey key)
Returns the encoded form of the designated Diffie-Hellman public key according to the Raw format supported by this library.
int
getFormatID()
Returns the unique identifier (within this library) of the format used to externalise public and private keys.

Methods inherited from class java.lang.Object

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

Method Details

decodePrivateKey

public PrivateKey decodePrivateKey(byte[] k)
Decodes an instance of an external private key into its native Java representation.
Specified by:
decodePrivateKey in interface IKeyPairCodec
Parameters:
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[] k)
Decodes an instance of an external public key into its native Java representation.
Specified by:
decodePublicKey in interface IKeyPairCodec
Parameters:
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)
Returns the encoded form of the designated Diffie-Hellman private key according to the Raw format supported by this library.

The Raw format for a DH private key, in this implementation, is a byte sequence consisting of the following:

  1. 4-byte magic consisting of the value of the literal Registry.MAGIC_RAW_DH_PRIVATE_KEY,
  2. 1-byte version consisting of the constant: 0x01,
  3. 4-byte count of following bytes representing the DH parameter q,
  4. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter q,
  5. 4-byte count of following bytes representing the DH parameter p in internet order,
  6. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter p,
  7. 4-byte count of following bytes representing the DH parameter g,
  8. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter g,
  9. 4-byte count of following bytes representing the DH parameter x,
  10. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter x,
Specified by:
encodePrivateKey in interface IKeyPairCodec
Parameters:
key - the key to encode.
Returns:
the Raw format encoding of the designated key.
Throws:
IllegalArgumentException - if the designated key is not a DH one.
See Also:
Registry.MAGIC_RAW_DH_PRIVATE_KEY

encodePublicKey

public byte[] encodePublicKey(PublicKey key)
Returns the encoded form of the designated Diffie-Hellman public key according to the Raw format supported by this library.

The Raw format for a DH public key, in this implementation, is a byte sequence consisting of the following:

  1. 4-byte magic consisting of the value of the literal Registry.MAGIC_RAW_DH_PUBLIC_KEY,
  2. 1-byte version consisting of the constant: 0x01,
  3. 4-byte count of following bytes representing the DH parameter q in internet order,
  4. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter q,
  5. 4-byte count of following bytes representing the DH parameter p in internet order,
  6. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter p,
  7. 4-byte count of following bytes representing the DH parameter g,
  8. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter g,
  9. 4-byte count of following bytes representing the DH parameter y,
  10. n-bytes representation of a BigInteger obtained by invoking the toByteArray() method on the DH parameter y,
Specified by:
encodePublicKey in interface IKeyPairCodec
Parameters:
key - the key to encode.
Returns:
the Raw format encoding of the designated key.
Throws:
IllegalArgumentException - if the designated key is not a DH one.
See Also:
Registry.MAGIC_RAW_DH_PUBLIC_KEY

getFormatID

public int getFormatID()
Returns the unique identifier (within this library) of the format used to externalise public and private keys.
Specified by:
getFormatID in interface IKeyPairCodec
Returns:
the identifier of the format, the object supports.
DHKeyPairRawCodec.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.

Overview Package Class Use Source Tree Index Deprecated About