Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 3.15 KB

installation.md

File metadata and controls

104 lines (73 loc) · 3.15 KB

Installing Search Guard SSL

Prerequisites

  • Java 7 or 8 (Oracle Java 8 recommended)
  • Elasticsearch 2.0 or above
  • Optional: Tomcat Native and OpenSSL

Disable the security manager

If you are running Elasticsearch 2.0.x or 2.1.x, then you have to disable the security manager in elasticsearch.yml. For Elasticsearch >= 2.2.x this is no longer necessary.

In order to disable the security manager, add the following line to your elastcsearch.yml configuration file:

security.manager.enabled=false

Install SG SSL

Choosing the right version

The versioning schema of SG SSL is: e1.e2.e3.sgv

where:

  • e1: Elasticsearch Major Version
  • e2: Elasticsearch Minor Version
  • e2: Elasticsearch Fix Version
  • sgv: Search Guard SSL Version

The following table illustrated which SG SSL version you need for a particular ES version:

ES version SG SSL version
1.x.y not supported
2.0 not supported
2.0.1 not supported
2.0.2 2.0.2.5
2.1.0 2.1.0.5
2.1.1 2.1.1.5
2.1.2 2.1.2.5
2.2.0 2.2.0.6
2.2.1 2.2.1.7
2.3.1 2.3.1.8
2.3.2 2.3.2.9

For an up-to-date version matrix, you can always refer to the Wiki on github

Install the plugin

Before installing the plugin, stop your ES node(s) if necessary.

From Maven

SG SSL can be installed it like any other Elasticsearch plugin. Change to the installation directory of ES, and execute:

bin/plugin install com.floragunn/search-guard-ssl/<version>

"<version>" is for example 2.3.2.9 (NOT v2.3.2.9)

Example:

bin/plugin install com.floragunn/search-guard-ssl/2.3.2.9

Accept the following warning message by typing "y" (since ES >= 2.2)

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@     WARNING: plugin requires additional permissions     @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
* java.lang.RuntimePermission accessClassInPackage.sun.misc
* java.lang.RuntimePermission getClassLoader
* java.lang.RuntimePermission loadLibrary.*
* java.lang.reflect.ReflectPermission suppressAccessChecks
* java.security.SecurityPermission getProperty.ssl.KeyManagerFactory.algorithm
See http://docs.oracle.com/javase/8/docs/technotes/guides/security/permissions.html
for descriptions of what these permissions allow and the associated risks.

Alternatively, you can download the zip from Maven Central and install it offline by typing:

bin/plugin install file:///path/to/search-guard-ssl-<version>.zip

Next steps

After performing these steps, SG SSL is installed. Next: