/* Сервис реализует функционал управления профилями шифрования */ syntax = "proto3"; import "google/protobuf/timestamp.proto"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/descriptor.proto"; import "google/protobuf/wrappers.proto"; package keyapis.encryption_profile.v1; option java_package = "ru.keyapis.encryption_profile.v1"; option java_outer_classname = "KeyapisEncryptionProfileV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_encryption_profile_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.EncryptionProfile.V1"; option objc_class_prefix = "KEYAPISENCRYPTIONPROFILEV1"; option php_namespace = "Keyapis\\EncryptionProfile\\V1"; option ruby_package = "Keyapis::EncryptionProfile::V1"; option optimize_for = LITE_RUNTIME; // Сервис профилей шифрования service EncryptionProfileService { // Метод сохранения шифрования по идентификатору. // Поддерживает создание и обновление. // Метод доступен для: device_admin rpc PostEncryptionProfile(PostEncryptionProfileRequest) returns (PostEncryptionProfileResponse) { option (google.api.http) = { post : "/encryption_profile/api/v1/encryption_profile" body : "*" }; } // Метод получения профиля шифрования по идентификатору. // Метод доступен для: admin, service, bti, device_admin rpc GetEncryptionProfile(GetEncryptionProfileRequest) returns (GetEncryptionProfileResponse) { option (google.api.http) = { get : "/encryption_profile/api/v1/encryption_profile/{id}" }; } // Метод получения списка профилей шифрования. // Метод доступен для: admin, service, bti, device_admin rpc GetEncryptionProfileList(GetEncryptionProfileListRequest) returns (stream GetEncryptionProfileListResponse) { option (google.api.http) = { get : "/encryption_profile/api/v1/encryption_profile/list" }; } // Метод получения количества профилей шифрования. // Метод доступен для: admin, service, bti, device_admin rpc GetEncryptionProfileCount(GetEncryptionProfileCountRequest) returns (GetEncryptionProfileCountResponse) { option (google.api.http) = { get : "/encryption_profile/api/v1/encryption_profile/count" }; } // Метод удаления профиля шифрования. // Метод доступен для: admin, service, device_admin rpc DeleteEncryptionProfile(DeleteEncryptionProfileRequest) returns (DeleteEncryptionProfileResponse) { option (google.api.http) = { delete: "/encryption_profile/api/v1/encryption_profile/{id}" }; } // Метод разархивации шифрования по идентификатору. // Метод доступен для: admin, service, device_admin rpc PostEncryptionProfileRestore(PostEncryptionProfileRestoreRequest) returns (PostEncryptionProfileRestoreResponse) { option (google.api.http) = { post : "/encryption_profile/api/v1/encryption_profile/restore/{id}" }; } } // Профиль шифрования. // # Описание модели message EncryptionProfile { // Идентификатор. // # Тип: Guid string id = 1; // Наименование. // # Диапазон: 3..64 string name = 2 [(google.api.field_behavior) = REQUIRED]; // Описание. // # Диапазон: 3..1000 google.protobuf.StringValue description = 3; // Справочник типов профиля шифрования. // # Тип: byte enum Type { // Значение не указано TYPE_UNKNOWN = 0; // Тип SL3 SL3 = 1; } // Тип профиля шифрования Type type = 4 [(google.api.field_behavior) = REQUIRED]; // Номер сектора. // # Диапазон: 0..15 int32 sector_number = 5; // Номер блока. // # Диапазон: 0..3 int32 block_number = 6; // Индекс первого символа для секрета. // # Диапазон: 0..31 int32 start_index = 7; // Индекс последнего символа для секрета. // # Диапазон: 0..31 int32 end_index = 8; // Пароль A профиля. // # Диапазон: 16..32 string secret_a = 9 [(google.api.field_behavior) = INPUT_ONLY]; // Зашифрованный пароль B профиля string encrypted_secret_a = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; // Пароль B профиля. // # Диапазон: 16..32 string secret_b = 11 [(google.api.field_behavior) = INPUT_ONLY]; // Зашифрованный пароль B профиля string encrypted_secret_b = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 13 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта. // # Тип: DateTime google.protobuf.Timestamp changed_at = 14; // Дата удаления. // # Тип: DateTime? google.protobuf.Timestamp deleted_at = 15 [(google.api.field_behavior) = OUTPUT_ONLY]; // Ошибка сохранения. // Эти проверки выполняются при работе с базой данных и сторонними сервисами message SavingError { // Конфликт версий. // Причины: // - В базе хранится другая версия строки, значения changed_at оличаются message Conflict {} // Указанный диапазон не соответствует минимальному значению. // Причины: // - Модуль разности между полями start_index и end_index меньше 7 message RangeIsTooSmall {} // Причина ошибки oneof reason { // Конфликт версий Conflict conflict = 1; // Указанный диапазон не соответствует минимальному значению RangeIsTooSmall range_is_too_small = 2; } } } // Фильтр по профилям шифрования message EncryptionProfileFilter { // Поиск по тексту. // Если значение не передано то поиск по нему не производится. // # Диапазон: 3..64. // # Поиск производится по полям: // # - Наименование; // # - Описание string text = 1; // По типам профиля шифрования repeated EncryptionProfile.Type types = 2; // Показывать удаленные google.protobuf.BoolValue show_deleted = 3; } // Постраничный вывод message EncryptionProfilePaging { // Справочник типов значений сортировки. // # Тип: byte enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; // Дата последнего изменения CHANGED_AT = 2; // Дата создания CREATED_AT = 3; // По рангу для поиска по тексту. // Применяется когда передано поле для поиска по тексту. // В случае если текстовое поле не передано, применяется значение по умолчанию RANK = 4; } // Тип значения сортировки. // Если значение не передано, то будет взято значение по умолчанию. // # По умолчанию: CHANGED_AT OrderByType order_by_type = 1; // Справочник типов направлений сортировки; // # Тип: byte enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // # По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Если значение 0 (не передано), то будет взято значение по умолчанию. // # Диапазон: 0..100. // # По умолчанию: 20 int32 limit = 3; // Сдвиг. // # Диапазон: 0..2147483647 int32 offset = 4; } // Запрос сохранения шифрования по идентификатору message PostEncryptionProfileRequest { // Профиль шифрования EncryptionProfile data = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос сохранения шифрования по идентификатору message PostEncryptionProfileResponse { // Ошибка запроса сохранения профиля шифрования message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; // Ошибка сохранения EncryptionProfile.SavingError saving = 2; } } // Тип результата oneof type { // Профиль шифрования EncryptionProfile data = 1; // Ошибка Error error = 2; } } // Запрос на получение списка профилей шифрования message GetEncryptionProfileListRequest { // Фильтр EncryptionProfileFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод EncryptionProfilePaging paging = 2; } } // Ответ на получение списка профилей шифрования message GetEncryptionProfileListResponse { // Ошибка запроса получения списка профилей шифрования message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Профиль шифрования EncryptionProfile data = 1; // Ошибка Error error = 2; } } // Запрос получения профиля шифрования message GetEncryptionProfileRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос получения профиля шифрования message GetEncryptionProfileResponse { // Ошибка запроса получения баннера message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Профиль шифрования EncryptionProfile data = 1; // Ошибка Error error = 2; } } // Запрос получения количества профилей шифрования message GetEncryptionProfileCountRequest { // Фильтр EncryptionProfileFilter filter = 1; } // Ответ на запрос получения количества профилей шифрования message GetEncryptionProfileCountResponse { // Ошибка запроса получения количества профилей шифрования message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // Всего устройтсв int32 data = 1; // Ошибка Error error = 2; } } // Запрос удаления профиля шифрования message DeleteEncryptionProfileRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос удаления профиля шифрования message DeleteEncryptionProfileResponse { // Ошибка запроса удаления профиля шифрования message Error { // Существуют устройства, связанные с этим профилем шифрования. // Следует отвязать устройства перед удалением профиля message LinkedDevicesExists {} // Причина ошибки oneof reason { // Существуют устройства, связанные с этим профилем шифрования LinkedDevicesExists linked_devices_exists = 1; } } // Тип результата oneof type { // Ошибка Error error = 1; } } // Запрос разархивации шифрования по идентификатору message PostEncryptionProfileRestoreRequest { // Идентификатор. // # Тип: Guid string id = 1 [(google.api.field_behavior) = REQUIRED]; } // Отвест на запрос разархивации шифрования по идентификатору message PostEncryptionProfileRestoreResponse {} // Ошибки валидации. // Эти проверки выполняются до обращения в базу данных message ValidationError { // Путь к полю в формате наименования прото string path = 1 [(google.api.field_behavior) = REQUIRED]; // Валидационное сообщение string message = 2 [(google.api.field_behavior) = REQUIRED]; }