XKMSRegisterRequest Class Reference
[XML Key Management System Implementation]

#include <XKMSRegisterRequest.hpp>

Inheritance diagram for XKMSRegisterRequest:

[legend]Collaboration diagram for XKMSRegisterRequest:

[legend]List of all members.

---

Detailed Description

Interface definition for the RegisterRequest elements.

The <RegisterRequest> is one of the fundamental message types of the X-KRMS service. It is used by a client wishing to register a key with a service.

The schema definition for RegisterRequest is as follows :

   <!-- RegisterRequest -->
   <element name="RegisterRequest" type="xkms:RegisterRequestType"/>
   <complexType name="RegisterRequestType">
      <complexContent>
         <extension base="xkms:RequestAbstractType">
            <sequence>
               <element ref="xkms:PrototypeKeyBinding"/>
               <element ref="xkms:Authentication"/>
               <element ref="xkms:ProofOfPossession" minOccurs="0"/>
            </sequence>
         </extension>
      </complexContent>
   </complexType>
   <!-- /RegisterRequest -->

Constructors and Destructors
virtual	~XKMSRegisterRequest ()
	XKMSRegisterRequest ()
Public Member Functions
Getter Interface Methods
virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *	getElement (void) const =0
	Return the element at the base of the message.
virtual XKMSPrototypeKeyBinding *	getPrototypeKeyBinding (void) const =0
	Obtain the PrototypKeyBinding element.
virtual XKMSAuthentication *	getAuthentication (void) const =0
	Get the Authentication element.
virtual DSIGSignature *	getProofOfPossessionSignature (void) const =0
	Get the signature used to prove possession of the private key.
Setter Interface Methods
virtual XKMSPrototypeKeyBinding *	addPrototypeKeyBinding (void)=0
	Add a PrototypeKeyBinding element.
virtual XKMSAuthentication *	addAuthentication (void)=0
	Add an Authentication element.
virtual DSIGSignature *	addProofOfPossessionSignature (canonicalizationMethod cm=CANON_C14N_NOC, signatureMethod sm=SIGNATURE_DSA, hashMethod hm=HASH_SHA1)=0
	Add a ProofOfPossession signature to the message.

---

Constructor & Destructor Documentation

XKMSRegisterRequest::XKMSRegisterRequest (   )  [inline, protected]

virtual XKMSRegisterRequest::~XKMSRegisterRequest (   )  [inline, virtual]

---

Member Function Documentation

virtual XKMSAuthentication* XKMSRegisterRequest::addAuthentication (  void   )  [pure virtual]

Add an Authentication element. Set a Authentication element in the Request message. The returned object can be manipulated to add Authentication information to the request. Returns: A pointer to the newly created Authenticaton object, or the pointer to extant object if one already existed.

virtual DSIGSignature* XKMSRegisterRequest::addProofOfPossessionSignature (  canonicalizationMethod  cm = CANON_C14N_NOC, signatureMethod  sm = SIGNATURE_DSA, hashMethod  hm = HASH_SHA1 )  [pure virtual]

Add a ProofOfPossession signature to the message. Allows the application to add a new ProofOfPossession signature into a RegisterRequest element Note: the client application will need to set the key and sign the message - however the appropriate reference (to the PrototypeKeyBinding element) will be set. This implies that the PrototypeKeyBinding *must* be added prior to the call to this method. Returns: the new Signature structure

virtual XKMSPrototypeKeyBinding* XKMSRegisterRequest::addPrototypeKeyBinding (  void   )  [pure virtual]

Add a PrototypeKeyBinding element. Set a PrototypeKeyBinding element in the Request message. The returned object can be manipulated to add KeyInfo elements to the Request. Returns: A pointer to the newly created PrototypeKeyBinding object, or the pointer to extant object if one already existed.

virtual XKMSAuthentication* XKMSRegisterRequest::getAuthentication (  void   )  const [pure virtual]

Get the Authentication element. The Authentication element of the RegisterRequest is used by the client to authenticate the request to the server. Returns: A pointer to the Authentication structure

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMElement* XKMSRegisterRequest::getElement (  void   )  const [pure virtual]

Return the element at the base of the message. Implements XKMSRequestAbstractType.

virtual DSIGSignature* XKMSRegisterRequest::getProofOfPossessionSignature (  void   )  const [pure virtual]

Get the signature used to prove possession of the private key. When the client presents a request for a key generated by them, this element is used to show that the client is authorised to make this request using this key. Returns: A pointer to the proof of possession Signature object (or NULL if none was defined

virtual XKMSPrototypeKeyBinding* XKMSRegisterRequest::getPrototypeKeyBinding (  void   )  const [pure virtual]

Obtain the PrototypKeyBinding element. The PrototypeKeyBinding element is the core of the RegisterRequest message, and defines the key information that will be sent to the server for registration. Returns: A pointer to the XKMSPrototypeKeyBinding element

---

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

• XKMSRegisterRequest.hpp

---