#include <OTSignedFile.hpp>

Inheritance diagram for opentxs::OTSignedFile:

Collaboration diagram for opentxs::OTSignedFile:

Public Member Functions
EXPORT	OTSignedFile ()

	OTSignedFile (const OTString &LOCAL_SUBDIR, const OTString &FILE_NAME)

	OTSignedFile (const char *LOCAL_SUBDIR, const OTString &FILE_NAME)

EXPORT	OTSignedFile (const char LOCAL_SUBDIR, const char FILE_NAME)

EXPORT bool	LoadFile ()

EXPORT bool	SaveFile ()

bool	VerifyFile ()

void	SetFilename (const OTString &LOCAL_SUBDIR, const OTString &FILE_NAME)

EXPORT OTString &	GetFilePayload ()

EXPORT void	SetFilePayload (const OTString &strArg)

EXPORT OTString &	GetSignerNymID ()

EXPORT void	SetSignerNymID (const OTString &strArg)

virtual EXPORT	~OTSignedFile ()

virtual void	Release ()

void	Release_SignedFile ()

virtual void	UpdateContents ()

virtual bool	SaveContractWallet (std::ofstream &ofs) const

Public Member Functions inherited from opentxs::OTContract
const char *	GetHashType () const

void	SetIdentifier (const OTIdentifier &theID)

EXPORT	OTContract ()

EXPORT	OTContract (const OTString &name, const OTString &foldername, const OTString &filename, const OTString &strID)

EXPORT	OTContract (const OTString &strID)

EXPORT	OTContract (const OTIdentifier &theID)

void	Initialize ()

virtual EXPORT	~OTContract ()

EXPORT void	Release_Contract ()

EXPORT void	ReleaseSignatures ()

virtual EXPORT bool	CreateContract (const OTString &strContract, const OTPseudonym &theSigner)

EXPORT bool	InsertNym (const OTString &strKeyName, const OTString &strKeyValue)

EXPORT void	GetName (OTString &strName) const

EXPORT void	SetName (const OTString &strName)

virtual EXPORT bool	VerifyContract ()

virtual EXPORT void	GetIdentifier (OTIdentifier &theIdentifier) const

virtual EXPORT void	GetIdentifier (OTString &theIdentifier) const

EXPORT void	GetFilename (OTString &strFilename) const

EXPORT void	GetFoldername (OTString &strFoldername) const

virtual EXPORT bool	LoadContract ()

EXPORT bool	LoadContract (const char szFoldername, const char szFilename)

EXPORT bool	LoadContractFromString (const OTString &theStr)

bool	LoadContractRawFile ()

EXPORT bool	ParseRawFile ()

EXPORT bool	SaveToContractFolder ()

EXPORT bool	SaveContractRaw (OTString &strOutput) const

EXPORT bool	RewriteContract (OTString &strOutput) const

EXPORT bool	SaveContract ()

EXPORT bool	SaveContract (const char szFoldername, const char szFilename)

virtual EXPORT void	CreateContents ()

EXPORT void	CreateInnerContents ()

virtual EXPORT bool	SaveContents (std::ofstream &ofs) const

virtual EXPORT bool	SaveContractWallet (OTString &strContents) const

virtual EXPORT bool	DisplayStatistics (OTString &strContents) const

virtual EXPORT bool	SaveContents (OTString &strContents) const

virtual EXPORT bool	SignContract (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContractAuthent (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignWithKey (const OTAsymmetricKey &theKey, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContract (const OTPseudonym &theNym, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContractAuthent (const OTPseudonym &theNym, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContract (const OTAsymmetricKey &theKey, OTSignature &theSignature, const OTString &strHashType, const OTPasswordData *pPWData=nullptr)

EXPORT bool	SignContract (const char szFoldername, const char szFilename, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)

virtual EXPORT bool	VerifyContractID () const

virtual EXPORT void	CalculateContractID (OTIdentifier &newID) const

virtual EXPORT bool	VerifySignature (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr) const

virtual EXPORT bool	VerifySigAuthent (const OTPseudonym &theNym, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifyWithKey (const OTAsymmetricKey &theKey, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySignature (const OTPseudonym &theNym, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySigAuthent (const OTPseudonym &theNym, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySignature (const OTAsymmetricKey &theKey, const OTSignature &theSignature, const OTString &strHashType, const OTPasswordData *pPWData=nullptr) const

EXPORT bool	VerifySignature (const char szFoldername, const char szFilename, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const

EXPORT const OTAsymmetricKey *	GetContractPublicKey () const

EXPORT const OTPseudonym *	GetContractPublicNym () const

Protected Member Functions
virtual int32_t	ProcessXMLNode (irr::io::IrrXMLReader *&xml)

Protected Member Functions inherited from opentxs::OTContract
bool	LoadContractXML ()

Additional Inherited Members
Static Public Member Functions inherited from opentxs::OTContract
static EXPORT bool	DearmorAndTrim (const OTString &strInput, OTString &strOutput, OTString &strFirstLine)

static bool	AddBookendsAroundContent (OTString &strOutput, const OTString &strContents, const OTString &strContractType, const OTString &strHashType, const listOfSignatures &listSignatures)

static EXPORT bool	LoadEncodedTextField (irr::io::IrrXMLReader *&xml, OTASCIIArmor &ascOutput)

static EXPORT bool	LoadEncodedTextField (irr::io::IrrXMLReader *&xml, OTString &strOutput)

static bool	LoadEncodedTextFieldByName (irr::io::IrrXMLReader &xml, OTASCIIArmor &ascOutput, const char &szName, OTString::Map *pmapExtraVars=nullptr)

static bool	LoadEncodedTextFieldByName (irr::io::IrrXMLReader &xml, OTString &strOutput, const char &szName, OTString::Map *pmapExtraVars=nullptr)

static bool	SkipToElement (irr::io::IrrXMLReader *&xml)

static bool	SkipToTextField (irr::io::IrrXMLReader *&xml)

static bool	SkipAfterLoadingField (irr::io::IrrXMLReader *&xml)

static EXPORT bool	SignFlatText (OTString &strFlatText, const OTString &strContractType, const OTPseudonym &theSigner, OTString &strOutput)

Detailed Description

Definition at line 141 of file OTSignedFile.hpp.

Constructor & Destructor Documentation

opentxs::OTSignedFile::OTSignedFile ( )

Definition at line 345 of file OTSignedFile.cpp.

     : ot_super()
 {
     m_strContractType.Set("FILE");
 }

opentxs::OTSignedFile::OTSignedFile	(	const OTString &	LOCAL_SUBDIR,
		const OTString &	FILE_NAME
	)

Definition at line 257 of file OTSignedFile.cpp.

     : ot_super()
 {
     m_strContractType.Set("FILE");
 
     SetFilename(LOCAL_SUBDIR, FILE_NAME);
 }

opentxs::OTSignedFile::OTSignedFile	(	const char *	LOCAL_SUBDIR,
		const OTString &	FILE_NAME
	)

Definition at line 266 of file OTSignedFile.cpp.

     : ot_super()
 {
     m_strContractType.Set("FILE");
 
     OTString strLocalSubdir(LOCAL_SUBDIR);
 
     SetFilename(strLocalSubdir, FILE_NAME);
 }

opentxs::OTSignedFile::OTSignedFile	(	const char *	LOCAL_SUBDIR,
		const char *	FILE_NAME
	)

Definition at line 276 of file OTSignedFile.cpp.

     : ot_super()
 {
     m_strContractType.Set("FILE");
 
     OTString strLocalSubdir(LOCAL_SUBDIR), strFile_Name(FILE_NAME);
 
     SetFilename(strLocalSubdir, strFile_Name);
 }

opentxs::OTSignedFile::~OTSignedFile ( )

virtual

Definition at line 351 of file OTSignedFile.cpp.

 {
     Release_SignedFile();
 }

Member Function Documentation

OTString & opentxs::OTSignedFile::GetFilePayload ( )

Definition at line 146 of file OTSignedFile.cpp.

 {
     return m_strSignedFilePayload;
 }

OTString & opentxs::OTSignedFile::GetSignerNymID ( )

Definition at line 156 of file OTSignedFile.cpp.

 {
     return m_strSignerNymID;
 }

bool opentxs::OTSignedFile::LoadFile ( )

Definition at line 310 of file OTSignedFile.cpp.

 {
     //    otOut << "DEBUG LoadFile (Signed) folder: %s file: %s \n",
     // m_strFoldername.Get(), m_strFilename.Get());
 
     if (OTDB::Exists(m_strFoldername.Get(), m_strFilename.Get()))
         return LoadContract();
 
     return false;
 }

int32_t opentxs::OTSignedFile::ProcessXMLNode ( irr::io::IrrXMLReader *& xml )

protectedvirtual

Reimplemented from opentxs::OTContract.

Definition at line 195 of file OTSignedFile.cpp.

 {
     int32_t nReturnVal = 0;
 
     // Here we call the parent class first.
     // If the node is found there, or there is some error,
     // then we just return either way.  But if it comes back
     // as '0', then nothing happened, and we'll continue executing.
     //
     // -- Note you can choose not to call the parent if
     // you don't want to use any of those xml tags.
     // As I do below, in the case of OTAccount.
     // if (nReturnVal = ot_super::ProcessXMLNode(xml))
     //    return nReturnVal;
 
     if (!strcmp("signedFile", xml->getNodeName())) {
         m_strVersion = xml->getAttributeValue("version");
 
         m_strPurportedLocalDir = xml->getAttributeValue("localDir");
         m_strPurportedFilename = xml->getAttributeValue("filename");
         m_strSignerNymID = xml->getAttributeValue("signer");
 
         nReturnVal = 1;
     }
     else if (!strcmp("filePayload", xml->getNodeName())) {
         if (false ==
             OTContract::LoadEncodedTextField(xml, m_strSignedFilePayload)) {
             otErr << "Error in OTSignedFile::ProcessXMLNode: filePayload field "
                      "without value.\n";
             return (-1); // error condition
         }
 
         return 1;
     }
 
     return nReturnVal;
 }

void opentxs::OTSignedFile::Release ( )

virtual

Reimplemented from opentxs::OTContract.

Definition at line 375 of file OTSignedFile.cpp.

 {
     Release_SignedFile();
 
     ot_super::Release();
 
     m_strContractType.Set("FILE");
 }

void opentxs::OTSignedFile::Release_SignedFile ( )

Definition at line 356 of file OTSignedFile.cpp.

 {
     m_strSignedFilePayload.Release(); // This is the file contents we were
                                       // wrapping.
                                       // We can release this now.
 
     //    m_strLocalDir.Release();            // We KEEP these, *not* release,
     // because LoadContract()
     //    m_strSignedFilename.Release();        // calls Release(), and these
     // are our core values. We don't
     // want to lose them when the file is loaded.
 
     // Note: Additionally, neither does OTContract release m_strFilename here,
     // for the SAME reason.
 
     m_strPurportedLocalDir.Release();
     m_strPurportedFilename.Release();
 }

bool opentxs::OTSignedFile::SaveContractWallet ( std::ofstream & ofs ) const

virtual

Implements opentxs::OTContract.

Definition at line 384 of file OTSignedFile.cpp.

 {
     return true;
 }

bool opentxs::OTSignedFile::SaveFile ( )

Definition at line 291 of file OTSignedFile.cpp.

 {
     const OTString strTheFileName(m_strFilename);
     const OTString strTheFolderName(m_strFoldername);
 
     // OTContract doesn't natively make it easy to save a contract to its own
     // filename.
     // Funny, I know, but OTContract is designed to save either to a specific
     // filename,
     // or to a string parameter, or to the internal rawfile member. It doesn't
     // normally
     // save to its own filename that was used to load it. But OTSignedFile is
     // different...
 
     // This saves to a file, the name passed in as a char *.
     return SaveContract(strTheFolderName.Get(), strTheFileName.Get());
 }

void opentxs::OTSignedFile::SetFilename	(	const OTString &	LOCAL_SUBDIR,
		const OTString &	FILE_NAME
	)

Definition at line 321 of file OTSignedFile.cpp.

 {
     // OTSignedFile specific variables.
     m_strLocalDir = LOCAL_SUBDIR;
     m_strSignedFilename = FILE_NAME;
 
     // OTContract variables.
     m_strFoldername = m_strLocalDir;
     m_strFilename = m_strSignedFilename;
 
     /*
     m_strFilename.Format("%s%s" // data_folder/
                          "%s%s" // nyms/
                          "%s",  // 5bf9a88c.nym
                          OTLog::Path(), OTLog::PathSeparator(),
                          m_strLocalDir.Get(), OTLog::PathSeparator(),
                          m_strSignedFilename.Get());
     */
     // Software Path + Local Sub-directory + Filename
     //
     // Finished Product:    "transaction/nyms/5bf9a88c.nym"
 }

void opentxs::OTSignedFile::SetFilePayload ( const OTString & strArg )

Definition at line 151 of file OTSignedFile.cpp.

 {
     m_strSignedFilePayload = strArg;
 }

void opentxs::OTSignedFile::SetSignerNymID ( const OTString & strArg )

Definition at line 161 of file OTSignedFile.cpp.

 {
     m_strSignerNymID = strArg;
 }

void opentxs::OTSignedFile::UpdateContents ( )

virtual

Reimplemented from opentxs::OTContract.

Definition at line 166 of file OTSignedFile.cpp.

 {
 
     OTString strSignerNym("");
     if (m_strSignerNymID.Exists()) {
         strSignerNym.Format("\n signer=\"%s\"", m_strSignerNymID.Get());
     }
 
     // I release this because I'm about to repopulate it.
     m_xmlUnsigned.Release();
 
     m_xmlUnsigned.Concatenate("<?xml version=\"%s\"?>\n\n", "1.0");
 
     m_xmlUnsigned.Concatenate("<signedFile\n version=\"%s\"\n"
                               " localDir=\"%s\"\n"
                               " filename=\"%s\"%s"
                               " >\n\n",
                               m_strVersion.Get(), m_strLocalDir.Get(),
                               m_strSignedFilename.Get(), strSignerNym.Get());
 
     if (m_strSignedFilePayload.Exists()) {
         OTASCIIArmor ascPayload(m_strSignedFilePayload);
         m_xmlUnsigned.Concatenate("<filePayload>\n%s</filePayload>\n\n",
                                   ascPayload.Get());
     }
 
     m_xmlUnsigned.Concatenate("</signedFile>\n");
 }

bool opentxs::OTSignedFile::VerifyFile ( )

Definition at line 242 of file OTSignedFile.cpp.

 {
     if (m_strLocalDir.Compare(m_strPurportedLocalDir) &&
         m_strSignedFilename.Compare(m_strPurportedFilename))
         return true;
 
     otErr << __FUNCTION__ << ": Failed verifying signed file:\n"
                              "Expected directory: " << m_strLocalDir
           << "  Found: " << m_strPurportedLocalDir
           << "\n"
              "Expected filename:  " << m_strSignedFilename
           << "  Found: " << m_strPurportedFilename << "\n";
     return false;
 }

Member Data Documentation

OTString opentxs::OTSignedFile::m_strLocalDir

protected

Definition at line 151 of file OTSignedFile.hpp.

OTString opentxs::OTSignedFile::m_strPurportedFilename

protected

Definition at line 160 of file OTSignedFile.hpp.

OTString opentxs::OTSignedFile::m_strPurportedLocalDir

protected

Definition at line 158 of file OTSignedFile.hpp.

OTString opentxs::OTSignedFile::m_strSignedFilename

protected

Definition at line 153 of file OTSignedFile.hpp.

OTString opentxs::OTSignedFile::m_strSignedFilePayload

protected

Definition at line 147 of file OTSignedFile.hpp.

OTString opentxs::OTSignedFile::m_strSignerNymID

protected

Definition at line 163 of file OTSignedFile.hpp.

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

/usr/local/src/opentxs/include/opentxs/core/crypto/OTSignedFile.hpp
/usr/local/src/opentxs/src/core/crypto/OTSignedFile.cpp

Protected Attributes
OTString	m_strSignedFilePayload

OTString	m_strLocalDir

OTString	m_strSignedFilename

OTString	m_strPurportedLocalDir

OTString	m_strPurportedFilename

OTString	m_strSignerNymID

Protected Attributes inherited from opentxs::OTContract
OTString	m_strName

OTString	m_strFoldername

OTString	m_strFilename

OTIdentifier	m_ID

OTStringXML	m_xmlUnsigned

OTString	m_strRawFile

OTString	m_strSigHashType

OTString	m_strContractType

mapOfNyms	m_mapNyms

listOfSignatures	m_listSignatures

OTString	m_strVersion

OTString	m_strEntityShortName

OTString	m_strEntityLongName

OTString	m_strEntityEmail

OTString::Map	m_mapConditions

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation