# MongoDB authentication plugin for StackStorm Community edition
[](https://travis-ci.org/StackStorm/st2-auth-backend-mongodb) [](http://webchat.freenode.net/?channels=stackstorm)
The MongoDB backend reads and authenticates user against data from a MongoDB collection named
``users``. The ``users`` collection and the user entries will have to be generated manually.
Entries need to have the following attributes:
| field | description |
| ---------|--------------------------------------------------------------|
| username | User name |
| salt | Password salt |
| password | SHA256 hash for the salt+password - SHA256(salt+password) |
### Configuration Options
| option | required | default | description |
|-------------|----------|-----------|----------------------------------------------------------|
| db_host | no | localhost | Hostname for the MongoDB server |
| db_port | no | 27017 | Port for the MongoDB server |
| db_name | no | st2auth | Database name in MongoDB |
| db_username | no | None | Username for MongoDB login |
| db_password | no | None | Password for MongoDB login |
### 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 flat-file
backend.
```
[auth]
mode = standalone
backend = mongodb
backend_kwargs = {"db_username": "admin", "db_password": "pass123"}
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
```
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/StackStorm/st2-auth-backend-mongodb",
"name": "st2-auth-backend-mongodb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "StackStorm, Inc.",
"author_email": "info@stackstorm.com",
"download_url": "https://files.pythonhosted.org/packages/0f/ed/78329e1c7db70c69b356e4d20706c618289a27286f8077e7ef599211742f/st2-auth-backend-mongodb-0.3.0.tar.gz",
"platform": "Any",
"description": "# MongoDB authentication plugin for StackStorm Community edition\n\n[](https://travis-ci.org/StackStorm/st2-auth-backend-mongodb) [](http://webchat.freenode.net/?channels=stackstorm)\n\nThe MongoDB backend reads and authenticates user against data from a MongoDB collection named \n``users``. The ``users`` collection and the user entries will have to be generated manually.\nEntries need to have the following attributes:\n\n| field | description |\n| ---------|--------------------------------------------------------------|\n| username | User name |\n| salt | Password salt |\n| password | SHA256 hash for the salt+password - SHA256(salt+password) |\n\n### Configuration Options\n\n| option | required | default | description |\n|-------------|----------|-----------|----------------------------------------------------------|\n| db_host | no | localhost | Hostname for the MongoDB server |\n| db_port | no | 27017 | Port for the MongoDB server |\n| db_name | no | st2auth | Database name in MongoDB |\n| db_username | no | None | Username for MongoDB login |\n| db_password | no | None | Password for MongoDB login |\n\n### Configuration Example\n\nPlease refer to the authentication section in the StackStorm\n[documentation](http://docs.stackstorm.com) for basic setup concept. The\nfollowing is an example of the auth section in the StackStorm configuration file for the flat-file\nbackend.\n\n```\n[auth]\nmode = standalone\nbackend = mongodb\nbackend_kwargs = {\"db_username\": \"admin\", \"db_password\": \"pass123\"}\nenable = True\nuse_ssl = True\ncert = /path/to/ssl/cert/file\nkey = /path/to/ssl/key/file\nlogging = /path/to/st2auth.logging.conf\napi_url = https://myhost.example.com:9101\ndebug = False\n```\n\n## Copyright, License, and Contributors Agreement\n\nCopyright 2015 StackStorm, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this work except in\ncompliance with the License. You may obtain a copy of the License in the [LICENSE](LICENSE) file,\nor at: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nBy contributing you agree that these contributions are your own (or approved by your employer) and \nyou grant a full, complete, irrevocable copyright license to all users and developers of the\nproject, present and future, pursuant to the license of the project.\n\n\n",
"bugtrack_url": null,
"license": "Apache License (2.0)",
"summary": "StackStorm authentication backend which reads credentials from a MongoDB collection.",
"version": "0.3.0",
"project_urls": {
"Download": "https://github.com/StackStorm/st2-auth-backend-mongodb/tarball/master",
"Homepage": "https://github.com/StackStorm/st2-auth-backend-mongodb"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "45574faf2a8eb69d50e72e3f211e334174f24259ebec9cadb87e88ae3fc159e8",
"md5": "c4ddbe4733fc7fd6fab5982bf5ff1457",
"sha256": "747297fb77dc4eb1fbeff7aa3422d754420e82f4a64ab7327edcd4f7268b3272"
},
"downloads": -1,
"filename": "st2_auth_backend_mongodb-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4ddbe4733fc7fd6fab5982bf5ff1457",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10609,
"upload_time": "2024-10-20T16:01:28",
"upload_time_iso_8601": "2024-10-20T16:01:28.459892Z",
"url": "https://files.pythonhosted.org/packages/45/57/4faf2a8eb69d50e72e3f211e334174f24259ebec9cadb87e88ae3fc159e8/st2_auth_backend_mongodb-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fed78329e1c7db70c69b356e4d20706c618289a27286f8077e7ef599211742f",
"md5": "e729830d7a3d3336a7d64453f81f9179",
"sha256": "48a916f8ba2343e591a1ae105261c4af52ebc7f04ce5979a1a7d3b35e3c13976"
},
"downloads": -1,
"filename": "st2-auth-backend-mongodb-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "e729830d7a3d3336a7d64453f81f9179",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10338,
"upload_time": "2024-10-20T16:01:30",
"upload_time_iso_8601": "2024-10-20T16:01:30.232150Z",
"url": "https://files.pythonhosted.org/packages/0f/ed/78329e1c7db70c69b356e4d20706c618289a27286f8077e7ef599211742f/st2-auth-backend-mongodb-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 16:01:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StackStorm",
"github_project": "st2-auth-backend-mongodb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pymongo",
"specs": [
[
"<",
"4.7"
],
[
">=",
"4.0.0"
]
]
}
],
"tox": true,
"lcname": "st2-auth-backend-mongodb"
}
JSON
