merged AI doc, some new pages
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
/*! \file piauth.h
|
||||
* \ingroup Crypt
|
||||
* \~\brief
|
||||
* \~english Authentication API
|
||||
* \~russian API аутентификации
|
||||
*/
|
||||
//! \~\file piauth.h
|
||||
//! \~\ingroup Crypt
|
||||
//! \~\brief
|
||||
//! \~english Authentication API
|
||||
//! \~russian API аутентификации
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
PIP Authentication API
|
||||
@@ -31,72 +30,110 @@
|
||||
#include "pip_crypt_export.h"
|
||||
|
||||
|
||||
//! \~\ingroup Crypt
|
||||
//! \~\brief
|
||||
//! \~english Peer authentication state machine with signed key exchange.
|
||||
//! \~russian Машина состояний аутентификации узлов с подписанным обменом ключами.
|
||||
class PIP_CRYPT_EXPORT PIAuth: public PIObject {
|
||||
PIOBJECT(PIAuth)
|
||||
|
||||
public:
|
||||
//! \~english Handshake state.
|
||||
//! \~russian Состояние рукопожатия.
|
||||
enum State {
|
||||
NotConnected,
|
||||
AuthProbe,
|
||||
PassRequest,
|
||||
AuthReply,
|
||||
KeyExchange,
|
||||
Connected
|
||||
NotConnected /** \~english No active authentication session. \~russian Активной сессии аутентификации нет. */,
|
||||
AuthProbe /** \~english Initial probe stage with signed peer introduction. \~russian Начальный этап с подписанным представлением
|
||||
узла. */
|
||||
,
|
||||
PassRequest /** \~english Password verification stage for unknown peers. \~russian Этап проверки пароля для неизвестных узлов. */,
|
||||
AuthReply /** \~english Reply with client authentication data. \~russian Ответ с данными аутентификации клиента. */,
|
||||
KeyExchange /** \~english Session key exchange stage. \~russian Этап обмена сеансовым ключом. */,
|
||||
Connected /** \~english Authentication finished and session key is established. \~russian Аутентификация завершена и сеансовый ключ
|
||||
установлен. */
|
||||
};
|
||||
|
||||
//! Create PIAuth with your digital sign
|
||||
|
||||
//! \~english Creates an authentication endpoint from a signing secret key.
|
||||
//! \~russian Создает конечную точку аутентификации из секретного ключа подписи.
|
||||
PIAuth(const PIByteArray & sign);
|
||||
|
||||
//! Set server info data for client authorize event
|
||||
|
||||
//! \~english Sets application-defined info exchanged during authorization.
|
||||
//! \~russian Задает прикладные данные, передаваемые во время авторизации.
|
||||
void setInfoData(const PIByteArray & info) { custom_info = info; }
|
||||
|
||||
//! Set server password for check
|
||||
//! \~english Sets the server password used for password-based peer validation.
|
||||
//! \~russian Устанавливает пароль сервера, используемый для проверки узла по паролю.
|
||||
void setServerPassword(const PIString & ps);
|
||||
|
||||
//! Set list of trusted clients/servers public digital sign keys
|
||||
//! \~english Replaces the list of trusted peer signing public keys.
|
||||
//! \~russian Заменяет список доверенных открытых ключей подписи удаленных узлов.
|
||||
void setAuthorizedPublicKeys(const PIVector<PIByteArray> & pkeys) { auth_pkeys = pkeys; }
|
||||
|
||||
//! Get list of trusted clients/servers public digital sign keys
|
||||
//! \~english Returns the list of trusted peer signing public keys.
|
||||
//! \~russian Возвращает список доверенных открытых ключей подписи удаленных узлов.
|
||||
PIVector<PIByteArray> getAuthorizedPublicKeys() { return auth_pkeys; }
|
||||
|
||||
//! Get your digital sign public key
|
||||
//! \~english Returns the public signing key derived from the local secret key.
|
||||
//! \~russian Возвращает открытый ключ подписи, полученный из локального секретного ключа.
|
||||
PIByteArray getSignPublicKey() { return sign_pk; }
|
||||
|
||||
|
||||
//! Stop authorization
|
||||
//! \~english Stops the current authorization session and clears transient keys.
|
||||
//! \~russian Останавливает текущую сессию авторизации и очищает временные ключи.
|
||||
void stop();
|
||||
|
||||
//! Start authorization as client
|
||||
//! \~english Starts the handshake in client mode.
|
||||
//! \~russian Запускает рукопожатие в режиме клиента.
|
||||
void startClient();
|
||||
|
||||
//! Start authorization as server, return first server message for client
|
||||
//! \~english Starts the handshake in server mode and returns the first packet for the client.
|
||||
//! \~russian Запускает рукопожатие в режиме сервера и возвращает первый пакет для клиента.
|
||||
PIByteArray startServer();
|
||||
|
||||
//! Process reseived message both for client and server, return current state and new message writed in "ba"
|
||||
//! \~english Processes an incoming handshake packet, updates the state and writes the reply back to \a ba.
|
||||
//! \~russian Обрабатывает входящий пакет рукопожатия, обновляет состояние и записывает ответ обратно в \a ba.
|
||||
State receive(PIByteArray & ba);
|
||||
|
||||
//! Get session secret key, return key only when Connected state
|
||||
//! \~english Returns the session secret key after the state becomes \a Connected.
|
||||
//! \~russian Возвращает сеансовый секретный ключ после перехода в состояние \a Connected.
|
||||
PIByteArray getSecretKey();
|
||||
|
||||
//! Generate digital sign from seed
|
||||
//! \~english Generates a signing secret key from \a seed.
|
||||
//! \~russian Генерирует секретный ключ подписи из \a seed.
|
||||
static PIByteArray generateSign(const PIByteArray & seed);
|
||||
|
||||
|
||||
//! Disconneted event
|
||||
//! \events
|
||||
//! \{
|
||||
|
||||
//! \fn void disconnected(PIString reason)
|
||||
//! \~english Raised when the handshake is aborted or an established session is dropped.
|
||||
//! \~russian Вызывается при прерывании рукопожатия или разрыве установленной сессии.
|
||||
EVENT1(disconnected, PIString, reason);
|
||||
|
||||
//! Conneted event
|
||||
//! \fn void connected(PIString info)
|
||||
//! \~english Raised after the peer reaches state \a Connected.
|
||||
//! \~russian Вызывается после перехода узла в состояние \a Connected.
|
||||
EVENT1(connected, PIString, info);
|
||||
|
||||
//! Client event for authorize new server
|
||||
//! \fn void authorize(PIByteArray info, bool * ok)
|
||||
//! \~english Client-side callback used to approve an unknown server and optionally trust its signing key.
|
||||
//! \~russian Клиентский вызов для подтверждения неизвестного сервера и, при необходимости, доверия его ключу подписи.
|
||||
EVENT2(authorize, PIByteArray, info, bool *, ok);
|
||||
|
||||
//! Client event for input server password
|
||||
//! \fn void passwordRequest(PIString * pass)
|
||||
//! \~english Client-side callback requesting the server password.
|
||||
//! \~russian Клиентский вызов для запроса пароля сервера.
|
||||
EVENT1(passwordRequest, PIString *, pass);
|
||||
|
||||
//! Server event on check client password
|
||||
//! \fn void passwordCheck(bool result)
|
||||
//! \~english Server-side callback reporting the result of client password validation.
|
||||
//! \~russian Серверный вызов, сообщающий результат проверки пароля клиента.
|
||||
EVENT1(passwordCheck, bool, result);
|
||||
|
||||
//! \}
|
||||
|
||||
private:
|
||||
enum Role {
|
||||
Client,
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/*! \file picrypt.h
|
||||
* \ingroup Crypt
|
||||
* \~\brief
|
||||
* \~english Cryptographic using libsodium
|
||||
* \~russian Шифрование с помощью libsodium
|
||||
*/
|
||||
//! \~\ingroup Crypt
|
||||
//! \~\file picrypt.h
|
||||
//! \brief
|
||||
//! \~english Cryptographic using libsodium
|
||||
//! \~russian Шифрование с помощью libsodium
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Cryptographic class using lib Sodium
|
||||
@@ -29,154 +28,136 @@
|
||||
#include "pip_crypt_export.h"
|
||||
#include "pistring.h"
|
||||
|
||||
//! \ingroup Crypt
|
||||
//! \~\ingroup Crypt
|
||||
//! \~\brief
|
||||
//! \~english Class for encrypting and decrypting data.
|
||||
//! \~russian Класс для шифрования и дешифрования данных.
|
||||
//! \details
|
||||
//! \~english Class providing cryptographic operations using the libsodium library, including encryption, decryption, hashing, and digital
|
||||
//! signatures. It supports both instance-based and static method-based operations.
|
||||
//! \~russian Класс, предоставляющий криптографические операции с использованием библиотеки libsodium, включая шифрование, дешифрование,
|
||||
//! хэширование и цифровые подписи. Поддерживаются операции как на основе экземпляра класса, так и на основе статических методов.
|
||||
//! \note
|
||||
//! \~english Requires libsodium library initialization. All methods are thread-safe when using different keys.
|
||||
//! \~russian Требуется инициализация библиотеки libsodium. Все методы потокобезопасны при использовании различных ключей.
|
||||
class PIP_CRYPT_EXPORT PICrypt {
|
||||
public:
|
||||
//! \~\brief
|
||||
//! \~english Constructor that generates a random key
|
||||
//! \~russian Конструктор, генерирующий случайный ключ
|
||||
//! \~english Constructor that generates a random key.
|
||||
//! \~russian Конструктор, генерирующий случайный ключ.
|
||||
PICrypt();
|
||||
|
||||
//! \~english Destructor.
|
||||
//! \~russian Деструктор.
|
||||
~PICrypt();
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Set key to "key", key size must be a \a sizeKey()
|
||||
//! \~russian Установить ключ "key", размер ключа должен быть равен \a sizeKey()
|
||||
//! \~english Set key to "key", key size must be a \a sizeKey().
|
||||
//! \~russian Установить ключ "key", размер ключа должен быть равен \a sizeKey().
|
||||
bool setKey(const PIByteArray & key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate and set key from keyphrase "secret"
|
||||
//! \~russian Генерировать и установить ключ из ключевой фразы "secret"
|
||||
//! \~english Generate and set key from keyphrase "secret".
|
||||
//! \~russian Генерировать и установить ключ из ключевой фразы "secret".
|
||||
bool setKey(const PIString & secret);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Returns current key
|
||||
//! \~russian Возвращает текущий ключ
|
||||
//! \~english Returns current key.
|
||||
//! \~russian Возвращает текущий ключ.
|
||||
PIByteArray key() { return key_; }
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Encrypt given data "data", result size will be increased by \a sizeCrypt()
|
||||
//! \~russian Зашифровать данные "data", размер результата увеличится на \a sizeCrypt()
|
||||
//! \~english Encrypt given data "data", result size will be increased by \a sizeCrypt().
|
||||
//! \~russian Зашифровать данные "data", размер результата увеличится на \a sizeCrypt().
|
||||
PIByteArray crypt(const PIByteArray & data);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Decrypt given data "crypt_data"
|
||||
//! \~russian Расшифровать данные "crypt_data"
|
||||
//! \~english Decrypt given data "crypt_data".
|
||||
//! \~russian Расшифровать данные "crypt_data".
|
||||
PIByteArray decrypt(const PIByteArray & crypt_data, bool * ok = 0);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Encrypt given data "data" with key "key", result size will be increased by \a sizeCrypt()
|
||||
//! \~russian Зашифровать данные "data" ключом "key", размер результата увеличится на \a sizeCrypt()
|
||||
//! \~english Encrypt given data "data" with key "key", result size will be increased by \a sizeCrypt().
|
||||
//! \~russian Зашифровать данные "data" ключом "key", размер результата увеличится на \a sizeCrypt().
|
||||
static PIByteArray crypt(const PIByteArray & data, PIByteArray key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Decrypt given data "crypt_data" with key "key"
|
||||
//! \~russian Расшифровать данные "crypt_data" ключом "key"
|
||||
//! \~english Decrypt given data "crypt_data" with key "key".
|
||||
//! \~russian Расшифровать данные "crypt_data" ключом "key".
|
||||
static PIByteArray decrypt(const PIByteArray & crypt_data, PIByteArray key, bool * ok = 0);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate hash from keyphrase "secret", may be used as a key for encryption
|
||||
//! \~russian Генерировать хэш из ключевой фразы "secret", может использоваться в качестве ключа для шифрования
|
||||
//! \~english Generate hash from keyphrase "secret", may be used as a key for encryption.
|
||||
//! \~russian Генерировать хэш из ключевой фразы "secret", может использоваться в качестве ключа для шифрования.
|
||||
static PIByteArray hash(PIString secret);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate hash from bytearray
|
||||
//! \~russian Генерировать хэш из массива байт
|
||||
//! \~english Generate hash from bytearray.
|
||||
//! \~russian Генерировать хэш из массива байт.
|
||||
static PIByteArray hash(const PIByteArray & data);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate hash from bytearray
|
||||
//! \~russian Генерировать хэш из массива байт
|
||||
//! \~english Generate hash from bytearray using provided key.
|
||||
//! \~russian Генерировать хэш из массива байт с использованием предоставленного ключа.
|
||||
static PIByteArray hash(const PIByteArray & data, const unsigned char * key, size_t keylen);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Returns hash size
|
||||
//! \~russian Возвращает размер хэша
|
||||
//! \~english Returns hash size.
|
||||
//! \~russian Возвращает размер хэша.
|
||||
static size_t sizeHash();
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate short hash from string "s", may be used for hash table
|
||||
//! \~russian Генерировать короткий хэш из строки "s", может использоваться для хэш-таблиц
|
||||
//! \~english Generate short hash from string "s", may be used for hash table.
|
||||
//! \~russian Генерировать короткий хэш из строки "s", может использоваться для хэш-таблиц.
|
||||
static ullong shorthash(const PIString & s, PIByteArray key = PIByteArray());
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate random key
|
||||
//! \~russian Генерировать случайный ключ
|
||||
//! \~english Generate random key.
|
||||
//! \~russian Генерировать случайный ключ.
|
||||
static PIByteArray generateKey();
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate random buffer
|
||||
//! \~russian Генерировать случайный буфер
|
||||
//! \~english Generate random buffer.
|
||||
//! \~russian Генерировать случайный буфер.
|
||||
static PIByteArray generateRandomBuff(int size);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Returns key size
|
||||
//! \~russian Возвращает размер ключа
|
||||
//! \~english Returns key size.
|
||||
//! \~russian Возвращает размер ключа.
|
||||
static size_t sizeKey();
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Returns size which be added to data size in encryption process
|
||||
//! \~russian Возвращает размер, который будет добавлен к размеру данных в процессе шифрования
|
||||
//! \~english Returns size which be added to data size in encryption process.
|
||||
//! \~russian Возвращает размер, который будет добавлен к размеру данных в процессе шифрования.
|
||||
static size_t sizeCrypt();
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Function randomly generates a secret key and a corresponding public key for digital signature
|
||||
//! \~russian Функция случайным образом генерирует секретный ключ и соответствующий ему открытый ключ для цифровой подписи
|
||||
//! \~english Function randomly generates a secret key and a corresponding public key for digital signature.
|
||||
//! \~russian Функция случайным образом генерирует секретный ключ и соответствующий ему открытый ключ для цифровой подписи.
|
||||
static bool generateSignKeys(PIByteArray & public_key, PIByteArray & secret_key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Function generates a secret key from input data and a corresponding public key for digital signature
|
||||
//! \~russian Функция генерирует секретный ключ из входных данных и соответствующий ему открытый ключ для цифровой подписи
|
||||
//! \~english Function generates a secret key from input data and a corresponding public key for digital signature.
|
||||
//! \~russian Функция генерирует секретный ключ из входных данных и соответствующий ему открытый ключ для цифровой подписи.
|
||||
static bool generateSignKeys(PIByteArray & public_key, PIByteArray & secret_key, const PIByteArray & seed);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Function extract sign public key from sing secret key
|
||||
//! \~russian Функция извлекает открытый ключ для подписи из секретного ключа для подписи
|
||||
//! \~english Function extract sign public key from sing secret key.
|
||||
//! \~russian Функция извлекает открытый ключ для подписи из секретного ключа для подписи.
|
||||
static PIByteArray extractSignPublicKey(const PIByteArray & secret_key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Calculate digital signature for data
|
||||
//! \~russian Вычислить цифровую подпись для данных
|
||||
//! \~english Calculate digital signature for data.
|
||||
//! \~russian Вычислить цифровую подпись для данных.
|
||||
PIByteArray signMessage(const PIByteArray & data, const PIByteArray & secret_key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Verify digital signature of signed message
|
||||
//! \~russian Проверить цифровую подпись подписанного сообщения
|
||||
//! \~english Verify digital signature of signed message.
|
||||
//! \~russian Проверить цифровую подпись подписанного сообщения.
|
||||
bool verifySign(const PIByteArray & data, const PIByteArray & signature, const PIByteArray & public_key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Function randomly generates a secret key and a corresponding public key for authenticated encryption
|
||||
//! \~english Function randomly generates a secret key and a corresponding public key for authenticated encryption.
|
||||
//! \~russian Функция случайным образом генерирует секретный ключ и соответствующий ему открытый ключ для аутентифицированного
|
||||
//! шифрования
|
||||
//! шифрования.
|
||||
static bool generateKeypair(PIByteArray & public_key, PIByteArray & secret_key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Function generates a secret key from input data and a corresponding public key for authenticated encryption
|
||||
//! \~english Function generates a secret key from input data and a corresponding public key for authenticated encryption.
|
||||
//! \~russian Функция генерирует секретный ключ из входных данных и соответствующий ему открытый ключ для аутентифицированного
|
||||
//! шифрования
|
||||
//! шифрования.
|
||||
static bool generateKeypair(PIByteArray & public_key, PIByteArray & secret_key, const PIByteArray & seed);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Encrypt given data "data"
|
||||
//! \~russian Зашифровать данные "data"
|
||||
//! \~english Encrypt given data "data".
|
||||
//! \~russian Зашифровать данные "data".
|
||||
PIByteArray crypt(const PIByteArray & data, const PIByteArray & public_key, const PIByteArray & secret_key);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Decrypt given data "crypt_data"
|
||||
//! \~russian Расшифровать данные "crypt_data"
|
||||
//! \~english Decrypt given data "crypt_data".
|
||||
//! \~russian Расшифровать данные "crypt_data".
|
||||
PIByteArray decrypt(const PIByteArray & crypt_data, const PIByteArray & public_key, const PIByteArray & secret_key, bool * ok = 0);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Generate password hash from "password"
|
||||
//! \~russian Генерировать хэш пароля из "password"
|
||||
//! \~english Generate password hash from "password".
|
||||
//! \~russian Генерировать хэш пароля из "password".
|
||||
static PIByteArray passwordHash(PIString password, const PIByteArray & seed);
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Returns libsodium version
|
||||
//! \~russian Возвращает версию libsodium
|
||||
//! \~english Returns libsodium version.
|
||||
//! \~russian Возвращает версию libsodium.
|
||||
static PIString version();
|
||||
|
||||
|
||||
|
||||
@@ -1,3 +1,13 @@
|
||||
/*! \file picryptmodule.h
|
||||
* \ingroup Crypt
|
||||
* \~\brief
|
||||
* \~english Umbrella header for the Crypt module
|
||||
* \~russian Зонтичный заголовок модуля Crypt
|
||||
*
|
||||
* \~\details
|
||||
* \~english Includes the public cryptographic and authentication headers.
|
||||
* \~russian Подключает публичные заголовки шифрования и аутентификации.
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Module includes
|
||||
|
||||
Reference in New Issue
Block a user