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.java.security.key.rsa

Class RSAKeyPairPKCS8Codec

Implemented Interfaces:
IKeyPairCodec
public class RSAKeyPairPKCS8Codec
extends Object
implements IKeyPairCodec
An implementation of an IKeyPairCodec that knows how to encode / decode PKCS#8 ASN.1 external representation of RSA private 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)
Returns the PKCS#8 ASN.1 PrivateKeyInfo representation of an RSA private key.
byte[]
encodePublicKey(PublicKey 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
Parameters:
input - the byte array to unmarshall into a valid RSA PrivateKey instance. MUST NOT be null.
Returns:
a new instance of a GnuRSAPrivateKey decoded from the PrivateKeyInfo material fed as input.

decodePublicKey

public PublicKey decodePublicKey(byte[] input)
Specified by:
decodePublicKey in interface IKeyPairCodec
Throws:
InvalidParameterException - ALWAYS.

encodePrivateKey

public byte[] encodePrivateKey(PrivateKey key)
Returns the PKCS#8 ASN.1 PrivateKeyInfo representation of an RSA private key. The ASN.1 specification is as follows: 
   PrivateKeyInfo ::= SEQUENCE {
     version              INTEGER, -- MUST be 0
     privateKeyAlgorithm  AlgorithmIdentifier,
     privateKey           OCTET STRING
   }

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

As indicated in RFC-2459: "The parameters field shall have ASN.1 type NULL for this algorithm identifier.".

The privateKey field, which is an OCTET STRING, contains the DER-encoded form of the RSA private key defined as: 

   RSAPrivateKey ::= SEQUENCE {
     version                 INTEGER, -- MUST be 0
     modulus                 INTEGER, -- n
     publicExponent          INTEGER, -- e
     privateExponent         INTEGER, -- d
     prime1                  INTEGER, -- p
     prime2                  INTEGER, -- q
     exponent1               INTEGER, -- d mod (p-1)
     exponent2               INTEGER, -- d mod (q-1)
     coefficient             INTEGER, -- (inverse of q) mod p
   }
Specified by:
encodePrivateKey in interface IKeyPairCodec
Returns:
the DER encoded form of the ASN.1 representation of the PrivateKeyInfo field for an RSA PrivateKey..

encodePublicKey

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

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.
RSAKeyPairPKCS8Codec.java -- PKCS#8 Encoding/Decoding handler Copyright (C) 2006, 2010 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.

Overview Package Class Use Source Tree Index Deprecated About