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

XKMSRecoverResult Class Reference
[XML Key Management System Implementation]

#include <XKMSRecoverResult.hpp>

Inheritance diagram for XKMSRecoverResult:

Inheritance graph
[legend]
Collaboration diagram for XKMSRecoverResult:

Collaboration graph
[legend]
List of all members.

Detailed Description

Interface definition for the RecoverResult elements.

The <RecoverResult> is used by the X-KRSS service to response to a user request to Recover a new key with the service.

The schema definition for RecoverResult is as follows :

   <!-- RecoverResult -->
   <element name="RecoverResult" type="xkms:RecoverResultType"/>
   <complexType name="RecoverResultType">
      <complexContent>
         <extension base="xkms:ResultType">
            <sequence>
               <element ref="xkms:KeyBinding" minOccurs="0" 
                     maxOccurs="unbounded"/>
               <element ref="xkms:PrivateKey" minOccurs="0"/>
            </sequence>
         </extension>
      </complexContent>
   </complexType>
   <!-- /RecoverResult -->


Constructors and Destructors

virtual ~XKMSRecoverResult ()
 XKMSRecoverResult ()

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.
KeyBinding handling
virtual int getKeyBindingSize (void) const =0
 Find number of KeyBinding elements.
virtual XKMSKeyBindinggetKeyBindingItem (int item) const =0
virtual XKMSKeyBindingappendKeyBindingItem (XKMSStatus::StatusValue status)=0
PrivateKey handling
virtual XKMSRSAKeyPairgetRSAKeyPair (const char *passPhrase)=0
 Return the RSAKeyPair.
virtual XENCEncryptedDatasetRSAKeyPair (const char *passPhrase, XMLCh *Modulus, XMLCh *Exponent, XMLCh *P, XMLCh *Q, XMLCh *DP, XMLCh *DQ, XMLCh *InverseQ, XMLCh *D, encryptionMethod em, const XMLCh *algorithmURI=NULL)=0
 Add the RSAKeyPair in an encrypted PrivateKey.


Constructor & Destructor Documentation

XKMSRecoverResult::XKMSRecoverResult  )  [inline, protected]
 

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


Member Function Documentation

virtual XKMSKeyBinding* XKMSRecoverResult::appendKeyBindingItem XKMSStatus::StatusValue  status  )  [pure virtual]
 

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

Return the element at the base of the message.

Implements XKMSMessageAbstractType.

virtual XKMSKeyBinding* XKMSRecoverResult::getKeyBindingItem int  item  )  const [pure virtual]
 

virtual int XKMSRecoverResult::getKeyBindingSize void   )  const [pure virtual]
 

Find number of KeyBinding elements.

Returns:
the number of KeyBinding items within the RecoverResult

virtual XKMSRSAKeyPair* XKMSRecoverResult::getRSAKeyPair const char *  passPhrase  )  [pure virtual]
 

Return the RSAKeyPair.

This call requires the passphrase used to encrypt the private key. The implementation decrypts the PrivateKey element in the RecoverResult and returns the resulting RSAKeyPair.

Note:
The decryption is performed *inside* the RecoverResult, so this actually modified the contents of the XML. It should never be called twice!
Parameters:
passPhrase The local code page version of the pass phrase
Returns:
the number of KeyBinding items within the RecoverResult

virtual XENCEncryptedData* XKMSRecoverResult::setRSAKeyPair const char *  passPhrase,
XMLCh *  Modulus,
XMLCh *  Exponent,
XMLCh *  P,
XMLCh *  Q,
XMLCh *  DP,
XMLCh *  DQ,
XMLCh *  InverseQ,
XMLCh *  D,
encryptionMethod  em,
const XMLCh *  algorithmURI = NULL
[pure virtual]
 

Add the RSAKeyPair in an encrypted PrivateKey.

This call requires the passphrase to encrypt the private key. The implementation encrypts the RSAKeyPair and adds the result to the resulting RSAKey Pair. It returns the CipherData element to the caller (not a structure for the PrivateKey)

Note:
The encryption is performed *inside* the RecoverResult, so this actually modified the contents of the XML. It should never be called twice!
Parameters:
passPhrase The local code page version of the pass phrase
Modulus Base64 encoded string with the modulus
Exponent Base64 encoded string with the exponent
P Base64 encoded string with p
Q Base64 encoded string with q
DP Base64 encoded string with dp
DQ Base64 encoded string with dq
InverseQ Base64 encoded string with inverseq
D Base64 encoded string with d
em The encryptionMethod to use for this encryption. Use ENCRYPT_NONE if a user defined type is required.
algorithmURI If ENCRYPT_NONE is passed in, this will be used to set the algorithm URI. If this is also NULL - no EncryptionMethod will be set. NULL Value Unsupported if em not set! It's use could cause problems!
Returns:
The encrypted result of adding the info


The documentation for this class was generated from the following file:
Generated on Sun Jan 28 19:50:22 2007 for XML-Security-C by  doxygen 1.4.2