Open-Transactions  0.93.0-ge03d287
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OTEnvelope.hpp
Go to the documentation of this file.
1 /************************************************************
2  *
3  * OTEnvelope.hpp
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 #ifndef OPENTXS_CORE_CRYPTO_OTENVELOPE_HPP
134 #define OPENTXS_CORE_CRYPTO_OTENVELOPE_HPP
135 
136 #include "../OTData.hpp"
137 
138 #include <map>
139 #include <set>
140 #include <string>
141 
142 namespace opentxs
143 {
144 
145 class OTASCIIArmor;
146 class OTAsymmetricKey;
147 class OTPassword;
148 class OTPasswordData;
149 class OTPseudonym;
150 class OTString;
151 class OTSymmetricKey;
152 
153 typedef std::multimap<std::string, OTAsymmetricKey*> mapOfAsymmetricKeys;
154 typedef std::set<OTPseudonym*> setOfNyms;
155 
157 {
158  friend class OTPayload;
159 
160  OTData m_dataContents; // Stores only encrypted contents.
161 
162 public:
163  EXPORT OTEnvelope();
164  EXPORT OTEnvelope(const OTASCIIArmor& theArmoredText);
165  EXPORT OTEnvelope(const OTString& strArmorWithBookends);
166  EXPORT virtual ~OTEnvelope();
167 
168  // SYMMETRIC CRYPTO (AES)
169 
170  EXPORT bool Encrypt(const OTString& theInput, OTSymmetricKey& theKey,
171  const OTPassword& thePassword);
172  EXPORT bool Decrypt(OTString& theOutput, const OTSymmetricKey& theKey,
173  const OTPassword& thePassword);
174 
175  // ASYMMETRIC CRYPTO (RSA / AES)
176 
177  // Single recipient:
178  //
179  EXPORT bool Seal(const OTPseudonym& theRecipient,
180  const OTString& theInput); // Put data into this object
181  // with Seal().
182  EXPORT bool Seal(const OTAsymmetricKey& RecipPubKey,
183  const OTString& theInput); // Currently supports strings
184  // only.
185 
186  // Multiple recipients:
187  //
188  EXPORT bool Seal(setOfNyms& theRecipients,
189  const OTString& theInput); // Same as above, except
190  // supports multiple recipients.
191  EXPORT bool Seal(mapOfAsymmetricKeys& RecipPubKeys,
192  const OTString& theInput); // Same as above, except
193  // supports multiple recipients.
194 
195  // (Opposite of Seal.)
196  //
197  EXPORT bool Open(const OTPseudonym& theRecipient, OTString& theOutput,
198  const OTPasswordData* pPWData = nullptr);
199 
200  // Should be called "Get Envelope's binary Ciphertext data into an
201  // Ascii-Armored output String."
202  //
203  // Presumably this Envelope contains encrypted data (in binary form.)
204  // If you would like an ASCII-armored version of that data, just call this
205  // function.
206  // (Bookends not included.)
207  //
208  EXPORT bool GetAsciiArmoredData(OTASCIIArmor& theArmoredText,
209  bool bLineBreaks = true) const;
210  EXPORT bool GetAsBookendedString(OTString& strArmorWithBookends,
211  bool bEscaped = false) const;
212 
213  // Should be called "Set This Envelope's binary ciphertext data, from an
214  // ascii-armored input string."
215  //
216  // Let's say you just retrieved the ASCII-armored contents of an encrypted
217  // envelope.
218  // Perhaps someone sent it to you, and you just read it out of his message.
219  // And let's say you want to get those contents back into binary form in an
220  // Envelope object again, so that they can be decrypted and extracted back
221  // as
222  // plaintext. Fear not, just call this function.
223  //
224  EXPORT bool SetAsciiArmoredData(const OTASCIIArmor& theArmoredText,
225  bool bLineBreaks = true);
226  EXPORT bool SetFromBookendedString(const OTString& strArmorWithBookends,
227  bool bEscaped = false);
228 };
229 
230 } // namespace opentxs
231 
232 #endif // OPENTXS_CORE_CRYPTO_OTENVELOPE_HPP
EXPORT bool Decrypt(OTString &theOutput, const OTSymmetricKey &theKey, const OTPassword &thePassword)
Definition: OTEnvelope.cpp:364
EXPORT bool GetAsBookendedString(OTString &strArmorWithBookends, bool bEscaped=false) const
Definition: OTEnvelope.cpp:184
std::set< OTPseudonym * > setOfNyms
Definition: OTEnvelope.hpp:154
EXPORT bool SetAsciiArmoredData(const OTASCIIArmor &theArmoredText, bool bLineBreaks=true)
Definition: OTEnvelope.cpp:178
EXPORT bool Open(const OTPseudonym &theRecipient, OTString &theOutput, const OTPasswordData *pPWData=nullptr)
Definition: OTEnvelope.cpp:581
EXPORT bool Seal(const OTPseudonym &theRecipient, const OTString &theInput)
Definition: OTEnvelope.cpp:521
EXPORT bool Encrypt(const OTString &theInput, OTSymmetricKey &theKey, const OTPassword &thePassword)
Definition: OTEnvelope.cpp:245
EXPORT bool GetAsciiArmoredData(OTASCIIArmor &theArmoredText, bool bLineBreaks=true) const
Definition: OTEnvelope.cpp:162
virtual EXPORT ~OTEnvelope()
Definition: OTEnvelope.cpp:634
std::multimap< std::string, OTAsymmetricKey * > mapOfAsymmetricKeys
Definition: OTCrypto.hpp:155
EXPORT bool SetFromBookendedString(const OTString &strArmorWithBookends, bool bEscaped=false)
Definition: OTEnvelope.cpp:212