FastAPI登录实现（JWT）

FastAPI登录实现（JWT）

JWT(JSON Web Tokens)

一、依赖库安装

jwt

pip install jwt==1.2.0

python-jose

• 用于生成和检验JWT令牌

pip install python-jose==3.2.0

passlib

• 用于处理哈希密码的包
• 支持许多安全哈希算法以及配合算法使用的实用程序
• 推荐的算法是 Bcrypt

pip install passlib[Bcrypt]==1.7.4

二、哈希并校验密码

1、创建对象，进行哈希和校验密码

from passlib.context import CryptContext
# 使用的算法是Bcrypt
pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")

2、哈希密码：hash(password)

def get_password_hash(password):
    """
    哈希来自用户的密码
    :param password: 原密码
    :return: 哈希后的密码
    """
    return pwd_context.hash(password)
# 哈希后的密码
# $2b$12$sErK932BEaLyIisz30PubepN7w91RLwkISWbAFYgUgoIqh8goJLEW

3、校验密码：verify(plain_password, hashed_password)

def verify_password(plain_password, hashed_password):
    """
    校验接收的密码是否与存储的哈希值匹配
    :param plain_password: 原密码
    :param hashed_password: 哈希后的密码
    :return: 返回值为bool类型，校验成功返回True,反之False
    """
    return pwd_context.verify(plain_password, hashed_password)

三、JWT令牌验证加密

1、生成一个随机的密钥，用于对JWT令牌进行签名

openssl rand -hex 32
# eac77e4e9a9a767b792779132e84ea37b1f4c31bec56714607f617a3fbdfbd53

2、创建密钥变量

SECRET_KEY = "eac77e4e9a9a767b792779132e84ea37b1f4c31bec56714607f617a3fbdfbd53"

3、创建用于设定JWT令牌签名算法的变量

ALGORITHM = "HS256"

4、创建设置令牌过期时间变量（单位：分钟）

ACCESS_TOKEN_EXPIRE_MINUTES = 30

5、模拟数据库用户信息

users_db = {
    "mockuser":{
        "id": 1,
        "username": "mockuser",
        "email": "mock@user.com",
        "password": "$2b$12$sErK932BEaLyIisz30PubepN7w91RLwkISWbAFYgUgoIqh8goJLEW",
    }
}

6、创建所需模型类

from typing import Optional
from pydantic import BaseModel, EmailStr

1) 用户模型基类

class UserBase(BaseModel):
    id: Optional[int] = False
    username: str = None
    # pip install pydantic[email] 使用email验证的时候需要增加这个库
    email: Optional[EmailStr] = None

2）登录成功返回token模型

class TokenModel(UserBase):
    token: str = None

3）用户登录模型

class LoginModel(BaseModel):
    username: str = None
    password: str = None

4）创建用户模型

class CreateModel(UserBase):
    password: str

7、创建生成访问令牌的函数

def create_access_token(data: dict, expires_delta: Optional[timedelta] = None):
    """

    :param data: 需要进行JWT令牌加密的数据（解密的时候会用到）
    :param expires_delta: 令牌有效期
    :return: token
    """
    to_encode = data.copy()
    if expires_delta:
        expire = datetime.utcnow() + expires_delta
    else:
        expire = datetime.utcnow() + timedelta(minutes=15)
    # 添加失效时间
    to_encode.update({"exp": expire})
    # SECRET_KEY：密钥
    # ALGORITHM：JWT令牌签名算法
    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
    return encoded_jwt

8、校验用户功能函数

def check_user(username, password):
    """
    校验用户（真实的应该是跟DB进行校验，这里只是做演示）
    :param username:
    :param password:
    :return:
    """
    user = users_db.get(username)
    if not user:
        return False
    if not verify_password(password, user.get("password")):
        return False
    return user

9、创建登录接口api

# 使用表单格式参数需要安装模块：python-multipart
@app.post("/token", response_model=TokenModel)
async def login_for_access_token(username: str = Form(...), password: str = Form(...)):
    user = check_user(username, password)
    if not user:
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="用户名或密码错误"
        )
    # 过期时间
    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
    # 把id进行username加密，要使用str类型
    access_token = create_access_token(
        data={"sub": user.get("username")}, expires_delta=access_token_expires
    )
    user.update({"token": access_token})
    return user

四、JWT令牌验证解密

1、验证token

def check_jwt_token(token: Optional[str] = Header("")):
    """
    验证token
    :param token:
    :return: 返回用户信息
    """
    try:
        payload = jwt.decode(token, SECRET_KEY, algorithms=ALGORITHM)
        username: str = payload.get("sub")
        # 通过解析得到的username,获取用户信息,并返回
        return users_db.get(username)
    except (jwt.JWTError, jwt.ExpiredSignatureError, ValidationError):
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail={
                'code': 5000,
                'message': "Token Error",
                'data': "Token Error",
            }
        )

2、访问当前用户信息接口api

# 定义返回数据格式为UserBase模型格式数据
# 把校验token函数当做依赖项进行赋值给user
# 验证成功，并返回user
@app.get("/user", response_model=UserBase)
async def get_user(*, user: UserBase = Depends(check_jwt_token)):
    return user

3、需要token验证但不需要用户信息数据接口api

# 当不需要依赖项的返回值时，可以将依赖项添加到路径中，只做验证使用
@app.get("/pro", dependencies=[Depends(check_jwt_token)])
async def get_projects():
    return {"projects": "pro"}

五、演示