Skip to content

README_RUS.md

Latest commit

 

History

History
135 lines (97 loc) · 5.82 KB

README_RUS.md

File metadata and controls

135 lines (97 loc) · 5.82 KB

Document Platform

CI Status Java 11 Spring Boot 2.7

English documentation

Document Platform — микросервисное веб-приложение для управления электронными документами и отчетами.
Данный репозиторий содержит реализацию микросервисов:

Document Management Service (DMS), который отвечает за:

  • загрузку, хранение и удаление документов;
  • версионирование документов;
  • хранение и поиск по метаданным;
  • интеграцию с S3-совместимыми хранилищами (MinIO, Amazon S3).

Document Management Service (DSS) отвечает за создание и проверку электронной подписи документов.

Реализованный функционал:

  • получение хэша документа из DMS через HTTP;
  • генерация электронной подписи с использованием RSA и SHA256;
  • проверка подписи по публичному ключу;
  • сохранение метаданных подписи в DMS (подписант, время, сертификат);
  • загрузка ключей (private.key, public.key) из внешнего источника;
  • использование криптопровайдера Bouncy Castle.

Стек технологий

  • Java 11
  • Spring Boot 2.7
  • Spring Web
  • Spring Data REST
  • Hibernate / Spring Data JPA
  • PostgreSQL / Liquibase
  • MongoDB / Mongock
  • WebClient
  • Bouncy Castle (SHA256withRSA)
  • MinIO
  • Elasticsearch + Logstash + Kibana (logging)
  • Docker, Docker Compose
  • MapStruct
  • Lombok
  • SpringDoc OpenAPI 3 (Swagger UI)

Быстрый старт

Требования

  • Java 11+
  • Maven 3.6+
  • Docker + Docker Compose

Настройка

1. Клонируйте репозиторий:

git clone https://github.com/tennyros/document-platform.git
cd document-platform

2. Скопируйте файл .env:

cp .env.example .env

3. Сгенерируйте для сервиса подписания пару RSA-ключей для локальной разработки:

chmod +x scripts/generate-keys.sh
./scripts/generate-keys.sh

4. Запустите приложение и сопутствующие сервисы через Docker:

# Скопируйте docker-compose.yml файл
cp docker-compose.example.yml docker-compose.yml  

# Убедитесь, что порты на Вашей системе, указанные в docker-compose, не заняты и запустите
docker-compose up -d

5. После этого API будет доступны по адресам:

http://localhost:8090/swagger-ui.html (Document Management Service)
http://localhost:8091/swagger-ui.html (Document Signing Service)

API-эндпоинты

Document Management Service

Документы

Метод Endpoint Описание
POST /documents Загрузить новый документ (метаданные + файл)
GET /documents Получить список документов с пагинацией и фильтрацией
DELETE /documents/{documentId} Удалить документ и все его версии

Версии документов

Метод Endpoint Описание
POST /documents/{documentId}/versions Загрузить новую версию документа
DELETE /documents/{documentId}/versions/{versionId} Удалить конкретную версию документа
GET /documents/{documentId}/versions/{versionId}/download Скачать указанную версию документа

Подписи и хэши (используется Document Signing Service)

Метод Endpoint Описание
GET /documents/{documentId}/versions/{versionId}/hash Получить Base64-хэш содержимого версии документа
POST /documents/{documentId}/versions/{versionId}/signatures Сохранить электронную подпись к версии документа
Вызывается из DSS через WebClient

Document Signing Service

Метод Endpoint Описание
POST /signatures/sign Подписать документ
GET /signatures/verify Верифицировать подпись

CI Pipeline

Проект настроен с CI для автоматической сборки с использованием GitHub Actions.