st2-auth-backend-flat-file 0.4.1

StackStorm authentication backend which reads credentials from a htpasswd compatible file on disk.

Flat file authentication plugin for StackStorm Community edition

Flat file backend supports reading credentials from an Apache HTTPd htpasswd formatted file. To manage this file you can use htpasswd utility which comes with a standard Apache httpd distribution or by installing apache2-utils package on Ubuntu / Debian.

Configuration Options

option	required	default	description
file_path	yes		Path to the file containing credentials

Configuration Example

Please refer to the authentication section in the StackStorm documentation for basic setup concept. The following is an example of the auth section in the StackStorm configuration file for the flat-file backend.

[auth]
mode = standalone
backend = flat_file
backend_kwargs = {"file_path": "/path/to/.htpasswd"}
enable = True
use_ssl = True
cert = /path/to/ssl/cert/file
key = /path/to/ssl/key/file
logging = /path/to/st2auth.logging.conf
api_url = https://myhost.example.com:9101
debug = False

The following is an example htpasswd command to generate a password file with a user entry. You should be using no other hashing algorithm than bcrypt as it is consider the only secure hashing algorithm amoung all the algorithms supported by htpasswd.

htpasswd -cB /path/to/.htpasswd stark

Copyright, License, and Contributors Agreement

Copyright 2025 StackStorm, Inc. 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 file, or at: 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.