Skip to main content

Security

AES-256-GCM algorithm​

These parameters define the settings of the AES-256-GCM encryption algorithm used for password protection of the documents.

aesEncrypt.config​

Type: object

Defines the AES-256-GCM algorithm configuration.

aesEncrypt.config.keyByteLength​

Type: integer Default: 32

Defines the key length measured in bytes.

aesEncrypt.config.saltByteLength​

Type: integer Default: 64

Defines the salt length measured in bytes.

aesEncrypt.config.initializationVectorByteLength​

Type: integer Default: 16

Defines the initialization vector length measured in bytes.

aesEncrypt.config.iterationsByteLength​

Type: integer Default: 5

Defines the iterations length measured in bytes.

aesEncrypt.secret​

Type: string Default: "verysecretstring"

Defines a password which is used for the AES-256-GCM encryption.

warning

Do not store sensitive values in version control. Consider using environment variables or a secrets manager.

OpenPGP protocol​

These parameters define the settings of the OpenPGP protocol, which is used to encrypt the password when opening an encrypted document for editing.

openpgpjs.config​

Type: object

Defines the OpenPGP protocol configuration.

openpgpjs.encrypt​

Type: object

Defines the OpenPGP encryption settings.

openpgpjs.encrypt.passwords​

Type: array of strings Default: ["verysecretstring"]

Defines a password which is used for the OpenPGP encryption.

openpgpjs.decrypt​

Type: object

Defines the OpenPGP decryption settings.

openpgpjs.decrypt.passwords​

Type: array of strings Default: ["verysecretstring"]

Defines a password which is used for the OpenPGP decryption.

Secret key​

These parameters define the secret key configuration.

services.CoAuthoring.secret.browser​

Type: object

Defines the parameters of a secret key to generate a token in the client-side browser requests to ONLYOFFICE Docs:

  • string - the secret key, type: string, example: "secret";

  • file - the PEM file where the secret is stored, type: string, example: "".

services.CoAuthoring.secret.browser.string​

Type: string Default: "secret"

Inline plaintext secret value. Takes priority over the file option when both are set.

services.CoAuthoring.secret.browser.file​

Type: string Default: ""

Path to a file containing the secret value. Loaded once and cached. Leave empty to use the string value.

services.CoAuthoring.secret.inbox​

Type: object

Defines the parameters of a secret key to generate a token in the incoming HTTP requests with the commands from the document storage service to the document command service, document conversion service and document builder service:

  • string - the secret key, type: string, example: "secret";

  • file - the PEM file where the secret is stored, type: string, example: "".

services.CoAuthoring.secret.inbox.string​

Type: string Default: "secret"

Inline plaintext secret value. Takes priority over the file option when both are set.

services.CoAuthoring.secret.inbox.file​

Type: string Default: ""

Path to a file containing the secret value. Loaded once and cached. Leave empty to use the string value.

services.CoAuthoring.secret.outbox​

Type: object

Defines the parameters of a secret key to generate a token in the outgoing HTTP requests to the callbackUrl address by document editing service:

  • string - the secret key, type: string, example: "secret";

  • file - the PEM file where the secret is stored, type: string, example: "".

services.CoAuthoring.secret.outbox.string​

Type: string Default: "secret"

Inline plaintext secret value. Takes priority over the file option when both are set.

services.CoAuthoring.secret.outbox.file​

Type: string Default: ""

Path to a file containing the secret value. Loaded once and cached. Leave empty to use the string value.

services.CoAuthoring.secret.session​

Type: object

Defines the parameters of a secret key to generate the session token:

  • string - the secret key, type: string, example: "secret";

  • file - the PEM file where the secret is stored, type: string, example: "".

services.CoAuthoring.secret.session.string​

Type: string Default: "secret"

Inline plaintext secret value. Takes priority over the file option when both are set.

services.CoAuthoring.secret.session.file​

Type: string Default: ""

Path to a file containing the secret value. Loaded once and cached. Leave empty to use the string value.

Example​

{
  "aesEncrypt": {
    "config": {
      "keyByteLength": 32,
      "saltByteLength": 64,
      "initializationVectorByteLength": 16,
      "iterationsByteLength": 5
    },
    "secret": "verysecretstring"
  },
  "openpgpjs": {
    "config": {},
    "encrypt": {
      "passwords": [
        "verysecretstring"
      ]
    },
    "decrypt": {
      "passwords": [
        "verysecretstring"
      ]
    }
  },
  "services": {
    "CoAuthoring": {
      "secret": {
        "browser": {
          "string": "secret",
          "file": ""
        },
        "inbox": {
          "string": "secret",
          "file": ""
        },
        "outbox": {
          "string": "secret",
          "file": ""
        },
        "session": {
          "string": "secret",
          "file": ""
        }
      }
    }
  }
}