cdac.medinfo.sdk.dcm30_04.services.basicdicommediasecurityprofile

Class BasicDICOMMediaSecurityProfile

java.lang.Object

cdac.medinfo.sdk.dcm30_04.services.basicdicommediasecurityprofile.BasicDICOMMediaSecurityProfile

public class BasicDICOMMediaSecurityProfile
extends java.lang.Object

The Basic DICOM Media Security Profile allows encapsulation of a DICOM File into a Secure DICOM File such that the following aspects of security are addressed: 1. confidentiality, 2. integrity, 3. data origin authentication. BasicDICOMMediaSecurityProfile performs encryption/decryption,digital signing and digesting of a DICOM file or a DICOMDIR File-Set as per required to provide support for all three security aspects.

Constructor Summary

Constructors

Constructor and Description
BasicDICOMMediaSecurityProfile()

Method Summary

Methods

Modifier and Type	Method and Description
void	decryptDICOMFileSet(java.lang.String strSecureDICOMDIRPath, java.lang.String strSourceDICOMDIRPath, EnumProfileAlgorithm enumProfileAlgorithm, byte[] objKey, byte[] objIV) This method decrypts the DICOMDIR file set and generates original DICOM file-set.
void	decryptSecureDICOMFile(java.lang.String strSecureDICOMFilePath, java.lang.String strDICOMFilePath, EnumProfileAlgorithm enumProfileAlgorithm, byte[] objKey, byte[] objIV) This method decrypts the secure DICOM file according to the profile algorithm , key and initializing vector provided to it.
void	encryptDICOMFile(java.lang.String strDICOMFilePath, java.lang.String strSecureDICOMFilePath, EnumProfileAlgorithm enumProfileAlgorithm, byte[] objKey, byte[] objIV) This method encrypts the DICOM file and dumped it on destination path provided as secure dicom file path.
void	encryptDICOMFileSet(java.lang.String strSourceDICOMDIRPath, java.lang.String strSecureDICOMDIRPath, EnumProfileAlgorithm enumProfileAlgorithm, byte[] objKey, byte[] objIV) This method encrypts the DICOMDIR file set and generates secure dicom file-set.
void	generateDigest(DicomStream objSourceDataStream, DicomStream objDestDataStream) Generates digest(hash code) for data available on source stream.
void	generateDigest(java.lang.String strSecureDICOMFile, java.lang.String strDigestPath) Generates digest(hash code) for file provided and accordingly dump it on given path.
void	generateDigestForFileSet(java.lang.String strSourceDICOMDIRPath, java.lang.String strDigestDIR, java.lang.String strDigestSuffix) This method generates digest for each file in DICOMDIR file set.
void	generateSignature(java.lang.String strSecureDICOMFile, java.lang.String strDigitalSignaturePath, java.security.PrivateKey objPrivateKey) Generates the Digital Signature for provided secure file and dump it on given location.
void	generateSignForFileSet(java.lang.String strSourceDICOMDIRPath, java.lang.String strSignatureDIR, java.security.PrivateKey objPrivateKey, java.lang.String strSignSuffix) This method generates digital signature for each file in DICOMDIR file set.
boolean	verifyDigest(DicomStream objSourceDataStream, DicomStream objDigestDataStream) Verifies digest(hash code) provided on given stream for source data available on source data stream.
boolean	verifyDigest(java.lang.String strSecureDICOMFile, java.lang.String strDigestPath) Verifies digest(hash code) provided on given location according to the secure dicom file specified In digest generation it uses SHA1 algorithm.
IPairedCollection<java.lang.String,java.lang.Boolean>	verifyDigestForFileSet(java.lang.String strSourceDICOMDIRPath, java.lang.String strDigestDIR, java.lang.String strDigestSuffix) This method verifies digest for each file in DICOMDIR file set.
boolean	verifySignature(DicomStream objSourceDataStream, DicomStream objExistingSignStream, java.security.PublicKey objPublicKey) Verifies the DigitalSignature provided on stream for source data available on source data stream In verification of Digital Signature it uses public key provided to it and SHA-1 as the digest algorithm.
boolean	verifySignature(java.lang.String strSecureDICOMFile, java.lang.String strDigitalSignaturePath, java.security.PublicKey objPublicKey) Verifies the DigitalSignature specified according to the provided secure DICOM file.
IPairedCollection<java.lang.String,java.lang.Boolean>	verifySignForFileSet(java.lang.String strSourceDICOMDIRPath, java.lang.String strSignatureDIR, java.security.PublicKey objPublicKey, java.lang.String strSignSuffix) This method verifies digital signature for each file in DICOMDIR file set.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicDICOMMediaSecurityProfile

public BasicDICOMMediaSecurityProfile()

Method Detail

encryptDICOMFileSet

public void encryptDICOMFileSet(java.lang.String strSourceDICOMDIRPath,
                       java.lang.String strSecureDICOMDIRPath,
                       EnumProfileAlgorithm enumProfileAlgorithm,
                       byte[] objKey,
                       byte[] objIV)
                         throws java.io.IOException,
                                java.security.NoSuchAlgorithmException,
                                javax.crypto.NoSuchPaddingException,
                                java.security.InvalidKeyException,
                                javax.crypto.IllegalBlockSizeException,
                                javax.crypto.BadPaddingException,
                                java.security.InvalidAlgorithmParameterException

This method encrypts the DICOMDIR file set and generates secure dicom file-set. If Source and destination path are same then Update operation will be performed and existing file will be modified. Encryption will be performed on each file of file-set but DICOMDIR file will not be encrypted.

Parameters:

strSourceDICOMDIRPath - path to the directory which contains DICOMDIR file and other images in DICOMDIR format name of DICOMDIR file should not be included

strSecureDICOMDIRPath - path to the directory where encrypted files will be stored in DICOMDIR structure.

enumProfileAlgorithm - - Encryption Algorithm that is to be used.

objKey - - Key that is to be used for the encryption of Data ELements.

objIV - - value of initializing vector

Throws:

java.io.IOException - Signals if IO Operation Fails.

java.security.NoSuchAlgorithmException - Signal is Encryption of the Data Set Fails.

javax.crypto.NoSuchPaddingException - Signal is Encryption of the Data Set Fails.

java.security.InvalidKeyException - Signal is Encryption of the Data Set Fails.

javax.crypto.IllegalBlockSizeException - Signal is Encryption of the Data Set Fails.

javax.crypto.BadPaddingException - Signal is Encryption of the Data Set Fails.

java.security.InvalidAlgorithmParameterException - signal if algorithm parameter are not valid

encryptDICOMFile

public void encryptDICOMFile(java.lang.String strDICOMFilePath,
                    java.lang.String strSecureDICOMFilePath,
                    EnumProfileAlgorithm enumProfileAlgorithm,
                    byte[] objKey,
                    byte[] objIV)
                      throws java.io.IOException,
                             java.security.NoSuchAlgorithmException,
                             javax.crypto.NoSuchPaddingException,
                             java.security.InvalidKeyException,
                             javax.crypto.IllegalBlockSizeException,
                             javax.crypto.BadPaddingException,
                             java.security.InvalidAlgorithmParameterException

This method encrypts the DICOM file and dumped it on destination path provided as secure dicom file path.

Parameters:

strDICOMFilePath - value of DICOM file path which need to be converted in secure DICOM file.

strSecureDICOMFilePath - value of secure DICOM file path.

enumProfileAlgorithm - - Encryption Algorithm that is to be used.

objKey - - Key that is to be used for the encryption of Data ELements.

objIV - - value of initializing vector

Throws:

java.io.IOException - Signals if IO Operation Fails.

java.security.NoSuchAlgorithmException - Signal is Encryption of the Data Set Fails.

javax.crypto.NoSuchPaddingException - Signal is Encryption of the Data Set Fails.

java.security.InvalidKeyException - Signal is Encryption of the Data Set Fails.

javax.crypto.IllegalBlockSizeException - Signal is Encryption of the Data Set Fails.

javax.crypto.BadPaddingException - Signal is Encryption of the Data Set Fails.

java.security.InvalidAlgorithmParameterException - signal if algorithm param are not valid

decryptDICOMFileSet

public void decryptDICOMFileSet(java.lang.String strSecureDICOMDIRPath,
                       java.lang.String strSourceDICOMDIRPath,
                       EnumProfileAlgorithm enumProfileAlgorithm,
                       byte[] objKey,
                       byte[] objIV)
                         throws java.io.IOException,
                                java.security.NoSuchAlgorithmException,
                                javax.crypto.NoSuchPaddingException,
                                java.security.InvalidKeyException,
                                javax.crypto.IllegalBlockSizeException,
                                javax.crypto.BadPaddingException,
                                java.security.InvalidAlgorithmParameterException

This method decrypts the DICOMDIR file set and generates original DICOM file-set. If Source and destination path are same then Update operation will be performed and existing file will be modified. Decryption will be performed on each file of file-set but DICOMDIR file will not be modified.

Parameters:

strSecureDICOMDIRPath - path to the directory which contains DICOMDIR file and other encrypted images which need to be decrypted. name of DICOMDIR file should not be included

strSourceDICOMDIRPath - path to the directory where decrypted files will be stored.

enumProfileAlgorithm - Algorithm that is to be used.

objKey - Key that is to be used for the decrption of Data ELements.

objIV - value of initializing vector

Throws:

java.io.IOException - Signals if IO Operation Fails.

java.security.NoSuchAlgorithmException - Signal is decrption of the Data Set Fails.

javax.crypto.NoSuchPaddingException - Signal is decrption of the Data Set Fails.

java.security.InvalidKeyException - Signal is decrption of the Data Set Fails.

javax.crypto.IllegalBlockSizeException - Signal is decrption of the Data Set Fails.

javax.crypto.BadPaddingException - Signal is decrption of the Data Set Fails.

java.security.InvalidAlgorithmParameterException - signal if algorithm parameter are not valid

decryptSecureDICOMFile

public void decryptSecureDICOMFile(java.lang.String strSecureDICOMFilePath,
                          java.lang.String strDICOMFilePath,
                          EnumProfileAlgorithm enumProfileAlgorithm,
                          byte[] objKey,
                          byte[] objIV)
                            throws java.io.IOException,
                                   java.security.NoSuchAlgorithmException,
                                   javax.crypto.NoSuchPaddingException,
                                   java.security.InvalidKeyException,
                                   javax.crypto.IllegalBlockSizeException,
                                   javax.crypto.BadPaddingException,
                                   java.security.InvalidAlgorithmParameterException

This method decrypts the secure DICOM file according to the profile algorithm , key and initializing vector provided to it. decrypted secure DICOM file will serialized on file path provided to it It serializes the decrypted data on destination stream

Parameters:

strSecureDICOMFilePath - path to secure DICOM file which need to be decrypted in original DICOM file.

strDICOMFilePath - path where decrypted original DICOM file will be serialized

enumProfileAlgorithm - Algorithm that is to be used.

objKey - Key that is to be used for the decrption of Data ELements.

objIV - value of initializing vector

Throws:

java.io.IOException - Signals if IO Operation Fails.

java.security.NoSuchAlgorithmException - Signal is decrption of the Data Set Fails.

javax.crypto.NoSuchPaddingException - Signal is decrption of the Data Set Fails.

java.security.InvalidKeyException - Signal is decrption of the Data Set Fails.

javax.crypto.IllegalBlockSizeException - Signal is decrption of the Data Set Fails.

javax.crypto.BadPaddingException - Signal is decrption of the Data Set Fails.

java.security.InvalidAlgorithmParameterException - signal if algorithm param are not valid

generateSignForFileSet

public void generateSignForFileSet(java.lang.String strSourceDICOMDIRPath,
                          java.lang.String strSignatureDIR,
                          java.security.PrivateKey objPrivateKey,
                          java.lang.String strSignSuffix)
                            throws java.security.InvalidKeyException,
                                   java.io.FileNotFoundException,
                                   java.io.IOException,
                                   java.security.SignatureException,
                                   java.security.NoSuchAlgorithmException

This method generates digital signature for each file in DICOMDIR file set. If Source and destination path are same then signature will be generated parallel to the images. Name of signatures will be concatenation of file name and a suffix specified. If suffix is not specified then '_Sig' will be taken as default.

Parameters:

strSourceDICOMDIRPath - path to the directory which contains DICOMDIR file and other images for which signature need to be generated. name of DICOMDIR file should not be included

strSignatureDIR - path to the directory where new generated signatures will be stored.

objPrivateKey - instance of private key.

strSignSuffix - suffix value which will be concatenated with image file name to generate name of signature file.

Throws:

java.security.InvalidKeyException - if key provided to it is invalid.

java.io.FileNotFoundException - if specified file is not found.

java.io.IOException - if input/output operation fails.

java.security.SignatureException - if signature generation fails.

java.security.NoSuchAlgorithmException - if algorithm specified is invalid.

generateSignature

public void generateSignature(java.lang.String strSecureDICOMFile,
                     java.lang.String strDigitalSignaturePath,
                     java.security.PrivateKey objPrivateKey)
                       throws java.security.InvalidKeyException,
                              java.io.FileNotFoundException,
                              java.io.IOException,
                              java.security.SignatureException,
                              java.security.NoSuchAlgorithmException

Generates the Digital Signature for provided secure file and dump it on given location. In generation of Digital Signature it uses private key provided to it and SHA-1 as the digest algorithm.

Parameters:

strSecureDICOMFile - path to secure DICOM file.

strDigitalSignaturePath - path where generated signature will be dumped.

objPrivateKey - instance of private key.

Throws:

java.security.InvalidKeyException - if key provided to it is invalid.

java.io.FileNotFoundException - if specified file is not found.

java.io.IOException - if input/output operation fails.

java.security.SignatureException - if signature generation fails.

java.security.NoSuchAlgorithmException - if algorithm specified is invalid.

verifySignForFileSet

public IPairedCollection<java.lang.String,java.lang.Boolean> verifySignForFileSet(java.lang.String strSourceDICOMDIRPath,
                                                                         java.lang.String strSignatureDIR,
                                                                         java.security.PublicKey objPublicKey,
                                                                         java.lang.String strSignSuffix)
                                                                           throws java.security.NoSuchAlgorithmException,
                                                                                  java.security.InvalidKeyException,
                                                                                  java.io.FileNotFoundException,
                                                                                  java.io.IOException,
                                                                                  java.security.SignatureException

This method verifies digital signature for each file in DICOMDIR file set. If Source and destination path are same then signature will be seen in the same directory , parralal to the image. Name of signatures will be concatenation of file name and a suffix specified. If suffix is not specified then '_Sig' will be taken as default.

Parameters:

strSourceDICOMDIRPath - path to the directory which contains DICOMDIR file and other images for which signature need to be verified. name of DICOMDIR file should not be included

strSignatureDIR - path to the directory where original signatures are stored.

objPublicKey - instance of public key.

strSignSuffix - suffix value which will be concatenated with image file name to generate name of signature file.

Returns:

IPairedCollection - map which contains file name and verification status.

Throws:

java.security.InvalidKeyException - if key provided to it is invalid.

java.io.FileNotFoundException - if specified file is not found.

java.io.IOException - if input/output operation fails.

java.security.SignatureException - if signature generation fails.

java.security.NoSuchAlgorithmException - if algorithm specified is invalid.

verifySignature

public boolean verifySignature(java.lang.String strSecureDICOMFile,
                      java.lang.String strDigitalSignaturePath,
                      java.security.PublicKey objPublicKey)
                        throws java.security.NoSuchAlgorithmException,
                               java.security.InvalidKeyException,
                               java.io.FileNotFoundException,
                               java.io.IOException,
                               java.security.SignatureException

Verifies the DigitalSignature specified according to the provided secure DICOM file. In verification of Digital Signature it uses public key provided to it and SHA-1 as the digest algorithm.

Parameters:

strSecureDICOMFile - path to secure DICOM file.

strDigitalSignaturePath - path where generated signature will be dumped.

objPublicKey - instance of public key.

Returns:

boolean - shows status as true or false

Throws:

java.security.InvalidKeyException - if key provided to it is invalid.

java.io.FileNotFoundException - if specified file is not found.

java.io.IOException - if input/output operation fails.

java.security.SignatureException - if signature generation fails.

java.security.NoSuchAlgorithmException - if algorithm specified is invalid.

verifySignature

public boolean verifySignature(DicomStream objSourceDataStream,
                      DicomStream objExistingSignStream,
                      java.security.PublicKey objPublicKey)
                        throws java.security.NoSuchAlgorithmException,
                               java.security.InvalidKeyException,
                               java.io.IOException,
                               java.security.SignatureException

Verifies the DigitalSignature provided on stream for source data available on source data stream In verification of Digital Signature it uses public key provided to it and SHA-1 as the digest algorithm.

Parameters:

objSourceDataStream - stream containing source data

objExistingSignStream - stream which contains digital signature

objPublicKey - instance of public key.

Returns:

boolean - shows status as true or false

Throws:

java.security.InvalidKeyException - if key provided to it is invalid.

java.io.IOException - if input/output operation fails.

java.security.SignatureException - if signature generation fails.

java.security.NoSuchAlgorithmException - if algorithm specified is invalid.

generateDigestForFileSet

public void generateDigestForFileSet(java.lang.String strSourceDICOMDIRPath,
                            java.lang.String strDigestDIR,
                            java.lang.String strDigestSuffix)
                              throws java.security.NoSuchAlgorithmException,
                                     java.io.FileNotFoundException,
                                     java.io.IOException

This method generates digest for each file in DICOMDIR file set. If Source and destination path are same then digest will be generated in the same directory , parralal to the image. Name of digest will be concatenation of file name and a suffix specified. If suffix is not specified then '_Digest' will be taken as default.

Parameters:

strSourceDICOMDIRPath - path to the directory which contains DICOMDIR file and other images for which digest need to be generated. name of DICOMDIR file should not be included

strDigestDIR - path to the directory where new generated digest files will be stored.

strDigestSuffix - suffix value which will be concatenated with image file name to generate name of digest file.

Throws:

java.io.FileNotFoundException - if specified file path is invalid

java.io.IOException - if input/output operation fails

java.security.NoSuchAlgorithmException - if algorithm specified is invalid

generateDigest

public void generateDigest(java.lang.String strSecureDICOMFile,
                  java.lang.String strDigestPath)
                    throws java.security.NoSuchAlgorithmException,
                           java.io.FileNotFoundException,
                           java.io.IOException

Generates digest(hash code) for file provided and accordingly dump it on given path. In digest generation it uses SHA1 algorithm.

Parameters:

strSecureDICOMFile - path to secure dicom file for which digest(hash code) need to be generated.

strDigestPath - path where generated digest(hash code) will be dumped.

Throws:

java.io.FileNotFoundException - if specified file path is invalid

java.io.IOException - if input/output operation fails

java.security.NoSuchAlgorithmException - if algorithm specified is invalid

generateDigest

public void generateDigest(DicomStream objSourceDataStream,
                  DicomStream objDestDataStream)
                    throws java.security.NoSuchAlgorithmException,
                           java.io.IOException

Generates digest(hash code) for data available on source stream. Generated digest will be serialized on destination stream provided to it In digest generation it uses SHA1 algorithm.

Parameters:

objSourceDataStream - stream containing source data

objDestDataStream - stream on which generated digest will be serialized

Throws:

java.io.IOException - if input/output operation fails

java.security.NoSuchAlgorithmException - if algorithm specified is invalid

verifyDigestForFileSet

public IPairedCollection<java.lang.String,java.lang.Boolean> verifyDigestForFileSet(java.lang.String strSourceDICOMDIRPath,
                                                                           java.lang.String strDigestDIR,
                                                                           java.lang.String strDigestSuffix)
                                                                             throws java.security.NoSuchAlgorithmException,
                                                                                    java.io.FileNotFoundException,
                                                                                    java.io.IOException

This method verifies digest for each file in DICOMDIR file set. If Source and destination path are same then digest will be seen in the same directory , parallel to the image. Name of digest will be concatenation of file name and a suffix specified. If suffix is not specified then '_Digest' will be taken as default.

Parameters:

strSourceDICOMDIRPath - path to the directory which contains DICOMDIR file and other images for which digest need to be verified. name of DICOMDIR file should not be included

strDigestDIR - path to the directory where original digest files are stored.

strDigestSuffix - suffix value which will be concatenated with image file name to generate name of digest file.

Throws:

java.io.FileNotFoundException - if specified file path is invalid

java.io.IOException - if input/output operation fails

java.security.NoSuchAlgorithmException - if algorithm specified is invalid

verifyDigest

public boolean verifyDigest(java.lang.String strSecureDICOMFile,
                   java.lang.String strDigestPath)
                     throws java.security.NoSuchAlgorithmException,
                            java.io.FileNotFoundException,
                            java.io.IOException

Verifies digest(hash code) provided on given location according to the secure dicom file specified In digest generation it uses SHA1 algorithm.

Parameters:

strSecureDICOMFile - path to secure dicom file for which digest(hash code) need to be generated.

strDigestPath - path where generated digest(hash code) will be dumped.

Returns:

boolean - shows status as true or false

Throws:

java.io.FileNotFoundException - if specified file path is invalid

java.io.IOException - if input/output operation fails

java.security.NoSuchAlgorithmException - if algorithm specified is invalid

verifyDigest

public boolean verifyDigest(DicomStream objSourceDataStream,
                   DicomStream objDigestDataStream)
                     throws java.security.NoSuchAlgorithmException,
                            java.io.IOException

Verifies digest(hash code) provided on given stream for source data available on source data stream. In digest generation it uses SHA1 algorithm.

Parameters:

objSourceDataStream - stream containing source data

objDigestDataStream - stream containing digest data

Returns:

boolean - shows status as true or false

Throws:

java.io.IOException - if input/output operation fails

java.security.NoSuchAlgorithmException - if algorithm specified is invalid