Skip to content

Latest commit

 

History

History
112 lines (77 loc) · 2.81 KB

README.md

File metadata and controls

112 lines (77 loc) · 2.81 KB
Raw

EasySSL

This is wrapper library that make using OpenSSL library more simple. This library contains interfaces for the signing and encryption data.

Supported encryption algorithms:

  • ECDSA
  • RSA

Supported features

  • encryption
  • signing
  • keys creating
  • asyn auth bse on the asyn encryptions methods

Build and Include

CMake

  • cd yourRepo

  • git submodule add https://github.com/QuasarApp/easyssl.git # add the repository of EasySSL into your repo like submodule

  • git submodule update --init --recursive

  • Include in your CMakeLists.txt file the main CMakeLists.txt file of EasySSL library

    add_subdirectory(easyssl)

  • link the EasySSL library to your target

    target_link_libraries(yourLib PUBLIC easyssl)

  • rebuild yuor project

Independet of SSL build

Dependency on the ssl library greatly complicates the deployment of the final product. For fix this issue, you can build EasySSL library with static SSL library. In this case, SSL library code will be saved in your EasySell binary, and deploy of your application will be easily. The ssl code will not available for your application or other libraries, so you will not get conflicts between different major versions ssl libraries if your distribution kit has it.

Just set the EASYSSL_STATIC_SSL option to true.

cmake .. -DEASYSSL_STATIC_SSL=1

The described case may be useful for the Qt 5.15.x, because the QNetwork 5.15 depends on the SSL v1.1 and EasySsl works with the SSL >= 3.0.

Usage

Encryption

#include "easyssl/rsassl.h"

// create a publick and private keys array.
int main() {
    QByteArray pub, priv;
    EasySSL::RSASSL crypto;
    crypto.makeKeys(pub, priv)

    auto siganture = crypto.signMessage(message, priv);
    crypto.checkSign(message, siganture, pub);

    auto encryptedMsg = crypto.encrypt(message, pub);
    auto decryptedMsg = crypto.decrypt(encryptedMsg, priv);
}

Authentication

#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)

Do not forget to help us make this library better...

See our main documentation about contributing to EasySsl

Full documentation available here