SecurePlayLibrary::SPTSecretAPIClass Class Reference

#include <SPTSecretAPIClass.h>

Inheritance diagram for SecurePlayLibrary::SPTSecretAPIClass:

List of all members.

---

Detailed Description

This class implements the Secret Transaction type - the ability for a single party, the Transaction Master, to send a single secret to other participants in a non-refutable fashion. The Secret is committed to irrevokably at the time it is initially sent in hidden form and then can be subsequently revealed.

Author:

IT GlobalSecure

See also:

SecurePlay License Information

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

---

Constructor & Destructor Documentation

SPTSecretAPIClass::SPTSecretAPIClass (   )

Default Constructor

SPTSecretAPIClass::~SPTSecretAPIClass (   )

Default Destructor

SPTSecretAPIClass::SPTSecretAPIClass (  SPTSecretClass *  secretinstance  )

Overloaded Constructor Parameters: secretinstance

---

Member Function Documentation

string SPTSecretAPIClass::APIgetSecret (   )

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

bool SPTSecretAPIClass::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 - bool: TRUE, if request successfully sent, FALSE, if not

bool SPTSecretAPIClass::APIrequestsendHiddenSecret (  string  pid, 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 - bool: TRUE, if request successfully sent, FALSE, if not

bool SPTSecretAPIClass::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 - bool: TRUE, if successful, FALSE, if not

bool SPTSecretAPIClass::APIsendHiddenSecret (  string  sender, 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 - bool: TRUE, if successful, FALSE, if not

bool SPTSecretAPIClass::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 bool flag to indicate success or failure. Returns: result - bool: TRUE, if able to verify secret, FALSE, if not

bool SPTSecretAPIClass::rulesrevealSecret (  string  sender, vector< string >  receivers, string  liststatus, SPTSecretClass *  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  receivers  liststatus  transobj  Returns: bool - TRUE, if allowed or bool FALSE, if not

bool SPTSecretAPIClass::rulessendHiddenSecret (  string  sender, string  newsecret, SPTSecretClass *  transobj )

This method handles incoming requests to send Hidden Secrets Parameters: sender  newsecret  transobj  Returns: string - newsecret, if Successful, bool FALSE, if not

---

Member Data Documentation

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

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

SPTSecretClass* SecurePlayLibrary::SPTSecretAPIClass::traninst [private]

Instance of SPSecretClass

---

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

• SPTSecretAPIClass.h
• SPTSecretAPIClass.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.