vipre-cryptor/DOCS.md
2025-12-27 17:16:44 +04:00

3.8 KiB
Raw Blame History

Документация на VIPRE-CRYPTOR

Установка

Зависимости для компиляции:

  • GCC
  • GNU Make
  • Git

Установка:

# Скачиваем программу:
cd ~
git clone https://gitlabor.ru/German/vipre-cryptor.git
cd vipre-cryptor
# Компилируем:
make clear
make
# Устанавливаем (или обновляем):
make update
# Проверяем (должно вывести версию):
vipre-cryptor --version

Шифрование

Для шифрования программа требует создать локального пользователя, зарегистрировать электронный ключ и привязать к пользователю зашифрованный ключом файл.

Регистрация ключа

Ключ можно создать с помощью OpenSSL:

# Создание ключа с помощью OpenSSL
openssl rand -base64 30

Также можно самому придумать ключ, но он, скорее всего, будет небезопастным. Чтобы зарегистрировать ключ, нужно выполнить команду:

# Чтобы зарегистрировать ключ, нужно выполнить команду:
vipre-cryptor --sig ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig

Данная команда запросит ваш ключ и запишет его в файл ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig особым образом.

Создание пользователя и шифрование

Создание пользователя и шифрование файла выглядит следующим образом:

vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --create-user ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-input ФАЙЛ_ДЛЯ_ШИФРОВАНИЯ

Данная команда запросит логин и пароль нового пользователя.

Чтение данных пользователя и расшифровка

Для чтения данных необходимо выполнить команду:

vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-out ФАЙЛ_РАСШИФРОВАННЫХАННЫХ

Данная команда запросит логин и пароль пользователя.

Опции команды

Доступны опции:

  • --help
  • --version
  • --user-data
  • --create-user
  • --sig
  • --file-input
  • --file-out

Все опции можно сокращать до одного знака, например:

# Опции "--file-input" и "--file-out" можно сократить до "--file" или просто "-f"
"--help" - "-h"
"--version" - "-v"

API

У библиотеки есть API:

/* Пример API */
#include "vipre-manager.h"

int main(void) {
    __set_api_mode("admin", "1234", "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");
    __api_detach();
    return EXIT_SUCCESS;
}