com.ibm.security.pkcs12
Class KeyBag

java.lang.Object
  |
  +--com.ibm.security.pkcsutil.PKCSDerObject
        |
        +--com.ibm.security.pkcs12.KeyBag

public final class KeyBag
extends PKCSDerObject
implements Bag, Cloneable

Implements the PKCS #12 KeyBag data type, which is a container for PKCS #8 KeyInfo data.

KeyBag ::= PrivateKeyInfo

KeyBag objects are immutable; they cannot be changed once created.

See Also:
PrivateKeyInfo

Fields inherited from class com.ibm.security.pkcsutil.PKCSDerObject
provider
 
Constructor Summary
KeyBag(byte[] der)
          Create a KeyBag with a DER byte array.
KeyBag(byte[] der, String provider)
          Create a KeyBag with a DER byte array.
KeyBag(PrivateKeyInfo keyInfo)
          Create a KeyBag with the input PrivateKeyInfo.
KeyBag(PrivateKeyInfo keyInfo, String provider)
          Create a KeyBag with the input PrivateKeyInfo.
KeyBag(String filename, boolean base64)
          Create a KeyBag with the filename of the DER-encoded or BASE64-encoded object.
KeyBag(String filename, boolean base64, String provider)
          Create a KeyBag with the filename of the DER-encoded or BASE64-encoded object.
 
Method Summary
 Object clone()
          Creates a clone of this KeyBag object.
protected  void decode(com.ibm.security.pkcs12.DerValue encoding)
          Initialize a KeyBag object from an input stream.
 void encode(OutputStream out)
          Encodes this object to a DER OutputStream.
 boolean equals(Object other)
          Determines if this KeyBag object is equivalent to the input object.
 byte[] getEncodedValue()
          Returns the DER-encoded contents of this object.
 String getName()
          Returns the common name for this bag type: "KeyBag".
 ObjectIdentifier getObjectIdentifier()
          Returns the object identifier for this PKCS #12 bag.
 Object getValue()
          Returns a copy of the contents of this PKCS #12 bag.
 String toString()
          Returns a string representation of this KeyBag object.
 
Methods inherited from class com.ibm.security.pkcsutil.PKCSDerObject
decode, decode, encode, hashCode, read, readBASE64, write, write, writeBASE64
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeyBag

public KeyBag(PrivateKeyInfo keyInfo)
Create a KeyBag with the input PrivateKeyInfo.
Parameters:
keyInfo - a PrivateKeyInfo object.

KeyBag

public KeyBag(PrivateKeyInfo keyInfo,
              String provider)
Create a KeyBag with the input PrivateKeyInfo.
Parameters:
keyInfo - a PrivateKeyInfo object.
provider - a provider to be used.

KeyBag

public KeyBag(byte[] der)
       throws IOException
Create a KeyBag with a DER byte array. The byte array must represent a DER-encoded KeyBag object.
Parameters:
der - a byte array with a DER-encoded KeyBag object.
Throws:
IOException - on parsing errors.

KeyBag

public KeyBag(byte[] der,
              String provider)
       throws IOException
Create a KeyBag with a DER byte array. The byte array must represent a DER-encoded KeyBag object.
Parameters:
der - a byte array with a DER-encoded KeyBag object.
provider - a provider to be used.
Throws:
IOException - on parsing errors.

KeyBag

public KeyBag(String filename,
              boolean base64)
       throws IOException
Create a KeyBag with the filename of the DER-encoded or BASE64-encoded object.
Parameters:
filename - name of the DER-encoded or base64-encoded object
base64 - true if BASE64-encoded, false if DER-encoded
Throws:
IOException - on decoding errors.

KeyBag

public KeyBag(String filename,
              boolean base64,
              String provider)
       throws IOException
Create a KeyBag with the filename of the DER-encoded or BASE64-encoded object.
Parameters:
filename - name of the DER-encoded or base64-encoded object
base64 - true if BASE64-encoded, false if DER-encoded
provider - a provider to be used
Throws:
IOException - on decoding errors.
Method Detail

encode

public void encode(OutputStream out)
            throws IOException
Encodes this object to a DER OutputStream.
Overrides:
encode in class PKCSDerObject
Parameters:
out - the DER OutputStream to write the encoded data to.
Throws:
IOException - on encoding errors.

getObjectIdentifier

public ObjectIdentifier getObjectIdentifier()
Returns the object identifier for this PKCS #12 bag. This object identifier is an immutable object.
Specified by:
getObjectIdentifier in interface Bag
Overrides:
getObjectIdentifier in class PKCSDerObject
Returns:
the ObjectIdentifier for this bag.

getValue

public Object getValue()
Returns a copy of the contents of this PKCS #12 bag. The type of the contents object is a PrivateKeyInfo object.
Specified by:
getValue in interface Bag
Returns:
the contents for this bag.

getEncodedValue

public byte[] getEncodedValue()
Returns the DER-encoded contents of this object.
Specified by:
getEncodedValue in interface Bag
Returns:
the DER-encoded PrivateKeyInfo of this bag. Null may be returned if the PrivateKeyInfo cannot be successfully encoded.

getName

public String getName()
Returns the common name for this bag type: "KeyBag".
Specified by:
getName in interface Bag
Returns:
the name of this bag.

equals

public boolean equals(Object other)
Determines if this KeyBag object is equivalent to the input object.
Overrides:
equals in class PKCSDerObject
Parameters:
other - the object to compare this one to.
Returns:
true, if the two objects are equivalent, false otherwise.

clone

public Object clone()
Creates a clone of this KeyBag object.
Overrides:
clone in class Object
Returns:
clone of this KeyBag object.

toString

public String toString()
Returns a string representation of this KeyBag object.
Overrides:
toString in class PKCSDerObject
Returns:
a string representation of this object.

decode

protected void decode(com.ibm.security.pkcs12.DerValue encoding)
               throws IOException
Initialize a KeyBag object from an input stream. The data on that input stream must be a DER-encoded PrivateKeyInfo object.
Parameters:
encoding - an input stream with a DER-encoded PrivateKeyInfo object.
Throws:
IOException - on parsing errors.