mirror of
https://github.com/QuasarApp/easyssl.git
synced 2025-05-08 18:29:34 +00:00
simple changes
This commit is contained in:
parent
5d279991f4
commit
5ae4009840
48
README.md
48
README.md
@ -1,9 +1,10 @@
|
||||
# EasySSL
|
||||
This is simple wrapper library that make using ssl simple.
|
||||
This is wrapper library that make using OpenSSL library more simple.
|
||||
This library contains interfaces for the signing and encription data.
|
||||
|
||||
### Supported encription alhorithms:
|
||||
* edsa based on sll 1.1
|
||||
* ECDSA
|
||||
* RSA
|
||||
|
||||
### Supported features
|
||||
* encription
|
||||
@ -33,7 +34,48 @@ This library contains interfaces for the signing and encription data.
|
||||
|
||||
## Usage
|
||||
|
||||
Authentication
|
||||
### Encription
|
||||
|
||||
```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)
|
||||
|
||||
```
|
||||
|
||||
|
||||
### Authentication
|
||||
|
||||
```cpp
|
||||
#include <easyssl/authecdsa.h>
|
||||
|
@ -51,7 +51,7 @@ PROJECT_BRIEF = EasySSL is base back end library for your c++ Qt projec
|
||||
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
||||
# the logo to the output directory.
|
||||
|
||||
PROJECT_LOGO = res/Logo_Web_alpha.png
|
||||
PROJECT_LOGO =
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||
# into which the generated documentation will be written. If a relative path is
|
||||
|
@ -15,7 +15,7 @@
|
||||
namespace EasySSL {
|
||||
|
||||
/**
|
||||
* @brief The ECDSASSL11 class is ecdsa implementation of the Async authentication. This implementation based on Openssl library.
|
||||
* @brief The ECDSASSL class is ecdsa implementation of the Async authentication. This implementation based on Openssl library.
|
||||
*/
|
||||
class EASYSSL_EXPORT ECDSASSL: public EasySSL::ICrypto
|
||||
{
|
||||
|
@ -17,7 +17,8 @@
|
||||
namespace EasySSL {
|
||||
|
||||
/**
|
||||
* @brief The SslSrtData struct This structure contains base information for generate self signed ssl certefication.
|
||||
* @brief The SslSrtData struct This structure contains base information to generate self-signed SSL certification.
|
||||
* Use this interface for creating a new certificates algorithms.
|
||||
*/
|
||||
struct SslSrtData {
|
||||
QString country = "BY";
|
||||
|
@ -17,7 +17,7 @@
|
||||
namespace EasySSL {
|
||||
|
||||
/**
|
||||
* @brief The ICrypto class This is base interface that provide encription functionality.
|
||||
* @brief The ICrypto class, This is base interface that provide encryption functionality.
|
||||
*/
|
||||
class EASYSSL_EXPORT ICrypto
|
||||
{
|
||||
@ -25,7 +25,7 @@ class EASYSSL_EXPORT ICrypto
|
||||
public:
|
||||
|
||||
/**
|
||||
* @brief The Features enum this is list of the supported ecription features
|
||||
* @brief The Features enum this is list of the supported description features
|
||||
*/
|
||||
enum Features {
|
||||
/// Signin and check sign of the data.
|
||||
|
@ -15,7 +15,7 @@
|
||||
namespace EasySSL {
|
||||
|
||||
/**
|
||||
* @brief The RSASSL30 class This is wrapper for RSA algorithm of openssl 3.0 libraryry.
|
||||
* @brief The RSASSL class This is wrapper for RSA algorithm of openssl 3.0 libraryry.
|
||||
*/
|
||||
class EASYSSL_EXPORT RSASSL: public EasySSL::ICrypto
|
||||
{
|
||||
|
Loading…
x
Reference in New Issue
Block a user