SODFile (JMRTD 0.5.6 API)

java.lang.Object
- org.jmrtd.lds.AbstractTaggedLDSFile
- - org.jmrtd.lds.SODFile

All Implemented Interfaces:

Serializable, LDSElement, LDSFile
```
public class SODFile
extends AbstractTaggedLDSFile
```
File structure for the EF_SOD file (the Document Security Object). Based on Appendix 3 of Doc 9303 Part 1 Vol 2. Basically the Document Security Object is a SignedData type as specified in RFC 3369.

Version:

$Revision: 1612 $

Author:

Wojciech Mostowski ([email protected]), Martijn Oostdijk ([email protected])

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.jmrtd.lds.LDSFile
  EF_COM_TAG, EF_DG1_TAG, EF_DG10_TAG, EF_DG11_TAG, EF_DG12_TAG, EF_DG13_TAG, EF_DG14_TAG, EF_DG15_TAG, EF_DG16_TAG, EF_DG2_TAG, EF_DG3_TAG, EF_DG4_TAG, EF_DG5_TAG, EF_DG6_TAG, EF_DG7_TAG, EF_DG8_TAG, EF_DG9_TAG, EF_SOD_TAG

Constructor Summary

Constructors
Constructor and Description
`SODFile(InputStream inputStream)` Constructs a Security Object data structure.
`SODFile(String digestAlgorithm, String digestEncryptionAlgorithm, Map<Integer,byte[]> dataGroupHashes, byte[] encryptedDigest, X509Certificate docSigningCertificate)` Constructs a Security Object data structure.
`SODFile(String digestAlgorithm, String digestEncryptionAlgorithm, Map<Integer,byte[]> dataGroupHashes, PrivateKey privateKey, X509Certificate docSigningCertificate)` Constructs a Security Object data structure.
`SODFile(String digestAlgorithm, String digestEncryptionAlgorithm, Map<Integer,byte[]> dataGroupHashes, PrivateKey privateKey, X509Certificate docSigningCertificate, String provider)` Constructs a Security Object data structure using a specified signature provider.
`SODFile(String digestAlgorithm, String digestEncryptionAlgorithm, Map<Integer,byte[]> dataGroupHashes, PrivateKey privateKey, X509Certificate docSigningCertificate, String provider, String ldsVersion, String unicodeVersion)` Constructs a Security Object data structure using a specified signature provider.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkDocSignature(Certificate docSigningCert)` Deprecated. this method will be moved, LDS data objects should not be responsible for verification
`boolean`	`equals(Object obj)`
`Map<Integer,byte[]>`	`getDataGroupHashes()` Gets the stored data group hashes.
`String`	`getDigestAlgorithm()` Gets the name of the algorithm used in the data group hashes.
`String`	`getDigestEncryptionAlgorithm()` Gets the name of the digest encryption algorithm used in the signature.
`X509Certificate`	`getDocSigningCertificate()` Gets the embedded document signing certificate (if present).
`byte[]`	`getEContent()` Gets the e-content inside the signed data structure.
`byte[]`	`getEncoded()` Gets the contents of this file as byte array, includes the ICAO tag and length.
`byte[]`	`getEncryptedDigest()` Gets the signature (the encrypted digest) over the hashes.
`X500Principal`	`getIssuerX500Principal()` Gets the issuer of the document signing certificate.
`String`	`getLDSVersion()` Gets the version of the LDS if stored in the Security Object (SOd).
`BigInteger`	`getSerialNumber()` Gets the serial number of the document signing certificate.
`String`	`getSignerInfoDigestAlgorithm()` Gets the name of the digest algorithm used in the signature.
`String`	`getUnicodeVersion()` Gets the version of unicode if stored in the Security Object (SOd).
`int`	`hashCode()`
`protected void`	`readContent(InputStream inputStream)` Reads the contents of the data group from an input stream.
`String`	`toString()` Gets a textual representation of this file.
`protected void`	`writeContent(OutputStream outputStream)` Writes the contents of the data group to an output stream.

Methods inherited from class org.jmrtd.lds.AbstractTaggedLDSFile
getLength, getTag, readObject, writeObject

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SODFile
```
public SODFile(String digestAlgorithm,
               String digestEncryptionAlgorithm,
               Map<Integer,byte[]> dataGroupHashes,
               PrivateKey privateKey,
               X509Certificate docSigningCertificate)
        throws NoSuchAlgorithmException,
               CertificateException
```
    Constructs a Security Object data structure.
    
    Parameters:
    
    digestAlgorithm - a digest algorithm, such as "SHA1" or "SHA256"
    
    digestEncryptionAlgorithm - a digest encryption algorithm, such as "SHA256withRSA"
    
    dataGroupHashes - maps datagroup numbers (1 to 16) to hashes of the data groups
    
    privateKey - private key to sign the data
    
    docSigningCertificate - the document signing certificate
    
    Throws:
    
    NoSuchAlgorithmException - if either of the algorithm parameters is not recognized
    
    CertificateException - if the document signing certificate cannot be used
  - SODFile
```
public SODFile(String digestAlgorithm,
               String digestEncryptionAlgorithm,
               Map<Integer,byte[]> dataGroupHashes,
               PrivateKey privateKey,
               X509Certificate docSigningCertificate,
               String provider)
        throws NoSuchAlgorithmException,
               CertificateException
```
    Constructs a Security Object data structure using a specified signature provider.
    
    Parameters:
    
    digestAlgorithm - a digest algorithm, such as "SHA-1" or "SHA-256"
    
    digestEncryptionAlgorithm - a digest encryption algorithm, such as "SHA256withRSA"
    
    dataGroupHashes - maps datagroup numbers (1 to 16) to hashes of the data groups
    
    privateKey - private key to sign the contents
    
    docSigningCertificate - the document signing certificate to embed
    
    provider - specific signature provider that should be used to create the signature
    
    Throws:
    
    NoSuchAlgorithmException - if either of the algorithm parameters is not recognized
    
    CertificateException - if the document signing certificate cannot be used
  - SODFile
```
public SODFile(String digestAlgorithm,
               String digestEncryptionAlgorithm,
               Map<Integer,byte[]> dataGroupHashes,
               PrivateKey privateKey,
               X509Certificate docSigningCertificate,
               String provider,
               String ldsVersion,
               String unicodeVersion)
        throws NoSuchAlgorithmException,
               CertificateException
```
    Constructs a Security Object data structure using a specified signature provider.
    
    Parameters:
    
    digestAlgorithm - a digest algorithm, such as "SHA-1" or "SHA-256"
    
    digestEncryptionAlgorithm - a digest encryption algorithm, such as "SHA256withRSA"
    
    dataGroupHashes - maps datagroup numbers (1 to 16) to hashes of the data groups
    
    privateKey - private key to sign the data
    
    docSigningCertificate - the document signing certificate
    
    provider - specific signature provider that should be used to create the signature
    
    ldsVersion - LDS version
    
    unicodeVersion - Unicode version
    
    Throws:
    
    NoSuchAlgorithmException - if either of the algorithm parameters is not recognized
    
    CertificateException - if the document signing certificate cannot be used
  - SODFile
```
public SODFile(String digestAlgorithm,
               String digestEncryptionAlgorithm,
               Map<Integer,byte[]> dataGroupHashes,
               byte[] encryptedDigest,
               X509Certificate docSigningCertificate)
        throws NoSuchAlgorithmException,
               CertificateException
```
    Constructs a Security Object data structure.
    
    Parameters:
    
    digestAlgorithm - a digest algorithm, such as "SHA-1" or "SHA-256"
    
    digestEncryptionAlgorithm - a digest encryption algorithm, such as "SHA256withRSA"
    
    dataGroupHashes - maps datagroup numbers (1 to 16) to hashes of the data groups
    
    encryptedDigest - externally signed contents
    
    docSigningCertificate - the document signing certificate
    
    Throws:
    
    NoSuchAlgorithmException - if either of the algorithm parameters is not recognized
    
    CertificateException - if the document signing certificate cannot be used
  - SODFile
```
public SODFile(InputStream inputStream)
        throws IOException
```
    Constructs a Security Object data structure.
    
    Parameters:
    
    inputStream - some inputstream
    
    Throws:
    
    IOException - if something goes wrong
- Method Detail
  - readContent
```
protected void readContent(InputStream inputStream)
                    throws IOException
```
    Description copied from class: AbstractTaggedLDSFile
    
    Reads the contents of the data group from an input stream. Client code implementing this method should only read the contents from the input stream, not the tag or length of the data group.
    
    Specified by:
    
    readContent in class AbstractTaggedLDSFile
    
    Parameters:
    
    inputStream - the input stream to read from
    
    Throws:
    
    IOException - on error reading from input stream
  - writeContent
```
protected void writeContent(OutputStream outputStream)
                     throws IOException
```
    Description copied from class: AbstractTaggedLDSFile
    
    Writes the contents of the data group to an output stream. Client code implementing this method should only write the contents to the output stream, not the tag or length of the data group.
    
    Specified by:
    
    writeContent in class AbstractTaggedLDSFile
    
    Parameters:
    
    outputStream - the output stream to write to
    
    Throws:
    
    IOException - on error writing to output stream
  - getDataGroupHashes
```
public Map<Integer,byte[]> getDataGroupHashes()
```
    Gets the stored data group hashes.
    
    Returns:
    
    data group hashes indexed by data group numbers (1 to 16)
  - getEncryptedDigest
```
public byte[] getEncryptedDigest()
```
    Gets the signature (the encrypted digest) over the hashes.
    
    Returns:
    
    the encrypted digest
  - getEContent
```
public byte[] getEContent()
```
    Gets the e-content inside the signed data structure.
    
    Returns:
    
    the e-content
  - getDigestAlgorithm
```
public String getDigestAlgorithm()
```
    Gets the name of the algorithm used in the data group hashes.
    
    Returns:
    
    an algorithm string such as "SHA-1" or "SHA-256"
  - getSignerInfoDigestAlgorithm
```
public String getSignerInfoDigestAlgorithm()
```
    Gets the name of the digest algorithm used in the signature.
    
    Returns:
    
    an algorithm string such as "SHA-1" or "SHA-256"
  - getDigestEncryptionAlgorithm
```
public String getDigestEncryptionAlgorithm()
```
    Gets the name of the digest encryption algorithm used in the signature.
    
    Returns:
    
    an algorithm string such as "SHA256withRSA"
  - getLDSVersion
```
public String getLDSVersion()
```
    Gets the version of the LDS if stored in the Security Object (SOd).
    
    Returns:
    
    the version of the LDS in "aabb" format or null if LDS < V1.8
    
    Since:
    
    LDS V1.8
  - getUnicodeVersion
```
public String getUnicodeVersion()
```
    Gets the version of unicode if stored in the Security Object (SOd).
    
    Returns:
    
    the unicode version in "aabbcc" format or null if LDS < V1.8
    
    Since:
    
    LDS V1.8
  - getDocSigningCertificate
```
public X509Certificate getDocSigningCertificate()
                                         throws CertificateException
```
    Gets the embedded document signing certificate (if present). Use this certificate to verify that eSignature is a valid signature for eContent. This certificate itself is signed using the country signing certificate.
    
    Returns:
    
    the document signing certificate
    
    Throws:
    
    CertificateException - when certificate not be constructed from this SOd
  - checkDocSignature
```
public boolean checkDocSignature(Certificate docSigningCert)
                          throws GeneralSecurityException
```
    Deprecated. this method will be moved, LDS data objects should not be responsible for verification
    
    Verifies the signature over the contents of the security object. Clients can also use the accessors of this class and check the validity of the signature for themselves. See RFC 3369, Cryptographic Message Syntax, August 2002, Section 5.4 for details.
    
    Parameters:
    
    docSigningCert - the certificate to use (should be X509 certificate)
    
    Returns:
    
    status of the verification
    
    Throws:
    
    GeneralSecurityException - if something goes wrong
  - getIssuerX500Principal
```
public X500Principal getIssuerX500Principal()
```
    Gets the issuer of the document signing certificate.
    
    Returns:
    
    a certificate issuer
  - getSerialNumber
```
public BigInteger getSerialNumber()
```
    Gets the serial number of the document signing certificate.
    
    Returns:
    
    a certificate serial number
  - toString
```
public String toString()
```
    Gets a textual representation of this file.
    
    Overrides:
    
    toString in class AbstractTaggedLDSFile
    
    Returns:
    
    a textual representation of this file
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getEncoded
```
public byte[] getEncoded()
```
    Gets the contents of this file as byte array, includes the ICAO tag and length.
    
    Specified by:
    
    getEncoded in interface LDSElement
    
    Returns:
    
    a byte array containing the file

Class SODFile

Field Summary

Fields inherited from interface org.jmrtd.lds.LDSFile

Constructor Summary

Method Summary

Methods inherited from class org.jmrtd.lds.AbstractTaggedLDSFile

Methods inherited from class java.lang.Object

Constructor Detail

SODFile

SODFile

SODFile

SODFile

SODFile

Method Detail

readContent

writeContent

getDataGroupHashes

getEncryptedDigest

getEContent

getDigestAlgorithm

getSignerInfoDigestAlgorithm

getDigestEncryptionAlgorithm

getLDSVersion

getUnicodeVersion

getDocSigningCertificate

checkDocSignature

getIssuerX500Principal

getSerialNumber

toString

equals

hashCode

getEncoded