Crypto module (#309)

* crypto module

* Crypto module added

* Moved from Crypto.h to Crypto.cpp

---------

Co-authored-by: Michał Cieślar <[email protected]>

CMakeLists.txt

@@ -54,7 +54,8 @@ set(FAKER_SOURCES
     src/modules/weather/Weather.cpp
     src/common/WeatherHelper.cpp
     src/modules/airline/Airline.cpp
-    src/modules/image/Image.cpp)
+    src/modules/image/Image.cpp
+    src/modules/crypto/Crypto.cpp)
 
 set(FAKER_UT_SOURCES
     src/modules/animal/AnimalTest.cpp
@@ -91,7 +92,8 @@ set(FAKER_UT_SOURCES
     src/modules/weather/WeatherTest.cpp
     src/common/WeatherHelperTest.cpp
     src/modules/airline/AirlineTest.cpp
-    src/modules/image/ImageTest.cpp)
+    src/modules/image/ImageTest.cpp
+    src/modules/crypto/CryptoTest.cpp)
 
 add_library(${LIBRARY_NAME} ${FAKER_SOURCES})
 

ExternalLicenses.txt

@@ -0,0 +1,49 @@
+External repositories licenses:
+
+    1. flexxxxer/md5_hash:
+
+MIT License
+
+Copyright (c) 2019 Alexandr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+    2. System-Glitch/SHA256:
+
+MIT License
+
+Copyright (c) 2021 Jérémy LAMBERT (SystemGlitch)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

include/faker-cxx/Crypto.h

@@ -0,0 +1,40 @@
+#pragma once
+
+#include <array>
+#include <cstdint>
+#include <cstring>
+#include <iomanip>
+#include <optional>
+#include <sstream>
+#include <string>
+
+namespace faker
+{
+class Crypto
+{
+public:
+    /**
+     * @brief Returns a random SHA256 hash or hash of provided data.
+     *
+     * @returns SHA256 hash string.
+     *
+     * @code
+     * Crypto::sha256("hello world") // "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
+     * Crypto::sha256()    // Random hash of random word
+     * @endcode
+     */
+    static std::string sha256(std::optional<std::string> = std::nullopt);
+
+    /**
+     * @brief Returns a random MD5 hash or hash of provided data.
+     *
+     * @returns MD5 hash string.
+     *
+     * @code
+     * Crypto::md5("hello world") // "5eb63bbbe01eeed093cb22bb8f5acdc3"
+     * Crypto::md5()    // Random hash of random word
+     * @endcode
+     */
+    static std::string md5(std::optional<std::string> = std::nullopt);
+};
+}