DCMTK Version 3.6.8
OFFIS DICOM Toolkit
Enumerations | Variables
sitypes.h File Reference

type definitions and constants for the dcmsign module More...

Enumerations

enum  E_KeyType {
  EKT_RSA , EKT_DSA , EKT_DH , EKT_EC ,
  EKT_none
}
 type of key for public key cryptosystem More...
 
enum  E_MACType {
  EMT_SHA1 , EMT_RIPEMD160 , EMT_MD5 , EMT_SHA256 ,
  EMT_SHA384 , EMT_SHA512
}
 type of MAC algorithm More...
 
enum  E_SignatureVerificationPolicy {
  ESVP_verifyIfPresent , ESVP_requireSignature , ESVP_requireCreatorRSASignature , ESVP_requireAuthorizationRSASignature ,
  ESVP_requireSRRSASignature
}
 signature verification policy More...
 
enum  E_TimestampVerificationPolicy { ETVP_verifyTSIfPresent , ETVP_ignoreTS , ETVP_requireTS }
 verification policy for certified timestamps attached to signatures More...
 

Variables

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InitializationFailed
 object initialization failed More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_OpenSSLFailure
 an OpenSSL call has failed More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_CannotRead
 file cannot be read More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_WrongTransferSyntax
 unable to use the selected transfer syntax for MAC computation More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_MacIDsExhausted
 no more MAC ID numbers available More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_CertificateDoesNotMatchPrivateKey
 certificate and private key do not match More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_MacDoesNotMatchProfile
 MAC algorithm not allowed for the current security profile. More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_AlgorithmDoesNotMatchProfile
 Signature algorithm not allowed for the current security profile. More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_TransferSyntaxDoesNotMatchProfile
 Transfer syntax not allowed for the current security profile. More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_DatasetDoesNotMatchProfile
 Dataset is not suitable for the current security profile (e.g. More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoCertificate
 signature verification failed because the certificate is missing or cannot be read (e.g. More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoMAC
 signature verification failed because the corresponding MAC parameters item could not be found or is incomplete More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoSignature
 signature verification failed because the corresponding signature item is incomplete More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_UnsupportedMACAlgorithm
 signature verification failed because the MAC algorithm is not supported More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_Corrupted
 signature verification failed because the signature is invalid (document corrupted) More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoTrust
 signature verification failed because the certificate was issued by an untrusted (unknown) CA More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_UnsupportedMAC
 unsupported MAC algorithm specified More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidOID
 invalid object identifier (OID) string More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_CannotWriteTSQ
 unable to write time stamp query file More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidTSR
 verification of timestamp response message failed More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoDataElementsSigned
 signature verification failed because DataElementsSigned is missing or incorrect More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_DataElementsSignedDoesNotMatchProfile
 List of data elements signed does not match the profile requirements. More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_ItemLocationNotFound
 desired signature location item not found More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_UnknownTimestampType
 unknown certified timestamp type More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidTimestamp
 certified timestamp in dataset cannot be read More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidFiletype
 filetype is unknown (neither PEM nor DER) More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_TimestampSignatureVerificationFailed
 signature verification of the certified timestamp failed More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_CertExpiredAtSignature
 signature verification failed because the certificate was already expired at the signature create date More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_CertNotYetValidAtSig
 signature verification failed because the certificate was not yet valid at signature creation date More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_AttributeNotSignable
 list of attributes to be signed contains attribute that is not signable More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_AttributeNotSignable
 signature verification failed because the signature contains an attribute that is not signable More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_DatasetEmpty
 selected dataset or item is empty, nothing to sign More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_RequiredAttributeMissing
 cannot create signature for current signature profile: required attributes missing More...
 
DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_EllipticCurveNotSupported
 cannot handle ECDSA signatures because OpenSSL was compiled without elliptic curve support More...
 

Detailed Description

type definitions and constants for the dcmsign module

Enumeration Type Documentation

◆ E_KeyType

enum E_KeyType

type of key for public key cryptosystem

Remarks
this enum is only available if DCMTK is compiled with OpenSSL support enabled.
Enumerator
EKT_RSA 

RSA key.

EKT_DSA 

DSA key.

EKT_DH 

DH key.

EKT_EC 

EC key.

EKT_none 

no key present

◆ E_MACType

enum E_MACType

type of MAC algorithm

Remarks
this enum is only available if DCMTK is compiled with OpenSSL support enabled.
Enumerator
EMT_SHA1 

SHA-1.

EMT_RIPEMD160 

RIPEMD160.

EMT_MD5 

MD5.

EMT_SHA256 

SHA-256.

EMT_SHA384 

SHA-384.

EMT_SHA512 

SHA-512.

◆ E_SignatureVerificationPolicy

signature verification policy

Remarks
this enum is only available if DCMTK is compiled with OpenSSL support enabled.
Enumerator
ESVP_verifyIfPresent 

verify signatures if present, pass otherwise

ESVP_requireSignature 

fail if no signature is present at all but do not check any signature profile

ESVP_requireCreatorRSASignature 

fail if no valid creator RSA signature is present on the main dataset level

ESVP_requireAuthorizationRSASignature 

fail if no valid authorization RSA signature is present on the main dataset level

ESVP_requireSRRSASignature 

fail if no valid SR RSA signature is present on the main dataset level

◆ E_TimestampVerificationPolicy

verification policy for certified timestamps attached to signatures

Remarks
this enum is only available if DCMTK is compiled with OpenSSL support enabled.
Enumerator
ETVP_verifyTSIfPresent 

verify timestamp if present, pass otherwise

ETVP_ignoreTS 

ignore certified timestamp even if present

ETVP_requireTS 

fail if signature does not contain a certified timestamp

Variable Documentation

◆ SI_EC_AlgorithmDoesNotMatchProfile

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_AlgorithmDoesNotMatchProfile
extern

Signature algorithm not allowed for the current security profile.

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_AttributeNotSignable

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_AttributeNotSignable
extern

list of attributes to be signed contains attribute that is not signable

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_CannotRead

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_CannotRead
extern

file cannot be read

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_CannotWriteTSQ

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_CannotWriteTSQ
extern

unable to write time stamp query file

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_CertificateDoesNotMatchPrivateKey

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_CertificateDoesNotMatchPrivateKey
extern

certificate and private key do not match

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_DataElementsSignedDoesNotMatchProfile

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_DataElementsSignedDoesNotMatchProfile
extern

List of data elements signed does not match the profile requirements.

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_DatasetDoesNotMatchProfile

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_DatasetDoesNotMatchProfile
extern

Dataset is not suitable for the current security profile (e.g.

wrong SOP class)

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_DatasetEmpty

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_DatasetEmpty
extern

selected dataset or item is empty, nothing to sign

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_EllipticCurveNotSupported

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_EllipticCurveNotSupported
extern

cannot handle ECDSA signatures because OpenSSL was compiled without elliptic curve support

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_InitializationFailed

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InitializationFailed
extern

object initialization failed

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_InvalidFiletype

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidFiletype
extern

filetype is unknown (neither PEM nor DER)

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_InvalidOID

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidOID
extern

invalid object identifier (OID) string

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_InvalidTimestamp

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidTimestamp
extern

certified timestamp in dataset cannot be read

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_InvalidTSR

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_InvalidTSR
extern

verification of timestamp response message failed

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_ItemLocationNotFound

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_ItemLocationNotFound
extern

desired signature location item not found

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_MacDoesNotMatchProfile

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_MacDoesNotMatchProfile
extern

MAC algorithm not allowed for the current security profile.

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_MacIDsExhausted

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_MacIDsExhausted
extern

no more MAC ID numbers available

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_OpenSSLFailure

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_OpenSSLFailure
extern

an OpenSSL call has failed

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_RequiredAttributeMissing

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_RequiredAttributeMissing
extern

cannot create signature for current signature profile: required attributes missing

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_TimestampSignatureVerificationFailed

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_TimestampSignatureVerificationFailed
extern

signature verification of the certified timestamp failed

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_TransferSyntaxDoesNotMatchProfile

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_TransferSyntaxDoesNotMatchProfile
extern

Transfer syntax not allowed for the current security profile.

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_UnknownTimestampType

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_UnknownTimestampType
extern

unknown certified timestamp type

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_UnsupportedMAC

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_UnsupportedMAC
extern

unsupported MAC algorithm specified

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_AttributeNotSignable

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_AttributeNotSignable
extern

signature verification failed because the signature contains an attribute that is not signable

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_CertExpiredAtSignature

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_CertExpiredAtSignature
extern

signature verification failed because the certificate was already expired at the signature create date

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_CertNotYetValidAtSig

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_CertNotYetValidAtSig
extern

signature verification failed because the certificate was not yet valid at signature creation date

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_Corrupted

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_Corrupted
extern

signature verification failed because the signature is invalid (document corrupted)

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_NoCertificate

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoCertificate
extern

signature verification failed because the certificate is missing or cannot be read (e.g.

unsupported format)

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_NoDataElementsSigned

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoDataElementsSigned
extern

signature verification failed because DataElementsSigned is missing or incorrect

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_NoMAC

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoMAC
extern

signature verification failed because the corresponding MAC parameters item could not be found or is incomplete

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_NoSignature

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoSignature
extern

signature verification failed because the corresponding signature item is incomplete

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_NoTrust

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_NoTrust
extern

signature verification failed because the certificate was issued by an untrusted (unknown) CA

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_VerificationFailed_UnsupportedMACAlgorithm

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_VerificationFailed_UnsupportedMACAlgorithm
extern

signature verification failed because the MAC algorithm is not supported

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.

◆ SI_EC_WrongTransferSyntax

DCMTK_DCMSIGN_EXPORT const OFConditionConst SI_EC_WrongTransferSyntax
extern

unable to use the selected transfer syntax for MAC computation

Remarks
this constant is only available if DCMTK is compiled with OpenSSL support enabled.


Generated on Tue Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4