From 553921b27a01ba8f9541361332ca29d0037132c8 Mon Sep 17 00:00:00 2001 From: german Date: Tue, 23 Dec 2025 19:37:10 +0400 Subject: [PATCH] docs --- DOCS.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++- Makefile | 5 +++- vipre-cryptor | Bin 17400 -> 17400 bytes vipre-manager.h | 2 +- 4 files changed, 63 insertions(+), 3 deletions(-) diff --git a/DOCS.md b/DOCS.md index eb961c3..8005f83 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1,5 +1,10 @@ # Документация на VIPRE-CRYPTOR - [Установка](#установка) + - [Шифрование](#шифрование) + - [Регестрация ключа](#регестрация-ключа) + - [Создание пользователя и шифрование](#создание-пользователя-и-шифрование) + - [Чтение данных пользователя и расшифровка](#чтение-данных-пользователя-и-расшифровка) + - [Опции команды](#опции-команды) ## Установка Зависимости для компиляции: - GCC @@ -8,6 +13,58 @@ Установка: ```bash +# Скачиваем программу: cd ~ git clone https://gitlabor.ru/German/vipre-cryptor.git -cd vipre-cryptor \ No newline at end of file +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" +``` \ No newline at end of file diff --git a/Makefile b/Makefile index fd03a8c..60c32c0 100644 --- a/Makefile +++ b/Makefile @@ -30,7 +30,7 @@ INSTALL_NAME=/usr/local/bin/vipre-cryptor MODE=chmod +x RUN_OF=./ -.PHONY: clear run install uninstall +.PHONY: clear run install uninstall update $(OUTPUT_NAME): $(INPUT_NAME) $(CC) $(OPTIONS) $(INPUT_NAME) -o $(OUTPUT_NAME) @@ -43,3 +43,6 @@ install: $(COPY) $(OUTPUT_NAME) $(INSTALL_NAME) uninstall: $(REMOVE) $(INSTALL_NAME) +update: + $(REMOVE) -f $(INSTALL_NAME) + $(COPY) $(OUTPUT_NAME) $(INSTALL_NAME) diff --git a/vipre-cryptor b/vipre-cryptor index c8379eb964466a7b6d1291d8443c5776f9cab8a7..932c295bbbde4e91c2e4b519a0c1fdeeafd11f2c 100755 GIT binary patch delta 839 zcmZ{jZ%9*77{<@Ltz=;8bhfLz>Q;A4!O~GSp#;T6Ge%3I5E7veijWXxWZ(Q!=wOEN z8uTGTL9t*&atB3F?n8eh2!aZfiV6}YuGESgvN%20KNUeQJp9gi-otyJbKs`?DBVYQ z>d892S*+Hy-b7Vo8`{3M{Y{RT7VPmG%NgslI&C&K)!9~GcbrIF@U`Y!_d9LJg-IxUvUEeUt-H}@s5TYsaa;{q% zBWv8~O`33fUn2PqNA4lNn76N;!zX7rUOIuu9cA~;zFpP2$90U3^#7DnS=WVicK+pU z^!~?|^|RN&T1bE4o}yli7vwbW8$<#d6irF_2uyvJG6iNp3*v6twuY)aM4D15cB`NXlA_NW_eJ~DYf0gnR35Ur3j%(p9RJ?Yl!48urD2=46w$Vb_p>xn8PiT&ca^&3T8XShSf4n$67cXfA zh5OOT!OkcZdJENZk*BPpADz_}l4{2hYo^NVJ&@& ztS9IPpR(4|AV0A-(;oKN0@SP?vpI;WIg-DZB0QOYvARD66CGbM$=Q-+uM=W>_{C(a z)JK*Vp*Ng_+xteeH#l+^`NfoJ=^Q>e!9xXuh}>eoms(o9rFfHC=xC%}LUjC;(zL9$ zWgh&?Tj~9eyO+=Qf@KgdI&JE>GfwS^&maX^ldF0`BXo9J%BSG?M=58)Sug`p{WDUQ zCJWI3#^L*CrF6h=0L#GrU;vDO`@kr898^9_83FxZpWX)(SN|gIQiCDBNom8oD0ulJ zIv1q8ufLOEk854-l}}Q7^j%%LqQeE1L2*9dTA!;SZNk=DC==8MjdRRpF0vr&N>^tT zGX3KX!Bcp`m7U{7ClfopY|t3AfemhZ(P?xN8Q|!16vXa@7sOgGFXV#vj6?1cQuv&E zGmY^bcRgL@R8KtxxzW>_nt`ka^|_}iO|@+7N}+cg^KGN3I_aCqr0e|3Ut;+4R~Tz5 P43+v_QI%?_=4R3_rXWUI diff --git a/vipre-manager.h b/vipre-manager.h index 86f2c28..b6881cc 100644 --- a/vipre-manager.h +++ b/vipre-manager.h @@ -28,7 +28,7 @@ #include #include -#define VERSION "0.9.2" +#define VERSION "1.0" #define ERROR_FILE_OUT "unnamed_out_file.csv" #define bool unsigned char