German/vipre-cryptor
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

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

German 2025-12-28 15:45:11 +00:00
parent ee59064812
commit ba85151be5
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F.md

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