Обновить Документация

German 2025-12-28 15:45:11 +00:00
parent ee59064812
commit ba85151be5

@ -2,8 +2,8 @@
- [Установка](#установка)
- [Шифрование](#шифрование)
- [Регистрация ключа](#регистрация-ключа)
- [Создание пользователя и шифрование](#создание-пользователя-и-шифрование)
- [Чтение данных пользователя и расшифровка](#чтение-данных-пользователя-и-расшифровка)
- [Команда шифрования](#команда-шифрования)
- [Расшифровка](#расшифровка)
- [Опции команды](#опции-команды)
- [API](#api)
## Установка
@ -27,7 +27,7 @@ make update
vipre-cryptor --version
```
## Шифрование
Для шифрования программа требует создать локального пользователя, зарегистрировать электронный ключ и привязать к пользователю зашифрованный ключом файл.
Для шифрования программа требует зарегистрировать электронный ключ и привязать к нему зашифрованный файл.
## Регистрация ключа
Ключ можно создать с помощью OpenSSL:
```bash
@ -41,18 +41,16 @@ openssl rand -base64 30
vipre-cryptor --sig ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig
```
Данная команда запросит ваш ключ и запишет его в файл **ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig** особым образом.
## Создание пользователя и шифрование
Создание пользователя и шифрование файла выглядит следующим образом:
## Команда шифрования
Шифрование файла выглядит следующим образом:
```bash
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --create-user ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-input ФАЙЛ_ДЛЯ_ШИФРОВАНИЯ
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --create-user ИМЯ_ЗАШИФРОВАННОГОАЙЛА.bin --file-input ФАЙЛ_ДЛЯ_ШИФРОВАНИЯ
```
Данная команда запросит логин и пароль нового пользователя.
## Чтение данных пользователя и расшифровка
## Расшифровка
Для чтения данных необходимо выполнить команду:
```bash
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-out ФАЙЛ_РАСШИФРОВАННЫХАННЫХ
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ЗАШИФРОВАННОГОАЙЛА.bin --file-out ФАЙЛ_РАСШИФРОВАННЫХАННЫХ
```
Данная команда запросит логин и пароль пользователя.
## Опции команды
Доступны опции:
- **--help**
@ -62,12 +60,15 @@ vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ПОЛЬ
- **--sig**
- **--file-input**
- **--file-out**
- **--type=users**
Все опции можно сокращать до одного знака, например:
```ini
# Опции "--file-input" и "--file-out" можно сократить до "--file" или просто "-f"
"--help" - "-h"
"--version" - "-v"
[options]
"--help" = "-h"
"--version" = "-v"
"--type=users" = "-t"
```
## API
У библиотеки есть **API**:
@ -76,11 +77,11 @@ vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ПОЛЬ
#include "vipre-manager.h"
int main(void) {
__set_api_mode("admin", "1234", "signature_key");
__set_api_mode(NULL, NULL, "signature_key");
__create_sig("api_example_key.sig");
__create_user("api_example_key.sig", "api_example_user.bin", "example.txt");
__read_user("api_example_key.sig", "api_example_user.bin", "example_out.txt");
__create_user("api_example_key.sig", "api_example_file.bin", "example.txt");
__read_user("api_example_key.sig", "api_example_file.bin", "example_out.txt");
__api_detach();
return EXIT_SUCCESS;
}
```
```