├── .gitignore
├── Algorithm.cpp
├── CMakeLists.txt
├── CustomHeader.cpp
├── LICENSE
├── README.md
├── headers
    ├── Algorithm.h
    ├── CustomHeader.h
    └── main.h
├── install.sh
└── main.cpp


/.gitignore:
--------------------------------------------------------------------------------
1 | .vscode
2 | build


--------------------------------------------------------------------------------
/Algorithm.cpp:
--------------------------------------------------------------------------------
  1 | #include <iostream>
  2 | #include "headers/Algorithm.h"
  3 | 
  4 | using namespace std;
  5 | 
  6 | int PlayWithWaveBuffer(vector<char>& buffer, string& msg, string& inputExt)
  7 | {
  8 |     char* modulusBytes = new char[4] {0}; // Max number of modulus in bytes
  9 |     char* customHeader = new char[MY_HEADER] {0}; // Custom header
 10 |     string fileExtension = "";
 11 | 
 12 |     string end = "@<;;";
 13 |     msg += end;
 14 | 
 15 |     // How many times the buffer is bigger than the message
 16 |     long modulus = ((buffer.size() - WAV_HEADER - START_SPACE) / (msg.size() + MY_HEADER));
 17 | 
 18 |     cout << "[\033[0;92m+\033[0;0m] Spreading level: " << "\033[0;92m" << modulus << "\033[0;0m" << endl;
 19 | 
 20 |     // Verify if it is safe to hide the message. Must me at must half the size of the space avaible
 21 |     if(modulus <= 3)
 22 |     {
 23 |         cout << "[\033[0;91m-\033[0;0m] \033[0;91mThe message might be to big for the audio file\033[0;0m" << endl;
 24 |         return ERROR;
 25 |     }
 26 | 
 27 |     CreateHeader(modulus, modulusBytes, customHeader, fileExtension, false);
 28 | 
 29 |     int n = 0;
 30 |     int pos = 0;
 31 | 
 32 |     // Write my custom header first (Spread)
 33 |     for (vector<char>::iterator it = buffer.begin() + WAV_HEADER + START_SPACE;
 34 |          it != buffer.end(); ++it)
 35 |     {
 36 |         if (n % MY_HEADER_MODULE == 0)
 37 |         {
 38 |             *it = customHeader[pos];
 39 |             pos++;
 40 |             //cout << "Header -> " << *it << endl; // Uncomment this to see the message being written
 41 | 
 42 |             if (pos == MY_HEADER)
 43 |             {
 44 |                 cout << "[\033[0;92m+\033[0;0m] \033[0;92mHeader Written Successfully...\033[0;0m" << endl;
 45 |                 break;
 46 |             }
 47 |         }
 48 |         n++;
 49 |     }
 50 | 
 51 |     // Delete arrays we are not using it anymore
 52 |     modulusBytes = new char[1]; // Relocate memory
 53 |     delete[] modulusBytes;
 54 |     delete[] customHeader;
 55 | 
 56 |     int j = 0;
 57 |     pos = 0;
 58 |     // Since the actual data of the wav starts at byte 44. Everything above is just header things that we don't care atm
 59 |     for (vector<char>::iterator it = buffer.begin() + WAV_HEADER + n + MY_HEADER_MODULE + START_SPACE;
 60 |          it != buffer.end(); ++it)
 61 |     {
 62 |         if (j % modulus == 0)
 63 |         {
 64 |             *it = msg.at(pos);
 65 |             pos++;
 66 |             //cout << *it << endl; // Uncomment this to see the message being written
 67 | 
 68 |             if (pos >= msg.size())
 69 |                 break;
 70 |         }
 71 |         j++;
 72 |     }
 73 | 
 74 |     if (pos < msg.size())
 75 |     {
 76 |         cout << "[\033[0;91m*\033[0;0m] \033[0;91mMaybe the whole file was not written in\033[0;0m" << endl;
 77 |     }
 78 | 
 79 |     return OutputBindedData(buffer, inputExt);
 80 | }
 81 | 
 82 | int PlayWithWaveBuffer(vector<char>& buffer, vector<char>& msgBuffer, string& fileExtension, string& inputExt)
 83 | {
 84 |     char* modulusBytes = new char[4] {0}; // Max number of modulus in bytes
 85 |     char* customHeader = new char[MY_HEADER] {0}; // Custom header
 86 | 
 87 |     if (buffer.size()/4 <= msgBuffer.size())
 88 |     {
 89 |         cout << "[\033[0;91m-\033[0;0m] \033[0;91mThe message might be to big for the audio file\033[0;0m" << endl;
 90 |         return ERROR;
 91 |     }
 92 | 
 93 |     msgBuffer.push_back('@');
 94 |     msgBuffer.push_back('<');
 95 |     msgBuffer.push_back(';');
 96 |     msgBuffer.push_back(';');
 97 | 
 98 |     // How many times the buffer is bigger than the message
 99 |     // buffer.size() - (HEADER SIZE = 44 bytes) - (My own tags to de hidden file = 3 bytes)
100 |     long modulus = ((buffer.size() - WAV_HEADER - START_SPACE) / (msgBuffer.size() + MY_HEADER));
101 | 
102 |     cout << "[\033[0;92m+\033[0;0m] Spreading level: " << "\033[0;92m" << modulus << "\033[0;0m" << endl;
103 | 
104 |     // Verify if it is safe to hide the message. Must me at must half the size of the space avaible
105 |     if(modulus <= 3)
106 |     {
107 |         cout << "[\033[0;91m-\033[0;0m] \033[0;91mThe message might be to big for the audio file\033[0;0m" << endl;
108 |         return ERROR;
109 |     }
110 | 
111 |     CreateHeader(modulus, modulusBytes, customHeader, fileExtension, true);
112 | 
113 |     int n = 0;
114 |     int pos = 0;
115 | 
116 |     // Write my custom header first (Spread)
117 |     for (vector<char>::iterator it = buffer.begin() + WAV_HEADER + START_SPACE;
118 |          it != buffer.end(); ++it)
119 |     {
120 |         if (n % MY_HEADER_MODULE == 0)
121 |         {
122 |             *it = customHeader[pos];
123 |             pos++;
124 |             //cout << "Header -> " << *it << endl; // Uncomment this to see the message being written
125 | 
126 |             if (pos == MY_HEADER)
127 |             {
128 |                 cout << "[\033[0;92m+\033[0;0m] \033[0;92mHeader Written Successfully...\033[0;0m" << endl;
129 |                 break;
130 |             }
131 |         }
132 |         n++;
133 |     }
134 | 
135 |     // Delete arrays we are not using it anymore
136 |     modulusBytes = new char[1]; // Relocate memory
137 |     delete[] modulusBytes;
138 |     delete[] customHeader;
139 | 
140 |     int j = 0;
141 |     pos = 0;
142 |     for (vector<char>::iterator it = buffer.begin() + WAV_HEADER + n + MY_HEADER_MODULE + START_SPACE;
143 |          it != buffer.end(); ++it)
144 |     {
145 |         if (j % modulus == 0)
146 |         {
147 |             *it = msgBuffer.at(pos);
148 |             pos++;
149 |             //cout << *it << endl; // Uncomment this to see the message being written
150 | 
151 |             if (pos >= msgBuffer.size())
152 |                 break;
153 |         }
154 |         j++;
155 |     }
156 | 
157 |     if (pos < msgBuffer.size())
158 |     {
159 |         cout << "[\033[0;91m*\033[0;0m] \033[0;91mMaybe the whole file was not written in\033[0;0m" << endl;
160 |     }
161 | 
162 |     return OutputBindedData(buffer, inputExt);
163 | }
164 | 
165 | /**
166 | * Look for the custom header and define what type of message is in it
167 | *
168 | * @param buffer: File loaded into a buffer
169 | * */
170 | int FindHiddenMessage(vector<char>& buffer)
171 | {
172 |     char* customHeader = new char[MY_HEADER] {0}; // Custom header
173 | 
174 |     int n = 0;
175 |     int pos = 0;
176 |     cout << "[\033[0;92m*\033[0;0m] \033[0;92mLooking for the hidden message...\033[0;0m" << endl;
177 |     // Since the actual data of the wav starts at byte 44 we start from it. Everything above is just header things that we don't care atm
178 |     for (vector<char>::iterator it = buffer.begin() + WAV_HEADER + START_SPACE;
179 |          it != buffer.end(); ++it)
180 |     {
181 |         if (n % MY_HEADER_MODULE == 0)
182 |         {
183 |             customHeader[pos] = *it;
184 |             //cout << "Custom Header: " << customHeader[pos] << endl; // Uncomment this if you want to see the header being read
185 |             pos++;
186 |             if (pos == MY_HEADER)
187 |             {
188 |                 //cout << "Header has been read " << endl;
189 |                 break;
190 |             }
191 |         }
192 |         n++;
193 |     }
194 | 
195 |     CustomHeader cHeader (customHeader);
196 | 
197 |     // Clean memory
198 |     delete[] customHeader;
199 | 
200 |     if (cHeader.GetType() == 'b')
201 |     {   
202 |         cout << "[\033[0;92m*\033[0;0m] \033[0;92mFile detected. Retrieving it...\033[0;0m" << endl;
203 |         cHeader.SetLastPosition(n);
204 |         return FindHiddenBinaryInWave(buffer, cHeader);
205 |     }
206 |     else if (cHeader.GetType() == 't'){
207 |         cout << "[\033[0;92m*\033[0;0m] \033[0;92mString detected. Retrieving it...\033[0;0m" << endl;
208 |         cHeader.SetLastPosition(n);
209 |         return FindHiddenTextInWave(buffer, cHeader);
210 |     }
211 |     else{
212 |         // If it hits here it's because there was no message found in the file
213 |         cout << "[\033[0;91m-\033[0;0m] \033[0;91mFailed to detect a hidden file...\033[0;0m" << endl;
214 |         cout << "[\033[0;91m-\033[0;0m] \033[0;91mNo custom header was found...\033[0;0m" << endl;
215 |         return ERROR;
216 |     }
217 | }
218 | 
219 | int FindHiddenTextInWave(vector<char>& buffer, CustomHeader& customHeader)
220 | {
221 |     string msgText;
222 | 
223 |     int modulus = customHeader.GetModulus();
224 |     int lastPos = customHeader.GetLastPosition();
225 | 
226 |     int n = 0;
227 |     int pos = 0;
228 |     vector<char>::iterator tempIterator;
229 |     // Since the actual data of the wav starts at byte 44. Everything above is just header things that we don't care atm
230 |     for (vector<char>::iterator it = buffer.begin() + WAV_HEADER + lastPos + MY_HEADER_MODULE + START_SPACE;
231 |          it != buffer.end(); ++it)
232 |     {
233 |         if (n % modulus == 0)
234 |         {
235 |             if (*it == 64)
236 |             {
237 |                 // @
238 |                 //Setting the iterator to the next possible position
239 |                 tempIterator = buffer.begin() + n + 44 + MY_HEADER_MODULE + START_SPACE + lastPos + modulus;
240 | 
241 |                 if (*tempIterator == 60) {
242 |                     //<
243 |                     //Setting the iterator to the next possible position
244 |                     tempIterator = buffer.begin() + n + 44 + MY_HEADER_MODULE + START_SPACE + lastPos + (2* modulus);
245 | 
246 |                     if (*tempIterator == 59) {
247 |                         // ;
248 |                         // Setting the iterator to next possible flag
249 |                         tempIterator = buffer.begin() + n + 44 + MY_HEADER_MODULE + START_SPACE + lastPos + (3 * modulus);
250 | 
251 |                         if (*tempIterator == 59){
252 |                             // End of message reached
253 |                             cout << "[\033[0;92m+\033[0;0m] Message recovered size: " << "\033[0;92m" << pos << "\033[0;0m" << " bytes" << endl;
254 | 
255 |                             // Output text
256 |                             cout << "[\033[0;92m+\033[0;0m] Message: " << "\033[0;92m" << msgText.c_str() << "\033[0;0m" << endl;
257 |                             return SUCCESS;
258 |                         }
259 |                     }
260 |                 }
261 |             }
262 | 
263 |             msgText[pos] = *it;
264 |             //cout << msgText[pos] << endl; // Uncomment this if yuo want to see the characters being read
265 |             pos++;
266 | 
267 |         }
268 |         n++;
269 |     }
270 | 
271 |     // If it hits here it's because there was no message found in the file
272 |     cout << "[\033[0;91m-\033[0;0m] \033[0;91mNo message found :(\033[0;0m" << endl;
273 |     return ERROR;
274 | 
275 | }
276 | 
277 | int FindHiddenBinaryInWave(vector<char>& buffer, CustomHeader& customHeader)
278 | {
279 |     vector<char> msgBuffer;
280 | 
281 |     int modulus = customHeader.GetModulus();
282 |     int lastPos = customHeader.GetLastPosition();
283 | 
284 |     int n = 0;
285 |     int pos = 0;
286 |     vector<char>::iterator tempIterator;
287 |     // Since the actual data of the wav starts at byte 44. Everything above is just header things that we don't care atm
288 |     for (vector<char>::iterator it = buffer.begin() + + WAV_HEADER + lastPos + MY_HEADER_MODULE + START_SPACE;
289 |          it != buffer.end(); ++it)
290 |     {
291 |         if (n % modulus == 0)
292 |         {
293 |             if (*it == 64)
294 |             {
295 |                 // @
296 |                 //Setting the iterator to the next possible position
297 |                 tempIterator = buffer.begin() + n + 44 + MY_HEADER_MODULE + START_SPACE + lastPos + modulus;
298 | 
299 |                 if (*tempIterator == 60) {
300 |                     //<
301 |                     //Setting the iterator to the next possible position
302 |                     tempIterator = buffer.begin() + n + 44 + MY_HEADER_MODULE + START_SPACE + lastPos + (2* modulus);
303 | 
304 |                     if (*tempIterator == 59) {
305 |                         // ;
306 |                         // Setting the iterator to next possible flag
307 |                         tempIterator = buffer.begin() + n + 44 + MY_HEADER_MODULE + START_SPACE + lastPos + (3 * modulus);
308 | 
309 |                         if (*tempIterator == 59){
310 |                             // End of message reached
311 |                             cout << "[\033[0;92m+\033[0;0m] Message recovered size: " << "\033[0;92m" << pos << "\033[0;0m" << " bytes" << endl;
312 |                             return OutputBinFile(msgBuffer, customHeader);
313 |                         }
314 |                     }
315 |                 }
316 |             }
317 | 
318 |             msgBuffer.push_back(*it);
319 |             //cout << "Data recovered: " << msgBuffer[pos] << endl; // Uncomment this if you want to see the characters being read
320 |             pos++;
321 | 
322 |         }
323 |         n++;
324 |     }
325 | 
326 |     // If it hits here it's because there was no message found in the file
327 |     cout << "[\033[0;91m-\033[0;0m] [\033[0;91mCould not find the end tags of the hidden file :(\033[0;0m" << endl;
328 |     return ERROR;
329 | }
330 | 
331 | int WriteMessageFromEnd(vector<char>& buffer, string msg)
332 | {
333 |     // Verify if it is safe to hide the message in the buffer
334 |     if ((buffer.size() / 4) < msg.size())
335 |     {
336 |         cout << "[\033[0;91m-\033[0;0m] \033[0;91mThe message might be to big for the audio file\033[0;0m" << endl;
337 |         return ERROR;
338 |     }
339 | 
340 |     // Inverse iterator runs backwards
341 |     int n = 0;
342 |     int pos = 0;
343 |     for (vector<char>::reverse_iterator i = buffer.rbegin();
344 |          i != buffer.rend(); ++i)
345 |     {
346 |         if (n%1000 == 0)
347 |         {
348 |             *i = msg.at(pos);
349 |             pos++;
350 |             cout << *i << endl;
351 | 
352 |             if (pos >= msg.size())
353 |                 break;
354 |         }
355 |         n++;
356 |     }
357 | 
358 |     return SUCCESS;
359 | }
360 | 
361 | int OutputBindedData(vector<char>& buffer, string& fileExtension)
362 | {
363 |     string fileName;
364 |     if (fileExtension == "")
365 |         fileName = "output";
366 |     else
367 |         fileName = "output";
368 |         // fileName = "output." + fileExtension;
369 | 
370 |     ofstream output(fileName, std::ios::binary);
371 |     output.write((const char*)&buffer[0], buffer.size());
372 |     output.close();
373 |     cout << "[\033[0;92m+\033[0;0m] File has been saved as: " << "\033[0;92m" << fileName << "\033[0;0m" << endl;
374 | 
375 |     return SUCCESS;
376 | }
377 | 
378 | int OutputBinFile(vector<char>& buffer, CustomHeader& cHeader)
379 | {
380 |     string fileName;
381 |     if (cHeader.GetExtension() == "")
382 |         fileName = "output";
383 |     else
384 |         fileName = "output." + cHeader.GetExtension();
385 | 
386 |     ofstream output(fileName, std::ios::binary);
387 |     output.write((const char*)&buffer[0], buffer.size());
388 |     output.close();
389 |     cout << "[\033[0;92m+\033[0;0m] File has been saved as: " << "\033[0;92m" << fileName << "\033[0;0m" << endl;
390 | 
391 |     return SUCCESS;
392 | }
393 | 
394 | void CreateHeader(long& modulus, char* modulusBytes, char* customHeader, string& fileExtension, bool isBinaryType)
395 | {
396 |     /**
397 |     * Create custom header (9 bytes):
398 |     * Modulus value: 4 bytes
399 |     * File extension: 4 bytes
400 |     * Message type (text or file): 1 byte
401 |     * */
402 | 
403 |     // If modulus is lesser than the max int value of 4 bytes assign it.
404 |     // Otherwise, set a flag to use DEF_MODULE constant
405 |     if (modulus <= 42946729)
406 |         modulusBytes = reinterpret_cast<char*>(&modulus);
407 |     else
408 |         modulusBytes[0] = DEF_MODULE;
409 | 
410 |     int y, i;
411 |     // Assign modulus to header
412 |     for (i = 0; i < 4; i++)
413 |         customHeader[i] = modulusBytes[i];
414 | 
415 |     // Assign the file extension to recover later
416 |     for(y = 0, i = 4; i < 8; i++)
417 |     {
418 |         // Dinamically fill the 4 bytes of the file extension even if its less than 4 characters
419 |         if(fileExtension.size() > y )
420 |             customHeader[i] = fileExtension.at(y);
421 |         else
422 |             customHeader[i] = ' ';
423 |         y++;
424 |     }
425 | 
426 |     // Assign the type of the message
427 |     if (isBinaryType)
428 |         customHeader[8] = 'b';
429 |     else
430 |         customHeader[8] = 't';
431 | }


--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | cmake_minimum_required(VERSION 2.8.4)
 2 | project(hiddenwave)
 3 | 
 4 | FIND_PACKAGE( Boost 1.40 COMPONENTS program_options REQUIRED )
 5 | INCLUDE_DIRECTORIES( ${Boost_INCLUDE_DIR} )
 6 | 
 7 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
 8 | 
 9 | set(SOURCE_FILES main.cpp headers/main.h Algorithm.cpp headers/Algorithm.h CustomHeader.cpp headers/CustomHeader.h)
10 | add_executable(hiddenwave ${SOURCE_FILES})
11 | TARGET_LINK_LIBRARIES( hiddenwave ${Boost_LIBRARIES} )
12 | 


--------------------------------------------------------------------------------
/CustomHeader.cpp:
--------------------------------------------------------------------------------
 1 | #include <string>
 2 | #include <boost/algorithm/string.hpp>
 3 | #include "headers/CustomHeader.h"
 4 | 
 5 | CustomHeader::CustomHeader(char* header) {
 6 |     // Set Modulus first
 7 |     char* bytes = new char[4];
 8 |     for (int i = 0; i < 4; i++) {
 9 |         bytes[i] = header[i];
10 |     }
11 | 
12 |     mModulus = *reinterpret_cast<int*>(bytes);
13 | 
14 |     //Set extension
15 |     char* ext = new char[4];
16 |     for (int y = 0, i = 4; i < 8; i++, y++) {
17 |         ext[y] = header[i];
18 |     }
19 | 
20 |     mExtension = std::string(ext);
21 |     boost::algorithm::trim(mExtension);
22 | 
23 |     // Set Type
24 |     mType = header[8];
25 |     delete[] bytes;
26 |     delete[] ext;
27 | }
28 | 
29 | CustomHeader::CustomHeader() {
30 |     // Initializing the variables
31 |     return;
32 | }
33 | 
34 | int CustomHeader::GetModulus() {
35 |     return this->mModulus;
36 | }
37 | 
38 | std::string CustomHeader::GetExtension() {
39 |     return this->mExtension;
40 | }
41 | 
42 | char CustomHeader::GetType() {
43 |     return this->mType;
44 | }
45 | 
46 | int CustomHeader::GetLastPosition() {
47 |     return this->mLastPos;
48 | }
49 | 
50 | void CustomHeader::SetLastPosition(int n) {
51 |     this->mLastPos = n;
52 | }
53 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # HiddenWave
 2 | > Hide your personal Data inside The Audio wav file<br/>
 3 | > Written in C++ by Gaurav Raj \[TheHackersBrain\]
 4 | 
 5 | ![bannerImage](https://thehackersbrain.github.io/assets/hiddenwave/banner.png)
 6 | 
 7 | Hiddenwave is an audio steganography tool written in **C++** for hiding your files or messages inside a `.wav` or `.mp3` audio file. You might be wondering, In **C++** :confused: ?? You could have done it easily in **Python** :expressionless:. Yeah! I could but we are hackers Gentleman, We love challenges :sunglasses:.
 8 | This tool is inspired by [HiddenWave](https://github.com/techchipnet/HiddenWave) created by [Techchip](https://github.com/techchipnet).
 9 | 
10 | **NOTE:** This tool only supports the `.mp3` and `.wav` audio files and can hide any other files inside the audio file.
11 | 
12 | ## Version
13 | **Hiddenwave 1.2.1**
14 | 
15 | ## Requirement
16 | - [libboost-all-dev](https://packages.debian.org/search?keywords=libboost-all-dev)
17 |     ```
18 |     sudo apt install libboost-all-dev -y
19 |     ```
20 | - [cmake](https://cmake.org/)
21 |     ```
22 |     sudo apt install cmake -y
23 |     ```
24 | 
25 | ## Todo
26 | - [x] Adding Support to hide files inside audio files
27 | - [x] Adding Support to `.mp3` files
28 | - [x] Improving UI by adding some colors
29 | 
30 | ## Installation and Uses
31 | 
32 | ### Automated Installation (Recommanded)
33 | Change the directory to where you want to install this tool and run the follwing command
34 | ```
35 | curl https://raw.githubusercontent.com/thehackersbrain/hiddenwave/main/install.sh -s | bash
36 | ```
37 | 
38 | ### Manual Installation
39 | 
40 | - Make Sure all requirements are installed
41 | ```
42 | sudo apt install libboost-all-dev cmake -y
43 | ```
44 | - Git clone this repo and change the directory
45 | ```
46 | git clone https://github.com/thehackersbrain/hiddenwave.git && cd hiddenwave
47 | ```
48 | - Now Build the package
49 | ```
50 | mkdir build && cd build && cmake ..
51 | ```
52 | - Now make the final binary
53 | ```
54 | make
55 | ```
56 | - Copy the binary in `/usr/bin/` for easy access \(optional\)
57 | ```
58 | sudo cp hiddenwave /usr/bin/
59 | ```
60 | 
61 | ## How to Use
62 | 
63 | ### Hiding Data
64 | - For hiding files inside `.wav` audio file.
65 |     ```
66 |     ./hiddenwave -i input.wav -f filetobehidden.txt -o output.wav
67 |     ```
68 | - For hiding message inside `.wav` audio file.
69 |     ```
70 |     ./hiddenwave -i input.wav -m 'Dummy Message' -o output.wav
71 |     ```
72 | 
73 | ### Extracting Data
74 | 
75 | ```
76 | ./hiddenwave -i output.wav
77 | ```
78 | - If the hidden data is some message, it will be printed on the terminal.
79 | - If the hidden data is a file, it will be extracted on the current directory.
80 | 
81 | ## Credits
82 | **Inspired by:** [HiddenWave](https://github.com/techchipnet/HiddenWave) by [Techchip](https://github.com/techchipnet)
83 | 
84 | ## Author
85 | 
86 | **Creator:** [Gaurav Raj](https://github.com/thehackersbrain/)<br/>
87 | **Portfolio:** [Here](https://thehackersbrain.github.io/)<br/>
88 | **Blog:** [TheHackersBrain Blog](https://thehackersbrain.pythonanywhere.com)<br/>
89 | **Projects:** [Here](https://github.com/thehackersbrain?tab=repositories)<br/>
90 | **Twitter:** [@thehackersbrain](https://twitter.com/thehackersbrain)<br/>
91 | **TryHackMe:** [hackersbrain](https://tryhackme.com/p/hackersbrain)
92 | 


--------------------------------------------------------------------------------
/headers/Algorithm.h:
--------------------------------------------------------------------------------
 1 | // guard header
 2 | #ifndef __ALGORITHM_H_INCLUDED__
 3 | 
 4 | #define __ALGORITHM_H_INCLUDED__
 5 | 
 6 | #define SUCCESS 1
 7 | #define ERROR 2
 8 | #define DEF_MODULE 64
 9 | #define WAV_HEADER 44
10 | #define MY_HEADER_MODULE 64
11 | #define START_SPACE 0
12 | 
13 | #define MY_HEADER 9
14 | 
15 | #include <vector>
16 | #include <string>
17 | #include <fstream>
18 | #include "CustomHeader.h"
19 | 
20 | void CreateHeader(long& modulus, char* modulusBytes, char* customHeader, std::string& fileExtension, bool isBinaryType);
21 | int OutputBinFile(std::vector<char>& buffer, CustomHeader& cHeader);
22 | int OutputBindedData(std::vector<char>& buffer, std::string& extension);
23 | int WriteMessageFromEnd(std::vector<char>& buffer, std::string msg);
24 | int PlayWithWaveBuffer(std::vector<char>& buffer, std::string& msg, std::string& inputExt);             // Hide a string
25 | int PlayWithWaveBuffer(std::vector<char>& buffer, std::vector<char>& fileMsg, std::string& fileExtension, std::string& inputExt);  // Hide a binary file
26 | int FindHiddenTextInWave(std::vector<char>& buffer, CustomHeader& customHeader);
27 | int FindHiddenBinaryInWave(std::vector<char>& buffer, CustomHeader& customHeader);
28 | int FindHiddenMessage(std::vector<char>& buffer);
29 | 
30 | #endif // __ALGORITHM_H_INCLUDED__
31 | 


--------------------------------------------------------------------------------
/headers/CustomHeader.h:
--------------------------------------------------------------------------------
 1 | // guard header
 2 | 
 3 | #ifndef __CUSTOMHEADER_H_INCLUDED__
 4 | #define __CUSTOMHEADER_H_INCLUDED__
 5 | 
 6 | #include <iostream>
 7 | 
 8 | class CustomHeader {
 9 |     int mModulus;
10 |     std::string mExtension;
11 |     char mType;
12 |     int mLastPos = 0;
13 | public:
14 |     CustomHeader(char* header);
15 |     CustomHeader();
16 |     int GetModulus();
17 |     std::string GetExtension();
18 |     char GetType();
19 |     int GetLastPosition();
20 | 
21 |     void SetLastPosition(int n);
22 | };
23 | 
24 | #endif //__CUSTOMHEADER_H_INCLUDED__
25 | 


--------------------------------------------------------------------------------
/headers/main.h:
--------------------------------------------------------------------------------
 1 | // guard header
 2 | #ifndef __MAIN_H_INCLUDED__
 3 | #define __MAIN_H_INCLUDED__
 4 | 
 5 | #include <vector>
 6 | #include <string>
 7 | #include <fstream>
 8 | 
 9 | std::string GetFileExtension(const std::string& fileName);
10 | 
11 | #endif // __MAIN_H_INCLUDED__


--------------------------------------------------------------------------------
/install.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # installing dependencies and requirements
 4 | sudo apt update -y
 5 | sudo apt install libboost-all-dev cmake git -y
 6 | 
 7 | git clone https://github.com/thehackersbrain/hiddenwave.git
 8 | cd hiddenwave
 9 | 
10 | if [[ `mkdir build` ]]; then
11 | 	cd build
12 | else
13 | 	cd build
14 | fi
15 | 
16 | # generating makefiles using cmake and generating the binary using make
17 | if [[ `cmake ..` && `make` ]]; then
18 | 	echo -e "\e[0;32mBuild Completed..."
19 | else
20 | 	echo -e "\e[0;31mSomething went wrong while making the binary.\e[0m" 1>&2
21 | 	exit 1
22 | fi
23 | 
24 | #Optional Configuration (coping the binary into `/usr/bin/` for easy access as a command)
25 | read -p "Add 'hiddenwave' to '/usr/bin/' [Y/N]: " confirmation
26 | 
27 | if [[ $confirmation == 'Y' || $confirmation == 'y' ]] ; then
28 | 	sudo cp hiddenwave /usr/bin/
29 | 	echo -e "\e[0;32mHiddenwave added successfully in /usr/bin, now use hiddenwave as a command... "
30 | else
31 | 	echo -e "\e[0;32mHiddedwave Build Successfully..."
32 | fi
33 | 


--------------------------------------------------------------------------------
/main.cpp:
--------------------------------------------------------------------------------
  1 | #include <iostream>
  2 | #include "headers/main.h"
  3 | #include "headers/Algorithm.h"
  4 | 
  5 | using namespace std;
  6 | 
  7 | void banner(){
  8 | 	cout <<
  9 | "\033[1;92m  ___ ___ .__    .___  .___            __      __                     \n"
 10 | " /   |   \\|__| __| _/__| _/____   ____/  \\    /  \\________  __ ____  \n"
 11 | "/    ~    \\  |/ __ |/ __ |/ __ \\ /    \\   \\/\\/   /\\__  \\  \\/ // __ \\ \n"
 12 | "\\    Y    /  / /_/ / /_/ \\  ___/|   |  \\        /  / __ \\   /\\  ___/ \n"
 13 | " \\___|_  /|__\\____ \\____ |\\___  >___|  /\\__/\\  /  (____ /\\_/  \\___ >\n"
 14 | "       \\/         \\/    \\/    \\/     \\/      \\/        \\/         \\/ \n"
 15 | "                  \033[92mHide Your Secret Files in Audio Files.\033[0m\n\n"
 16 | "                     [Author: \033[1;92mTheHackersBrain\033[0m]\n\n";
 17 | }
 18 | 
 19 | void help(string packageName){
 20 | 	cout << "Usage: " << packageName << " [-h] [-i AUDIOFILE] [-m SECRETMSG] [-o OUTFILE]\n\nArguments:\n"
 21 |     "   -h                Show this help message and exit\n" 
 22 |     "   -i    INPUTFILE     Select Audio File\n"
 23 |     "   -m    SECRETMSG     Enter Your Message\n"
 24 | 	"   -f    SECRETFILE    Select the Secret File\n"
 25 |     "   -o    OUTPUTFILE    Name of the output file (with .wav extension)\n\n" << endl;
 26 | }
 27 | 
 28 | int argsHandler(int argc, char** argv) {
 29 | 	// int mode; // hide mode (message)
 30 | 	if (argc == 7) {
 31 | 		if ((string) argv[1] == "-i" && (string) argv[3] == "-m" && (string) argv[5] == "-o") {
 32 | 			return 1; // hide mode (message)
 33 | 		} else if ((string) argv[1] == "-i" && (string) argv[3] == "-f" && (string) argv[5] == "-o") {
 34 | 			return 3; // hide mode (file)
 35 | 		} else {
 36 | 			help((string) argv[0]);
 37 | 		}
 38 | 	} else if (argc == 3) {
 39 | 		if ((string) argv[1] == "-i") {
 40 | 			return 2; // extract mode (message or file)			
 41 | 		} else {
 42 | 			help((string) argv[0]);
 43 | 			exit(0);
 44 | 		}
 45 | 	}
 46 | 	else {
 47 | 		help((string) argv[0]);
 48 | 		exit(0);
 49 | 	}
 50 | 	return 0;
 51 | }
 52 | 
 53 | int fileHandler(int mode, char** argv) {
 54 | 	string message, outfile, fileExt, inputExt, inputfile;
 55 | 	inputfile = (string) argv[2];
 56 | 	ifstream binStreamFile;
 57 | 	streampos binFileSize;
 58 | 	vector<char> msgBuffer;
 59 | 
 60 | 	if (mode == 3) {
 61 | 		fileExt = GetFileExtension(string(argv[4]));
 62 | 		inputExt = GetFileExtension(string(argv[2]));
 63 | 
 64 | 		binStreamFile.open(string(argv[4]), ios::binary);
 65 | 		binFileSize = binStreamFile.tellg();
 66 | 		msgBuffer.reserve(binFileSize); // Reserve the amount of memory for file size on vector.
 67 | 	}
 68 | 
 69 | 	// loading the input file in the stream
 70 | 	ifstream input(inputfile, ios::binary);
 71 | 	if (!input.is_open()) {
 72 | 		cout << "[\033[0;91m-\033[0;0m] \033[0;91mError Encountered while opening the file...\033[0;0m" << endl;
 73 | 		return 0;
 74 | 	}
 75 | 
 76 | 	// copying the audio file into a buffer and closing it.
 77 | 	vector<char> buffer((istreambuf_iterator<char>(input)), (istreambuf_iterator<char>()));
 78 | 	if (mode == 3) {
 79 | 		msgBuffer.assign((istreambuf_iterator<char>(binStreamFile)), (istreambuf_iterator<char>()));
 80 | 		binStreamFile.close();
 81 | 	}
 82 | 	input.close();
 83 | 
 84 | 	// Modes:
 85 | 	// 1 => Hide a String
 86 | 	// 2 => Hide a File or Binary
 87 | 	// 3 => Extract the file
 88 | 
 89 | 	if (mode == 1) {
 90 | 		message = (string) argv[4];
 91 | 		inputExt = GetFileExtension((string) argv[2]);
 92 | 		int status = PlayWithWaveBuffer(buffer, message, inputExt);
 93 | 		if (status == SUCCESS) {
 94 | 			cout << "[\033[0;92m+\033[0;0m] \033[0;92mData Hidden Successfully...\033[0;0m\n[\033[0;92m+\033[0;0m] \033[0;92mCleaning Memory...\033[0;0m" << endl;
 95 | 		} else if (status == ERROR) {
 96 | 			cout << "[\033[0;91m-\033[0;0m] \033[0;91mSomething went wrong...\033[0;0m\n[\033[0;92m+\033[0;0m] \033[0;92mCleaning Memory...\033[0;0m" << endl;
 97 | 		}
 98 | 	} else if (mode == 3) {
 99 | 		int status = PlayWithWaveBuffer(buffer, msgBuffer, fileExt, inputExt);
100 | 		if (status == SUCCESS) {
101 | 			cout << "[\033[0;92m+\033[0;0m] \033[0;92mData Hidden Successfully...\033[0;0m\n[\033[0;92m+\033[0;0m] \033[0;92mCleaning Memory...\033[0;0m" << endl;
102 | 		} else if (status == ERROR) {
103 | 			cout << "[\033[0;91m-\033[0;0m] \033[0;91mSomething went wrong...\033[0;0m\n[\033[0;92m+\033[0;0m] \033[0;92mCleaning Memory...\033[0;0m" << endl;
104 | 		}
105 | 	} else if (mode == 2) {
106 | 		int status = FindHiddenMessage(buffer);
107 | 		if (status == SUCCESS) {
108 | 			cout << "[\033[0;92m+\033[0;0m] \033[0;92mData Extracted Successfully...\033[0;0m\n[\033[0;92m+\033[0;0m] \033[0;92mCleaning Memory...\033[0;0m" << endl;
109 | 		} else if (status == ERROR) {
110 | 			cout << "[\033[0;91m-\033[0;0m] \033[0;91mSomething went wrong...\033[0;0m\n[\033[0;92m+\033[0;0m] \033[0;92mCleaning Memory...\033[0;0m" << endl;
111 | 		}
112 | 	}
113 | 
114 | 	// Force remove the buffer from memory
115 | 	vector<char>().swap(buffer);
116 | 	vector<char>().swap(msgBuffer);
117 | 	return 0;
118 | }
119 | 
120 | int main(int argc, char** argv) {
121 | 	banner();
122 | 	int mode = argsHandler(argc, argv);
123 | 	fileHandler(mode, argv);
124 | 	return 0;
125 | }
126 | 
127 | string GetFileExtension(const string& fileName) {
128 | 	if (fileName.find_last_of(".") != string::npos) {
129 | 		return fileName.substr(fileName.find_last_of(".") + 1);
130 | 	}
131 | 	return "";
132 | }
133 | 


--------------------------------------------------------------------------------