https://github.com/stackstorm/st2-auth-backend-pam
PAM authentication plugin for StackStorm
https://github.com/stackstorm/st2-auth-backend-pam
Last synced: 10 months ago
JSON representation
PAM authentication plugin for StackStorm
- Host: GitHub
- URL: https://github.com/stackstorm/st2-auth-backend-pam
- Owner: StackStorm
- License: apache-2.0
- Created: 2015-10-13T21:07:43.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T17:01:06.000Z (about 1 year ago)
- Last Synced: 2025-03-24T05:02:50.646Z (10 months ago)
- Language: Python
- Size: 62.5 KB
- Stars: 3
- Watchers: 14
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PAM authentication plugin for StackStorm
PAM authentication backend allows users to authenticate against the PAM (Pluggable Authentication
Modules) on the system where ``st2auth`` service is running.
### Requirements
Ubuntu:
```bash
sudo apt-get -y install libpam0g
```
RHEL/CentOS:
```
sudo yum -y install pam-devel
```
### Installation
Install this into the ST2 virtualenv with:
```bash
sudo /opt/stackstorm/st2/bin/pip install git+https://github.com/StackStorm/st2-auth-backend-pam.git@master#egg=st2_auth_backend_pam
```
Edit the file: `/lib/systemd/system/st2auth.service`. Modify it so that the `stauth` service runs as root.
### Configuration Options
| option | required | default | description |
|-----------|----------|---------|------------------------------------------------------------|
| service | no | login | PAM service to authenticate against |
### Configuration Example
Please refer to the authentication section in the StackStorm
[documentation](http://docs.stackstorm.com) for basic setup concept. The following is an
example of the auth section in the StackStorm configuration file for the PAM backend.
```ini
[auth]
mode = standalone
backend = pam
backend_kwargs = {"service": "login"}
...
```
### Limitations
The python implementation of PAM does not allow authentication as the `root` user.
When utilizing this backend, you will need to authenticate as a non-`root` user.
## Copyright, License, and Contributors Agreement
Copyright 2015 StackStorm, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in
compliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file,
or at: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
By contributing you agree that these contributions are your own (or approved by your employer) and
you grant a full, complete, irrevocable copyright license to all users and developers of the
project, present and future, pursuant to the license of the project.