Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
arangodb/Documentation/Books/Manual/Security/SecurityOptions.md

6.6 KiB
Raw Blame History

Server security options

arangod provides a variety of options to make a setup more secure. Administrators can use these options to limit access to certain ArangoDB server functionality as well as providing the leakage of information about the environment that a server is running in.

General security options

The following security options are available:

  • --server.harden If this option is set to true and authentication is enabled, non-admin users will be denied access to the following REST APIs:

    • /_admin/log
    • /_admin/log/level
    • /_admin/status
    • /_admin/statistics
    • /_admin/statistics-description
    • /_api/engine/stats

    Additionally, no version details will be revealed by the version REST API at /_api/version. The default value for this option isfalse`.

JavaScript security options

arangod has several options that allow you to make your installation more secure when it comes to running application code in it. Below you will find an overview of the relevant options.

Blacklist and whitelists

Several options exists to restrict JavaScript application code functionality to just certain allowed subsets. Which subset of functionality is available can be controlled via blacklisting and whitelisting access to individual components. Blacklists can be used to disallow access to dedicated functionality, whereas whitelists can be used to explicitly allow access to certain functionality.

If an item is covered by both a blacklist and a whitelist, the whitelist will overrule and access to the functionality will be allowed.

Values for blacklist and whitelist options need to be specified as ECMAScript regular expressions. Each option can be used multiple times. In this case, the individual values for each option will be combined with a logical or.

For example, the following combination of startup options

--javascript.startup-options-whitelist "^server\."
--javascript.startup-options-whitelist "^log\."
--javascript.startup-options-blacklist "^javascript\."
--javascript.startup-options-blacklist "endpoint"

will resolve internally to the following regular expressions:

--javascript.startup-options-whitelist = "^server\.|^log\."
--javascript.startup-options-blacklist = "^javascript\.|endpoint"

Access to directories and files from JavaScript operations is only controlled via a whitelist, which can be specified via the startup option --javascript.files-whitelist.

For example, when using the following startup options

--javascript.startup-options-whitelist "^/etc/required/"
--javascript.startup-options-whitelist "^/etc/mtab/"

all files in the directories /etc/required and /etc/mtab plus their subdirectories will be accessible, while access to files in any other directories will be disallowed from JavaScript operations, with the following exceptions:

  • ArangoDB's temporary directory: JavaScript code is given access to this directory for storing temporary files. The temporary directory location can be specified explicitly via the --temp.path option at startup. If the option is not specified, ArangoDB will automatically use a subdirectory of the system's temporary directory).
  • ArangoDB's own JavaScript code, shipped with the ArangoDB release packages. Files in this directory and its subdirectories will be readable for JavaScript code running in ArangoDB. The exact path can be specified by the startup option --javascript.startup-directory.

Options for blacklisting and whitelisting

The following options are available for blacklisting and whitelisting access to dedicated functionality for application code:

  • --javascript.startup-options-whitelist and --javascript.startup-options-blacklist: These options control which startup options will be exposed to JavaScript code, following above rules for blacklists and whitelists.

  • --javascript.environment-variables-whitelist and --javascript.environment-variables-blacklist: These options control which environment variables will be exposed to JavaScript code, following above rules for blacklists and whitelists.

  • --javascript.endpoints-whitelist and --javascript.endpoints-blacklist: These options control which endpoints can be used from within the @arangodb/request JavaScript module. Endpoint values are passed into the filter in a normalized format starting with either of the prefixes tcp://, ssl://, unix:// or srv://. Note that for HTTP/SSL-based endpoints the port number will be included too, and that the endpoint can be specified either as an IP address or host name from application code.

  • --javascript.files-whitelist: This option controls which filesystem paths can be accessed from JavaScript code.

Additional JavaScript security options

In addition to the blacklisting and whitelisting security options, the following extra options are available for locking down JavaScript access to server functionality:

  • --javascript.allow-port-testing: If set to true, this option enables the testPort JavaScript function in the internal module. The default value is false.

  • --javascript.allow-external-process-control: If set to true, this option allows the execution and control of external processes from JavaScript code via the functions from the internal module:

    • executeExternal
    • executeExternalAndWait
    • getExternalSpawned
    • killExternal
    • suspendExternal
    • continueExternal
    • statusExternal

  • --javascript.harden: If set to true, this setting will deactivate the following JavaScript functions which may leak information about the environment:

    • internal.clientStatistics()
    • internal.httpStatistics()
    • internal.processStatistics()
    • internal.getPid()
    • internal.logLevel().

    The default value is false.

Security options for managing Foxx applications

The following options are available for controlling the installation of Foxx applications in an ArangoDB server:

  • --foxx.api: If set to false, this option disables the Foxx management API, which will make it impossible to install and uninstall Foxx applications. Setting the option to false will also deactivate the "Services" section in the web interface. The default value is true, meaning that Foxx apps can be installed and uninstalled.

  • --foxx.store: If set to false, this option disables the Foxx app store in ArangoDB's web interface, which will also prevent ArangoDB and its web interface from making calls to the main Foxx application Github repository at https://github.com/arangodb/foxx-apps. The default value is true.