Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

DSIGKeyInfo Class Reference
[Main Signature API]

#include <DSIGKeyInfo.hpp>

Inheritance diagram for DSIGKeyInfo:

Inheritance graph
[legend]
Collaboration diagram for DSIGKeyInfo:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for <Key*> nodes in a KeyInfo list.

Digital signatures can have a number of KeyInfo elements that are used to communicate information about what key to use between the signer and the validator.

In the XML-Security-C libary, KeyInfo elements are only used for holding information about keys. They do not in themselves perform any cryptographic function.


Public Types

enum  keyInfoType {
  KEYINFO_NOTSET = 1,
  KEYINFO_X509 = 2,
  KEYINFO_VALUE_DSA = 3,
  KEYINFO_VALUE_RSA = 4,
  KEYINFO_NAME = 5
}
 List of potential KeyInfo types. More...


Public Methods

Constructors and Destructors
 DSIGKeyInfo (DSIGSignature *sig)
 Construct from an owning signature.

virtual ~DSIGKeyInfo ()
 The Destructor.

Get functions
virtual keyInfoType getKeyInfoType (void)=0
 Return type.

virtual const DOMNode * getKeyInfoDOMNode ()
 Return the DOMNode that heads up this DOMNode.

virtual const XMLCh * getKeyName (void)=0
 Return the name of this key.

Load and Set
virtual void load ()=0
 Load the DOM structures.


Protected Attributes

DOMNode * mp_keyInfoDOMNode
DSIGSignaturemp_parentSignature


Member Enumeration Documentation

enum DSIGKeyInfo::keyInfoType
 

List of potential KeyInfo types.

The keyIntoType enumerated type defines the KeyInfo types known by the XML-Security-C library.

Enumeration values:
KEYINFO_NOTSET 
KEYINFO_X509 
KEYINFO_VALUE_DSA 
KEYINFO_VALUE_RSA 
KEYINFO_NAME 


Constructor & Destructor Documentation

DSIGKeyInfo::DSIGKeyInfo DSIGSignature   sig [inline]
 

Construct from an owning signature.

All KeyInfo types take a constructor that names the owning signature.

Parameters:
sig  The signature that owns this element

virtual DSIGKeyInfo::~DSIGKeyInfo   [inline, virtual]
 

The Destructor.


Member Function Documentation

virtual const DOMNode* DSIGKeyInfo::getKeyInfoDOMNode   [inline, virtual]
 

Return the DOMNode that heads up this DOMNode.

virtual keyInfoType DSIGKeyInfo::getKeyInfoType void    [pure virtual]
 

Return type.

Can be used to find what type of KeyInfo this is

Implemented in DSIGKeyInfoName, DSIGKeyInfoValue, and DSIGKeyInfoX509.

virtual const XMLCh* DSIGKeyInfo::getKeyName void    [pure virtual]
 

Return the name of this key.

For those KeyInfo types that have a keyname, this function should return it. For certificates, this may be the DN.

Returns:
A pointer to a buffer containing the name

Implemented in DSIGKeyInfoName, DSIGKeyInfoValue, and DSIGKeyInfoX509.

virtual void DSIGKeyInfo::load   [pure virtual]
 

Load the DOM structures.

Used by the library to instruct the object to load information from the DOM nodes

Implemented in DSIGKeyInfoName, DSIGKeyInfoValue, and DSIGKeyInfoX509.


Member Data Documentation

DOMNode* DSIGKeyInfo::mp_keyInfoDOMNode [protected]
 

DSIGSignature* DSIGKeyInfo::mp_parentSignature [protected]
 


The documentation for this class was generated from the following file:
Generated on Wed Mar 26 20:59:08 2003 for XML-Security-C by doxygen1.2.18