fastapi/security/api_key.py · 清风/FastAPI

代码拉取完成,页面将自动刷新

扫描微信二维码支付

取消

支付完成

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 76

清风/FastAPI

forked from Gitee 极速下载/FastAPI

代码 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

文件

master

分支 (7)

标签 (116)

管理

master

python3.9-3.10

fastapi-people

add-link-to-testdriven-io

release-notes

consistency-star

windows-dev

0.70.0

0.69.0

0.68.2

0.68.1

0.68.0

0.67.0

0.66.1

0.66.0

0.65.3

0.65.2

0.65.1

0.65.0

0.64.0

0.63.0

0.62.0

0.61.2

0.61.1

0.61.0

0.60.2

0.60.1

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

分支 7

标签 116

FastAPI

fastapi

security

api_key.py

api_key.py 2.73 KB

from typing import Optional

from fastapi.openapi.models import APIKey, APIKeyIn
from fastapi.security.base import SecurityBase
from starlette.exceptions import HTTPException
from starlette.requests import Request
from starlette.status import HTTP_403_FORBIDDEN

class APIKeyBase(SecurityBase):
 pass

class APIKeyQuery(APIKeyBase):
 def __init__(
 self,
 *,
 name: str,
 scheme_name: Optional[str] = None,
 description: Optional[str] = None,
 auto_error: bool = True
 ):
 self.model: APIKey = APIKey(
 **{"in": APIKeyIn.query}, name=name, description=description
 )
 self.scheme_name = scheme_name or self.__class__.__name__
 self.auto_error = auto_error

async def __call__(self, request: Request) -> Optional[str]:
 api_key: str = request.query_params.get(self.model.name)
 if not api_key:
 if self.auto_error:
 raise HTTPException(
 status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
 )
 else:
 return None
 return api_key

class APIKeyHeader(APIKeyBase):
 def __init__(
 self,
 *,
 name: str,
 scheme_name: Optional[str] = None,
 description: Optional[str] = None,
 auto_error: bool = True
 ):
 self.model: APIKey = APIKey(
 **{"in": APIKeyIn.header}, name=name, description=description
 )
 self.scheme_name = scheme_name or self.__class__.__name__
 self.auto_error = auto_error

async def __call__(self, request: Request) -> Optional[str]:
 api_key: str = request.headers.get(self.model.name)
 if not api_key:
 if self.auto_error:
 raise HTTPException(
 status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
 )
 else:
 return None
 return api_key

class APIKeyCookie(APIKeyBase):
 def __init__(
 self,
 *,
 name: str,
 scheme_name: Optional[str] = None,
 description: Optional[str] = None,
 auto_error: bool = True
 ):
 self.model: APIKey = APIKey(
 **{"in": APIKeyIn.cookie}, name=name, description=description
 )
 self.scheme_name = scheme_name or self.__class__.__name__
 self.auto_error = auto_error

async def __call__(self, request: Request) -> Optional[str]:
 api_key = request.cookies.get(self.model.name)
 if not api_key:
 if self.auto_error:
 raise HTTPException(
 status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
 )
 else:
 return None
 return api_key

一键复制编辑原始数据按行查看历史

Hylke Postma 提交于 2021年07月29日 18:30 +08:00 . ✨ Add description parameter to all the security scheme classes, e.g....

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92

from typing import Optional

from fastapi.openapi.models import APIKey, APIKeyIn
from fastapi.security.base import SecurityBase
from starlette.exceptions import HTTPException
from starlette.requests import Request
from starlette.status import HTTP_403_FORBIDDEN


class APIKeyBase(SecurityBase):
 pass


class APIKeyQuery(APIKeyBase):
 def __init__(
 self,
 *,
 name: str,
 scheme_name: Optional[str] = None,
 description: Optional[str] = None,
 auto_error: bool = True
 ):
 self.model: APIKey = APIKey(
 **{"in": APIKeyIn.query}, name=name, description=description
 )
 self.scheme_name = scheme_name or self.__class__.__name__
 self.auto_error = auto_error

 async def __call__(self, request: Request) -> Optional[str]:
 api_key: str = request.query_params.get(self.model.name)
 if not api_key:
 if self.auto_error:
 raise HTTPException(
 status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
 )
 else:
 return None
 return api_key


class APIKeyHeader(APIKeyBase):
 def __init__(
 self,
 *,
 name: str,
 scheme_name: Optional[str] = None,
 description: Optional[str] = None,
 auto_error: bool = True
 ):
 self.model: APIKey = APIKey(
 **{"in": APIKeyIn.header}, name=name, description=description
 )
 self.scheme_name = scheme_name or self.__class__.__name__
 self.auto_error = auto_error

 async def __call__(self, request: Request) -> Optional[str]:
 api_key: str = request.headers.get(self.model.name)
 if not api_key:
 if self.auto_error:
 raise HTTPException(
 status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
 )
 else:
 return None
 return api_key


class APIKeyCookie(APIKeyBase):
 def __init__(
 self,
 *,
 name: str,
 scheme_name: Optional[str] = None,
 description: Optional[str] = None,
 auto_error: bool = True
 ):
 self.model: APIKey = APIKey(
 **{"in": APIKeyIn.cookie}, name=name, description=description
 )
 self.scheme_name = scheme_name or self.__class__.__name__
 self.auto_error = auto_error

 async def __call__(self, request: Request) -> Optional[str]:
 api_key = request.cookies.get(self.model.name)
 if not api_key:
 if self.auto_error:
 raise HTTPException(
 status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
 )
 else:
 return None
 return api_key