SiCertificate Class Reference

a class representing X.509 public key certificates. More...

List of all members.

Public Member Functions

 SiCertificate ()
 default constructor
virtual ~SiCertificate ()
 destructor
OFCondition loadCertificate (const char *filename, int filetype)
 loads an X.509 certificate from file.
OFCondition read (DcmItem &item)
 reads an X.509 certificate from an item of the Digital Signatures Sequence and checks the certificate type information in the item.
OFCondition write (DcmItem &item)
 writes the current X.509 certificate into an item of the Digital Signatures Sequence and creates the certificate type information in the item.
E_KeyType getKeyType ()
 returns the type of public key stored in this certificate
SiAlgorithm * createAlgorithmForPublicKey ()
 creates an SiAlgorithm object for the public key contained in this certificate.
long getX509Version ()
 returns the format version of the X.509 certificate.
void getCertSubjectName (OFString &str)
 returns the subject name (distinguished name) of the current certificate.
void getCertIssuerName (OFString &str)
 returns the issuer name (distinguished name) of the current certificate.
long getCertSerialNo ()
 returns the serial number of the X.509 certificate.
void getCertValidityNotBefore (OFString &str)
 returns the start of validity of the current certificate in human readable form.
void getCertValidityNotAfter (OFString &str)
 returns the end of validity of the current certificate in human readable form.
long getCertKeyBits ()
 returns the strength (number of bits) of the public key contained in the current certificate.
X509 * getRawCertificate ()
 returns a pointer to the raw certificate structure or NULL if no certificate present.

Private Member Functions

 SiCertificate (SiCertificate &arg)
 private undefined copy constructor
SiCertificate & operator= (SiCertificate &arg)
 private undefined copy assignment operator

Private Attributes

X509 * x509
 OpenSSL X.509 structure.

Detailed Description

a class representing X.509 public key certificates.

Definition at line 52 of file sicert.h.

Member Function Documentation

SiAlgorithm* SiCertificate::createAlgorithmForPublicKey (   ) 
 

creates an SiAlgorithm object for the public key contained in this certificate.

If no certificate loaded or operation fails, returns NULL. New SiAlgorithm object must be deleted by caller.

Returns:
pointer to new SiAlgorithm object

void SiCertificate::getCertIssuerName (  OFString &  str  ) 
 

returns the issuer name (distinguished name) of the current certificate.

If no certificate is loaded, returns an empty string.

Parameters:
str issuer name returned in this string.

long SiCertificate::getCertKeyBits (   ) 
 

returns the strength (number of bits) of the public key contained in the current certificate.

If no certificate is loaded, returns 0.

Returns:
key strength in bits.

long SiCertificate::getCertSerialNo (   ) 
 

returns the serial number of the X.509 certificate.

If no certificate is loaded, returns -1.

Returns:
X.509 certificate serial number

void SiCertificate::getCertSubjectName (  OFString &  str  ) 
 

returns the subject name (distinguished name) of the current certificate.

If no certificate is loaded, returns an empty string.

Parameters:
str subject name returned in this string.

void SiCertificate::getCertValidityNotAfter (  OFString &  str  ) 
 

returns the end of validity of the current certificate in human readable form.

If no certificate is loaded, returns an empty string.

Parameters:
str end of validity returned in this string.

void SiCertificate::getCertValidityNotBefore (  OFString &  str  ) 
 

returns the start of validity of the current certificate in human readable form.

If no certificate is loaded, returns an empty string.

Parameters:
str start of validity returned in this string.

X509* SiCertificate::getRawCertificate (   ) 
 

returns a pointer to the raw certificate structure or NULL if no certificate present.

Should not be called by users of this library.

long SiCertificate::getX509Version (   ) 
 

returns the format version of the X.509 certificate.

If no certificate is loaded, returns 0.

Returns:
X.509 certificate version

OFCondition SiCertificate::loadCertificate (  const char *  filename,
int  filetype
) 
 

loads an X.509 certificate from file.

Parameters:
filename file name of X.509 certificate
filetype file format: X509_FILETYPE_PEM or X509_FILETYPE_ASN1
Returns:
status code

OFCondition SiCertificate::read (  DcmItem &  item  ) 
 

reads an X.509 certificate from an item of the Digital Signatures Sequence and checks the certificate type information in the item.

Parameters:
item item of the DigitalSignatureSQ from which the certificate is read
Returns:
status code

OFCondition SiCertificate::write (  DcmItem &  item  ) 
 

writes the current X.509 certificate into an item of the Digital Signatures Sequence and creates the certificate type information in the item.

Parameters:
item item of the DigitalSignatureSQ to which the certificate is written
Returns:
dcmdata OFCondition status code

The documentation for this class was generated from the following file:

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5