Skip to main content

# searchguard-python

[![build status](https://travis-ci.org/ByteInternet/searchguard-python.svg?branch=master)](https://travis-ci.org/ByteInternet/searchguard-python) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

Unofficial Python library for Search Guard (a security solution for Elasticsearch)

## Installation ##

This library requires a Search Guard subscription (or trial license). Information can be found on https://search-guard.com/.

Make sure enterprise modules are enabled in your elasticsearch.yml:

searchguard.enterprise_modules_enabled: true

Make sure backend role management in your elasticsearch.yml is set to either of the two options below:

searchguard.roles_mapping_resolution: [BACKENDROLES_ONLY|BOTH]

Install the library:

pip3 install searchguard

Set the environment variables

export SEARCHGUARD_API_URL=”https://www.example.com:1234/_searchguard/api” export SEARCHGUARD_API_USER=”foo” export SEARCHGUARD_API_PASS=”bar”

## Future work ##

  • Add code for managing actiongroups

## Legal

  • Elasticsearch is a trademark of Elasticsearch BV, registered in the U.S. and in other countries.

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

  • Byte Internet is not affiliated with either Elasticsearch BV / floragunn GmbH.

Metadata

Release files for searchguard 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for searchguard 0.8.1
File Size Uploaded
searchguard-0.8.1.tar.gz 7.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for searchguard 0.8.1
File Interpreter ABI Platform
searchguard-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 16.9 kB

Release files / searchguard-0.8.1.tar.gz

Download URL searchguard-0.8.1.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
774f73735fba37b5bf39d03561290f3ee2346462acd5163ba31a2acccaece10e
BLAKE2b-256 checksum
How to use checksums
ddcc04e2e5ac6b32482991dbecc744b619bd9ad22df304f6fce91edf8f18cf13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.9.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

Release files / searchguard-0.8.1-py3-none-any.whl

Download URL searchguard-0.8.1-py3-none-any.whl
Size 9.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ae44e23d66baf636493dbbc574c20b8275a84b2333f2495f755f6b76ee894493
BLAKE2b-256 checksum
How to use checksums
c8e44c53b1859039804bb44844e8e57f3ff77bb931b8b7fbdeb15f1af6ffcb81
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.9.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8

2 release files

0.7

2 release files

0.6

2 release files

0.5

2 release files

0.4

2 release files

0.3

2 release files

0.2

2 release files

0.1.1

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page