Search Guard Kibana Plugin

About this plugin

This plugin for Kibana adds session management and true multi-tenancy to a Search Guard secured cluster.

For Kibana 7.x and 6.x it also provides a configuration GUI for Search Guard.

Commercial use

This software is licensed under the Apache2 license and can be used freely also for commercial purposes. Some features may require the Search Guard Enterprise Edition or above to function.

Installation

Download the release matching your Kibana installation, and install it like any other Kibana plugin:

bin/kibana-plugin install file:///path/to/searchguard-kibana-<version>.zip

Configuration

Execute the install_demo_configuration script to configure the Search Guard Kibana plugin with a demo configuration and create a self-signed TLS certificate. Afterward, make sure you configured the Search Guard Elasticsearch plugin accordingly. Check the documentation.

  ____                                 _          ____                              _ 
 / ___|    ___    __ _   _ __    ___  | |__      / ___|  _   _    __ _   _ __    __| |
 \___ \   / _ \  / _` | | '__|  / __| | '_ \    | |  _  | | | |  / _` | | '__|  / _` |
  ___) | |  __/ | (_| | | |    | (__  | | | |   | |_| | | |_| | | (_| | | |    | (_| |
 |____/   \___|  \__,_| |_|     \___| |_| |_|    \____|  \__,_|  \__,_| |_|     \__,_|
                                                                                      
? What do you want to configure? (Use arrow keys)
❯ Basic Login demo 
  OpenID Connect demo 
  JWT demo 
  SAML demo 
  Proxy demo 
  Kerberos demo 

Linux

cd kibana/plugins/searchguard
./install_demo_configuration.sh

Windows

cd kibana\plugins\searchguard
powershell -ExecutionPolicy Bypass -File install_demo_configuration.ps1

Documentation

Kibana 7.x

• Installation
• Authentication
• Multi Tenancy
• Configuration GUI

Kibana 6.x

• Installation
• Authentication
• Multi Tenancy
• Configuration GUI

Kibana 5.x

• Installation
• Authentication
• Multi Tenancy

Development

See the kibana contributing guide and the Search Guard documentation above for instructions setting up your development environment. Once you have completed that, use the following yarn scripts.

• yarn kbn bootstrap

  Install dependencies and crosslink Kibana and all projects/plugins.

  IMPORTANT: Use this script instead of yarn to install dependencies when switching branches, and re-run it whenever your dependencies change.

• yarn start

  Start kibana and have it include this plugin. You can pass any arguments that you would normally send to bin/kibana

  yarn start --elasticsearch.hosts http://localhost:9220
  

• ./build.sh <install-local|deploy-snapshot-maven>

  Build locally a distributable archive of your plugin or deploy snapshot to maven repository.

• yarn test:browser

  Run UI unit tests.

• yarn test:server

  Run server unit tests.

• yarn test:prepare_integration_test

  Run script for integration tests when Elasticsearch and Kibana should have different version in the same cluster: eliminate Kibana version check error and install required packages.

For more information about any of these commands run yarn ${task} --help. For a full list of tasks checkout the package.json file, or run yarn run.

Development tips

• Use NVM to manage multiple versions of Node.js.

• Comment /plugins in Kibana .eslintignore file to make the eslint working in your IDE.

Integration tests

Custom branch

You can make CI to run integration tests against specific Kibana branch or/and specific branch of Search Guard Suite plugin, for example: package.json

    "searchguard": {  
        "test_sg_version": "7.8.0-42.0.0-SNAPSHOT",
        "kibana_branch": "7.7"
    }

where

• test_sg_version - is the location of the latest SNAPSHOT for specified Search Guard and ES versions in Search Guard maven repository.
• kibana_branch - is the branch in the official Kibana repository, which should be used for building and testing Search Guard Kibana plugin.

These parameters are optional - if you don't specify them, the integration tests will be executed according to standard procedure.

IMPORTANT: Please, do not use these parameters in production branches of Search Guard Kibana plugin.

License

Copyright 2015-2018 floragunn GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Legal

Search Guard is a trademark of floragunn GmbH, registered in the U.S. and in other countries

Elasticsearch, Kibana, Logstash, and Beats are trademarks of Elasticsearch BV, registered in the U.S. and in other countries.

floragunn GmbH is not affiliated with Elasticsearch BV.