APIdia Launch Partner
Top Description Fields Constructors Methods
java.security

public final Class SignedObject

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.*

SignedObject is a class for the purpose of creating authentic runtime objects whose integrity cannot be compromised without being detected.

More specifically, a SignedObject contains another Serializable object, the (to-be-)signed object and its signature.

The signed object is a "deep copy" (in serialized form) of an original object. Once the copy is made, further manipulation of the original object has no side effect on the copy.

The underlying signing algorithm is designated by the Signature object passed to the constructor and the verify method. A typical usage for signing is the following:

Signature signingEngine = Signature.getInstance(algorithm,
                                                provider);
SignedObject so = new SignedObject(myobject, signingKey,
                                   signingEngine);

A typical usage for verification is the following (having received SignedObject so):

Signature verificationEngine =
    Signature.getInstance(algorithm, provider);
if (so.verify(publickey, verificationEngine))
    try {
        Object myobj = so.getObject();
    } catch (java.lang.ClassNotFoundException e) {};

Several points are worth noting. First, there is no need to initialize the signing or verification engine, as it will be re-initialized inside the constructor and the verify method. Secondly, for verification to succeed, the specified public key must be the public key corresponding to the private key used to generate the SignedObject.

More importantly, for flexibility reasons, the constructor and verify method allow for customized signature engines, which can implement signature algorithms that are not installed formally as part of a crypto provider. However, it is crucial that the programmer writing the verifier code be aware what Signature engine is being used, as its own implementation of the verify method is invoked to verify a signature. In other words, a malicious Signature may choose to always return true on verification in an attempt to bypass a security check.

The signature algorithm can be, among others, the NIST standard DSA, using DSA and SHA-256. The algorithm is specified using the same convention as that for signatures. The DSA algorithm using the SHA-256 message digest algorithm can be specified, for example, as "SHA256withDSA". In the case of RSA the signing algorithm could be specified as, for example, "SHA256withRSA". The algorithm name must be specified, as there is no default.

The name of the Cryptography Package Provider is designated also by the Signature parameter to the constructor and the verify method. If the provider is not specified, the default provider is used. Each installation can be configured to use a particular provider as default.

Potential applications of SignedObject include:

Author
Li Gong
Since
1.2
See Also
Signature

Field Summary

Modifier and TypeField and Description
private byte[]
private static final long
private byte[]
private String

Constructor Summary

AccessConstructor and Description
public
SignedObject(Serializable
the object to be signed.
object
,
PrivateKey
the private key for signing.
signingKey
,
Signature
the signature signing engine.
signingEngine
)

Constructs a SignedObject from any Serializable object.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the signature algorithm name.
getAlgorithm
()

Retrieves the name of the signature algorithm.

public Object

Returns:

the encapsulated object.
getObject
()

Retrieves the encapsulated object.

public byte[]

Returns:

the signature. Returns a new array each time this method is called.
getSignature
()

Retrieves the signature on the signed object, in the form of a byte array.

private void
readObject(ObjectInputStream
the ObjectInputStream from which data is read
s
)

readObject is called to restore the state of the SignedObject from a stream.

private void
sign(PrivateKey signingKey, Signature signingEngine)

public boolean

Returns:

true if the signature is valid, false otherwise
verify
(PublicKey
the public key for verification.
verificationKey
,
Signature
the signature verification engine.
verificationEngine
)

Verifies that the signature in this SignedObject is the valid signature for the object stored inside, with the given verification key, using the designated verification engine.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

contentback to summary
private byte[] content
serialVersionUIDback to summary
private static final long serialVersionUID
Annotations
@Serial
signatureback to summary
private byte[] signature
thealgorithmback to summary
private String thealgorithm

Constructor Detail

SignedObjectback to summary
public SignedObject(Serializable object, PrivateKey signingKey, Signature signingEngine) throws IOException, InvalidKeyException, SignatureException

Constructs a SignedObject from any Serializable object. The given object is signed with the given signing key, using the designated signature engine.

Parameters
object:Serializable

the object to be signed.

signingKey:PrivateKey

the private key for signing.

signingEngine:Signature

the signature signing engine.

Exceptions
IOException:
if an error occurs during serialization
InvalidKeyException:
if the key is invalid.
SignatureException:
if signing fails.

Method Detail

getAlgorithmback to summary
public String getAlgorithm()

Retrieves the name of the signature algorithm.

Returns:String

the signature algorithm name.

getObjectback to summary
public Object getObject() throws IOException, ClassNotFoundException

Retrieves the encapsulated object. The encapsulated object is de-serialized before it is returned.

Returns:Object

the encapsulated object.

Exceptions
IOException:
if an error occurs during de-serialization
ClassNotFoundException:
if an error occurs during de-serialization
getSignatureback to summary
public byte[] getSignature()

Retrieves the signature on the signed object, in the form of a byte array.

Returns:byte[]

the signature. Returns a new array each time this method is called.

readObjectback to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

readObject is called to restore the state of the SignedObject from a stream.

Parameters
s:ObjectInputStream

the ObjectInputStream from which data is read

Annotations
@Serial
Exceptions
IOException:
if an I/O error occurs
ClassNotFoundException:
if a serialized class cannot be loaded
signback to summary
private void sign(PrivateKey signingKey, Signature signingEngine) throws InvalidKeyException, SignatureException
verifyback to summary
public boolean verify(PublicKey verificationKey, Signature verificationEngine) throws InvalidKeyException, SignatureException

Verifies that the signature in this SignedObject is the valid signature for the object stored inside, with the given verification key, using the designated verification engine.

Parameters
verificationKey:PublicKey

the public key for verification.

verificationEngine:Signature

the signature verification engine.

Returns:boolean

true if the signature is valid, false otherwise

Exceptions
InvalidKeyException:
if the verification key is invalid.
SignatureException:
if signature verification failed (an exception prevented the signature verification engine from completing normally).