DWFToolkit::DWFSignature Class Reference
[DWF Package API]

#include "dwf/package/Signature.h"

Inheritance diagram for DWFToolkit::DWFSignature:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFSignature:

Collaboration graph
[legend]
List of all members.

Detailed Description

A DWFSignature is used to ...

Since:
7.3.0
The DWFSignature is used to ...

Definition at line 70 of file Signature.h.

Public Types

typedef DWFOrderedVector<
DWFSignature * > 
tList
 This type defines a list of DWFSignature pointers.
typedef DWFStringKeySkipList<
DWFSignature * > 
tMap
 This type defines a mapped collection of DWFSignature pointers.
typedef DWFCachingIterator<
DWFSignature * > 
tCachingIterator
 This type defines a caching iterator on a collection of DWFSignature pointers, that caches the pointers in its own container.
typedef DWFIterator< DWFSignature * > tIterator
 This type defines a basic iterator on a collection of DWFSignature pointers.
typedef DWFOrderedVector<
DWFSignature::Reference * > 
tReferenceVector
 This type defines a list of DWFSignature::Reference pointers.
typedef DWFOrderedVector<
X509Data * > 
tX509DataVector
 This type defines a list of X509Data pointers.

Public Member Functions

_DWFTK_API DWFSignature () throw ()
virtual _DWFTK_API ~DWFSignature () throw ()
_DWFTK_API void addReference (Reference *pReference) throw ( DWFException )
_DWFTK_API tReferenceVector::Iterator * references () throw ()
_DWFTK_API void setDigestMethod (const DigestMethod *pDigestMethod) throw ()
_DWFTK_API const DigestMethoddigestMethod () const throw ()
_DWFTK_API void setSignatureMethod (SignatureMethod *pSignatureMethod) throw ()
_DWFTK_API SignatureMethodsignatureMethod () const throw (DWFException)
_DWFTK_API void setSignatureValue (const SignatureValue *pSignatureValue) throw ()
_DWFTK_API const SignatureValuesignatureValue () const throw (DWFException)
_DWFTK_API void addX509Data (X509Data *pX509Data) throw ()
_DWFTK_API void setPublicKey (DWFCryptoKey *pPublicKey) throw ()
_DWFTK_API DWFCryptoKey * publicKey () const throw ()
_DWFTK_API void setKeyName (const DWFString &zKeyName) throw ()
_DWFTK_API const DWFStringkeyName () const throw ()
virtual _DWFTK_API const DWFStringprovideReference (const DWFString &zReferenceURI) throw ( DWFException )
virtual _DWFTK_API const DWFStringprovideSignatureMethod (const DWFString &zSigMethod) throw ( DWFException )
virtual _DWFTK_API const DWFStringprovideSignatureValue (const DWFString &zSigValue) throw ( DWFException )
virtual _DWFTK_API X509DataprovideX509Data (X509Data *pX509Data) throw ( DWFException )
virtual _DWFTK_API const DWFStringprovideDigestMethod (const DWFString &zDigestMethod) throw ( DWFException )
virtual _DWFTK_API const DWFStringprovideDigestValue (const DWFString &zDigestValue) throw ( DWFException )
virtual _DWFTK_API const DWFSignatureReader::RSAKeyValueStringsprovideRSAKeyValueStrings (const DWFSignatureReader::RSAKeyValueStrings &rRSAKeyValueStrings) throw ( DWFException )
virtual _DWFTK_API const DWFSignatureReader::DSAKeyValueStringsprovideDSAKeyValueStrings (const DWFSignatureReader::DSAKeyValueStrings &pDSAKeyValueStrings) throw ( DWFException )
virtual _DWFTK_API const DWFStringprovideKeyName (const DWFString &zKeyName) throw ( DWFException )
virtual _DWFTK_API void computeSignedInfoDigestValue (DWFSignature::DigestValue &signedInfoDigest, const DWFString &zNamespace) throw ( DWFException )
virtual _DWFTK_API bool validateSignedInfo (DWFCryptoKey *pPublicKey) throw ( DWFException )
 TODO: document this.
virtual _DWFTK_API bool validateReferences (DWFPackageReader *pReader) throw ( DWFException )
 TODO: document this.

Protected Attributes

float _nVersion
tReferenceVector _oReferences
const DigestMethod_pDigestMethod
const SignatureValue_pSignatureValue
SignatureMethod_pSignatureMethod
tX509DataVector _oX509DataVector
Reference_pCurrentReference
DWFCryptoKey * _pPublicKey
DWFString _zKeyName

Classes

class  DigestMethod
 a DigestMethod ... More...
class  DigestMethodMD5
 a DigestMethodMD5 ... More...
class  DigestMethodSHA1
 a DigestMethodSHA1 ... More...
class  DigestValue
 a DigestValue ... More...
class  Reference
 a Reference ... More...
class  SignatureMethod
 a SignatureMethod ... More...
class  SignatureMethodDSA
 a SignatureMethodDSA ... More...
class  SignatureMethodRSA
 a SignatureMethodRSA ... More...
class  SignatureValue
 a SignatureValue ... More...


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSignature::DWFSignature  )  throw ()
 

Constructor

Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFSignature::~DWFSignature  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API void DWFToolkit::DWFSignature::addReference Reference pReference  )  throw ( DWFException )
 

Parameters:
pReference A pointer to the Reference.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFSignature::addX509Data X509Data pX509Data  )  throw ()
 

Adds an X509Data element to the signature.

Parameters:
pX509Data A pointer to the pX509Data to be added.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFSignature::computeSignedInfoDigestValue DWFSignature::DigestValue signedInfoDigest,
const DWFString zNamespace
throw ( DWFException ) [virtual]
 

Computes the digest value of the SignedInfo portion of this signature.

Exceptions:
DWFException 

_DWFTK_API const DigestMethod* DWFToolkit::DWFSignature::digestMethod  )  const throw () [inline]
 

Returns the digest method to be used.

Returns:
A pointer to the specified DigestMethod.
Exceptions:
None 

Definition at line 824 of file Signature.h.

_DWFTK_API const DWFString& DWFToolkit::DWFSignature::keyName  )  const throw () [inline]
 

Returns the key name.

Returns:
A reference to the key name string.
Exceptions:
None 

Definition at line 935 of file Signature.h.

virtual _DWFTK_API const DWFString& DWFToolkit::DWFSignature::provideDigestMethod const DWFString zDigestMethod  )  throw ( DWFException ) [virtual]
 

Accepts digest method strings.

Parameters:
zDigestMethod The digest method value.
Returns:
The filtered digest method value.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFSignature::provideDigestValue const DWFString zDigestValue  )  throw ( DWFException ) [virtual]
 

Accepts digest value strings.

Parameters:
zDigestValue The digest value.
Returns:
The filtered digest value.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFSignatureReader::DSAKeyValueStrings& DWFToolkit::DWFSignature::provideDSAKeyValueStrings const DWFSignatureReader::DSAKeyValueStrings pDSAKeyValueStrings  )  throw ( DWFException ) [virtual]
 

Accepts DSA Key Value strings.

Parameters:
pDSAKeyValueStrings The DSA Key Value strings.
Returns:
The filtered DSA Key Value strings.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFSignature::provideKeyName const DWFString zKeyName  )  throw ( DWFException ) [virtual]
 

Accepts KeyInfo KeyName strings.

Parameters:
zKeyName The KeyName string.
Returns:
The filtered KeyName string.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFSignature::provideReference const DWFString zReferenceURI  )  throw ( DWFException ) [virtual]
 

Accepts References.

Parameters:
zReferenceURI The reference URI.
Returns:
The filtered reference URI.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFSignatureReader::RSAKeyValueStrings& DWFToolkit::DWFSignature::provideRSAKeyValueStrings const DWFSignatureReader::RSAKeyValueStrings rRSAKeyValueStrings  )  throw ( DWFException ) [virtual]
 

Accepts RSA Key Value strings.

Parameters:
rRSAKeyValueStrings The RSA Key Value strings.
Returns:
The filtered RSA Key Value strings.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFSignature::provideSignatureMethod const DWFString zSigMethod  )  throw ( DWFException ) [virtual]
 

Accepts signature method strings.

Parameters:
zSigMethod The signature method.
Returns:
The filtered signature method.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFSignature::provideSignatureValue const DWFString zSigValue  )  throw ( DWFException ) [virtual]
 

Accepts signature value strings.

Parameters:
zSigValue The signature value.
Returns:
The filtered signature value.
Exceptions:
DWFException 

virtual _DWFTK_API X509Data* DWFToolkit::DWFSignature::provideX509Data X509Data pX509Data  )  throw ( DWFException ) [virtual]
 

Accepts X509 Data Elements.

Note that the recipient of this call must take ownership of the X509Data object, and eventually free it by calling DWFCORE_FREE_OBJECT.

Parameters:
pX509Data The X509 Data Element.
Returns:
The filtered X509 Data Element.
Exceptions:
DWFException 

_DWFTK_API DWFCryptoKey* DWFToolkit::DWFSignature::publicKey  )  const throw () [inline]
 

Returns the public key to be used.

Returns:
A pointer to the specified public key.
Exceptions:
None 

Definition at line 909 of file Signature.h.

_DWFTK_API tReferenceVector::Iterator* DWFToolkit::DWFSignature::references  )  throw () [inline]
 

Gets an iterator that allows enumeration of the given References.

Returns:
An iterator over the Reference.
Exceptions:
None 

Definition at line 800 of file Signature.h.

_DWFTK_API void DWFToolkit::DWFSignature::setDigestMethod const DigestMethod pDigestMethod  )  throw ()
 

Sets the digest method to be used.

Parameters:
pDigestMethod A pointer to the requested DigestMethod.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFSignature::setKeyName const DWFString zKeyName  )  throw () [inline]
 

Sets the key name.

Parameters:
zKeyName A reference to the key name string.
Exceptions:
None 

Definition at line 922 of file Signature.h.

_DWFTK_API void DWFToolkit::DWFSignature::setPublicKey DWFCryptoKey *  pPublicKey  )  throw () [inline]
 

Sets the public key.

Parameters:
pPublicKey A pointer to the public key.
Exceptions:
None 

Definition at line 896 of file Signature.h.

_DWFTK_API void DWFToolkit::DWFSignature::setSignatureMethod SignatureMethod pSignatureMethod  )  throw ()
 

Sets the signature method to be used.

Parameters:
pSignatureMethod A pointer to the requested SignatureMethod.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFSignature::setSignatureValue const SignatureValue pSignatureValue  )  throw ()
 

Sets the signature value.

Parameters:
pSignatureValue A pointer to the specified SignatureValue.
Exceptions:
None 

_DWFTK_API SignatureMethod* DWFToolkit::DWFSignature::signatureMethod  )  const throw (DWFException) [inline]
 

Returns the signature method to be used.

Returns:
A pointer to the specified SignatureMethod.
Exceptions:
None 

Definition at line 848 of file Signature.h.

_DWFTK_API const SignatureValue* DWFToolkit::DWFSignature::signatureValue  )  const throw (DWFException) [inline]
 

Returns the signature method to be used.

Returns:
A pointer to the specified SignatureMethod.
Exceptions:
None 

Definition at line 872 of file Signature.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:34 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5