QuasarApp/easyssl
4
1
Fork 0
mirror of https://github.com/QuasarApp/easyssl.git synced 2025-04-26 04:54:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review
Some checks failed
buildbot/DocsGenerator Build finished.
Details
buildbot/LinuxCMakeBuilderQt6 Build finished.
Details
buildbot/WindowsCMakeBuilder Build finished.
Details
buildbot/AndroidBuilder_v8Qt6 Build finished.
Details
buildbot/IOSCMakeBuilder Build finished.
Details

Browse Source 
Co-authored-by: usermeme <romanyankovich98@gmail.com>
This commit is contained in:
Andrei Yankovich 2023-07-19 10:03:07 +03:00 committed by GitHub
parent c7508736dd
commit ad328f0447
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/lib/src/private/easysslutils.h
View File

@ -11,59 +11,59 @@
namespace EasySSL {
/**
* @brief The EasySSLUtils class This is base utils for work with opwnssl library.
* @brief The EasySSLUtils class These are basic utils for work with the opwnssl library.
*/
class EasySSLUtils {
public:
/**
* @brief printlastOpenSSlError This method print last ssl error message.
* @brief printlastOpenSSlError This method prints the latest ssl error message.
*/
static void printlastOpenSSlError();
/**
* @brief bignumToArray This method convert openssl BIGNUM into byteArray
* @param num This is big num of the openssl library
* @brief bignumToArray This method converts openssl BIGNUM into byteArray
* @param num This is a big num of the openssl library
* @return bytes array.
*/
static QByteArray bignumToArray(const BIGNUM* num);
/**
* @brief bignumFromArray This method convert Qt bytes array into opensll big num.
* @param array This is input array.
* @brief bignumFromArray This method converts the Qt bytes array into the opensll big num.
* @param array This is an input array.
* @return big num pointer.
* @note This result pointer will not free automatically. Please free returned pointer after using.
* @note This result pointer will not be free automatically. Please free the returned pointer after use.
*/
[[nodiscard("This pointer will not free automatically. Please free returned pointer after using.")]]
[[nodiscard("The result pointer will not be free automatically. Please free the returned pointer after using.")]]
static BIGNUM* bignumFromArray(const QByteArray& array);
/**
* @brief bioToByteArray This method conver openssl BIO to QByteArry
* @brief bioToByteArray This method converts the openssl BIO to the QByteArry
* @param bio input arrary.
* @return Qt Array
*/
static QByteArray bioToByteArray(BIO *bio);
/**
* @brief byteArrayToBio This method create BIO struct from the Qt QByteArray object.
* @param byteArray This is input Qt byte array.
* @return pointer tot the BIO.
* @note Do not forget free result pointer.
* @brief byteArrayToBio This method creates the BIO struct from the Qt QByteArray object.
* @param byteArray This is an input Qt byte array.
* @return pointer to the BIO struct of OpenSLL library.
* @note Don't forget to free the result pointer.
*/
[[nodiscard("This pointer will not free automatically. Please free returned pointer after using.")]]
static BIO *byteArrayToBio(const QByteArray &byteArray);
/**
* @brief extractPublcKey This method extracts publick key from the ssl (pem) structure.
* @param ssl_keys This is ssl keys objects.
* @brief extractPublcKey This method extracts the public key from the ssl (pem) structure.
* @param ssl_keys These are objects of the ssl keys.
* @return bytes array of the extracted key.
*/
static QByteArray extractPublcKey(EVP_PKEY* ssl_keys);
/**
* @brief extractPrivateKey This method extracts private key from the ssl (pem) structure.
* @param ssl_keys This is ssl keys objects.
* @brief extractPrivateKey This method extracts the private key from the ssl (pem) structure.
* @param ssl_keys These are objects of the ssl keys.
* @return bytes array of the extracted key.
*/
static QByteArray extractPrivateKey(EVP_PKEY* ssl_keys);

2
src/lib/src/public/easyssl/ecdsassl.h
View File

@ -56,7 +56,7 @@ public:
QByteArray encrypt(const QByteArray &message, const QByteArray &key) override;
/**
* @brief curve This method return current curve method. using only for generate new pair keys.
* @brief curve This method returns the current curve method. Using only for generating new pair of keys.
* @return current cursve type.
* @see EllipticCurveStandart
*/