# kcwarden - Keycloak Configuration Auditor

[](https://pypi.python.org/pypi/kcwarden)
[](https://iteratec.github.io/kcwarden)
[](https://github.com/iteratec/kcwarden/discussions)
[](https://pepy.tech/project/kcwarden)
[](https://github.com/iteratec/kcwarden/stargazers)
[](https://github.com/iteratec/kcwarden/actions/workflows/publish.yaml)
**[kcwarden](https://iteratec.github.io/kcwarden/) checks your Keycloak configuration for common misconfigurations and security vulnerabilities.**
## 🚀 Getting started
Install it using Python:
```shell
pip install kcwarden
```
For details and other methods, see our [documentation](https://iteratec.github.io/kcwarden/installation/).
## ▶️ Usage
Download your Keycloak's config:
```shell
kcwarden download --realm $REALM --user admin --output config.json $KEYCLOAK_BASE_URL
```
and run the checks against it:
```shell
kcwarden audit config.json
```
For more information, see the [documentation on the project website](https://iteratec.github.io/kcwarden/).
## Sponsors
<a href="https://www.iteratec.com/"><img alt="Logo iteratec" src="./docs/assets/iteratec.svg" width="300"></a>
Raw data
{
"_id": null,
"home_page": "https://iteratec.github.io/kcwarden/",
"name": "kcwarden",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "keycloak, security-scanner, oauth2, oidc",
"author": "Max Maass",
"author_email": "max.maass@iteratec.com",
"download_url": "https://files.pythonhosted.org/packages/00/95/30d00cc31bf262b59db800569fe88559c44f4c87c69038d4aef79b28c82f/kcwarden-0.12.1.tar.gz",
"platform": null,
"description": "# kcwarden - Keycloak Configuration Auditor\n\n\n[](https://pypi.python.org/pypi/kcwarden)\n[](https://iteratec.github.io/kcwarden)\n[](https://github.com/iteratec/kcwarden/discussions)\n[](https://pepy.tech/project/kcwarden)\n[](https://github.com/iteratec/kcwarden/stargazers)\n\n[](https://github.com/iteratec/kcwarden/actions/workflows/publish.yaml)\n\n**[kcwarden](https://iteratec.github.io/kcwarden/) checks your Keycloak configuration for common misconfigurations and security vulnerabilities.**\n\n## \ud83d\ude80 Getting started\n\nInstall it using Python:\n\n```shell\npip install kcwarden\n```\n\nFor details and other methods, see our [documentation](https://iteratec.github.io/kcwarden/installation/).\n\n## \u25b6\ufe0f Usage\n\nDownload your Keycloak's config:\n\n```shell\nkcwarden download --realm $REALM --user admin --output config.json $KEYCLOAK_BASE_URL\n```\n\nand run the checks against it:\n\n```shell\nkcwarden audit config.json\n```\n\nFor more information, see the [documentation on the project website](https://iteratec.github.io/kcwarden/).\n\n## Sponsors\n\n<a href=\"https://www.iteratec.com/\"><img alt=\"Logo iteratec\" src=\"./docs/assets/iteratec.svg\" width=\"300\"></a>\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Keycloak auditor",
"version": "0.12.1",
"project_urls": {
"Bug Tracker": "https://github.com/iteratec/kcwarden/issues",
"Documentation": "https://iteratec.github.io/kcwarden/",
"Homepage": "https://iteratec.github.io/kcwarden/",
"Repository": "https://github.com/iteratec/kcwarden",
"Sponsor": "https://www.iteratec.com/"
},
"split_keywords": [
"keycloak",
" security-scanner",
" oauth2",
" oidc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "914b5e48bff3b617417c104457c1a44e00d089a18b7a7559ff0b9097d5f642c5",
"md5": "260c4be27b749f6877723290cfc6f230",
"sha256": "d5456467d58adaaac9b1e516831c62846312a2b807fcb4eb54f4e8639e8b7082"
},
"downloads": -1,
"filename": "kcwarden-0.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "260c4be27b749f6877723290cfc6f230",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 79115,
"upload_time": "2025-01-21T08:03:12",
"upload_time_iso_8601": "2025-01-21T08:03:12.110443Z",
"url": "https://files.pythonhosted.org/packages/91/4b/5e48bff3b617417c104457c1a44e00d089a18b7a7559ff0b9097d5f642c5/kcwarden-0.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "009530d00cc31bf262b59db800569fe88559c44f4c87c69038d4aef79b28c82f",
"md5": "79beebf41f6d5cfd6f7904082b061997",
"sha256": "727ee7248e52ac0d97676fab6eed85c3778d8c37169168090422e69401399e3e"
},
"downloads": -1,
"filename": "kcwarden-0.12.1.tar.gz",
"has_sig": false,
"md5_digest": "79beebf41f6d5cfd6f7904082b061997",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 45374,
"upload_time": "2025-01-21T08:03:14",
"upload_time_iso_8601": "2025-01-21T08:03:14.255150Z",
"url": "https://files.pythonhosted.org/packages/00/95/30d00cc31bf262b59db800569fe88559c44f4c87c69038d4aef79b28c82f/kcwarden-0.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-21 08:03:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iteratec",
"github_project": "kcwarden",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kcwarden"
}