OTPayload.cpp

Go to the documentation of this file.

/************************************************************
 *
 *  OTPayload.cpp
 *
 */

/************************************************************
 -----BEGIN PGP SIGNED MESSAGE-----
 Hash: SHA1

 *                 OPEN TRANSACTIONS
 *
 *       Financial Cryptography and Digital Cash
 *       Library, Protocol, API, Server, CLI, GUI
 *
 *       -- Anonymous Numbered Accounts.
 *       -- Untraceable Digital Cash.
 *       -- Triple-Signed Receipts.
 *       -- Cheques, Vouchers, Transfers, Inboxes.
 *       -- Basket Currencies, Markets, Payment Plans.
 *       -- Signed, XML, Ricardian-style Contracts.
 *       -- Scripted smart contracts.
 *
 *  Copyright (C) 2010-2013 by "Fellow Traveler" (A pseudonym)
 *
 *  EMAIL:
 *  [email protected]
 *
 *  BITCOIN:  1NtTPVVjDsUfDWybS4BwvHpG2pdS9RnYyQ
 *
 *  KEY FINGERPRINT (PGP Key in license file):
 *  9DD5 90EB 9292 4B48 0484  7910 0308 00ED F951 BB8E
 *
 *  OFFICIAL PROJECT WIKI(s):
 *  https://github.com/FellowTraveler/Moneychanger
 *  https://github.com/FellowTraveler/Open-Transactions/wiki
 *
 *  WEBSITE:
 *  http://www.OpenTransactions.org/
 *
 *  Components and licensing:
 *   -- Moneychanger..A Java client GUI.....LICENSE:.....GPLv3
 *   -- otlib.........A class library.......LICENSE:...LAGPLv3
 *   -- otapi.........A client API..........LICENSE:...LAGPLv3
 *   -- opentxs/ot....Command-line client...LICENSE:...LAGPLv3
 *   -- otserver......Server Application....LICENSE:....AGPLv3
 *  Github.com/FellowTraveler/Open-Transactions/wiki/Components
 *
 *  All of the above OT components were designed and written by
 *  Fellow Traveler, with the exception of Moneychanger, which
 *  was contracted out to Vicky C ([email protected]).
 *  The open-source community has since actively contributed.
 *
 *  -----------------------------------------------------
 *
 *   LICENSE:
 *   This program is free software: you can redistribute it
 *   and/or modify it under the terms of the GNU Affero
 *   General Public License as published by the Free Software
 *   Foundation, either version 3 of the License, or (at your
 *   option) any later version.
 *
 *   ADDITIONAL PERMISSION under the GNU Affero GPL version 3
 *   section 7: (This paragraph applies only to the LAGPLv3
 *   components listed above.) If you modify this Program, or
 *   any covered work, by linking or combining it with other
 *   code, such other code is not for that reason alone subject
 *   to any of the requirements of the GNU Affero GPL version 3.
 *   (==> This means if you are only using the OT API, then you
 *   don't have to open-source your code--only your changes to
 *   Open-Transactions itself must be open source. Similar to
 *   LGPLv3, except it applies to software-as-a-service, not
 *   just to distributing binaries.)
 *
 *   Extra WAIVER for OpenSSL, Lucre, and all other libraries
 *   used by Open Transactions: This program is released under
 *   the AGPL with the additional exemption that compiling,
 *   linking, and/or using OpenSSL is allowed. The same is true
 *   for any other open source libraries included in this
 *   project: complete waiver from the AGPL is hereby granted to
 *   compile, link, and/or use them with Open-Transactions,
 *   according to their own terms, as long as the rest of the
 *   Open-Transactions terms remain respected, with regard to
 *   the Open-Transactions code itself.
 *
 *   Lucre License:
 *   This code is also "dual-license", meaning that Ben Lau-
 *   rie's license must also be included and respected, since
 *   the code for Lucre is also included with Open Transactions.
 *   See Open-Transactions/src/otlib/lucre/LUCRE_LICENSE.txt
 *   The Laurie requirements are light, but if there is any
 *   problem with his license, simply remove the Lucre code.
 *   Although there are no other blind token algorithms in Open
 *   Transactions (yet. credlib is coming), the other functions
 *   will continue to operate.
 *   See Lucre on Github:  https://github.com/benlaurie/lucre
 *   -----------------------------------------------------
 *   You should have received a copy of the GNU Affero General
 *   Public License along with this program.  If not, see:
 *   http://www.gnu.org/licenses/
 *
 *   If you would like to use this software outside of the free
 *   software license, please contact FellowTraveler.
 *   (Unfortunately many will run anonymously and untraceably,
 *   so who could really stop them?)
 *
 *   DISCLAIMER:
 *   This program is distributed in the hope that it will be
 *   useful, but WITHOUT ANY WARRANTY; without even the implied
 *   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 *   PURPOSE.  See the GNU Affero General Public License for
 *   more details.

 -----BEGIN PGP SIGNATURE-----
 Version: GnuPG v1.4.9 (Darwin)

 iQIcBAEBAgAGBQJRSsfJAAoJEAMIAO35UbuOQT8P/RJbka8etf7wbxdHQNAY+2cC
 vDf8J3X8VI+pwMqv6wgTVy17venMZJa4I4ikXD/MRyWV1XbTG0mBXk/7AZk7Rexk
 KTvL/U1kWiez6+8XXLye+k2JNM6v7eej8xMrqEcO0ZArh/DsLoIn1y8p8qjBI7+m
 aE7lhstDiD0z8mwRRLKFLN2IH5rAFaZZUvj5ERJaoYUKdn4c+RcQVei2YOl4T0FU
 LWND3YLoH8naqJXkaOKEN4UfJINCwxhe5Ke9wyfLWLUO7NamRkWD2T7CJ0xocnD1
 sjAzlVGNgaFDRflfIF4QhBx1Ddl6wwhJfw+d08bjqblSq8aXDkmFA7HeunSFKkdn
 oIEOEgyj+veuOMRJC5pnBJ9vV+7qRdDKQWaCKotynt4sWJDGQ9kWGWm74SsNaduN
 TPMyr9kNmGsfR69Q2Zq/FLcLX/j8ESxU+HYUB4vaARw2xEOu2xwDDv6jt0j3Vqsg
 x7rWv4S/Eh18FDNDkVRChiNoOIilLYLL6c38uMf1pnItBuxP3uhgY6COm59kVaRh
 nyGTYCDYD2TK+fI9o89F1297uDCwEJ62U0Q7iTDp5QuXCoxkPfv8/kX6lS6T3y9G
 M9mqIoLbIQ1EDntFv7/t6fUTS2+46uCrdZWbQ5RjYXdrzjij02nDmJAm2BngnZvd
 kamH0Y/n11lCvo1oQxM+
 =uSzz
 -----END PGP SIGNATURE-----
 **************************************************************/

#include "stdafx.hpp"

#include "OTPayload.hpp"

#include "util/OTDataCheck.hpp"
#include "crypto/OTEnvelope.hpp"
#include "OTLog.hpp"
#include "OTMessage.hpp"

namespace opentxs
{

OTPayload::OTPayload()
    : OTData()
{
}

OTPayload::OTPayload(const void* pNewData, uint32_t nNewSize)
    : OTData(pNewData, nNewSize)
{
}

OTPayload::OTPayload(const OTPayload& rhs)
    : OTData(rhs)
{
}

OTPayload::OTPayload(const OTASCIIArmor& theSource)
    : OTData(theSource)
{
}

OTPayload::~OTPayload()
{
}

uint32_t OTPayload::ReadBytesFrom(OTData& theData, uint32_t lSize)
{
    OT_ASSERT(theData.GetSize() >= lSize);

    // The size requested to read MUST be less or equal to size of theData
    if (theData.GetSize() < lSize) abort();

    OTPayload& refPayload = (OTPayload&)theData; // todo fix this cast.

    // Copy from theData to this, up until lSize
    Assign(refPayload.GetPayloadPointer(), lSize);

    // Create a temp var, starting from theData+lSize, copying to the end of
    // theData
    OTData TEMPdata((uint8_t*)refPayload.GetPayloadPointer() + lSize,
                    theData.GetSize() - lSize);

    // theData is assigned to TEMPdata (thus removing from it the bytes that we
    // just read into this.)
    theData.Assign(TEMPdata);

    return lSize;
}

// Envelope copied into payload to prepare for sending.
bool OTPayload::SetEnvelope(const OTEnvelope& theEnvelope)
{
    OTASCIIArmor theArmor;

    if (theEnvelope.GetAsciiArmoredData(theArmor)) {
        uint32_t lSize = theArmor.GetLength() + 1; //+1 for the null terminater

        if (theArmor.GetLength()) {
            SetPayloadSize(lSize + 1); // +1 for the checksum byte.

            // Copy it in.
            memcpy((void*)GetPointer(), theArmor.Get(), lSize);

            // Add the checksum, success.
            AppendChecksum((OT_BYTE*)GetPointer(), lSize);
            return true;
        }
    }
    return false;
}

bool OTPayload::SetMessagePayload(const OTMessage& theMessage)
{
    uint32_t lSize =
        theMessage.m_strRawFile.GetLength() + 1; //+1 for the null terminater

    if (theMessage.m_strRawFile.GetLength()) {
        SetPayloadSize(lSize + 1); // +1 for the checksum byte.
        memcpy((void*)GetPointer(), theMessage.m_strRawFile.Get(), lSize);

        // Add the checksum
        AppendChecksum((OT_BYTE*)GetPointer(), lSize);
        return true;
    }
    return false;
}

// Envelope retrieved from payload.
bool OTPayload::GetEnvelope(OTEnvelope& theEnvelope) const
{
    // validate checksum
    uint32_t lSize = GetSize();
    uint32_t lIndex = lSize - 2; // the index to where the nullptr terminator
                                 // SHOULD be if they
    // sent us a base64-encoded string, containing an encrypted message. (which
    // we expect...)

    // (lSize-1 would be the location of the checksum at the end.)
    if (0 == lSize) return false;

    if (IsChecksumValid((OT_BYTE*)GetPointer(), (uint32_t)lSize)) {
        // We add the null-terminator ourselves at this point, for security
        // reasons,
        // since we will process the data, soon after this function, as a
        // string.
        ((OT_BYTE*)GetPointer())[lIndex] = 0;

        theEnvelope.m_dataContents.Release();

        OTASCIIArmor theArmor;
        // Why is this safe, where I cast the Payload data pointer as
        // a char * and tell the data object to set itself from that?
        // Because (1) I just validated the checksum, and
        // (2) There place where the nullptr should be, I set to 0, by hand,
        // just above 2 lines. So when this set operation occurs, the
        // farthest it will go is to that 0.
        theArmor.Set((const char*)GetPointer());

        // Todo NOTE: If I ever want to process bookends here instead of
        // assuming they aren't there,
        // IT'S VERY EASY!! All I have to do is call theArmor.LoadFromString
        // instead of theArmor.Set.

        // Now the ascii-armored string that was sent across is decoded back to
        // binary into the
        // Envelope object.
        theEnvelope.SetAsciiArmoredData(theArmor);
        return true;
    }
    else {
        otErr << "Invalid Checksum in OTPayload::GetEnvelope\n";
        return false;
    }
}

// Message retrieved from Payload
bool OTPayload::GetMessagePayload(OTMessage& theMessage) const
{
    // validate checksum
    uint32_t lSize = GetSize();
    uint32_t lIndex = lSize - 2; // the index to where the nullptr terminator
                                 // SHOULD be if they
    // sent us a string like they were supposed to. (A contract.)
    // (nSize-1 would be the location of the checksum at the end.)
    if (0 == lSize) return false;

    if (IsChecksumValid((OT_BYTE*)GetPointer(), (uint32_t)lSize)) {
        // We add the null-terminator ourselves at this point, for security
        // reasons,
        // since we will process the data, after this point, as a string.
        ((OT_BYTE*)GetPointer())[lIndex] = 0;

        theMessage.Release();

        // Why is this safe, where I cast the Payload data pointer as
        // a char * and tell the string to set itself from that?
        // Because (1) I just validated the checksum, and
        // (2) There place where the nullptr should be, I set to 0, by hand,
        // just above 2 lines. So when this set operation occurs, the
        // farthest it will go is to that 0.
        theMessage.m_strRawFile.Set((const char*)GetPointer());
        return true;
    }
    else {
        otErr << "Invalid Checksum in OTPayload::GetMessage\n";
        return false;
    }
}

void OTPayload::SetPayloadSize(uint32_t lNewSize)
{
    SetSize(lNewSize);
}

const void* OTPayload::GetPayloadPointer() const
{
    return GetPointer();
}

} // namespace opentxs