SecurePlayLibrary::SPTMultiPartSecretAPIClass Class Reference

#include <SPTMultiPartSecretAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTMultiPartSecretAPIClass:

List of all members.

---

Detailed Description

API version of SPSecretClass

Author:

IT GlobalSecure Inc.

See also:

SecurePlay License Information

Public Member Functions
	SPTMultiPartSecretAPIClass ()
	~SPTMultiPartSecretAPIClass ()
	SPTMultiPartSecretAPIClass (SPTMultiPartSecretClass *secretinstance)
vector< string >	APIgetSecret ()
bool	APIrequestrevealSecret (string pid, vector< string > receivers, string liststatus)
bool	APIrequestsendHiddenSecret (string pid, vector< string > newsecret)
bool	APIrevealSecret (string sender, vector< string > recievers, string liststatus)
bool	APIsendHiddenSecret (string sender, vector< string > newsecret)
bool	APIverifySecret ()
bool	rulesrevealSecret (string sender, vector< string > receivers, string liststatus, SPTMultiPartSecretClass *transobj)
bool	rulessendHiddenSecret (string sender, vector< string > newsecret, SPTMultiPartSecretClass *transobj)
Private Attributes
SPTMultiPartSecretClass *	traninst
const bool	librarytestmode

---

Constructor & Destructor Documentation

SPTMultiPartSecretAPIClass::SPTMultiPartSecretAPIClass (   )

Default Constructor.

SPTMultiPartSecretAPIClass::~SPTMultiPartSecretAPIClass (   )

Default Destructor

SPTMultiPartSecretAPIClass::SPTMultiPartSecretAPIClass (  SPTMultiPartSecretClass *  secretinstance  )

Overloaded Constructor Parameters: secretinstance  SPMultiPartSecretClass - the API associated with SPMultiPartSecretClass

---

Member Function Documentation

vector< string > SPTMultiPartSecretAPIClass::APIgetSecret (   )

This method returns the actual secret that this transaction is protecting, if available. Returns: result - string - the secret

bool SPTMultiPartSecretAPIClass::APIrequestrevealSecret (  string  pid, vector< string >  receivers, string  liststatus )

This method allows a third party player to request that the secret be revealed by the transaction master to the specified receiver list. This method is mainly used for remote debugging. Parameters: pid  string - the player id of the requestor receivers  vector<string> - player ids of recievers of the secret liststatus  string - status of the list Returns: result - Boolean: TRUE, if request successfully sent, FALSE, if not

bool SPTMultiPartSecretAPIClass::APIrequestsendHiddenSecret (  string  pid, vector< string >  newsecret )

This method allows a non-transaction master to request the transaction master send a Secret. It is mainly used for remote debugging purposes. Parameters: pid  string - player id of the requestor newsecret  string - the secret to be sent Returns: result - Boolean: TRUE, if request successfully sent, FALSE, if not

bool SPTMultiPartSecretAPIClass::APIrevealSecret (  string  sender, vector< string >  recievers, string  liststatus )

This method sends the secretpadded value to the specified remote players. Parameters: sender  string - the sender of the secret recievers  vector<string> - player ids of recievers liststatus  string - "P" or "L" Returns: result - Boolean: TRUE, if successful, FALSE, if not

bool SPTMultiPartSecretAPIClass::APIsendHiddenSecret (  string  sender, vector< string >  newsecret )

This method allows the Secret Transaction master to send the transform of a secret to the other participants in the transaction. Parameters: sender  string - the sender of the hidden secret newsecret  string - the secret message Returns: result - Boolean: TRUE, if successful, FALSE, if not

bool SPTMultiPartSecretAPIClass::APIverifySecret (   )

This method verifies the paddedsecret that was sent. It computes the transform of the paddedsecret that has been sent and compares it with the previously sent secrettransform. It returns a Boolean flag to indicate success or failure. Returns: result - Boolean: TRUE, if able to verify secret, FALSE, if not

bool SPTMultiPartSecretAPIClass::rulesrevealSecret (  string  sender, vector< string >  receivers, string  liststatus, SPTMultiPartSecretClass *  transobj )

This shell method is a pluggable function to allow the override of handing incoming requests to reveal a Secret by the transaction master. It is mainly used for remote debugging purposes. Parameters: sender  string - sender of the secret receivers  vector<string> - recievers of the secret liststatus  string - list status transobj  SPMultiPartSecretClass - the transaction object Returns: result - boolean: TRUE, if allowed or boolean FALSE, if not

bool SPTMultiPartSecretAPIClass::rulessendHiddenSecret (  string  sender, vector< string >  newsecret, SPTMultiPartSecretClass *  transobj )

This shell method provides a pluggable function to handle sendHiddenSecret requests. It is mainly used for debugging remote transactions. Parameters: sender  string - sender of the secret newsecret  vector<string> - the secret transobj  SPMultiPartSecretClass - the transaction object Returns: string - newsecret, if Successful, BOOLEAN FALSE, if not

---

Member Data Documentation

const bool SecurePlayLibrary::SPTMultiPartSecretAPIClass::librarytestmode [private]

This should be set to FALSE for production systems or all "rulesXXXX methods should be edited Reimplemented from SecurePlayLibrary::SPAbstractTransactionAPIClass.

SPTMultiPartSecretClass* SecurePlayLibrary::SPTMultiPartSecretAPIClass::traninst [private]

Instance of SPSecretClass

---

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

• SPTMultiPartSecretAPIClass.h
• SPTMultiPartSecretAPIClass.cpp

2006 Copyright Filed by IT GlobalSecure, Inc. All Rights Reserved. Not to be used without authorization by Author. SecurePlay, IT GlobalSecure, and IT Armor are registered trademarks by IT GlobalSecure, Inc. Software protected by software license, and one or more the following U.S. and International patent numbers: U.S. Patent 6,030,288, U.S. Patent 6,165,072, European Patent Office EP1016049A1,and World Intellectual Property Organization WO9912135C1 and additional filings worldwide.