Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

XKMSAuthentication Class Reference
[XML Key Management System Implementation]

#include <XKMSAuthentication.hpp>

List of all members.


Detailed Description

Interface definition for the Authentication elements.

The <Authentication> Element used within a number of X-KRSS requests as the mechanism for authentication a request from a client to the server

It can contain either a standard XML-Signature element (via a KeyBindingAuthentication element) or a straight password (not otherwise protected).

The schema definition for ValidityInterval is as follows :

   <!-- Authentication -->
   <element name="Authentication" type="xkms:AuthenticationType"/>
   <complexType name="AuthenticationType">
      <sequence>
         <element ref="xkms:KeyBindingAuthentication" minOccurs="0"/>
         <element ref="xkms:NotBoundAuthentication" minOccurs="0"/>
      </sequence>
   </complexType>
   <!-- /Authentication -->


Constructors and Destructors

virtual ~XKMSAuthentication ()
 XKMSAuthentication ()

Public Member Functions

Get Methods
virtual DSIGSignaturegetKeyBindingAuthenticationSignature (void) const =0
 Get KeyBindingAuthentication signature construct.
virtual XKMSNotBoundAuthenticationgetNotBoundAuthentication (void) const =0
 Get the NotBoundAuthentication structure.
Set Methods
virtual DSIGSignatureaddKeyBindingAuthenticationSignature (canonicalizationMethod cm=CANON_C14NE_NOC, signatureMethod sm=SIGNATURE_HMAC, hashMethod hm=HASH_SHA1)=0
 Add a KeyBindingAuthentication signature to the message.
virtual void setNotBoundAuthentication (const XMLCh *uri, const XMLCh *value)=0
 Set the NotBoundAuthentication value.


Constructor & Destructor Documentation

XKMSAuthentication::XKMSAuthentication  )  [inline, protected]
 

virtual XKMSAuthentication::~XKMSAuthentication  )  [inline, virtual]
 


Member Function Documentation

virtual DSIGSignature* XKMSAuthentication::addKeyBindingAuthenticationSignature canonicalizationMethod  cm = CANON_C14NE_NOC,
signatureMethod  sm = SIGNATURE_HMAC,
hashMethod  hm = HASH_SHA1
[pure virtual]
 

Add a KeyBindingAuthentication signature to the message.

Allows the application to add a new signature into a KeyBindingAuthentication element

Returns:
the new Signature structure

virtual DSIGSignature* XKMSAuthentication::getKeyBindingAuthenticationSignature void   )  const [pure virtual]
 

Get KeyBindingAuthentication signature construct.

A <XKMSAuthentication> can have a <KeyBindingAuthentication> element as an immediate child. This element is used to hold a XML-Signature over the PrototypeKeyBinding.

Returns:
The signature held in the KeyBindingAuthentication - or NULL if none is set.

virtual XKMSNotBoundAuthentication* XKMSAuthentication::getNotBoundAuthentication void   )  const [pure virtual]
 

Get the NotBoundAuthentication structure.

The NotBoundAuthentication element is used to pass a plaintext key along with the request message as the authentication mechanism.

Note:
The XKMS Spec indicates that this element MUST NOT be used unless there is another form of security being used to wrap the requests - e.g. authenticated SSL.
Returns:
The NotBoundAuthentication structure (or NULL if none is defined)

virtual void XKMSAuthentication::setNotBoundAuthentication const XMLCh *  uri,
const XMLCh *  value
[pure virtual]
 

Set the NotBoundAuthentication value.

Allows applications to set a authentication value

Parameters:
uri URI defining the authentication protocol
value Base64 encoded value to set as the authentication value


The documentation for this class was generated from the following file:
Generated on Sun Jul 3 17:44:01 2005 for XML-Security-C by  doxygen 1.4.2