gnu.java.security.key.dss

Class DSSKeyPairX509Codec

Implemented Interfaces:
IKeyPairCodec

public class DSSKeyPairX509Codec
extends Object
implements IKeyPairCodec

An implementation of an IKeyPairCodec that knows how to encode / decode X.509 ASN.1 external representation of DSS public keys.

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

ASN1_FORMAT, PKCS8_FORMAT, RAW_FORMAT, X509_FORMAT

Method Summary

PrivateKey
decodePrivateKey(byte[] input)
PublicKey
decodePublicKey(byte[] input)
byte[]
encodePrivateKey(PrivateKey key)
byte[]
encodePublicKey(PublicKey key)
Returns the X.509 ASN.1 SubjectPublicKeyInfo representation of a DSA public key.
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[] input)
Specified by:
decodePrivateKey in interface IKeyPairCodec
Throws:
InvalidParameterException - ALWAYS.

decodePublicKey

public PublicKey decodePublicKey(byte[] input)
Specified by:
decodePublicKey in interface IKeyPairCodec
Parameters:
input - the byte array to unmarshall into a valid DSS PublicKey instance. MUST NOT be null.
Returns:
a new instance of a DSSPublicKey decoded from the SubjectPublicKeyInfo material in an X.509 certificate.

encodePrivateKey

public byte[] encodePrivateKey(PrivateKey key)
Specified by:
encodePrivateKey in interface IKeyPairCodec
Throws:
InvalidParameterException - ALWAYS.

encodePublicKey

public byte[] encodePublicKey(PublicKey key)
Returns the X.509 ASN.1 SubjectPublicKeyInfo representation of a DSA public key. The ASN.1 specification, as defined in RFC-3280, and RFC-2459, is as follows:
   SubjectPublicKeyInfo ::= SEQUENCE {
     algorithm         AlgorithmIdentifier,
     subjectPublicKey  BIT STRING
   }

   AlgorithmIdentifier ::= SEQUENCE {
     algorithm   OBJECT IDENTIFIER,
     parameters  ANY DEFINED BY algorithm OPTIONAL
   }

   DssParams ::= SEQUENCE {
     p   INTEGER,
     q   INTEGER,
     g   INTEGER
   }
 

Note that RFC-3280 (page 79) implies that some certificates MAY have an absent, or NULL, parameters field in their AlgorithmIdentifier element, implying that those parameters MUST be inherited from another certificate. This implementation, encodes a NULL element as the DER value of the parameters field when such is the case.

The subjectPublicKey field, which is a BIT STRING, contains the DER-encoded form of the DSA public key as an INTEGER.

       DSAPublicKey ::= INTEGER -- public key, Y
 
Specified by:
encodePublicKey in interface IKeyPairCodec
Parameters:
key - the PublicKey instance to encode. MUST be an instance of DSSPublicKey.
Returns:
the ASN.1 representation of the SubjectPublicKeyInfo in an X.509 certificate.

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.

DSSKeyPairX509Codec.java -- X.509 Encoding/Decoding handler Copyright (C) 2006 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.