<p align="center">
<a href="https://authress.io/knowledge-base/docs/SDKs/authress-local"><img src="https://authress.io/static/images/logoText.png" height="100px" alt="Authress logo"></a>
<a href="https://authress.io/knowledge-base/docs/SDKs/authress-local"><img src="https://github.com/Authress/localstack-extension/assets/5056218/7bad113d-405f-4cd4-9335-3427d6419a13" alt="Partnership" height="80px"></a>
<a href="https://authress.io/knowledge-base/docs/SDKs/authress-local"><img src="https://github.com/Authress/localstack-extension/assets/5056218/a52d0c26-f6e1-4347-859e-fef2bd10cf89" alt="LocalStack logo"></a>
</p>
# LocalStack Extension for Authress Authentication and Authorization
This is the [LocalStack](https://localstack.cloud/) extension that enables running authentication, user identity, permissions, api key management, and access control in your [LocalStack environment](<a href="https://authress.io/knowledge-base/docs/SDKs/authress-local">) via [Authress](https://authress.io).
This LocalStack extension generates a copy of the [Authress API](https://authress.io/app/#/api) so that the authentication and access management the Authress API provides can be utilized by running services directly in any environment. You can use this to build authentication and authorization directly into your applications and services. Additionally, this extension can be used locally to develop faster without needing an [Authress Account](https://authress.io).
<p align="center">
<a href="https://badge.fury.io/py/localstack-extension-authress" alt="LocalStack Authress Extension">
<img src="https://badge.fury.io/py/localstack-extension-authress.svg"></a>
<a href="https://github.com/Authress/localstack-extension/actions/workflows/build.yml" alt="Build status">
<img src="https://github.com/Authress/localstack-extension/actions/workflows/build.yml/badge.svg"></a>
<a href="https://github.com/Authress/localstack-extension/blob/main/LICENSE" alt="Apache-2.0">
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
<a href="https://authress.io/community" alt="authress community">
<img src="https://img.shields.io/badge/Community-Authress-fbaf0b.svg"></a>
<a href="https://app.localstack.cloud/extensions/remote?url=git+https://github.com/Authress/localstack-extension/#egg=localstack-extension-authress" alt="extensions installer">
<img src="https://localstack.cloud/gh/extension-badge.svg"></a>
</p>
---
## Installation
To install the Authentication & Authorization extension into LocalStack, run
```sh
localstack extensions install localstack-extension-authress
```
## Usage
1. [Start LocalStack](https://docs.localstack.cloud/getting-started/installation/#starting-localstack-with-docker-compose) if it isn't started already. You can do this by running:
```sh
ACTIVATE_PRO=1 LOCALSTACK_AUTH_TOKEN="LOCALSTACK_AUTH_TOKEN" EXTENSION_DEV_MODE=1 DEBUG=1 localstack start
```
If you run into any issues doing that, check out the [Troubleshooting Guide](./troubleshooting.md).
The auth extension runs at `http://authress.localhost.localstack.cloud:4566`.
You can configure API calls to the authorization server by passing this url as the `authressApiUrl` or the `authress_api_url` depending on which SDK you are using.
```ts
import { AuthressClient } from 'authress-sdk';
const authressClient = new AuthressClient({ authressApiUrl: `http://authress.localhost.localstack.cloud:4566` });
await authressClient.userPermissions.authorizeUser(userId, resourceUri, permission);
```
## Knowledge Base
Review the in depth guides in the [Authress Local KB](https://authress.io/knowledge-base/docs/SDKs/authress-local).
## Contribution Guide
[Developing for the LocalStack Authress Extension](https://github.com/Authress/localstack-extension/blob/main/contributing.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/authress/authress-local",
"name": "localstack-extension-authress",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Authorization as a service, Security, authorization, authorization as a service, authentication, user authentication, Authress, Authress client, access management, access management as a service, user security, localstack, localstack extensions, verified, verified access, verified permissions, open source policy engine, embedded authorization, batteries included authorization",
"author": "Authress",
"author_email": "developers@authress.io",
"download_url": "https://files.pythonhosted.org/packages/94/cf/1ee68949789e71b5b80bb607159f51ffc6911804946b6430f3db9f55fce1/localstack_extension_authress-0.1.24.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <a href=\"https://authress.io/knowledge-base/docs/SDKs/authress-local\"><img src=\"https://authress.io/static/images/logoText.png\" height=\"100px\" alt=\"Authress logo\"></a>\n <a href=\"https://authress.io/knowledge-base/docs/SDKs/authress-local\"><img src=\"https://github.com/Authress/localstack-extension/assets/5056218/7bad113d-405f-4cd4-9335-3427d6419a13\" alt=\"Partnership\" height=\"80px\"></a>\n <a href=\"https://authress.io/knowledge-base/docs/SDKs/authress-local\"><img src=\"https://github.com/Authress/localstack-extension/assets/5056218/a52d0c26-f6e1-4347-859e-fef2bd10cf89\" alt=\"LocalStack logo\"></a>\n\n\n</p>\n\n# LocalStack Extension for Authress Authentication and Authorization\n\nThis is the [LocalStack](https://localstack.cloud/) extension that enables running authentication, user identity, permissions, api key management, and access control in your [LocalStack environment](<a href=\"https://authress.io/knowledge-base/docs/SDKs/authress-local\">) via [Authress](https://authress.io).\n\nThis LocalStack extension generates a copy of the [Authress API](https://authress.io/app/#/api) so that the authentication and access management the Authress API provides can be utilized by running services directly in any environment. You can use this to build authentication and authorization directly into your applications and services. Additionally, this extension can be used locally to develop faster without needing an [Authress Account](https://authress.io).\n\n<p align=\"center\">\n <a href=\"https://badge.fury.io/py/localstack-extension-authress\" alt=\"LocalStack Authress Extension\">\n <img src=\"https://badge.fury.io/py/localstack-extension-authress.svg\"></a>\n <a href=\"https://github.com/Authress/localstack-extension/actions/workflows/build.yml\" alt=\"Build status\">\n <img src=\"https://github.com/Authress/localstack-extension/actions/workflows/build.yml/badge.svg\"></a>\n <a href=\"https://github.com/Authress/localstack-extension/blob/main/LICENSE\" alt=\"Apache-2.0\">\n <img src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"></a>\n <a href=\"https://authress.io/community\" alt=\"authress community\">\n <img src=\"https://img.shields.io/badge/Community-Authress-fbaf0b.svg\"></a>\n <a href=\"https://app.localstack.cloud/extensions/remote?url=git+https://github.com/Authress/localstack-extension/#egg=localstack-extension-authress\" alt=\"extensions installer\">\n <img src=\"https://localstack.cloud/gh/extension-badge.svg\"></a>\n</p>\n\n---\n\n## Installation\n\nTo install the Authentication & Authorization extension into LocalStack, run\n```sh\nlocalstack extensions install localstack-extension-authress\n```\n\n## Usage\n1. [Start LocalStack](https://docs.localstack.cloud/getting-started/installation/#starting-localstack-with-docker-compose) if it isn't started already. You can do this by running:\n\n```sh\nACTIVATE_PRO=1 LOCALSTACK_AUTH_TOKEN=\"LOCALSTACK_AUTH_TOKEN\" EXTENSION_DEV_MODE=1 DEBUG=1 localstack start\n```\n\nIf you run into any issues doing that, check out the [Troubleshooting Guide](./troubleshooting.md).\n\nThe auth extension runs at `http://authress.localhost.localstack.cloud:4566`.\n\nYou can configure API calls to the authorization server by passing this url as the `authressApiUrl` or the `authress_api_url` depending on which SDK you are using.\n\n\n```ts\nimport { AuthressClient } from 'authress-sdk';\nconst authressClient = new AuthressClient({ authressApiUrl: `http://authress.localhost.localstack.cloud:4566` });\nawait authressClient.userPermissions.authorizeUser(userId, resourceUri, permission);\n```\n\n## Knowledge Base\n\nReview the in depth guides in the [Authress Local KB](https://authress.io/knowledge-base/docs/SDKs/authress-local).\n\n## Contribution Guide\n\n[Developing for the LocalStack Authress Extension](https://github.com/Authress/localstack-extension/blob/main/contributing.md)\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "LocalStack Extension: Authress",
"version": "0.1.24",
"project_urls": {
"Homepage": "https://github.com/authress/authress-local"
},
"split_keywords": [
"authorization as a service",
" security",
" authorization",
" authorization as a service",
" authentication",
" user authentication",
" authress",
" authress client",
" access management",
" access management as a service",
" user security",
" localstack",
" localstack extensions",
" verified",
" verified access",
" verified permissions",
" open source policy engine",
" embedded authorization",
" batteries included authorization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2abf42c4fca858492f754b630f2c0f573296469ee32780c01e1694a2828a4cde",
"md5": "586fe0445dc65373296747c2a98598e3",
"sha256": "ada4c23699dcab558639a0db4ee92870d9e7a56d68ba0616edad23c581c096c7"
},
"downloads": -1,
"filename": "localstack_extension_authress-0.1.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "586fe0445dc65373296747c2a98598e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17827,
"upload_time": "2024-07-23T09:02:36",
"upload_time_iso_8601": "2024-07-23T09:02:36.436744Z",
"url": "https://files.pythonhosted.org/packages/2a/bf/42c4fca858492f754b630f2c0f573296469ee32780c01e1694a2828a4cde/localstack_extension_authress-0.1.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94cf1ee68949789e71b5b80bb607159f51ffc6911804946b6430f3db9f55fce1",
"md5": "da97707956ac9e25d2b9726dc056786f",
"sha256": "b21143290b1259c311d7981603bb9dd1ab610d1da6b9d990a8b0bdf06d7a21f8"
},
"downloads": -1,
"filename": "localstack_extension_authress-0.1.24.tar.gz",
"has_sig": false,
"md5_digest": "da97707956ac9e25d2b9726dc056786f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17236,
"upload_time": "2024-07-23T09:02:37",
"upload_time_iso_8601": "2024-07-23T09:02:37.414686Z",
"url": "https://files.pythonhosted.org/packages/94/cf/1ee68949789e71b5b80bb607159f51ffc6911804946b6430f3db9f55fce1/localstack_extension_authress-0.1.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 09:02:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "authress",
"github_project": "authress-local",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "localstack-extension-authress"
}
JSON
