more ai generated doc with human review
This commit is contained in:
@@ -1,8 +1,12 @@
|
||||
/*! \file piauth.h
|
||||
* \ingroup Crypt
|
||||
* \~\brief
|
||||
* \~english Authentication API
|
||||
* \~russian API аутентификации
|
||||
* \addtogroup Crypt
|
||||
* \{
|
||||
* \brief Authentication API
|
||||
* \~english Authentication API for client-server key exchange and authentication
|
||||
* \~russian API аутентификации для обмена ключами и аутентификации клиент-сервер
|
||||
* \details
|
||||
* \~english Provides classes for secure client-server authentication with digital signatures, password verification, and key exchange
|
||||
* \~russian Предоставляет классы для безопасной клиент-серверной аутентификации с цифровыми подписями, проверкой пароля и обменом ключами
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
@@ -31,70 +35,106 @@
|
||||
#include "pip_crypt_export.h"
|
||||
|
||||
|
||||
//! \~english Authentication and key exchange class
|
||||
//! \~russian Класс аутентификации и обмена ключами
|
||||
class PIP_CRYPT_EXPORT PIAuth: public PIObject {
|
||||
PIOBJECT(PIAuth)
|
||||
|
||||
public:
|
||||
//! \~english Authentication state
|
||||
//! \~russian Состояние аутентификации
|
||||
enum State {
|
||||
NotConnected,
|
||||
AuthProbe,
|
||||
PassRequest,
|
||||
AuthReply,
|
||||
KeyExchange,
|
||||
Connected
|
||||
NotConnected, //!< \~english Not connected \~russian Не подключен
|
||||
AuthProbe, //!< \~english Authentication probe \~russian Зондирование аутентификации
|
||||
PassRequest, //!< \~english Password request \~russian Запрос пароля
|
||||
AuthReply, //!< \~english Authentication reply \~russian Ответ аутентификации
|
||||
KeyExchange, //!< \~english Key exchange \~russian Обмен ключами
|
||||
Connected //!< \~english Connected, authenticated \~russian Подключено, аутентифицировано
|
||||
};
|
||||
|
||||
//! Create PIAuth with your digital sign
|
||||
//! \~english Create PIAuth with your digital sign
|
||||
//! \~russian Создать PIAuth с вашей цифровой подписью
|
||||
//! \param sign \~english Digital sign private key \~russian Приватный ключ цифровой подписи
|
||||
PIAuth(const PIByteArray & sign);
|
||||
|
||||
//! Set server info data for client authorize event
|
||||
//! \~english Set server info data for client authorize event
|
||||
//! \~russian Установить информационные данные сервера для события авторизации клиента
|
||||
//! \param info \~english Info data \~russian Информационные данные
|
||||
void setInfoData(const PIByteArray & info) { custom_info = info; }
|
||||
|
||||
//! Set server password for check
|
||||
//! \~english Set server password for check
|
||||
//! \~russian Установить пароль сервера для проверки
|
||||
//! \param ps \~english Server password \~russian Пароль сервера
|
||||
void setServerPassword(const PIString & ps);
|
||||
|
||||
//! Set list of trusted clients/servers public digital sign keys
|
||||
//! \~english Set list of trusted clients/servers public digital sign keys
|
||||
//! \~russian Установить список доверенных публичных ключей цифровой подписи клиентов/серверов
|
||||
//! \param pkeys \~english List of public keys \~russian Список публичных ключей
|
||||
void setAuthorizedPublicKeys(const PIVector<PIByteArray> & pkeys) { auth_pkeys = pkeys; }
|
||||
|
||||
//! Get list of trusted clients/servers public digital sign keys
|
||||
//! \~english Get list of trusted clients/servers public digital sign keys
|
||||
//! \~russian Получить список доверенных публичных ключей цифровой подписи клиентов/серверов
|
||||
//! \return \~english List of public keys \~russian Список публичных ключей
|
||||
PIVector<PIByteArray> getAuthorizedPublicKeys() { return auth_pkeys; }
|
||||
|
||||
//! Get your digital sign public key
|
||||
//! \~english Get your digital sign public key
|
||||
//! \~russian Получить ваш публичный ключ цифровой подписи
|
||||
//! \return Public sign key \~english Публичный ключ подписи
|
||||
PIByteArray getSignPublicKey() { return sign_pk; }
|
||||
|
||||
|
||||
//! Stop authorization
|
||||
//! \~english Stop authorization
|
||||
//! \~russian Остановить авторизацию
|
||||
void stop();
|
||||
|
||||
//! Start authorization as client
|
||||
//! \~english Start authorization as client
|
||||
//! \~russian Начать авторизацию как клиент
|
||||
void startClient();
|
||||
|
||||
//! Start authorization as server, return first server message for client
|
||||
//! \~english Start authorization as server, return first server message for client
|
||||
//! \~russian Начать авторизацию как сервер, вернуть первое сообщение сервера для клиента
|
||||
//! \return \~english First server message \~russian Первое сообщение сервера
|
||||
PIByteArray startServer();
|
||||
|
||||
//! Process reseived message both for client and server, return current state and new message writed in "ba"
|
||||
//! \~english Process received message both for client and server, return current state and new message written in "ba"
|
||||
//! \~russian Обработать полученное сообщение как для клиента, так и для сервера, вернуть текущее состояние и новое сообщение в "ba"
|
||||
//! \param ba \~english Message to process, output message \~russian Сообщение для обработки, выходное сообщение
|
||||
//! \return \~english Current authentication state \~russian Текущее состояние аутентификации
|
||||
State receive(PIByteArray & ba);
|
||||
|
||||
//! Get session secret key, return key only when Connected state
|
||||
//! \~english Get session secret key, return key only when Connected state
|
||||
//! \~russian Получить секретный ключ сессии, вернуть ключ только в состоянии Connected
|
||||
//! \return \~english Session secret key \~russian Секретный ключ сессии
|
||||
//! \note
|
||||
//! \~english Returns empty array if not connected
|
||||
//! \~russian Возвращает пустой массив если не подключен
|
||||
PIByteArray getSecretKey();
|
||||
|
||||
//! Generate digital sign from seed
|
||||
//! \~english Generate digital sign from seed
|
||||
//! \~russian Сгенерировать цифровую подпись из зерна
|
||||
//! \param seed \~english Seed for key generation \~russian Зерно для генерации ключа
|
||||
//! \return \~english Generated digital sign key \~russian Сгенерированный ключ цифровой подписи
|
||||
static PIByteArray generateSign(const PIByteArray & seed);
|
||||
|
||||
|
||||
//! Disconneted event
|
||||
//! \~english Disconnected event
|
||||
//! \~russian Событие отключения
|
||||
EVENT1(disconnected, PIString, reason);
|
||||
|
||||
//! Conneted event
|
||||
//! \~english Connected event
|
||||
//! \~russian Событие подключения
|
||||
EVENT1(connected, PIString, info);
|
||||
|
||||
//! Client event for authorize new server
|
||||
//! \~english Client event for authorize new server
|
||||
//! \~russian Событие клиента для авторизации нового сервера
|
||||
EVENT2(authorize, PIByteArray, info, bool *, ok);
|
||||
|
||||
//! Client event for input server password
|
||||
//! \~english Client event for input server password
|
||||
//! \~russian Событие клиента для ввода пароля сервера
|
||||
EVENT1(passwordRequest, PIString *, pass);
|
||||
|
||||
//! Server event on check client password
|
||||
//! \~english Server event on check client password
|
||||
//! \~russian Событие сервера при проверке пароля клиента
|
||||
EVENT1(passwordCheck, bool, result);
|
||||
|
||||
private:
|
||||
|
||||
@@ -40,6 +40,9 @@ public:
|
||||
//! \~russian Конструктор, генерирующий случайный ключ
|
||||
PICrypt();
|
||||
|
||||
//! \~\brief
|
||||
//! \~english Destructor
|
||||
//! \~russian Деструктор
|
||||
~PICrypt();
|
||||
|
||||
//! \~\brief
|
||||
|
||||
Reference in New Issue
Block a user