#include <OTCrypto.hpp>

Inheritance diagram for opentxs::OTCrypto:

Public Member Functions
virtual	~OTCrypto ()

virtual OTPassword *	InstantiateBinarySecret () const =0

EXPORT bool	GetPasswordFromConsole (OTPassword &theOutput, bool bRepeat=false) const

EXPORT bool	GetPasswordFromConsoleLowLevel (OTPassword &theOutput, const char *szPrompt) const

virtual bool	RandomizeMemory (uint8_t *szDestination, uint32_t nNewSize) const =0

virtual bool	CalculateDigest (const OTString &strInput, const OTString &strHashAlgorithm, OTIdentifier &theOutput) const =0

virtual bool	CalculateDigest (const OTData &dataInput, const OTString &strHashAlgorithm, OTIdentifier &theOutput) const =0

bool	IsBase62 (const std::string &str) const

virtual void	SetIDFromBase62String (const OTString &strInput, OTIdentifier &theOutput) const =0

virtual void	SetBase62StringFromID (const OTIdentifier &theInput, OTString &strOutput) const =0

virtual bool	Base64Encode (const OTData &theInput, OTString &strOutput, bool bLineBreaks=true) const

virtual bool	Base64Decode (const OTString &strInput, OTData &theOutput, bool bLineBreaks=true) const

virtual char *	Base64Encode (const uint8_t *input, int32_t in_len, bool bLineBreaks) const =0

virtual uint8_t *	Base64Decode (const char input, size_t out_len, bool bLineBreaks) const =0

virtual OTPassword *	DeriveKey (const OTPassword &userPassword, const OTPayload &dataSalt, uint32_t uIterations, const OTPayload &dataCheckHash=OTPayload()) const =0

virtual OTPassword *	DeriveNewKey (const OTPassword &userPassword, const OTPayload &dataSalt, uint32_t uIterations, OTPayload &dataCheckHash) const =0

virtual bool	Encrypt (const OTPassword &theRawSymmetricKey, const char *szInput, uint32_t lInputLength, const OTPayload &theIV, OTPayload &theEncryptedOutput) const =0

virtual bool	Decrypt (const OTPassword &theRawSymmetricKey, const char *szInput, uint32_t lInputLength, const OTPayload &theIV, OTCrypto_Decrypt_Output theDecryptedOutput) const =0

virtual bool	Seal (mapOfAsymmetricKeys &RecipPubKeys, const OTString &theInput, OTData &dataOutput) const =0

virtual bool	Open (OTData &dataInput, const OTPseudonym &theRecipient, OTString &theOutput, const OTPasswordData *pPWData=nullptr) const =0

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

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

virtual bool	SignContract (const OTString &strContractUnsigned, const OTString &strSigHashType, const std::string &strCertFileContents, OTSignature &theSignature, const OTPasswordData *pPWData=nullptr)=0

virtual bool	VerifySignature (const OTString &strContractToVerify, const OTString &strSigHashType, const std::string &strCertFileContents, const OTSignature &theSignature, const OTPasswordData *pPWData=nullptr) const =0

EXPORT void	Init () const

EXPORT void	Cleanup () const

Static Public Member Functions
static EXPORT OTCrypto *	It ()

Protected Member Functions
	OTCrypto ()

virtual void	Init_Override () const

virtual void	Cleanup_Override () const

Detailed Description

Definition at line 232 of file OTCrypto.hpp.

Constructor & Destructor Documentation

opentxs::OTCrypto::OTCrypto ( )

protected

Definition at line 420 of file OTCrypto.cpp.

421 {

422 }

opentxs::OTCrypto::~OTCrypto ( )

virtual

Definition at line 423 of file OTCrypto.cpp.

424 {

425 }

Member Function Documentation

bool opentxs::OTCrypto::Base64Decode	(	const OTString &	strInput,
		OTData &	theOutput,
		bool	bLineBreaks = `true`
	)		const

virtual

Definition at line 740 of file OTCrypto.cpp.

 {
 
     const char* szInput = strInput.Get();
     size_t theSize = 0;
 
     // Caller is responsible to delete.
     uint8_t* pOutput = Base64Decode(szInput, &theSize, bLineBreaks);
 
     if (nullptr == pOutput) {
         otErr << __FUNCTION__
               << ": Base64Decode returned nullptr. (Failure.)\n";
         return false;
     }
 
     // pOutput not nullptr, and must be cleaned up.
     //
     const void* pVoid = reinterpret_cast<void*>(pOutput);
     uint32_t lNewSize = static_cast<uint32_t>(theSize);
 
     theOutput.Assign(pVoid, lNewSize);
     delete pOutput;
     pOutput = nullptr;
 
     return true; // <=== Success.
 }

virtual uint8_t* opentxs::OTCrypto::Base64Decode	(	const char *	input,
		size_t *	out_len,
		bool	bLineBreaks
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

bool opentxs::OTCrypto::Base64Encode	(	const OTData &	theInput,
		OTString &	strOutput,
		bool	bLineBreaks = `true`
	)		const

virtual

Definition at line 710 of file OTCrypto.cpp.

 {
 
     const uint8_t* pDataIn = static_cast<const uint8_t*>(theInput.GetPointer());
     int32_t nLength = static_cast<int32_t>(theInput.GetSize());
 
     OT_ASSERT_MSG(nLength >= 0, "ASSERT!!! nLength is an int32_t, matching the "
                                 "openssl interface, and a size was just "
                                 "attempted that wouldn't fit into an int32_t, "
                                 "after static casting.\n");
 
     // Caller is responsible to delete.
     char* pChar = Base64Encode(pDataIn, nLength, bLineBreaks);
 
     if (nullptr == pChar) {
         otErr << __FUNCTION__
               << ": Base64Encode returned nullptr. (Failure.)\n";
         return false;
     }
 
     // pChar not nullptr, and must be cleaned up.
     //
     strOutput.Set(pChar);
     delete pChar;
     pChar = nullptr;
 
     return true; // <=== Success.
 }

virtual char* opentxs::OTCrypto::Base64Encode	(	const uint8_t *	input,
		int32_t	in_len,
		bool	bLineBreaks
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::CalculateDigest	(	const OTString &	strInput,
		const OTString &	strHashAlgorithm,
		OTIdentifier &	theOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::CalculateDigest	(	const OTData &	dataInput,
		const OTString &	strHashAlgorithm,
		OTIdentifier &	theOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

void opentxs::OTCrypto::Cleanup ( ) const

Definition at line 678 of file OTCrypto.cpp.

 {
     // This is only supposed to happen once per run.
     //
     if (1 == OTCrypto::s_nCount) {
         --(OTCrypto::s_nCount);
 
         // Any crypto-related cleanup code NOT specific to OpenSSL (which is
         // handled in OTCrypto_OpenSSL, a subclass) would go here.
         //
 
         Cleanup_Override();
     }
     else
         otErr << "OTCrypto::Cleanup: ERROR: Somehow this erroneously got "
                  "called more than once! (Doing nothing.)\n";
 }

void opentxs::OTCrypto::Cleanup_Override ( ) const

protectedvirtual

Reimplemented in opentxs::OTCrypto_OpenSSL.

Definition at line 704 of file OTCrypto.cpp.

 {
     otErr << "OTCrypto::Cleanup_Override: ERROR: This function should NEVER be "
              "called (you should be overriding it...)\n";
 }

virtual bool opentxs::OTCrypto::Decrypt	(	const OTPassword &	theRawSymmetricKey,
		const char *	szInput,
		uint32_t	lInputLength,
		const OTPayload &	theIV,
		OTCrypto_Decrypt_Output	theDecryptedOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual OTPassword* opentxs::OTCrypto::DeriveKey	(	const OTPassword &	userPassword,
		const OTPayload &	dataSalt,
		uint32_t	uIterations,
		const OTPayload &	dataCheckHash = `OTPayload()`
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual OTPassword* opentxs::OTCrypto::DeriveNewKey	(	const OTPassword &	userPassword,
		const OTPayload &	dataSalt,
		uint32_t	uIterations,
		OTPayload &	dataCheckHash
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::Encrypt	(	const OTPassword &	theRawSymmetricKey,
		const char *	szInput,
		uint32_t	lInputLength,
		const OTPayload &	theIV,
		OTPayload &	theEncryptedOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

bool opentxs::OTCrypto::GetPasswordFromConsole	(	OTPassword &	theOutput,
		bool	bRepeat = `false`
	)		const

Definition at line 587 of file OTCrypto.cpp.

 {
     int32_t nAttempts = 0;
 
     for (;;) {
         theOutput.zeroMemory();
 
         if (GetPasswordFromConsoleLowLevel(theOutput, "(OT) passphrase: ")) {
             if (!bRepeat) {
                 std::cout << std::endl;
                 return true;
             }
         }
         else {
             std::cout << "Sorry." << std::endl;
             return false;
         }
 
         OTPassword tempPassword;
 
         if (!GetPasswordFromConsoleLowLevel(tempPassword,
                                             "(Verifying) passphrase again: ")) {
             std::cout << "Sorry." << std::endl;
             return false;
         }
 
         if (!tempPassword.Compare(theOutput)) {
             if (++nAttempts >= 3) break;
 
             std::cout << "(Mismatch, try again.)\n" << std::endl;
         }
         else {
             std::cout << std::endl;
             return true;
         }
     }
 
     std::cout << "Sorry." << std::endl;
 
     return false;
 }

bool opentxs::OTCrypto::GetPasswordFromConsoleLowLevel	(	OTPassword &	theOutput,
		const char *	szPrompt
	)		const

Definition at line 488 of file OTCrypto.cpp.

 {
     OT_ASSERT(nullptr != szPrompt);
 
 #ifdef _WIN32
     {
         std::cout << szPrompt;
 
         {
             std::string strPassword = "";
 
 #ifdef UNICODE
 
             const wchar_t enter[] = {L'\x000D', L'\x0000'}; // carrage return
             const std::wstring wstrENTER = enter;
 
             std::wstring wstrPass = L"";
 
             for (;;) {
                 const wchar_t ch[] = {_getwch(), L'\x0000'};
                 const std::wstring wstrCH = ch;
                 if (wstrENTER == wstrCH) break;
                 wstrPass.append(wstrCH);
             }
             strPassword = OTString::ws2s(wstrPass);
 
 #else
 
             const char enter[] = {'\x0D', '\x00'}; // carrage return
             const std::string strENTER = enter;
 
             std::string strPass = "";
 
             for (;;) {
                 const char ch[] = {_getch(), '\x00'};
                 const std::string strCH = ch;
                 if (strENTER == strCH) break;
                 strPass.append(strCH);
             }
             strPassword = strPass;
 
 #endif
             theOutput.setPassword(
                 strPassword.c_str(),
                 static_cast<int32_t>(strPassword.length() - 1));
         }
 
         std::cout << std::endl; // new line.
         return true;
     }
 #elif defined(OT_CRYPTO_USING_OPENSSL)
     // todo security: might want to allow to set OTPassword's size and copy
     // directly into it,
     // so that we aren't using this temp buf in between, which, although we're
     // zeroing it, could
     // technically end up getting swapped to disk.
     //
     {
         char buf[_PASSWORD_LEN + 10] = "", buff[_PASSWORD_LEN + 10] = "";
 
         if (UI_UTIL_read_pw(buf, buff, _PASSWORD_LEN, szPrompt, 0) == 0) {
             size_t nPassLength = OTString::safe_strlen(buf, _PASSWORD_LEN);
             theOutput.setPassword_uint8(reinterpret_cast<uint8_t*>(buf),
                                         nPassLength);
             OTPassword::zeroMemory(buf, nPassLength);
             OTPassword::zeroMemory(buff, nPassLength);
             return true;
         }
         else
             return false;
     }
 #else
     {
         otErr << "__FUNCTION__: Open-Transactions is not compiled to collect "
               << "the passphrase from the console!\n";
         return false;
     }
 #endif
 }

void opentxs::OTCrypto::Init ( ) const

Definition at line 646 of file OTCrypto.cpp.

 {
     // This is only supposed to happen once per run.
     //
     if (0 == OTCrypto::s_nCount) {
         ++(OTCrypto::s_nCount);
 
         otWarn << "OT_Init: Setting up rlimits, and crypto library...\n";
 
 // Here is a security measure intended to make it more difficult to capture a
 // core
 // dump. (Not used in debug mode, obviously.)
 //
 #if !defined(PREDEF_MODE_DEBUG) && defined(PREDEF_PLATFORM_UNIX)
         struct rlimit rlim;
         getrlimit(RLIMIT_CORE, &rlim);
         rlim.rlim_max = rlim.rlim_cur = 0;
         if (setrlimit(RLIMIT_CORE, &rlim)) {
             OT_FAIL_MSG("OTCrypto::Init: ASSERT: setrlimit failed. (Used for "
                         "preventing core dumps.)\n");
         }
 #endif
 
         Init_Override();
     }
     else
         otErr << "OTCrypto::Init: ERROR: Somehow this erroneously got called "
                  "more than once! (Doing nothing.)\n";
 }

void opentxs::OTCrypto::Init_Override ( ) const

protectedvirtual

Reimplemented in opentxs::OTCrypto_OpenSSL.

Definition at line 697 of file OTCrypto.cpp.

 {
     otErr << "OTCrypto::Init_Override: ERROR: This function should NEVER be "
              "called (you should be overriding it...)\n";
 }

virtual OTPassword* opentxs::OTCrypto::InstantiateBinarySecret ( ) const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

bool opentxs::OTCrypto::IsBase62 ( const std::string & str ) const

Definition at line 427 of file OTCrypto.cpp.

 {
     return str.find_first_not_of("0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHI"
                                  "JKLMNOPQRSTUVWXYZ") == std::string::npos;
 }

OTCrypto * opentxs::OTCrypto::It ( )

static

Definition at line 630 of file OTCrypto.cpp.

 {
     // Todo: someday, swapping the crypto lib should be as easy as changing this
     // compile flag to OT_CRYPTO_USING_GPG. We'll get there.
     //
     static
 #ifdef OT_CRYPTO_USING_OPENSSL
         OTCrypto_OpenSSL
 #endif
             s_theSingleton; // For now we're only allowing a single instance.
 
     return &s_theSingleton;
 }

virtual bool opentxs::OTCrypto::Open	(	OTData &	dataInput,
		const OTPseudonym &	theRecipient,
		OTString &	theOutput,
		const OTPasswordData *	pPWData = `nullptr`
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::RandomizeMemory	(	uint8_t *	szDestination,
		uint32_t	nNewSize
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::Seal	(	mapOfAsymmetricKeys &	RecipPubKeys,
		const OTString &	theInput,
		OTData &	dataOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual void opentxs::OTCrypto::SetBase62StringFromID	(	const OTIdentifier &	theInput,
		OTString &	strOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual void opentxs::OTCrypto::SetIDFromBase62String	(	const OTString &	strInput,
		OTIdentifier &	theOutput
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::SignContract	(	const OTString &	strContractUnsigned,
		const OTAsymmetricKey &	theKey,
		OTSignature &	theSignature,
		const OTString &	strHashType,
		const OTPasswordData *	pPWData = `nullptr`
	)

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::SignContract	(	const OTString &	strContractUnsigned,
		const OTString &	strSigHashType,
		const std::string &	strCertFileContents,
		OTSignature &	theSignature,
		const OTPasswordData *	pPWData = `nullptr`
	)

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::VerifySignature	(	const OTString &	strContractToVerify,
		const OTAsymmetricKey &	theKey,
		const OTSignature &	theSignature,
		const OTString &	strHashType,
		const OTPasswordData *	pPWData = `nullptr`
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

virtual bool opentxs::OTCrypto::VerifySignature	(	const OTString &	strContractToVerify,
		const OTString &	strSigHashType,
		const std::string &	strCertFileContents,
		const OTSignature &	theSignature,
		const OTPasswordData *	pPWData = `nullptr`
	)		const

pure virtual

Implemented in opentxs::OTCrypto_OpenSSL.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation