Encrypted values by keys (crypto_values)

Overview

Report on domain encrypted secrets by encryption method and installation key (general.crypto_kid): storage passwords (storage), settings secrets (settings), integration channel tokens (webservice), master domain configuration secrets (configuration). Shows how many values are encrypted with a non-current key — for example, after a key change or before re-encryption.

Access: admin role (in the master domain — system administrator), user session only (integration channel token — 403). In the master domain the report contains all domains; in other domains only the current domain.

Requests

HTTP verb Endpoint Description

GET

/rest/v1/domain/crypto_values

Getting the report

Getting the report

Report rows are by domain, object type, encryption method, and key. Values are not decrypted; counting is performed by the domain center of the central site (updated one second after domain loading or object changes).

Field Type Description

domain

string

Domain.

class

string

Object type: storage — storages, settings — domain settings, webservice — integration channels, configuration — configurations (master domain only).

version

string

Encryption method: v4 — legacy (key in platform code), v5 — installation key.

kid

string

Installation key identifier (for v4 — null).

count

integer

Number of encrypted values.

current

boolean

Values are encrypted with the current method: v5 of the current key, and without a configured key — v4.

Values with current: false are re-encrypted with the current key when the domain is loaded by the domain center (domain center restart); for values of another key, its file is needed in :SYNC/secure/keys. Without a configured key values are not re-encrypted (v5 is not downgraded to v4). The object change journal is not included in the report: it retains ciphertexts of previous keys; dynamic data model collections of type history and transactionlog are not tracked. Removing previous keys — Encryption and keys.

Request

Example request
GET /rest/v1/domain/crypto_values HTTP/1.1

Response

Example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {"domain": "okteller.ru", "class": "settings", "version": "v5", "kid": "3f1c9a7e5b2d4086", "count": 4, "current": true},
  {"domain": "test.okteller.ru", "class": "storage", "version": "v4", "kid": null, "count": 2, "current": false},
  {"domain": "test.okteller.ru", "class": "webservice", "version": "v5", "kid": "3f1c9a7e5b2d4086", "count": 12, "current": true},
  {"domain": "test.okteller.ru", "class": "webservice", "version": "v5", "kid": "a90b17c24e6f3d58", "count": 1, "current": false}
]

Errors: 403 — no admin role or request via integration channel token; 503 — domain center unavailable.

See also