Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graylog2/graylog-plugin-auth-sso
SSO support for Graylog through trusted HTTP headers set by load balancers or authentication proxies
https://github.com/graylog2/graylog-plugin-auth-sso
authentication graylog graylog-plugin single-sign-on sso
Last synced: 3 months ago
JSON representation
SSO support for Graylog through trusted HTTP headers set by load balancers or authentication proxies
- Host: GitHub
- URL: https://github.com/graylog2/graylog-plugin-auth-sso
- Owner: Graylog2
- License: other
- Created: 2016-06-29T13:48:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T15:46:10.000Z (about 2 years ago)
- Last Synced: 2024-04-15T00:39:05.917Z (10 months ago)
- Topics: authentication, graylog, graylog-plugin, single-sign-on, sso
- Language: Java
- Homepage:
- Size: 608 KB
- Stars: 49
- Watchers: 20
- Forks: 13
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: COPYING
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Note
This plugin no longer works in recent Graylog versions and is archived. It is provided only for historical purposes in case someone needs access to the source code.
# SSO Authentication Plugin for Graylog
[](https://travis-ci.org/Graylog2/graylog-plugin-auth-sso)
This plugins adds SSO (Single Sign-On) capabilities to Graylog. It supports automatic login and user account creation based on trusted HTTP headers set by an authentication proxy.
**Required Graylog version:** 3.3.x.
**This plugin will not be compatible with Graylog 4.0 and later!**
Version Compatibility
---------------------
| Plugin Version | Graylog Version |
| -------------- | --------------- |
| 3.3.x | 3.3.x |
| 3.2.x | 3.2.x |
| 3.1.x | 3.1.x |
| 3.0.x | 3.0.x |
| 2.5.x | 2.5.x |
| 2.4.x | 2.4.x |
| 2.3.x | 2.3.x |
| 1.0.x | >=2.1.x, <2.3.x |
Installation
------------
[Download the plugin](https://github.com/Graylog2/graylog-plugin-auth-sso/releases)
and place the `.jar` file in your Graylog plugin directory. The plugin directory
is the `plugins/` folder relative from your `graylog-server` directory by default
and can be configured in your `graylog.conf` file.
Restart `graylog-server` and you are done.
Development
-----------
You can improve your development experience for the web interface part of your plugin
dramatically by making use of hot reloading. To do this, do the following:
* `git clone https://github.com/Graylog2/graylog2-server.git`
* `cd graylog2-server/graylog2-web-interface`
* `ln -s $YOURPLUGIN plugin/`
* `npm install && npm start`
Usage
-----
How this Plugin can be used is described in [the Graylog Documentation](http://docs.graylog.org/en/latest/pages/users_and_roles/external_auth.html#single-sign-on)
Getting started
---------------
This project is using Maven 3 and requires Java 8 or higher.
* Clone this repository.
* Run `mvn package` to build a JAR file.
* Optional: Run `mvn jdeb:jdeb` and `mvn rpm:rpm` to create a DEB and RPM package respectively.
* Copy generated JAR file in target directory to your Graylog plugin directory.
* Restart the Graylog.
Plugin Release
--------------
- Bump version in `package.json`
- Bump parent version and `graylog.version` in pom.xml
- Change branch name for the graylog2-server checkout in `.travis.yml`
For the rest we are using the maven release plugin:
```
$ mvn release:prepare
```
(no need for `mvn release:perform`)
This sets the version numbers, creates a tag and pushes to GitHub. Travis CI will build the release artifacts and upload to GitHub automatically.