70 lines
3.4 KiB
Markdown
70 lines
3.4 KiB
Markdown
# Документация на VIPRE-CRYPTOR
|
||
- [Установка](#установка)
|
||
- [Шифрование](#шифрование)
|
||
- [Регестрация ключа](#регестрация-ключа)
|
||
- [Создание пользователя и шифрование](#создание-пользователя-и-шифрование)
|
||
- [Чтение данных пользователя и расшифровка](#чтение-данных-пользователя-и-расшифровка)
|
||
- [Опции команды](#опции-команды)
|
||
## Установка
|
||
Зависимости для компиляции:
|
||
- GCC
|
||
- GNU Make
|
||
- Git
|
||
|
||
Установка:
|
||
```bash
|
||
# Скачиваем программу:
|
||
cd ~
|
||
git clone https://gitlabor.ru/German/vipre-cryptor.git
|
||
cd vipre-cryptor
|
||
# Компилируем:
|
||
make clear
|
||
make
|
||
# Устанавливаем (или обновляем):
|
||
make update
|
||
# Проверяем (должно вывести версию):
|
||
vipre-cryptor --version
|
||
```
|
||
## Шифрование
|
||
Для шифрования программа требует создать локального пользователя, зарегестрировать электронный ключ и привязать к пользователю зашифрованный ключом файл.
|
||
## Регестрация ключа
|
||
Ключ можно создать с помощью OpenSSL:
|
||
```bash
|
||
# Создание ключа с помощью OpenSSL
|
||
openssl rand -base64 30
|
||
```
|
||
Также можно самому придумать ключ, но он, скорее всего, будет небезопастным.
|
||
Чтобы зарегестрировать ключ, нужно выполнить команду:
|
||
```bash
|
||
# Чтобы зарегестрировать ключ, нужно выполнить команду:
|
||
vipre-cryptor --sig ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig
|
||
```
|
||
Данная команда запросит ваш ключ и запишет его в файл **ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig** особым образом.
|
||
## Создание пользователя и шифрование
|
||
Создание пользователя и шифрование файла выглядит следующим образом:
|
||
```bash
|
||
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --create-user ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-input ФАЙЛ_ДЛЯ_ШИФРОВАНИЯ
|
||
```
|
||
Данная команда запросит логин и пароль нового пользователя.
|
||
## Чтение данных пользователя и расшифровка
|
||
Для чтения данных необходимо выполнить команду:
|
||
```bash
|
||
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-out ФАЙЛ_РАСШИФРОВАННЫХ_ДАННЫХ
|
||
```
|
||
Данная команда запросит логин и пароль пользователя.
|
||
## Опции команды
|
||
Доступны опции:
|
||
- **--help**
|
||
- **--version**
|
||
- **--user-data**
|
||
- **--create-user**
|
||
- **--sig**
|
||
- **--file-input**
|
||
- **--file-out**
|
||
|
||
Все опции можно сокращать до одного знака, например:
|
||
```ini
|
||
# Опции "--file-input" и "--file-out" можно сократить до "--file" или просто "-f"
|
||
"--help" - "-h"
|
||
"--version" - "-v"
|
||
``` |