first version

QuasarApp · Mar 26, 2023 · a6c3973 · a6c3973
1 parent e69c43f
commit a6c3973
Show file tree

Hide file tree

Showing 20 changed files with 92 additions and 31 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,6 +1,6 @@
 #
 # Copyright (C) 2020-2023 QuasarApp.
-# Distributed under the lgplv3 software license, see the accompanying
+# Distributed under the GPLv3 software license, see the accompanying
 # Everyone is permitted to copy and distribute verbatim copies
 # of this license document, but changing it is not allowed.
 #

diff --git a/README.md b/README.md
@@ -1,15 +1,76 @@
-# CMakeProject
-Template repository for cmake project
-Fork me and replase easyssl to Name of your new project.
+# EasySSL
+This is simple wrapper library that make using ssl simple. 
+This library contains interfaces for the signing and encription data.
 
-1. Clone this repository 
-2. Run ./init.sh NewProjectName 
+### Supported encription alhorithms:
+* edsa based on sll 1.1 
+
+### Supported features
+* encription 
+* signing
+* keys creating
+* asyn auth bse on the asyn encriptions methods
+
+
+## Build and Include
+
+ * cd yourRepo
+ * git submodule add https://github.com/QuasarApp/easyssl.git # add the repository of Heart into your repo like submodule
+ * git submodule update --init --recursive
+ * Include in your CMakeLists.txt file the main CMakeLists.txt file of Heart library
+
+     ```cmake
+     add_subdirectory(easyssl)
+     ```
+     
+ * link the Heart library to your target
+     ```cmake
+     target_link_libraries(yourLib PUBLIC easyssl)
+     ```
+ * rebuild yuor project
+
+
+
+## Usage
+
+Authentication 
+
+```cpp
+#include <easyssl/authecdsa.h>
+
+class ECDSA: public EasySSL::AuthECDSA {
+
+public:
+
+    // AsyncKeysAuth interface
+    void setPrivateKey(const QByteArray &newPriv) {
+        _priv = newPriv;
+    }
+
+    QByteArray getPrivateKey() const {
+        return _priv;
+    };
+
+private:
+    QByteArray _priv;
+
+};
+
+ECDSA edsa;
+QByteArray pub, priv;
+QString userID;
+
+// make public and private keys.
+edsa.makeKeys(pub, priv);
+edsa.setPrivateKey(priv);
+edsa.setPublicKey(pub);
+
+// prepare an authentication object.
+edsa.prepare();
+edsa.setPrivateKey({});
+
+edsa.auth(1000, &userID)
+
+```
 
-# This template supports next build targets:
 
-|   Command or make target   |  Description    |
-|------|------|
-| **make test** | The run tests for a project (dependet of Qt Tests, so you need to add Qt in Cmake using CMAKE_PREFIX_PATH) |
-| **make doc** | The generate a documentation for a project (dependet of doxygen) |
-| **make deploy** | The generate distribution for a project (dependet of CQtDeployer) |
-| **make release** | The prepare Qt Installer framework repository for a project, generate a snap package and APK file for android (dependet of CQtDeployer,  snapcraft, AndroidDeployer). |
diff --git a/src/lib/CMakeLists.txt b/src/lib/CMakeLists.txt
@@ -1,6 +1,6 @@
 #
 # Copyright (C) 2020-2023 QuasarApp.
-# Distributed under the lgplv3 software license, see the accompanying
+# Distributed under the GPLv3 software license, see the accompanying
 # Everyone is permitted to copy and distribute verbatim copies
 # of this license document, but changing it is not allowed.
 #

diff --git a/src/lib/src/public/easyssl.cpp b/src/lib/src/public/easyssl.cpp
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2021-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/src/lib/src/public/easyssl.h b/src/lib/src/public/easyssl.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2021-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/src/lib/src/public/easyssl/asynckeysauth.h b/src/lib/src/public/easyssl/asynckeysauth.h
@@ -1,6 +1,6 @@
 /*
  * Copyright (C) 2021-2023 QuasarApp.
- * Distributed under the lgplv3 software license, see the accompanying
+ * Distributed under the GPLv3 software license, see the accompanying
  * Everyone is permitted to copy and distribute verbatim copies
  * of this license document, but changing it is not allowed.
 */

diff --git a/src/lib/src/public/easyssl/authecdsa.h b/src/lib/src/public/easyssl/authecdsa.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2021-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/src/lib/src/public/easyssl/ecdsassl11.cpp b/src/lib/src/public/easyssl/ecdsassl11.cpp
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2021-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/src/lib/src/public/easyssl/ecdsassl11.h b/src/lib/src/public/easyssl/ecdsassl11.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2021-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/src/lib/src/public/easyssl/global.h.in b/src/lib/src/public/easyssl/global.h.in
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2018-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/src/lib/src/public/easyssl/icrypto.h b/src/lib/src/public/easyssl/icrypto.h
@@ -1,6 +1,6 @@
 /*
  * Copyright (C) 2021-2023 QuasarApp.
- * Distributed under the lgplv3 software license, see the accompanying
+ * Distributed under the GPLv3 software license, see the accompanying
  * Everyone is permitted to copy and distribute verbatim copies
  * of this license document, but changing it is not allowed.
 */

diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -1,6 +1,6 @@
 #
 # Copyright (C) 2020-2023 QuasarApp.
-# Distributed under the lgplv3 software license, see the accompanying
+# Distributed under the GPLv3 software license, see the accompanying
 # Everyone is permitted to copy and distribute verbatim copies
 # of this license document, but changing it is not allowed.
 #

diff --git a/tests/tstMain.cpp b/tests/tstMain.cpp
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/authtest.cpp b/tests/units/authtest.cpp
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/authtest.h b/tests/units/authtest.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/cryptotest.h b/tests/units/cryptotest.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/test.cpp b/tests/units/test.cpp
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/test.h b/tests/units/test.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/testutils.cpp b/tests/units/testutils.cpp
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#

diff --git a/tests/units/testutils.h b/tests/units/testutils.h
@@ -1,6 +1,6 @@
 //#
 //# Copyright (C) 2020-2023 QuasarApp.
-//# Distributed under the lgplv3 software license, see the accompanying
+//# Distributed under the GPLv3 software license, see the accompanying
 //# Everyone is permitted to copy and distribute verbatim copies
 //# of this license document, but changing it is not allowed.
 //#