iaik.jades

Class SigPIdHeader

java.lang.Object

iaik.jades.SigPIdHeader

All Implemented Interfaces:

JWSHeader, ProtectedHeader

public class SigPIdHeader
extends Object
implements ProtectedHeader

The sigPId is a protected header defined in the JAdES specification. It contains either an explicit identifier for the signature policy or an indication that there is an implied signature policy. The syntax of the header is:

"sigPId":{
   "type": "object",
   "properties": {
     "id":     {"$ref": "#/definitions/oId"},
     "digAlg": {"type": "string"},
     "digVal": {"type": "string","contentEncoding": "base64"},
     "digPSp": {"type": "boolean"},
     "sigPQuals": {"type":  "array",
                   "items": {"$ref": "#/definitions/sigPQual"},
                   "minItems": 1}
   },
   "required": ["id"],
   "additionalProperties": false
 }
 

For the contents of the sigPId header, see JAdESOID and SigPQual.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY The json key of the header

Constructor Summary

Constructors

Constructor and Description
SigPIdHeader(JAdESOID id) Creates a sigPId header with only the provided oID.

Method Summary

Modifier and Type	Method and Description
void	addSigPQual(JAdESOID spDSpec) Adds a spDSpec to the sigPQuals array.
void	addSigPQual(SpURI spURI) Adds a SpURI to the sigPQuals array.
void	addSigPQual(SpUserNotice spUserNotice) Adds a SpUserNotice to the sigPQuals array.
DigestAlgorithmIdentifiers	getDigAlg() Returns the digAlg member.
String	getDigVal() Returns the digVal member.
JAdESOID	getId() Returns the id member.
String	getJsonKey() Returns the json key of the sigPId header.
List<JAdESOID>	getSpDSpecs() Returns all SpDSpecs as unmodifiable list.
List<SpURI>	getSpURIS() Returns all SpURIs as unmodifiable list.
List<SpUserNotice>	getSpUserNotices() Returns all SpUserNotices as unmodifiable list.
boolean	isDigPSp() Returns the sigPSp member.
void	setDigest(DigestAlgorithmIdentifiers digAlg, byte[] digVal) Sets the digAlg and digVal member of the sigPId.
void	setDigest(DigestAlgorithmIdentifiers digAlg, InputStream sigPolDoc) Sets the digAlg and digVal member of the sigPId.
void	writeToJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator) Writes the Json representation of the sigPId header to the provided JsonGenerator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY

public static final String KEY

The json key of the header

See Also:

Constant Field Values

Constructor Detail

SigPIdHeader

public SigPIdHeader(JAdESOID id)

Creates a sigPId header with only the provided oID.

Parameters:

id - an oID

Method Detail

setDigest

public void setDigest(DigestAlgorithmIdentifiers digAlg,
                      byte[] digVal)

Sets the digAlg and digVal member of the sigPId. Base 64 url encodes the digVal member. Note that this method does not verify the provided digest. The method setDigest(DigestAlgorithmIdentifiers, InputStream) computes the hash correctly from an input stream.

Parameters:

digAlg - the digAlg

digVal - the digest

setDigest

public void setDigest(DigestAlgorithmIdentifiers digAlg,
                      InputStream sigPolDoc)
               throws IOException

Sets the digAlg and digVal member of the sigPId. Reads the octets from the InputStream and computes the hash as specified by the first parameter. This method closes the stream after reading from it completely.

Parameters:

digAlg - the digAlg

sigPolDoc - the InputStream to read the signature policy doc from

Throws:

IOException - if not possible to read from stream

addSigPQual

public void addSigPQual(SpURI spURI)

Adds a SpURI to the sigPQuals array.

Parameters:

spURI - an instance of SpURI

addSigPQual

public void addSigPQual(SpUserNotice spUserNotice)

Adds a SpUserNotice to the sigPQuals array.

Parameters:

spUserNotice - an instance of SpUserNotice

addSigPQual

public void addSigPQual(JAdESOID spDSpec)

Adds a spDSpec to the sigPQuals array.

Parameters:

spDSpec - an instance of JAdESOID

getId

public JAdESOID getId()

Returns the id member. Never null.

Returns:

the JAdESOID.

getDigAlg

public DigestAlgorithmIdentifiers getDigAlg()

Returns the digAlg member. May be null.

Returns:

the digAlg member or null

getDigVal

public String getDigVal()

Returns the digVal member. May be null.

Returns:

the digVal member or null

isDigPSp

public boolean isDigPSp()

Returns the sigPSp member. If not present, returns false.

Returns:

true if present and set to true. false otherwise.

getSpUserNotices

public List<SpUserNotice> getSpUserNotices()

Returns all SpUserNotices as unmodifiable list. May be empty, but never null.

Returns:

a list containing the incorporated SigPQuals.

getSpURIS

public List<SpURI> getSpURIS()

Returns all SpURIs as unmodifiable list. May be empty, but never null.

Returns:

a list containing the incorporated SigPQuals.

getSpDSpecs

public List<JAdESOID> getSpDSpecs()

Returns all SpDSpecs as unmodifiable list. May be empty, but never null.

Returns:

a list containing the incorporated SigPQuals.

writeToJson

public void writeToJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator)
                 throws IOException

Writes the Json representation of the sigPId header to the provided JsonGenerator.

Specified by:

writeToJson in interface ProtectedHeader

Parameters:

jsonGenerator - a JsonGenerator for serializing

Throws:

IOException - if it is not possible to write to the provided source

getJsonKey

public String getJsonKey()

Returns the json key of the sigPId header.

Specified by:

getJsonKey in interface JWSHeader

Returns:

"sigPId"