معرفی شرکت ها
fastapi-cognito-2.3.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Basic AWS cognito authentication package for FastAPI
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | fastapi-cognito-2.3.0 |
| نام | fastapi-cognito |
| نسخه کتابخانه | 2.3.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Marko Mirosavljev |
| ایمیل نویسنده | mirosavljevm023@gmail.com |
| آدرس صفحه اصلی | https://github.com/markomirosavljev/fastapi-cognito |
| آدرس اینترنتی | https://pypi.org/project/fastapi-cognito/ |
| مجوز | MIT |
# FastAPI - Cognito
FastAPI package that ease usage of AWS Cognito Auth.
This package provides basic functions/tools which helps developers to use
Cognito JWT.
## Requirements
* Python >=3.8
* FastAPI
* AWS Cognito Service
## How to install
### Pip Command
```
pip install fastapi-cognito
```
## How to use
This is the simple example of how to use this package:
* Create app
```python
from fastapi import FastAPI
app = FastAPI()
```
All mandatory fields are added in CognitoSettings
BaseSettings object. Settings can be added in different ways.
You can provide all required settings in **.yaml** or **.json** files,
or your global BaseSettings file. Note that userpools field is Dict,
**FIRST** user pool in a dict will be set as default automatically if
userpool_name is not provided in CognitoAuth object.
All fields shown in example below, are also required in .json or .yaml file
(with syntax matching those files.)
You should also import BaseSettings from pydantic if you are going to use global BaseSettings object.
* Provide settings that are mandatory for CognitoAuth to work. You can provide
one or more userpools.
* `app_client_id` field for userpool besides string, can contain multiple string values provided within
list, tuple or set
```python
from pydantic import BaseSettings
class Settings(BaseSettings):
check_expiration = True
jwt_header_prefix = "Bearer"
jwt_header_name = "Authorization"
userpools = {
"eu": {
"region": "USERPOOL_REGION",
"userpool_id": "USERPOOL_ID",
"app_client_id": ["APP_CLIENT_ID_1", "APP_CLIENT_ID_2"] # Example with multiple ids
},
"us": {
"region": "USERPOOL_REGION",
"userpool_id": "USERPOOL_ID",
"app_client_id": "APP_CLIENT_ID"
},
...
}
settings = Settings()
```
This example below shows how global BaseSettings object can be mapped to
CognitoSettings and passed as param to CognitoAuth.
If we were using .yaml or .json, we should call **.from_yaml(_filename_)** or
**.from_json(_filename_)** methods on CognitoSettings object.
* Instantiate CognitoAuth and pass previously created settings as settings param.
```python
from fastapi_cognito import CognitoAuth, CognitoSettings
# default userpool(eu) will be used if there is no userpool_name param provided.
cognito_eu = CognitoAuth(settings=CognitoSettings.from_global_settings(settings))
cognito_us = CognitoAuth(settings=CognitoSettings.from_global_settings(settings), userpool_name="us")
```
* This is a simple endpoint that is protected by Cognito, it uses FastAPI
dependency injection to resolve all required operations and get Cognito JWT.
It can be used later to add more security to endpoints and to get required
data about user which token belongs to.
```python
from fastapi_cognito import CognitoToken
from fastapi import Depends
@app.get("/")
def hello_world(auth: CognitoToken = Depends(cognito_eu.auth_required)):
return {"message": "Hello world"}
```
### Optional authentication
If authentication should be optional, we can use ```cognito_eu.auth_optional```
Example:
```python
from fastapi_cognito import CognitoToken
from fastapi import Depends
@app.get("/")
def hello_world(auth: CognitoToken = Depends(cognito_eu.auth_optional)):
return {"message": "Hello world"}
```
### Custom Token Model
In case your token payload contains additional values, you can provide custom
token model instead of `CognitoToken`. If there is no custom token model
provided, `CognitoToken` will be set as a default model.
Example:
```python
class CustomTokenModel(CognitoToken):
custom_value: Optional[str]
class Settings(BaseSettings):
check_expiration = True
jwt_header_prefix = "Bearer"
jwt_header_name = "Authorization"
userpools = {
"eu": {
"region": "USERPOOL_REGION",
"userpool_id": "USERPOOL_ID",
"app_client_id": "APP_CLIENT_ID"
},
"us": {
"region": "USERPOOL_REGION",
"userpool_id": "USERPOOL_ID",
"app_client_id": "APP_CLIENT_ID"
}
}
custom_cognito_token_model: PyObject = CustomTokenModel
@app.get("/")
def hello_world(auth: CustomTokenModel = Depends(cognito_us.auth_required)):
return {"message": f"Hello {auth.custom_value}"}
```
**NOTE: It is important to set `custom_cognito_token_model` type in BaseSettings
to `PyObject`**. In order to have type hints, you need to set your custom model
as type of `auth`.
نیازمندی
| مقدار | نام |
|---|---|
| - | fastapi |
| ==1.4.1 | cognitojwt[sync] |
| - | pyYAML |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8 | Python |
نحوه نصب
نصب پکیج whl fastapi-cognito-2.3.0:
pip install fastapi-cognito-2.3.0.whl
نصب پکیج tar.gz fastapi-cognito-2.3.0:
pip install fastapi-cognito-2.3.0.tar.gz