Open-Transactions  0.93.0-ge03d287
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OTSignedFile.cpp
Go to the documentation of this file.
1 /************************************************************
2  *
3  * OTSignedFile.cpp
4  *
5  */
6 
7 /************************************************************
8  -----BEGIN PGP SIGNED MESSAGE-----
9  Hash: SHA1
10 
11  * OPEN TRANSACTIONS
12  *
13  * Financial Cryptography and Digital Cash
14  * Library, Protocol, API, Server, CLI, GUI
15  *
16  * -- Anonymous Numbered Accounts.
17  * -- Untraceable Digital Cash.
18  * -- Triple-Signed Receipts.
19  * -- Cheques, Vouchers, Transfers, Inboxes.
20  * -- Basket Currencies, Markets, Payment Plans.
21  * -- Signed, XML, Ricardian-style Contracts.
22  * -- Scripted smart contracts.
23  *
24  * Copyright (C) 2010-2013 by "Fellow Traveler" (A pseudonym)
25  *
26  * EMAIL:
28  *
29  * BITCOIN: 1NtTPVVjDsUfDWybS4BwvHpG2pdS9RnYyQ
30  *
31  * KEY FINGERPRINT (PGP Key in license file):
32  * 9DD5 90EB 9292 4B48 0484 7910 0308 00ED F951 BB8E
33  *
34  * OFFICIAL PROJECT WIKI(s):
35  * https://github.com/FellowTraveler/Moneychanger
36  * https://github.com/FellowTraveler/Open-Transactions/wiki
37  *
38  * WEBSITE:
39  * http://www.OpenTransactions.org/
40  *
41  * Components and licensing:
42  * -- Moneychanger..A Java client GUI.....LICENSE:.....GPLv3
43  * -- otlib.........A class library.......LICENSE:...LAGPLv3
44  * -- otapi.........A client API..........LICENSE:...LAGPLv3
45  * -- opentxs/ot....Command-line client...LICENSE:...LAGPLv3
46  * -- otserver......Server Application....LICENSE:....AGPLv3
47  * Github.com/FellowTraveler/Open-Transactions/wiki/Components
48  *
49  * All of the above OT components were designed and written by
50  * Fellow Traveler, with the exception of Moneychanger, which
51  * was contracted out to Vicky C ([email protected]).
52  * The open-source community has since actively contributed.
53  *
54  * -----------------------------------------------------
55  *
56  * LICENSE:
57  * This program is free software: you can redistribute it
58  * and/or modify it under the terms of the GNU Affero
59  * General Public License as published by the Free Software
60  * Foundation, either version 3 of the License, or (at your
61  * option) any later version.
62  *
63  * ADDITIONAL PERMISSION under the GNU Affero GPL version 3
64  * section 7: (This paragraph applies only to the LAGPLv3
65  * components listed above.) If you modify this Program, or
66  * any covered work, by linking or combining it with other
67  * code, such other code is not for that reason alone subject
68  * to any of the requirements of the GNU Affero GPL version 3.
69  * (==> This means if you are only using the OT API, then you
70  * don't have to open-source your code--only your changes to
71  * Open-Transactions itself must be open source. Similar to
72  * LGPLv3, except it applies to software-as-a-service, not
73  * just to distributing binaries.)
74  *
75  * Extra WAIVER for OpenSSL, Lucre, and all other libraries
76  * used by Open Transactions: This program is released under
77  * the AGPL with the additional exemption that compiling,
78  * linking, and/or using OpenSSL is allowed. The same is true
79  * for any other open source libraries included in this
80  * project: complete waiver from the AGPL is hereby granted to
81  * compile, link, and/or use them with Open-Transactions,
82  * according to their own terms, as long as the rest of the
83  * Open-Transactions terms remain respected, with regard to
84  * the Open-Transactions code itself.
85  *
86  * Lucre License:
87  * This code is also "dual-license", meaning that Ben Lau-
88  * rie's license must also be included and respected, since
89  * the code for Lucre is also included with Open Transactions.
90  * See Open-Transactions/src/otlib/lucre/LUCRE_LICENSE.txt
91  * The Laurie requirements are light, but if there is any
92  * problem with his license, simply remove the Lucre code.
93  * Although there are no other blind token algorithms in Open
94  * Transactions (yet. credlib is coming), the other functions
95  * will continue to operate.
96  * See Lucre on Github: https://github.com/benlaurie/lucre
97  * -----------------------------------------------------
98  * You should have received a copy of the GNU Affero General
99  * Public License along with this program. If not, see:
100  * http://www.gnu.org/licenses/
101  *
102  * If you would like to use this software outside of the free
103  * software license, please contact FellowTraveler.
104  * (Unfortunately many will run anonymously and untraceably,
105  * so who could really stop them?)
106  *
107  * DISCLAIMER:
108  * This program is distributed in the hope that it will be
109  * useful, but WITHOUT ANY WARRANTY; without even the implied
110  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
111  * PURPOSE. See the GNU Affero General Public License for
112  * more details.
113 
114  -----BEGIN PGP SIGNATURE-----
115  Version: GnuPG v1.4.9 (Darwin)
116 
117  iQIcBAEBAgAGBQJRSsfJAAoJEAMIAO35UbuOQT8P/RJbka8etf7wbxdHQNAY+2cC
118  vDf8J3X8VI+pwMqv6wgTVy17venMZJa4I4ikXD/MRyWV1XbTG0mBXk/7AZk7Rexk
119  KTvL/U1kWiez6+8XXLye+k2JNM6v7eej8xMrqEcO0ZArh/DsLoIn1y8p8qjBI7+m
120  aE7lhstDiD0z8mwRRLKFLN2IH5rAFaZZUvj5ERJaoYUKdn4c+RcQVei2YOl4T0FU
121  LWND3YLoH8naqJXkaOKEN4UfJINCwxhe5Ke9wyfLWLUO7NamRkWD2T7CJ0xocnD1
122  sjAzlVGNgaFDRflfIF4QhBx1Ddl6wwhJfw+d08bjqblSq8aXDkmFA7HeunSFKkdn
123  oIEOEgyj+veuOMRJC5pnBJ9vV+7qRdDKQWaCKotynt4sWJDGQ9kWGWm74SsNaduN
124  TPMyr9kNmGsfR69Q2Zq/FLcLX/j8ESxU+HYUB4vaARw2xEOu2xwDDv6jt0j3Vqsg
125  x7rWv4S/Eh18FDNDkVRChiNoOIilLYLL6c38uMf1pnItBuxP3uhgY6COm59kVaRh
126  nyGTYCDYD2TK+fI9o89F1297uDCwEJ62U0Q7iTDp5QuXCoxkPfv8/kX6lS6T3y9G
127  M9mqIoLbIQ1EDntFv7/t6fUTS2+46uCrdZWbQ5RjYXdrzjij02nDmJAm2BngnZvd
128  kamH0Y/n11lCvo1oQxM+
129  =uSzz
130  -----END PGP SIGNATURE-----
131  **************************************************************/
132 
133 #include "stdafx.hpp"
134 
135 #include "crypto/OTSignedFile.hpp"
136 
137 #include "crypto/OTASCIIArmor.hpp"
138 #include "OTLog.hpp"
139 #include "OTStorage.hpp"
140 
141 #include <irrxml/irrXML.hpp>
142 
143 namespace opentxs
144 {
145 
147 {
148  return m_strSignedFilePayload;
149 }
150 
152 {
153  m_strSignedFilePayload = strArg;
154 }
155 
157 {
158  return m_strSignerNymID;
159 }
160 
162 {
163  m_strSignerNymID = strArg;
164 }
165 
167 {
168 
169  OTString strSignerNym("");
170  if (m_strSignerNymID.Exists()) {
171  strSignerNym.Format("\n signer=\"%s\"", m_strSignerNymID.Get());
172  }
173 
174  // I release this because I'm about to repopulate it.
176 
177  m_xmlUnsigned.Concatenate("<?xml version=\"%s\"?>\n\n", "1.0");
178 
179  m_xmlUnsigned.Concatenate("<signedFile\n version=\"%s\"\n"
180  " localDir=\"%s\"\n"
181  " filename=\"%s\"%s"
182  " >\n\n",
184  m_strSignedFilename.Get(), strSignerNym.Get());
185 
188  m_xmlUnsigned.Concatenate("<filePayload>\n%s</filePayload>\n\n",
189  ascPayload.Get());
190  }
191 
192  m_xmlUnsigned.Concatenate("</signedFile>\n");
193 }
194 
196 {
197  int32_t nReturnVal = 0;
198 
199  // Here we call the parent class first.
200  // If the node is found there, or there is some error,
201  // then we just return either way. But if it comes back
202  // as '0', then nothing happened, and we'll continue executing.
203  //
204  // -- Note you can choose not to call the parent if
205  // you don't want to use any of those xml tags.
206  // As I do below, in the case of OTAccount.
207  // if (nReturnVal = ot_super::ProcessXMLNode(xml))
208  // return nReturnVal;
209 
210  if (!strcmp("signedFile", xml->getNodeName())) {
211  m_strVersion = xml->getAttributeValue("version");
212 
213  m_strPurportedLocalDir = xml->getAttributeValue("localDir");
214  m_strPurportedFilename = xml->getAttributeValue("filename");
215  m_strSignerNymID = xml->getAttributeValue("signer");
216 
217  nReturnVal = 1;
218  }
219  else if (!strcmp("filePayload", xml->getNodeName())) {
220  if (false ==
222  otErr << "Error in OTSignedFile::ProcessXMLNode: filePayload field "
223  "without value.\n";
224  return (-1); // error condition
225  }
226 
227  return 1;
228  }
229 
230  return nReturnVal;
231 }
232 
233 // We just loaded a certain subdirectory/filename
234 // This file also contains that information within it.
235 // This function allows me to compare the two and make sure
236 // the file that I loaded is what it claims to be.
237 //
238 // Make sure you also VerifySignature() whenever doing something
239 // like this :-)
240 //
241 // Assumes SetFilename() has been set, and that LoadFile() has just been called.
243 {
246  return true;
247 
248  otErr << __FUNCTION__ << ": Failed verifying signed file:\n"
249  "Expected directory: " << m_strLocalDir
250  << " Found: " << m_strPurportedLocalDir
251  << "\n"
252  "Expected filename: " << m_strSignedFilename
253  << " Found: " << m_strPurportedFilename << "\n";
254  return false;
255 }
256 
258  const OTString& FILE_NAME)
259  : ot_super()
260 {
261  m_strContractType.Set("FILE");
262 
263  SetFilename(LOCAL_SUBDIR, FILE_NAME);
264 }
265 
266 OTSignedFile::OTSignedFile(const char* LOCAL_SUBDIR, const OTString& FILE_NAME)
267  : ot_super()
268 {
269  m_strContractType.Set("FILE");
270 
271  OTString strLocalSubdir(LOCAL_SUBDIR);
272 
273  SetFilename(strLocalSubdir, FILE_NAME);
274 }
275 
276 OTSignedFile::OTSignedFile(const char* LOCAL_SUBDIR, const char* FILE_NAME)
277  : ot_super()
278 {
279  m_strContractType.Set("FILE");
280 
281  OTString strLocalSubdir(LOCAL_SUBDIR), strFile_Name(FILE_NAME);
282 
283  SetFilename(strLocalSubdir, strFile_Name);
284 }
285 
286 // This is entirely separate from the OTContract saving methods. This is
287 // specifically
288 // for saving the internal file payload based on the internal file information,
289 // which
290 // this method assumes has already been set (using SetFilename())
292 {
293  const OTString strTheFileName(m_strFilename);
294  const OTString strTheFolderName(m_strFoldername);
295 
296  // OTContract doesn't natively make it easy to save a contract to its own
297  // filename.
298  // Funny, I know, but OTContract is designed to save either to a specific
299  // filename,
300  // or to a string parameter, or to the internal rawfile member. It doesn't
301  // normally
302  // save to its own filename that was used to load it. But OTSignedFile is
303  // different...
304 
305  // This saves to a file, the name passed in as a char *.
306  return SaveContract(strTheFolderName.Get(), strTheFileName.Get());
307 }
308 
309 // Assumes SetFilename() has already been set.
311 {
312  // otOut << "DEBUG LoadFile (Signed) folder: %s file: %s \n",
313  // m_strFoldername.Get(), m_strFilename.Get());
314 
316  return LoadContract();
317 
318  return false;
319 }
320 
321 void OTSignedFile::SetFilename(const OTString& LOCAL_SUBDIR,
322  const OTString& FILE_NAME)
323 {
324  // OTSignedFile specific variables.
325  m_strLocalDir = LOCAL_SUBDIR;
326  m_strSignedFilename = FILE_NAME;
327 
328  // OTContract variables.
331 
332  /*
333  m_strFilename.Format("%s%s" // data_folder/
334  "%s%s" // nyms/
335  "%s", // 5bf9a88c.nym
336  OTLog::Path(), OTLog::PathSeparator(),
337  m_strLocalDir.Get(), OTLog::PathSeparator(),
338  m_strSignedFilename.Get());
339  */
340  // Software Path + Local Sub-directory + Filename
341  //
342  // Finished Product: "transaction/nyms/5bf9a88c.nym"
343 }
344 
346  : ot_super()
347 {
348  m_strContractType.Set("FILE");
349 }
350 
352 {
354 }
355 
357 {
358  m_strSignedFilePayload.Release(); // This is the file contents we were
359  // wrapping.
360  // We can release this now.
361 
362  // m_strLocalDir.Release(); // We KEEP these, *not* release,
363  // because LoadContract()
364  // m_strSignedFilename.Release(); // calls Release(), and these
365  // are our core values. We don't
366  // want to lose them when the file is loaded.
367 
368  // Note: Additionally, neither does OTContract release m_strFilename here,
369  // for the SAME reason.
370 
373 }
374 
376 {
378 
380 
381  m_strContractType.Set("FILE");
382 }
383 
384 bool OTSignedFile::SaveContractWallet(std::ofstream&) const
385 {
386  return true;
387 }
388 
389 } // namespace opentxs
EXPORT void SetSignerNymID(const OTString &strArg)
EXPORT OTString & GetFilePayload()
EXPORT bool SaveContract()
virtual void UpdateContents()
virtual EXPORT ~OTSignedFile()
EXPORT bool SaveFile()
virtual int32_t ProcessXMLNode(irr::io::IrrXMLReader *&xml)
EXPORT void Concatenate(const char *arg,...)
Definition: OTString.cpp:1334
EXPORT bool Exists() const
Definition: OTString.cpp:1035
EXPORT void Format(const char *fmt,...)
Definition: OTString.cpp:1319
EXPORT bool Compare(const char *compare) const
Definition: OTString.cpp:1102
EXPORT void Set(const char *data, uint32_t enforcedMaxLength=0)
Definition: OTString.cpp:1055
EXPORT void SetFilePayload(const OTString &strArg)
static EXPORT bool LoadEncodedTextField(irr::io::IrrXMLReader *&xml, OTASCIIArmor &ascOutput)
OTString m_strContractType
Definition: OTContract.hpp:178
virtual EXPORT bool LoadContract()
EXPORT OTString & GetSignerNymID()
OTStringXML m_xmlUnsigned
Definition: OTContract.hpp:174
EXPORT const char * Get() const
Definition: OTString.cpp:1045
OTLOG_IMPORT OTLogStream otErr
virtual bool SaveContractWallet(std::ofstream &ofs) const
virtual EXPORT void Release()
Definition: OTContract.cpp:277
EXPORT bool Exists(std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
Definition: OTStorage.cpp:584
virtual void Release()
void SetFilename(const OTString &LOCAL_SUBDIR, const OTString &FILE_NAME)
virtual EXPORT void Release()
Definition: OTString.cpp:765
EXPORT bool LoadFile()
OTString m_strFoldername
Definition: OTContract.hpp:169