New directory structure for libghettocrypt

ExampleApp/.gitignore

@@ -1,2 +0,0 @@
-/main.cpp.crypt
-/main.cpp.clear

GhettoCrypt/CMakeLists.txt

@@ -0,0 +1,46 @@
+cmake_minimum_required(VERSION 3.16)
+project(GCrypt)
+
+###################
+# Library project #
+###################
+set(CMAKE_CXX_STANDARD 17)
+
+FILE(GLOB main_src src/*.cpp)
+add_library(${PROJECT_NAME}
+  ${main_src}
+)
+
+target_include_directories(${PROJECT_NAME} PRIVATE
+  include
+)
+
+#########
+# Tests #
+#########
+FILE(GLOB test_src test/*.cpp)
+add_executable(test
+  test/Catch2.h
+  ${test_src}
+)
+target_link_libraries(test ${PROJECT_NAME})
+
+target_include_directories(test PRIVATE
+  include
+)
+
+
+##############
+# Executable #
+##############
+FILE(GLOB exec_src exec/*.cpp)
+add_executable(exec
+  ${exec_src}
+)
+target_link_libraries(exec ${PROJECT_NAME})
+
+target_include_directories(exec PRIVATE
+  include
+  ${eule_include}
+)
+

GhettoCrypt/Cipher.h

@@ -1,41 +0,0 @@
-#pragma once
-#include "Feistel.h"
-#include "Flexblock.h"
-
-namespace GhettoCipher
-{
-	/** Class to apply a block cipher to messages of arbitrary length in a distributed manner
-	*/
-	class Cipher
-	{
-	public:
-		explicit Cipher(const Block& key);
-		explicit Cipher(const std::string& password);
-
-		Cipher(const Cipher& other) = delete;
-		Cipher(Cipher&& other) noexcept = delete;
-
-		~Cipher();
-
-		//! Will set the key
-		void SetKey(const Block& key);
-
-		//! Will set the key from a password
-		void SetPassword(const std::string& password);
-
-		//! Will encipher a flexblock of data
-		Flexblock Encipher(const Flexblock& data, bool printProgress = false) const;
-
-		//! Will decipher a flexblock of data
-		Flexblock Decipher(const Flexblock& data, bool printProgress = false) const;
-
-	private:
-		Block key;
-
-		//! Will zero the memory used by the key
-		void ZeroKeyMemory();
-
-		// Initial value for cipher block chaining
-		Block initializationVector;
-	};
-}

GhettoCrypt/Config.h

@@ -1,11 +0,0 @@
-#pragma once
-#include <cstddef>
-
-namespace GhettoCipher
-{
-	// MUST BE A POWER OF 2 > 4
-	constexpr std::size_t BLOCK_SIZE = 512;
-
-	// MUST BE > 2
-	constexpr std::size_t N_ROUNDS = 64;
-}

GhettoCrypt/include/Cipher.h

@@ -0,0 +1,40 @@
+#pragma once
+#include "Feistel.h"
+#include "Flexblock.h"
+
+namespace GhettoCipher {
+  /** Class to apply a block cipher to messages of arbitrary length in a distributed manner
+  */
+  class Cipher {
+  public:
+    explicit Cipher(const Block& key);
+    explicit Cipher(const std::string& password);
+
+    Cipher(const Cipher& other) = delete;
+    Cipher(Cipher&& other) noexcept = delete;
+
+    ~Cipher();
+
+    //! Will set the key
+    void SetKey(const Block& key);
+
+    //! Will set the key from a password
+    void SetPassword(const std::string& password);
+
+    //! Will encipher a flexblock of data
+    Flexblock Encipher(const Flexblock& data, bool printProgress = false) const;
+
+    //! Will decipher a flexblock of data
+    Flexblock Decipher(const Flexblock& data, bool printProgress = false) const;
+
+  private:
+    Block key;
+
+    //! Will zero the memory used by the key
+    void ZeroKeyMemory();
+
+    // Initial value for cipher block chaining
+    Block initializationVector;
+  };
+}
+

GhettoCrypt/include/Config.h

@@ -0,0 +1,11 @@
+#pragma once
+#include <cstddef>
+
+namespace GhettoCipher {
+  // MUST BE A POWER OF 2 > 4
+  constexpr std::size_t BLOCK_SIZE = 512;
+
+  // MUST BE > 2
+  constexpr std::size_t N_ROUNDS = 64;
+}
+

INCLUDE/GhettoCrypt.cpp

@@ -1,549 +0,0 @@
-/*
-* BSD 2-Clause License
-* 
-* Copyright (c) 2021, Leon Etienne
-* All rights reserved.
-* 
-* Redistribution and use in source and binary forms, with or without
-* modification, are permitted provided that the following conditions are met:
-* 
-* 1. Redistributions of source code must retain the above copyright notice, this
-*    list of conditions and the following disclaimer.
-* 
-* 2. Redistributions in binary form must reproduce the above copyright notice,
-*    this list of conditions and the following disclaimer in the documentation
-*    and/or other materials provided with the distribution.
-* 
-* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-
-#include "GhettoCrypt.h"
-
-/*** ./../GhettoCrypt/Cipher.cpp ***/
-
-#include <iostream>
-#include <vector>
-
-GhettoCipher::Cipher::Cipher(const Block& key)
-	:
-	key { key },
-	initializationVector(InitializationVector(key))
-{
-
-	return;
-}
-
-GhettoCipher::Cipher::Cipher(const std::string& password)
-	:
-	key { PasswordToKey(password) },
-	initializationVector(InitializationVector(key))
-{
-	return;
-}
-
-GhettoCipher::Cipher::~Cipher()
-{
-	// Clear key memory
-	ZeroKeyMemory();
-
-	return;
-}
-
-void GhettoCipher::Cipher::SetKey(const Block& key)
-{
-	ZeroKeyMemory();
-
-	this->key = key;
-	return;
-}
-
-void GhettoCipher::Cipher::SetPassword(const std::string& password)
-{
-	ZeroKeyMemory();
-
-	key = PasswordToKey(password);
-	return;
-}
-
-GhettoCipher::Flexblock GhettoCipher::Cipher::Encipher(const Flexblock& data, bool printProgress) const
-{
-	// Split cleartext into blocks
-	std::vector<Block> blocks;
-
-	for (std::size_t i = 0; i < data.size(); i += BLOCK_SIZE)
-		blocks.push_back(Block(
-			PadStringToLength(data.substr(i, BLOCK_SIZE), BLOCK_SIZE, '0', false))
-		);
-
-	// Encrypt individual blocks using cipher block chaining
-	Feistel feistel(key);
-
-	for (std::size_t i = 0; i < blocks.size(); i++)
-	{
-		// Print reports if desired. If we have > 1000 blocks, print one report every 100 blocks. Otherwise for every 10th block.
-		if ((i % ((blocks.size() > 1000)? 100 : 10) == 0) && (printProgress))
-			std::cout << "Encrypting... (Block " << i << " / " << blocks.size() << " - " << ((float)i*100 / blocks.size()) << "%)" << std::endl;
-	
-		const Block& lastBlock = (i>0) ? blocks[i-1] : initializationVector;
-		blocks[i] = feistel.Encipher(blocks[i] ^ lastBlock); // Xor last cipher block with new clear text block before E()
-	}
-
-	// Concatenate ciphertext blocks back into a flexblock
-	std::stringstream ss;
-	for (Block& b : blocks)
-		ss << b;
-
-	// Return it
-	return ss.str();
-}
-
-GhettoCipher::Flexblock GhettoCipher::Cipher::Decipher(const Flexblock& data, bool printProgress) const
-{
-	// Split ciphertext into blocks
-	std::vector<Block> blocks;
-
-	for (std::size_t i = 0; i < data.size(); i += BLOCK_SIZE)
-		blocks.push_back(Block(
-			PadStringToLength(data.substr(i, BLOCK_SIZE), BLOCK_SIZE, '0', false))
-		);
-
-	// Decrypt individual blocks
-	Feistel feistel(key);
-
-	// We can't do this in-loop for decryption, because we are decrypting the blocks in-place.
-	Block lastBlock = initializationVector;
-	
-	for (std::size_t i = 0; i < blocks.size(); i++)
-	{
-		// Print reports if desired. If we have > 1000 blocks, print one report every 100 blocks. Otherwise for every 10th block.
-		if ((i % ((blocks.size() > 1000) ? 100 : 10) == 0) && (printProgress))
-			std::cout << "Decrypting... (Block " << i << " / " << blocks.size() << " - " << ((float)i*100/ blocks.size()) << "%)" << std::endl;
-
-		Block tmpCopy = blocks[i];
-
-		blocks[i] = feistel.Decipher(blocks[i]) ^ lastBlock; // Decipher cipher block [i] and then xor it with the last cipher block [i-1] we've had
-
-		lastBlock = std::move(tmpCopy);
-	}
-
-	// Concatenate ciphertext blocks back into a flexblock
-	std::stringstream ss;
-	for (Block& b : blocks)
-		ss << b;
-
-	// Return it
-	return ss.str();
-}
-
-// These pragmas only work for MSVC and g++, as far as i know. Beware!!!
-#if defined _WIN32 || defined _WIN64
-#pragma optimize("", off )
-#elif defined __GNUG__
-#pragma GCC push_options
-#pragma GCC optimize ("O0")
-#endif
-void GhettoCipher::Cipher::ZeroKeyMemory()
-{
-	key.reset();
-	return;
-}
-#if defined _WIN32 || defined _WIN64
-#pragma optimize("", on )
-#elif defined __GNUG__
-#pragma GCC pop_options
-#endif
-
-
-/*** ./../GhettoCrypt/Feistel.cpp ***/
-
-#include <unordered_map>
-
-GhettoCipher::Feistel::Feistel(const Block& key)
-{
-    SetKey(key);
-    return;
-}
-
-GhettoCipher::Feistel::~Feistel()
-{
-    ZeroKeyMemory();
-
-    return;
-}
-
-void GhettoCipher::Feistel::SetKey(const Block& key)
-{
-    GenerateRoundKeys(key);
-    return;
-}
-
-GhettoCipher::Block GhettoCipher::Feistel::Encipher(const Block& data)
-{
-    return Run(data, false);
-}
-
-GhettoCipher::Block GhettoCipher::Feistel::Decipher(const Block& data)
-{
-    return Run(data, true);
-}
-
-GhettoCipher::Block GhettoCipher::Feistel::Run(const Block& data, bool reverseKeys)
-{
-    const auto splitData = FeistelSplit(data);
-    GhettoCipher::Halfblock l = splitData.first;
-    GhettoCipher::Halfblock r = splitData.second;
-
-    Halfblock tmp;
-
-    for (std::size_t i = 0; i < N_ROUNDS; i++)
-    {
-        // Calculate key index
-        std::size_t keyIndex;
-        if (reverseKeys)
-            keyIndex = N_ROUNDS - i - 1;
-        else
-            keyIndex = i;
-
-        // Do a feistel round
-        tmp = r;
-        r = l ^ F(r, roundKeys[keyIndex]);
-        l = tmp;
-    }
-
-    // Block has finished de*ciphering.
-    // Let's generate a new set of round keys.
-    GenerateRoundKeys((Block)roundKeys.back());
-
-    return FeistelCombine(r, l);
-}
-
-GhettoCipher::Halfblock GhettoCipher::Feistel::F(Halfblock m, const Block& key)
-{
-    // Made-up F function
-
-    // Expand to full bitwidth
-    Block m_expanded = ExpansionFunction(m);
-
-    // Shift to left by 1
-    m_expanded = Shiftl(m_expanded, 1);
-
-    // Xor with key
-    m_expanded ^= key;
-
-    // Non-linearly apply subsitution boxes
-    std::stringstream ss;
-    const std::string m_str = m_expanded.to_string();
-
-    for (std::size_t i = 0; i < BLOCK_SIZE; i += 4)
-    {
-        ss << SBox(m_str.substr(i, 4));
-    }
-
-    m_expanded = Block(ss.str());
-
-    // Return the compressed version
-    return CompressionFunction(m_expanded);
-}
-
-std::pair<GhettoCipher::Halfblock, GhettoCipher::Halfblock> GhettoCipher::Feistel::FeistelSplit(const Block& block)
-{
-    const std::string bits = block.to_string();
-
-    Halfblock l(bits.substr(0, bits.size() / 2));
-    Halfblock r(bits.substr(bits.size() / 2));
-
-    return std::make_pair(l, r);
-}
-
-GhettoCipher::Block GhettoCipher::Feistel::FeistelCombine(const Halfblock& l, const Halfblock& r)
-{
-    return Block(l.to_string() + r.to_string());
-}
-
-GhettoCipher::Block GhettoCipher::Feistel::ExpansionFunction(const Halfblock& block)
-{
-    std::stringstream ss;
-    const std::string bits = block.to_string();
-
-    std::unordered_map<std::string, std::string> expansionMap;
-    expansionMap["00"] = "1101";
-    expansionMap["01"] = "1000";
-    expansionMap["10"] = "0010";
-    expansionMap["11"] = "0111";
-
-    // We have to double the bits!
-    for (std::size_t i = 0; i < HALFBLOCK_SIZE; i += 2)
-    {
-        const std::string sub = bits.substr(i, 2);
-        ss << expansionMap[sub];
-    }
-
-    return Block(ss.str());
-}
-
-GhettoCipher::Halfblock GhettoCipher::Feistel::CompressionFunction(const Block& block)
-{
-    std::stringstream ss;
-    const std::string bits = block.to_string();
-
-    std::unordered_map<std::string, std::string> compressionMap;
-    compressionMap["0000"] = "10";
-    compressionMap["0001"] = "01";
-    compressionMap["0010"] = "10";
-    compressionMap["0011"] = "10";
-    compressionMap["0100"] = "11";
-    compressionMap["0101"] = "01";
-    compressionMap["0110"] = "00";
-    compressionMap["0111"] = "11";
-    compressionMap["1000"] = "01";
-    compressionMap["1001"] = "00";
-    compressionMap["1010"] = "11";
-    compressionMap["1011"] = "00";
-    compressionMap["1100"] = "11";
-    compressionMap["1101"] = "10";
-    compressionMap["1110"] = "00";
-    compressionMap["1111"] = "01";
-
-    // We have to half the bits!
-    for (std::size_t i = 0; i < BLOCK_SIZE; i += 4)
-    {
-        const std::string sub = bits.substr(i, 4);
-        ss << compressionMap[sub];
-    }
-
-    return Halfblock(ss.str());
-}
-
-std::string GhettoCipher::Feistel::SBox(const std::string& in)
-{
-    static std::unordered_map<std::string, std::string> subMap;
-    static bool mapInitialized = false;
-    if (!mapInitialized)
-    {
-        subMap["0000"] = "1100";
-        subMap["0001"] = "1000";
-        subMap["0010"] = "0001";
-        subMap["0011"] = "0111";
-        subMap["0100"] = "1011";
-        subMap["0101"] = "0011";
-        subMap["0110"] = "1101";
-        subMap["0111"] = "1111";
-        subMap["1000"] = "0000";
-        subMap["1001"] = "1010";
-        subMap["1010"] = "0100";
-        subMap["1011"] = "1001";
-        subMap["1100"] = "0010";
-        subMap["1101"] = "1110";
-        subMap["1110"] = "0101";
-        subMap["1111"] = "0110";
-        mapInitialized = true;
-    }
-
-    return subMap[in];
-}
-
-void GhettoCipher::Feistel::GenerateRoundKeys(const Block& seedKey)
-{
-    // Clear initial key memory
-    ZeroKeyMemory();
-    roundKeys = Keyset();
-
-    // Derive the initial two round keys
-
-    // Compress- substitute, and expand the seed key to form the initial and the second-initial round key
-    // This action is non-linear and irreversible, and thus strenghtens security.
-    Halfblock compressedSeed1 = CompressionFunction(seedKey);
-    Halfblock compressedSeed2 = CompressionFunction(Shiftl(seedKey, 1)); // Shifting one key by 1 will result in a completely different compression
-
-    // To add further confusion, let's shift seed1 by 1 aswell (after compression, but before substitution)
-    // but only if the total number of bits set are a multiple of 3
-    // if it is a multiple of 4, we'll shift it by 1 into the opposite direction
-    const std::size_t setBits1 = compressedSeed1.count();
-
-    if (setBits1 % 4 == 0)
-        compressedSeed1 = Shiftr(compressedSeed1, 1);
-    else if (setBits1 % 3 == 0)
-        compressedSeed1 = Shiftl(compressedSeed1, 1);
-
-    // Now apply substitution
-    std::stringstream ssKey1;
-    std::stringstream ssKey2;
-    const std::string bitsKey1 = compressedSeed1.to_string();
-    const std::string bitsKey2 = compressedSeed2.to_string();
-
-    for (std::size_t i = 0; i < HALFBLOCK_SIZE; i += 4)
-    {
-        ssKey1 << SBox(bitsKey1.substr(i, 4));
-        ssKey2 << SBox(bitsKey2.substr(i, 4));
-    }
-
-    compressedSeed1 = Halfblock(ssKey1.str());
-    compressedSeed2 = Halfblock(ssKey2.str());
-
-    // Now extrapolate them to BLOCK_SIZE (key size) again
-    // Xor with the original seed key to get rid of the repititions caused by the expansion
-    roundKeys[0] = ExpansionFunction(compressedSeed1) ^ seedKey;
-    roundKeys[1] = ExpansionFunction(compressedSeed2) ^ seedKey;
-
-    
-    // Now derive all other round keys
-
-    for (std::size_t i = 2; i < roundKeys.size(); i++)
-    {
-        // Initialize new round key with last round key
-        Block newKey = roundKeys[i - 1];
-
-        // Shift to left by how many bits are set, modulo 8
-        newKey = Shiftl(newKey, newKey.count() % 8); // This action is irreversible
-
-        // Split into two halfblocks,
-        // apply F() to one halfblock with rk[i-2],
-        // xor the other one with it
-        // and put them back together
-        auto halfkeys = FeistelSplit(newKey);
-        Halfblock halfkey1 = F(halfkeys.first, roundKeys[i - 2]);
-        Halfblock halfkey2 = halfkeys.second ^ halfkey1;
-
-        roundKeys[i] = FeistelCombine(halfkey1, halfkey2);
-    }
-
-    return;
-}
-
-// These pragmas only work for MSVC and g++, as far as i know. Beware!!!
-#if defined _WIN32 || defined _WIN64
-#pragma optimize("", off )
-#elif defined __GNUG__
-#pragma GCC push_options
-#pragma GCC optimize ("O0")
-#endif
-void GhettoCipher::Feistel::ZeroKeyMemory()
-{
-    for (Block& key : roundKeys)
-        key.reset();
-
-    return;
-}
-#if defined _WIN32 || defined _WIN64
-#pragma optimize("", on )
-#elif defined __GNUG__
-#pragma GCC pop_options
-#endif
-
-
-/*** ./../GhettoCrypt/GhettoCryptWrapper.cpp ***/
-
-
-std::string GhettoCipher::GhettoCryptWrapper::EncryptString(const std::string& cleartext, const std::string& password)
-{
-	// Instanciate our cipher and supply a key
-	const Block key = PasswordToKey(password);
-	Cipher cipher(key);
-
-	// Recode the ascii-string to bits
-	const Flexblock cleartext_bits = StringToBits(cleartext);
-
-	// Encrypt our cleartext bits
-	const Flexblock ciphertext_bits = cipher.Encipher(cleartext_bits);
-
-	// Recode the ciphertext bits to a hex-string
-	const std::string ciphertext = BitsToHexstring(ciphertext_bits);
-
-	// Return it
-	return ciphertext;
-}
-
-std::string GhettoCipher::GhettoCryptWrapper::DecryptString(const std::string& ciphertext, const std::string& password)
-{
-	// Instanciate our cipher and supply a key
-	const Block key = PasswordToKey(password);
-	Cipher cipher(key);
-
-	// Recode the hex-string to bits
-	const Flexblock ciphertext_bits = HexstringToBits(ciphertext);
-
-	// Decrypt the ciphertext bits
-	const std::string cleartext_bits = cipher.Decipher(ciphertext_bits);
-
-	// Recode the cleartext bits to an ascii-string
-	const std::string cleartext = BitsToString(cleartext_bits);
-
-	// Return it
-	return cleartext;
-}
-
-bool GhettoCipher::GhettoCryptWrapper::EncryptFile(const std::string& filename_in, const std::string& filename_out, const std::string& password, bool printProgressReport)
-{
-	try
-	{
-		// Read the file to bits
-		const Flexblock cleartext_bits = ReadFileToBits(filename_in);
-
-		// Instanciate our cipher and supply a key
-		const Block key = PasswordToKey(password);
-		Cipher cipher(key);
-
-		// Encrypt our cleartext bits
-		const Flexblock ciphertext_bits = cipher.Encipher(cleartext_bits, printProgressReport);
-
-		// Write our ciphertext bits to file
-		WriteBitsToFile(filename_out, ciphertext_bits);
-
-		return true;
-	}
-	catch (std::runtime_error&)
-	{
-		return false;
-	}
-}
-
-bool GhettoCipher::GhettoCryptWrapper::DecryptFile(const std::string& filename_in, const std::string& filename_out, const std::string& password, bool printProgressReport)
-{
-	try
-	{
-		// Read the file to bits
-		const Flexblock ciphertext_bits = ReadFileToBits(filename_in);
-
-		// Instanciate our cipher and supply a key
-		const Block key = PasswordToKey(password);
-		Cipher cipher(key);
-
-		// Decrypt the ciphertext bits
-		const Flexblock cleartext_bits = cipher.Decipher(ciphertext_bits, printProgressReport);
-
-		// Write our cleartext bits to file
-		WriteBitsToFile(filename_out, cleartext_bits);
-
-		return true;
-	}
-	catch (std::runtime_error&)
-	{
-		return false;
-	}
-}
-
-
-/*** ./../GhettoCrypt/InitializationVector.cpp ***/
-
-
-GhettoCipher::InitializationVector::InitializationVector(const Block& seed)
-{
-	// We'll generate our initialization vector by encrypting our seed with itself as a key
-	// iv = E(M=seed, K=seed)
-	iv = Feistel(seed).Encipher(seed);
-}
-
-GhettoCipher::InitializationVector::operator GhettoCipher::Block() const
-{
-	return iv;
-}
-

INCLUDE/GhettoCrypt.h

@@ -1,864 +0,0 @@
-/*
-* BSD 2-Clause License
-* 
-* Copyright (c) 2021, Leon Etienne
-* All rights reserved.
-* 
-* Redistribution and use in source and binary forms, with or without
-* modification, are permitted provided that the following conditions are met:
-* 
-* 1. Redistributions of source code must retain the above copyright notice, this
-*    list of conditions and the following disclaimer.
-* 
-* 2. Redistributions in binary form must reproduce the above copyright notice,
-*    this list of conditions and the following disclaimer in the documentation
-*    and/or other materials provided with the distribution.
-* 
-* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-
-#pragma once
-
-/*** ./../GhettoCrypt/GhettoCryptWrapper.h ***/
-
-#pragma once
-#include <string>
-
-namespace GhettoCipher
-{
-	/** This class is a wrapper to make working with the GhettoCipher super easy with a python-like syntax
-	*/
-	class GhettoCryptWrapper
-	{
-	public:
-		//! Will encrypt a string and return it hexadecimally encoded.
-		static std::string EncryptString(const std::string& cleartext, const std::string& password);
-
-		//! Will decrypt a hexadecimally encoded string.
-		static std::string DecryptString(const std::string& ciphertext, const std::string& password);
-
-		//! Will encrypt a file.
-		//! Returns false if anything goes wrong (like, file-access).
-		//! @filename_in The file to be read.
-		//! @filename_out The file the encrypted version should be saved in.
-		static bool EncryptFile(const std::string& filename_in, const std::string& filename_out, const std::string& password, bool printProgressReport = false);
-
-		//! Will decrypt a file.
-		//! Returns false if anything goes wrong (like, file-access).
-		//! @filename_in The file to be read.
-		//! @filename_out The file the decrypted version should be saved in.
-		static bool DecryptFile(const std::string& filename_in, const std::string& filename_out, const std::string& password, bool printProgressReport = false);
-
-	private:
-		// No instanciation! >:(
-		GhettoCryptWrapper();
-	};
-}
-
-/*** ./../GhettoCrypt/Flexblock.h ***/
-
-#pragma once
-#include <string>
-
-namespace GhettoCipher
-{
-	//! A "bitset" of variable length
-	typedef std::string Flexblock;
-}
-
-/*** ./../GhettoCrypt/Config.h ***/
-
-#pragma once
-#include <cstddef>
-
-namespace GhettoCipher
-{
-	// MUST BE A POWER OF 2 > 4
-	constexpr std::size_t BLOCK_SIZE = 512;
-
-	// MUST BE > 2
-	constexpr std::size_t N_ROUNDS = 64;
-}
-
-/*** ./../GhettoCrypt/Version.h ***/
-
-#pragma once
-#define GHETTOCRYPT_VERSION 0.21
-
-/*** ./../GhettoCrypt/SecureBitset.h ***/
-
-#pragma once
-#include <bitset>
-#include <ostream>
-#include <istream>
-
-namespace GhettoCipher
-{
-/** Wrapper for std::bitset<T> that zeroes memory upon deletion.
-* This does not include ALL methods, but the ones needed.
-* 
-* Just creating a specialization of std::bitset<T> does not work.
-*/
-template <std::size_t T>
-class SecureBitset
-{
-public:
-	explicit SecureBitset();
-	explicit SecureBitset(const std::string& str);
-	explicit SecureBitset(const long long int i);
-
-	~SecureBitset();
-
-	bool operator==(const SecureBitset<T>& other) const;
-	bool operator!=(const SecureBitset<T>& other) const;
-	bool operator[](const std::size_t) const;
-	bool test(const std::size_t index) const;
-	bool all() const;
-	bool any() const;
-	bool none() const;
-	std::size_t count() const;
-	std::size_t size() const;
-	SecureBitset<T>& operator&=(const SecureBitset<T>& other);
-	SecureBitset<T>& operator|=(const SecureBitset<T>& other);
-	SecureBitset<T>& operator^=(const SecureBitset<T>& other);
-	SecureBitset<T> operator&(const SecureBitset<T>& other);
-	SecureBitset<T> operator|(const SecureBitset<T>& other);
-	SecureBitset<T> operator^(const SecureBitset<T>& other);
-	SecureBitset<T> operator~() const;
-	SecureBitset<T>& operator<<=(const std::size_t offset);
-	SecureBitset<T>& operator>>=(const std::size_t offset);
-	SecureBitset<T> operator<<(const std::size_t offset) const;
-	SecureBitset<T> operator>>(const std::size_t offset) const;
-	SecureBitset<T>& set();
-	SecureBitset<T>& set(const std::size_t index, bool value = true);
-	SecureBitset<T>& reset();
-	SecureBitset<T>& reset(const std::size_t index);
-	SecureBitset<T>& flip();
-	SecureBitset<T>& flip(const std::size_t index);
-	std::string to_string() const;
-	unsigned long to_ulong() const;
-	unsigned long long to_ullong() const;
-
-	std::bitset<T>& Get();
-	const std::bitset<T>& Get() const;
-
-private:
-	std::bitset<T> bitset;
-};
-
-template<std::size_t T>
-inline SecureBitset<T>::SecureBitset()
-	:
-	bitset()
-{
-	return;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>::SecureBitset(const std::string& str)
-	:
-	bitset(str)
-{
-	return;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>::SecureBitset(const long long int i)
-	:
-	bitset(i)
-{
-	return;
-}
-
-
-// Don't optimize the destructor out!!!
-// These pragmas only work for MSVC and g++, as far as i know. Beware!!!
-#if defined _WIN32 || defined _WIN64
-#pragma optimize("", off )
-#elif defined __GNUG__
-#pragma GCC push_options
-#pragma GCC optimize ("O0")
-#endif
-template<std::size_t T>
-inline SecureBitset<T>::~SecureBitset()
-{
-	bitset.reset();
-	return;
-}
-#if defined _WIN32 || defined _WIN64
-#pragma optimize("", on )
-#elif defined __GNUG__
-#pragma GCC pop_options
-#endif
-
-template<std::size_t T>
-inline bool SecureBitset<T>::operator==(const SecureBitset<T>& other) const
-{
-	return bitset == other.bitset;
-}
-
-template<std::size_t T>
-inline bool SecureBitset<T>::operator!=(const SecureBitset<T>& other) const
-{
-	return bitset != other.bitset;
-}
-
-template<std::size_t T>
-inline bool SecureBitset<T>::operator[](const std::size_t index) const
-{
-	return bitset[index];
-}
-
-template<std::size_t T>
-inline bool SecureBitset<T>::test(const std::size_t index) const
-{
-	return bitset.test(index);
-}
-
-template<std::size_t T>
-inline bool SecureBitset<T>::all() const
-{
-	return bitset.all();
-}
-
-template<std::size_t T>
-inline bool SecureBitset<T>::any() const
-{
-	return bitset.any();
-}
-
-template<std::size_t T>
-inline bool SecureBitset<T>::none() const
-{
-	return bitset.none();
-}
-
-template<std::size_t T>
-inline std::size_t SecureBitset<T>::count() const
-{
-	return bitset.count();
-}
-
-template<std::size_t T>
-inline std::size_t SecureBitset<T>::size() const
-{
-	return bitset.count();
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::operator&=(const SecureBitset<T>& other)
-{
-	bitset &= other.bitset;
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::operator|=(const SecureBitset<T>& other)
-{
-	bitset |= other.bitset;
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::operator^=(const SecureBitset<T>& other)
-{
-	bitset ^= other.bitset;
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T> SecureBitset<T>::operator&(const SecureBitset<T>& other)
-{
-	SecureBitset bs;
-	bs.bitset = bitset & other.bitset;
-	return bs;
-}
-
-template<std::size_t T>
-inline SecureBitset<T> SecureBitset<T>::operator|(const SecureBitset<T>& other)
-{
-	SecureBitset bs;
-	bs.bitset = bitset | other.bitset;
-	return bs;
-}
-
-template<std::size_t T>
-inline SecureBitset<T> SecureBitset<T>::operator^(const SecureBitset<T>& other)
-{
-	SecureBitset bs;
-	bs.bitset = bitset ^ other.bitset;
-	return bs;
-}
-
-template<std::size_t T>
-inline SecureBitset<T> SecureBitset<T>::operator~() const
-{
-	SecureBitset bs;
-	bs.bitset = ~bitset;
-	return bs;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::operator<<=(const std::size_t offset)
-{
-	bitset <<= offset;
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::operator>>=(const std::size_t offset)
-{
-	bitset >>= offset;
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T> SecureBitset<T>::operator<<(const std::size_t offset) const
-{
-	SecureBitset bs;
-	bs.bitset = bitset << offset;
-	return bs;
-}
-
-template<std::size_t T>
-inline SecureBitset<T> SecureBitset<T>::operator>>(const std::size_t offset) const
-{
-	SecureBitset bs;
-	bs.bitset = bitset >> offset;
-	return bs;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::set()
-{
-	bitset.set();
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::set(const std::size_t index, bool value)
-{
-	bitset.set(index, value);
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::reset()
-{
-	bitset.reset();
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::reset(const std::size_t index)
-{
-	bitset.reset(index);
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::flip()
-{
-	bitset.flip();
-	return *this;
-}
-
-template<std::size_t T>
-inline SecureBitset<T>& SecureBitset<T>::flip(const std::size_t index)
-{
-	bitset.flip(index);
-	return *this;
-}
-
-template<std::size_t T>
-inline std::string SecureBitset<T>::to_string() const
-{
-	return bitset.to_string();
-}
-
-template<std::size_t T>
-inline unsigned long SecureBitset<T>::to_ulong() const
-{
-	return bitset.to_ulong();
-}
-template<std::size_t T>
-inline unsigned long long SecureBitset<T>::to_ullong() const
-{
-	return bitset.to_ullong();
-}
-
-template<std::size_t T>
-inline std::bitset<T>& SecureBitset<T>::Get()
-{
-	return bitset;
-}
-
-template<std::size_t T>
-inline const std::bitset<T>& SecureBitset<T>::Get() const
-{
-	return bitset;
-}
-
-template <std::size_t T>
-inline std::ostream& operator<<(std::ostream& ofs, const SecureBitset<T>& bs)
-{
-	return ofs << bs.Get();
-}
-
-template <std::size_t T>
-inline std::istream& operator>>(std::istream& ifs, const SecureBitset<T>& bs)
-{
-	return ifs >> bs.Get();
-}
-}
-
-/*** ./../GhettoCrypt/Halfblock.h ***/
-
-#pragma once
-#include <cstdint>
-
-namespace GhettoCipher
-{
-	constexpr std::size_t HALFBLOCK_SIZE = (BLOCK_SIZE / 2);
-	typedef SecureBitset<HALFBLOCK_SIZE> Halfblock;
-}
-
-/*** ./../GhettoCrypt/Block.h ***/
-
-#pragma once
-
-namespace GhettoCipher
-{
-	typedef SecureBitset<BLOCK_SIZE> Block;
-}
-
-/*** ./../GhettoCrypt/InitializationVector.h ***/
-
-#pragma once
-
-namespace GhettoCipher
-{
-	/** Will create a sudo-random Block based on a seed
-	*/
-	class InitializationVector
-	{
-	public:
-		InitializationVector(const GhettoCipher::Block& seed);
-
-		operator GhettoCipher::Block() const;
-
-	private:
-		GhettoCipher::Block iv;
-	};
-}
-
-/*** ./../GhettoCrypt/Util.h ***/
-
-#pragma once
-#include <bitset>
-#include <sstream>
-#include <fstream>
-#include <cstring>
-
-namespace GhettoCipher
-{
-    //! Mod-operator that works with negative values
-    inline int Mod(const int numerator, const int denominator)
-    {
-        return (denominator + (numerator % denominator)) % denominator;
-    }
-
-    //! Will perform a wrapping left-bitshift on a bitset
-    template <std::size_t T>
-    inline SecureBitset<T> Shiftl(const SecureBitset<T>& bits, const std::size_t amount)
-    {
-        std::stringstream ss;
-        const std::string bitss = bits.to_string();
-
-        for (std::size_t i = 0; i < bitss.size(); i++)
-            ss << bitss[Mod((int)(i + amount), (int)bitss.size())];
-
-        return SecureBitset<T>(ss.str());
-    }
-
-    //! Will perform a wrapping right-bitshift on a bitset
-    template <std::size_t T>
-    inline SecureBitset<T> Shiftr(const SecureBitset<T>& bits, const  std::size_t amount)
-    {
-        std::stringstream ss;
-        const std::string bitss = bits.to_string();
-
-        for (std::size_t i = 0; i < bitss.size(); i++)
-            ss << bitss[Mod((i - amount), bitss.size())];
-
-        return SecureBitset<T>(ss.str());
-    }
-
-    //! Will pad a string to a set length with a certain character
-    inline std::string PadStringToLength(const std::string& str, const std::size_t len, const char pad, const bool padLeft = true)
-    {
-        // Fast-reject: Already above padded length
-        if (str.length() >= len)
-            return str;
-
-        std::stringstream ss;
-
-        // Pad left:
-        if (padLeft)
-        {
-            for (std::size_t i = 0; i < len - str.size(); i++)
-                ss << pad;
-            ss << str;
-        }
-        // Pad right:
-        else
-        {
-            ss << str;
-            for (std::size_t i = 0; i < len - str.size(); i++)
-                ss << pad;
-        }
-
-        return ss.str();
-    }
-
-    //! Will convert a string to a fixed-size data block
-    inline Block StringToBitblock(const std::string& s)
-    {
-        std::stringstream ss;
-
-        for (std::size_t i = 0; i < s.size(); i++)
-            ss << std::bitset<8>(s[i]);
-
-        // Pad rest with zeores
-        return Block(PadStringToLength(ss.str(), 128, '0', false));
-    }
-
-    //! Will convert a string to a flexible data block
-    inline Flexblock StringToBits(const std::string& s)
-    {
-        std::stringstream ss;
-
-        for (std::size_t i = 0; i < s.size(); i++)
-            ss << std::bitset<8>(s[i]);
-
-        return Flexblock(ss.str());
-    }
-
-    //! Will convert a fixed-size data block to a bytestring
-    inline std::string BitblockToBytes(const Block& bits)
-    {
-        std::stringstream ss;
-
-        const std::string bitstring = bits.to_string();
-
-        for (std::size_t i = 0; i < BLOCK_SIZE; i += 8)
-        {
-            ss << (char)std::bitset<8>(bitstring.substr(i, 8)).to_ulong();
-        }
-
-        return ss.str();
-    }
-    
-    //! Will convert a fixed-size data block to a string
-    //! The difference to BitblockToBytes() is, that it strips excess nullbytes
-    inline std::string BitblockToString(const Block& bits)
-    {
-        // Decode to bytes
-        std::string text = BitblockToBytes(bits);
-
-        // Dümp excess nullbytes
-        text.resize(strlen(text.data()));
-
-        return text;
-    }
-
-    //! Will convert a flexible data block to a bytestring
-    inline std::string BitsToBytes(const Flexblock& bits)
-    {
-        std::stringstream ss;
-
-        const std::string bitstring = bits;
-
-        for (std::size_t i = 0; i < bits.size(); i += 8)
-        {
-            ss << (char)std::bitset<8>(bitstring.substr(i, 8)).to_ulong();
-        }
-
-        return ss.str();
-    }
-
-    //! Will convert a flexible data block to a string
-    //! //! The difference to BitsToBytes() is, that it strips excess nullbytes
-    inline std::string BitsToString(const Flexblock& bits)
-    {
-        // Decode to bytes
-        std::string text = BitsToBytes(bits);
-
-        // Dümp excess nullbytes
-        text.resize(strlen(text.data()));
-
-        return text;
-    }
-
-    //! Turns a fixed-size data block into a hex-string
-    inline std::string BitblockToHexstring(const Block& b)
-    {
-        std::stringstream ss;
-        const std::string charset = "0123456789abcdef";
-        const std::string bstr = b.to_string();
-
-        for (std::size_t i = 0; i < bstr.size(); i += 4)
-            ss << charset[std::bitset<4>(bstr.substr(i, 4)).to_ulong()];
-
-        return ss.str();
-    }
-
-    //! Turns a flexible data block into a hex-string
-    inline std::string BitsToHexstring(const Flexblock& b)
-    {
-        std::stringstream ss;
-        const std::string charset = "0123456789abcdef";
-        const std::string bstr = b;
-
-        for (std::size_t i = 0; i < bstr.size(); i += 4)
-            ss << charset[std::bitset<4>(bstr.substr(i, 4)).to_ulong()];
-
-        return ss.str();
-    }
-
-
-    //! Turns a hex string into a fixed-size data block
-    inline Block HexstringToBitblock(const std::string& hexstring)
-    {
-        std::stringstream ss;
-
-        for (std::size_t i = 0; i < hexstring.size(); i++)
-        {
-            const char c = hexstring[i];
-
-            // Get value
-            std::size_t value;
-            if ((c >= '0') && (c <= '9'))
-                // Is it a number?
-                value = ((std::size_t)c - '0') + 0;
-            else if ((c >= 'a') && (c <= 'f'))
-                // Else, it is a lowercase letter
-                value = ((std::size_t)c - 'a') + 10;
-            else
-                throw std::logic_error("non-hex string detected in HexstringToBits()");
-
-            // Append to our bits
-            ss << std::bitset<4>(value);
-        }
-
-        return Block(ss.str());
-    }
-
-    //! Turns a hex string into a flexible data block
-    inline Flexblock HexstringToBits(const std::string& hexstring)
-    {
-        std::stringstream ss;
-
-        for (std::size_t i = 0; i < hexstring.size(); i++)
-        {
-            const char c = hexstring[i];
-
-            // Get value
-            std::size_t value;
-            if ((c >= '0') && (c <= '9'))
-                // Is it a number?
-                value = ((std::size_t)c - '0') + 0;
-            else if ((c >= 'a') && (c <= 'f'))
-                // Else, it is a lowercase letter
-                value = ((std::size_t)c - 'a') + 10;
-            else
-                throw std::logic_error("non-hex string detected in HexstringToBits()");
-
-            // Append to our bits
-            ss << std::bitset<4>(value);
-        }
-
-        return ss.str();
-    }
-
-    //! Creates a key of size BLOCK_SIZE from a password of arbitrary length.
-    //! Using passwords larger (in bits) than BLOCK_SIZE is generally not recommended.
-    //! Note that if your password is shorter (in bits) than BLOCK_SIZE, the rest of the key will be padded with 0 (see next line!).
-    //! To provide a better initial key, (and to get rid of padding zeroes), the raw result (b) will be xor'd with an initialization vector based on b.
-    //! : return b ^ iv(b)
-    inline Block PasswordToKey(const std::string& in)
-    {
-        Block b;
-
-        // Segment the password in segments of key-size, and xor them together.
-        for (std::size_t i = 0; i < in.size(); i += BLOCK_SIZE / 8)
-            b ^= StringToBitblock(
-                PadStringToLength(in.substr(i, BLOCK_SIZE / 8), BLOCK_SIZE / 8, 0, false)
-            );
-
-        return b ^ InitializationVector(b);
-    }
-
-    //! Will read a file into a flexblock
-    inline Flexblock ReadFileToBits(const std::string& filepath)
-    {
-        // Read file
-        std::ifstream ifs(filepath, std::ios::binary);
-
-        if (!ifs.good())
-            throw std::runtime_error("Unable to open ifilestream!");
-
-        std::stringstream ss;
-        std::copy(
-            std::istreambuf_iterator<char>(ifs),
-            std::istreambuf_iterator<char>(),
-            std::ostreambuf_iterator<char>(ss)
-        );
-
-        ifs.close();
-
-        const std::string bytes = ss.str();
-
-        // Convert bytes to bits
-        return StringToBits(bytes);
-    }
-
-    //! Will save bits to a binary file
-    inline void WriteBitsToFile(const std::string& filepath, const Flexblock& bits)
-    {
-        // Convert bits to bytes
-        const std::string bytes = BitsToBytes(bits);
-
-        // Write bits to file
-        std::ofstream ofs(filepath, std::ios::binary);
-
-        if (!ofs.good())
-            throw std::runtime_error("Unable to open ofilestream!");
-
-        ofs.write(bytes.data(), bytes.length());
-        ofs.close();
-
-        return;
-    }
-}
-
-/*** ./../GhettoCrypt/Keyset.h ***/
-
-#pragma once
-#include <array>
-
-namespace GhettoCipher
-{
-	typedef std::array<Block, N_ROUNDS> Keyset;
-}
-
-/*** ./../GhettoCrypt/Feistel.h ***/
-
-#pragma once
-
-namespace GhettoCipher
-{
-	/** Class to perform a feistel block chipher
-	*/
-	class Feistel
-	{
-	public:
-		explicit Feistel(const Block& key);
-
-		Feistel(const Feistel& other) = delete;
-		Feistel(Feistel&& other) noexcept = delete;
-
-		~Feistel();
-
-		//! Will set the seed-key for this feistel network.
-		//! Roundkeys will be derived from this.
-		void SetKey(const Block& key);
-
-		//! Will encipher a data block via the set seed-key
-		Block Encipher(const Block& data);
-
-		//! Will decipher a data block via the set seed-key
-		Block Decipher(const Block& data);
-
-	private:
-		//! Will run the feistel rounds, with either regular key order or reversed key order
-		Block Run(const Block& data, bool reverseKeys);
-
-		//! Arbitrary cipher function
-		static Halfblock F(Halfblock m, const Block& key);
-
-		//! Split a data block into two half blocks (into L and R)
-		static std::pair<Halfblock, Halfblock> FeistelSplit(const Block& block);
-
-		//! Combine two half blocks (L and R) into a regular data block
-		static Block FeistelCombine(const Halfblock& l, const Halfblock& r);
-
-		//! Will expand a halfblock to a fullblock
-		static Block ExpansionFunction(const Halfblock& block);
-
-		//! Will compress a fullblock to a halfblock
-		static Halfblock CompressionFunction(const Block& block);
-
-		//! Substitutes four bits by static random others
-		static std::string SBox(const std::string& in);
-
-		//! Will generate a the round keys
-		void GenerateRoundKeys(const Block& seedKey);
-
-		//! Will zero the memory used by the keyset
-		void ZeroKeyMemory();
-
-		Keyset roundKeys;
-	};
-}
-
-/*** ./../GhettoCrypt/Cipher.h ***/
-
-#pragma once
-
-namespace GhettoCipher
-{
-	/** Class to apply a block cipher to messages of arbitrary length in a distributed manner
-	*/
-	class Cipher
-	{
-	public:
-		explicit Cipher(const Block& key);
-		explicit Cipher(const std::string& password);
-
-		Cipher(const Cipher& other) = delete;
-		Cipher(Cipher&& other) noexcept = delete;
-
-		~Cipher();
-
-		//! Will set the key
-		void SetKey(const Block& key);
-
-		//! Will set the key from a password
-		void SetPassword(const std::string& password);
-
-		//! Will encipher a flexblock of data
-		Flexblock Encipher(const Flexblock& data, bool printProgress = false) const;
-
-		//! Will decipher a flexblock of data
-		Flexblock Decipher(const Flexblock& data, bool printProgress = false) const;
-
-	private:
-		Block key;
-
-		//! Will zero the memory used by the key
-		void ZeroKeyMemory();
-
-		// Initial value for cipher block chaining
-		Block initializationVector;
-	};
-}

INCLUDE/generate.sh

@@ -1,8 +0,0 @@
-# Compile single-header
-deggl -i ../GhettoCrypt/*.cpp ../GhettoCrypt/Version.h --out GhettoCrypt --loc --license-file ../LICENSE
-
-
-# Verify that this builds cleanly via g++
-echo "Verifying build..."
-g++ GhettoCrypt.cpp -c -S -o - -Wall > /dev/null
-echo "If you saw no compiler errors, everything's good!"

LICENSE

@@ -1,25 +1,674 @@
-BSD 2-Clause License
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-Copyright (c) 2021, Leon Etienne
-All rights reserved.
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+                            Preamble
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

SimpleTests/.gitignore

@@ -1,2 +0,0 @@
-/testfile.png.crypt
-/testfile.png.clear.png

SimpleTests/SimpleTests.vcxproj

@@ -1,171 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <ItemGroup Label="ProjectConfigurations">
-    <ProjectConfiguration Include="Debug|Win32">
-      <Configuration>Debug</Configuration>
-      <Platform>Win32</Platform>
-    </ProjectConfiguration>
-    <ProjectConfiguration Include="Release|Win32">
-      <Configuration>Release</Configuration>
-      <Platform>Win32</Platform>
-    </ProjectConfiguration>
-    <ProjectConfiguration Include="Debug|x64">
-      <Configuration>Debug</Configuration>
-      <Platform>x64</Platform>
-    </ProjectConfiguration>
-    <ProjectConfiguration Include="Release|x64">
-      <Configuration>Release</Configuration>
-      <Platform>x64</Platform>
-    </ProjectConfiguration>
-  </ItemGroup>
-  <PropertyGroup Label="Globals">
-    <VCProjectVersion>16.0</VCProjectVersion>
-    <ProjectGuid>{9AE03058-3A1E-461E-A2C2-33C5C9D0F4CB}</ProjectGuid>
-    <Keyword>Win32Proj</Keyword>
-    <RootNamespace>SimpleTests</RootNamespace>
-    <WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
-    <ProjectSubType>NativeUnitTestProject</ProjectSubType>
-  </PropertyGroup>
-  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
-    <ConfigurationType>DynamicLibrary</ConfigurationType>
-    <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>v142</PlatformToolset>
-    <CharacterSet>Unicode</CharacterSet>
-    <UseOfMfc>false</UseOfMfc>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
-    <ConfigurationType>DynamicLibrary</ConfigurationType>
-    <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>v142</PlatformToolset>
-    <WholeProgramOptimization>true</WholeProgramOptimization>
-    <CharacterSet>Unicode</CharacterSet>
-    <UseOfMfc>false</UseOfMfc>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
-    <ConfigurationType>DynamicLibrary</ConfigurationType>
-    <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>v142</PlatformToolset>
-    <CharacterSet>Unicode</CharacterSet>
-    <UseOfMfc>false</UseOfMfc>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
-    <ConfigurationType>DynamicLibrary</ConfigurationType>
-    <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>v142</PlatformToolset>
-    <WholeProgramOptimization>true</WholeProgramOptimization>
-    <CharacterSet>Unicode</CharacterSet>
-    <UseOfMfc>false</UseOfMfc>
-  </PropertyGroup>
-  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
-  <ImportGroup Label="ExtensionSettings">
-  </ImportGroup>
-  <ImportGroup Label="Shared">
-  </ImportGroup>
-  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
-    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-  </ImportGroup>
-  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
-    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-  </ImportGroup>
-  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
-    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-  </ImportGroup>
-  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
-    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
-  </ImportGroup>
-  <PropertyGroup Label="UserMacros" />
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
-    <LinkIncremental>false</LinkIncremental>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
-    <LinkIncremental>true</LinkIncremental>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
-    <LinkIncremental>true</LinkIncremental>
-  </PropertyGroup>
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
-    <LinkIncremental>false</LinkIncremental>
-  </PropertyGroup>
-  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
-    <ClCompile>
-      <PrecompiledHeader>NotUsing</PrecompiledHeader>
-      <WarningLevel>Level3</WarningLevel>
-      <FunctionLevelLinking>true</FunctionLevelLinking>
-      <IntrinsicFunctions>true</IntrinsicFunctions>
-      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(VCInstallDir)UnitTest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
-      <PreprocessorDefinitions>NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
-      <UseFullPaths>true</UseFullPaths>
-      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-    </ClCompile>
-    <Link>
-      <SubSystem>Windows</SubSystem>
-      <EnableCOMDATFolding>true</EnableCOMDATFolding>
-      <OptimizeReferences>true</OptimizeReferences>
-      <AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
-    </Link>
-  </ItemDefinitionGroup>
-  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
-    <ClCompile>
-      <PrecompiledHeader>NotUsing</PrecompiledHeader>
-      <WarningLevel>Level3</WarningLevel>
-      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(VCInstallDir)UnitTest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
-      <PreprocessorDefinitions>WIN32;_DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
-      <UseFullPaths>true</UseFullPaths>
-      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-    </ClCompile>
-    <Link>
-      <SubSystem>Windows</SubSystem>
-      <AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
-    </Link>
-  </ItemDefinitionGroup>
-  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
-    <ClCompile>
-      <PrecompiledHeader>NotUsing</PrecompiledHeader>
-      <WarningLevel>Level3</WarningLevel>
-      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(VCInstallDir)UnitTest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
-      <PreprocessorDefinitions>_DEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
-      <UseFullPaths>true</UseFullPaths>
-      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-    </ClCompile>
-    <Link>
-      <SubSystem>Windows</SubSystem>
-      <AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
-    </Link>
-  </ItemDefinitionGroup>
-  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
-    <ClCompile>
-      <PrecompiledHeader>NotUsing</PrecompiledHeader>
-      <WarningLevel>Level3</WarningLevel>
-      <FunctionLevelLinking>true</FunctionLevelLinking>
-      <IntrinsicFunctions>true</IntrinsicFunctions>
-      <SDLCheck>true</SDLCheck>
-      <AdditionalIncludeDirectories>$(VCInstallDir)UnitTest\include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
-      <PreprocessorDefinitions>WIN32;NDEBUG;%(PreprocessorDefinitions)</PreprocessorDefinitions>
-      <UseFullPaths>true</UseFullPaths>
-      <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-    </ClCompile>
-    <Link>
-      <SubSystem>Windows</SubSystem>
-      <EnableCOMDATFolding>true</EnableCOMDATFolding>
-      <OptimizeReferences>true</OptimizeReferences>
-      <AdditionalLibraryDirectories>$(VCInstallDir)UnitTest\lib;%(AdditionalLibraryDirectories)</AdditionalLibraryDirectories>
-    </Link>
-  </ItemDefinitionGroup>
-  <ItemGroup>
-    <ClCompile Include="EncryptEqualsDecrypt.cpp" />
-    <ClCompile Include="GCWrapper.cpp" />
-    <ClCompile Include="Password2Key_CollisionResistance.cpp" />
-  </ItemGroup>
-  <ItemGroup>
-    <ProjectReference Include="..\GhettoCrypt\GhettoCrypt.vcxproj">
-      <Project>{2b2cf665-f5e6-44db-961f-fc81c88a356d}</Project>
-    </ProjectReference>
-  </ItemGroup>
-  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
-  <ImportGroup Label="ExtensionTargets">
-  </ImportGroup>
-</Project>

SimpleTests/SimpleTests.vcxproj.filters

@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <ItemGroup>
-    <Filter Include="Quelldateien">
-      <UniqueIdentifier>{4FC737F1-C7A5-4376-A066-2A32D752A2FF}</UniqueIdentifier>
-      <Extensions>cpp;c;cc;cxx;c++;cppm;ixx;def;odl;idl;hpj;bat;asm;asmx</Extensions>
-    </Filter>
-    <Filter Include="Headerdateien">
-      <UniqueIdentifier>{93995380-89BD-4b04-88EB-625FBE52EBFB}</UniqueIdentifier>
-      <Extensions>h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd</Extensions>
-    </Filter>
-    <Filter Include="Ressourcendateien">
-      <UniqueIdentifier>{67DA6AB6-F800-4c08-8B7A-83BB121AAD01}</UniqueIdentifier>
-      <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
-    </Filter>
-  </ItemGroup>
-  <ItemGroup>
-    <ClCompile Include="EncryptEqualsDecrypt.cpp">
-      <Filter>Quelldateien</Filter>
-    </ClCompile>
-    <ClCompile Include="GCWrapper.cpp">
-      <Filter>Quelldateien</Filter>
-    </ClCompile>
-    <ClCompile Include="Password2Key_CollisionResistance.cpp">
-      <Filter>Quelldateien</Filter>
-    </ClCompile>
-  </ItemGroup>
-</Project>

readme.md

@@ -101,29 +101,679 @@ knowing the password(=cleartext) to begin with. *You could make a hashfunction o
 
 ## LICENSE
 ```
-BSD 2-Clause License
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
 
-Copyright (c) 2021, Leon Etienne
-All rights reserved.
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+                            Preamble
 
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
 
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
 ```
+