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

DSIGKeyInfoValue Class Reference
[Main Signature API]

The class for <KeyValue> nodes in a KeyInfo list. More...

#include <DSIGKeyInfoValue.hpp>

Inheritance diagram for DSIGKeyInfoValue:

Inheritance graph
[legend]
Collaboration diagram for DSIGKeyInfoValue:

Collaboration graph
[legend]
List of all members.

Public Methods

Constructors and Destructors
 DSIGKeyInfoValue (DSIGSignature *sig, DOMNode *valueNode)
 Constructor for an existing signature *. More...

 DSIGKeyInfoValue (DSIGSignature *sig)
 Constructor for creating from scratch. More...

virtual ~DSIGKeyInfoValue ()
Loading and Get functions
virtual void load (void)
 Load an existing XML structure. More...

const char * getDSAP (void)
 Get P value. More...

const char * getDSAQ (void)
 Get Q value. More...

const char * getDSAG (void)
 Get G value. More...

const char * getDSAY (void)
 Get Y value. More...

const char * getRSAModulus (void)
 Get Modulus. More...

const char * getRSAExponent (void)
 Get Exponent. More...

DSA Create and set functions
DOMElement * createBlankDSAKeyValue (const char *P, const char *Q, const char *G, const char *Y)
 Create a blank KeyValue (and DOM structure). More...

void setDSAP (const char *P)
 Set P value. More...

void setDSAQ (const char *Q)
 Set Q value. More...

void setDSAG (const char *G)
 Set G value. More...

void setDSAY (const char *Y)
 Set Y value. More...

RSA Create and Set functions
DOMElement * DSIGKeyInfoValue::createBlankRSAKeyValue (const char *modulus, const char *exponent)
void DSIGKeyInfoValue::setRSAModulus (const char *modulus)
 Set the Modulus. More...

void DSIGKeyInfoValue::setRSAExponent (const char *exponent)
 Set the exponent. More...

Information Functions
virtual keyInfoType getKeyInfoType (void)
 Interface call to return type. More...

virtual safeBuffer getKeyName (void)
 Get the name of this key (irrelevant for a KeyValue). More...


Detailed Description

The class for <KeyValue> nodes in a KeyInfo list.

Class for holding information on a KeyValue node as well as setting such a node in a signature.


Constructor & Destructor Documentation

DSIGKeyInfoValue::DSIGKeyInfoValue DSIGSignature   sig,
DOMNode *    valueNode
 

Constructor for an existing signature *.

Constructor used when loading a KeyValue node that already exists in an XML document.

Parameters:
sig  Owning signature
valueNode  DOMNode at head of XML structure

DSIGKeyInfoValue::DSIGKeyInfoValue DSIGSignature   sig
 

Constructor for creating from scratch.

Constructor used when creating a new KeyValue node to append to a signature structure.

Parameters:
sig  Owning signature

virtual DSIGKeyInfoValue::~DSIGKeyInfoValue   [virtual]
 


Member Function Documentation

DOMElement* DSIGKeyInfoValue::createBlankDSAKeyValue const char *    P,
const char *    Q,
const char *    G,
const char *    Y
 

Create a blank KeyValue (and DOM structure).

Create a blank KeyValue structure with the passed parameters and create the required DOM structure as well.

Parameters:
P  The P value (base64 encoded)
Q  The Q value (base64 encoded)
G  The G value (base64 encoded)
Y  The Y value (base64 encoded)
Returns:
the DOMElement at the head of the DOM structure

DOMElement* DSIGKeyInfoValue::DSIGKeyInfoValue::createBlankRSAKeyValue const char *    modulus,
const char *    exponent
 

void DSIGKeyInfoValue::DSIGKeyInfoValue::setRSAExponent const char *    exponent
 

Set the exponent.

Set the base64 encoded string of the exponent value within the element

Parameters:
exponent  Base64 encoded value to set

void DSIGKeyInfoValue::DSIGKeyInfoValue::setRSAModulus const char *    modulus
 

Set the Modulus.

Set the base64 encoded string of the Modulus value within the element.

Parameters:
modulus  Base64 encoded value to set

const char* DSIGKeyInfoValue::getDSAG void    [inline]
 

Get G value.

Returns:
a pointer to the DSA G string value.

const char* DSIGKeyInfoValue::getDSAP void    [inline]
 

Get P value.

Returns:
a pointer to the DSA P string value.

const char* DSIGKeyInfoValue::getDSAQ void    [inline]
 

Get Q value.

Returns:
a pointer to the DSA Q string value.

const char* DSIGKeyInfoValue::getDSAY void    [inline]
 

Get Y value.

Returns:
a pointer to the DSA Y string value.

virtual keyInfoType DSIGKeyInfoValue::getKeyInfoType void    [virtual]
 

Interface call to return type.

Returns:
the type of this keyInfo node

Implements DSIGKeyInfo.

virtual safeBuffer DSIGKeyInfoValue::getKeyName void    [virtual]
 

Get the name of this key (irrelevant for a KeyValue).

Returns:
NULL

Implements DSIGKeyInfo.

const char* DSIGKeyInfoValue::getRSAExponent void   
 

Get Exponent.

Returns:
A pointer to the buffer containing the RSA Modulus string

const char* DSIGKeyInfoValue::getRSAModulus void   
 

Get Modulus.

Returns:
A pointer to the RSA Modulus

virtual void DSIGKeyInfoValue::load void    [virtual]
 

Load an existing XML structure.

Called by the Signature class when it is reading in a DOM structure

Implements DSIGKeyInfo.

void DSIGKeyInfoValue::setDSAG const char *    G
 

Set G value.

Take the provided string and use it to set the G parameter in the KeyValue

void DSIGKeyInfoValue::setDSAP const char *    P
 

Set P value.

Take the provided string and use it to set the P parameter in the KeyValue

void DSIGKeyInfoValue::setDSAQ const char *    Q
 

Set Q value.

Take the provided string and use it to set the Q parameter in the KeyValue

void DSIGKeyInfoValue::setDSAY const char *    Y
 

Set Y value.

Take the provided string and use it to set the Y parameter in the KeyValue


The documentation for this class was generated from the following file:
Generated on Sat Jan 11 20:35:05 2003 for XML-Security-C by doxygen1.2.15