FastAPI 屏蔽字段答案

【问题标题】：FastAPI masking fieldFastAPI 屏蔽字段
【发布时间】：2021-01-28 08:45:41
【问题描述】：

我在 FastAPI web site 上关注有关安全性的教程

以具有以下端点结束：

@app.post("/token", response_model= Token)
async def login(form_data: OAuth2PasswordRequestForm = Depends()):
    user = authenticate_user(fake_users_db, form_data.username, form_data.password)
    if not user:
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="Incorrect username or password",
            headers={"WWW-Authenticate": "Bearer"},
        )
    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    access_token = create_access_token(
        data={"sub": user.username}, expires_delta=access_token_expires
    )
    return {"access_token": access_token, "token_type": "bearer"}

导致以下招摇：

我的问题： 有没有一种简单的方法来屏蔽密码字段？所以我没有在纯文本中看到它？就像我们可以使用授权按钮一样。

【问题讨论】：

另外，您可以点击右上角的“授权”按钮，而不是直接使用 /login 路由，这样会屏蔽密码表单输入。

标签： python-3.x openapi fastapi

【解决方案1】：

您可以使用 Pydantic 的 SecretStr。它只是将{"format": "password"} 添加到您的 OpenAPI 架构中。

from fastapi import FastAPI, Depends
from pydantic import BaseModel, SecretStr


class User(BaseModel):
    username: str
    password: SecretStr 

app = FastAPI()


@app.post("/user")
async def create_user(user: User = Depends()):
    print(user.password.get_secret_value())

您将拥有这个，更多信息请参阅documentation

【讨论】：

谢谢你的回答，但是端点依赖于 OAuth2PasswordRequestForm，所以我需要取代类吗？和带有密码的超级 init 方法：SecretStr = Form(...)?

【解决方案2】：

根据@Yagiz 的回答，这是可行的：


class CustomOAuth2PasswordRequestForm(OAuth2PasswordRequestForm):
    def __init__(
            self,
            grant_type: str = Form(..., regex="password"),
            username: str = Form(...),
            password: SecretStr = Form(...),
            scope: str = Form(""),
            client_id: Optional[str] = Form(None),
            client_secret: Optional[str] = Form(None),
    ):
        super().__init__(
            grant_type=grant_type,
            username=username,
            password=password,
            scope=scope,
            client_id=client_id,
            client_secret=client_secret,
        )

【讨论】：