集成 OAuth2 密码流程
在 FastAPI 应用中集成 OAuth2 密码流程,实现用户登录和令牌获取。
集成 OAuth2 密码流程 是 CoddyKit 上的免费 Node.js Backend Development Bootcamp 课时。 这是第 4 节课,共 6 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Node.js Backend Development Bootcamp 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Node.js Backend Development Bootcamp 课程共包含 6 节课。
本课时的部分内容尚未翻译,以英文显示。
Intro to OAuth2 Password Flow
Welcome! This lesson focuses on integrating the OAuth2 Password Flow in FastAPI. It's a standard and secure way for users to log in to your application.
This flow allows users to provide their username and password directly to your API. If successful, your API issues an access token, which the user then uses to access protected resources.
Why Use Password Flow?
The OAuth2 Password Flow is particularly suitable for first-party applications, like your own mobile app or web frontend, where you fully trust the client.
- Security: It's a widely adopted, well-understood security standard.
- Simplicity: Provides a straightforward login experience for users.
- Token-based: After login, users get a token, avoiding the need to send credentials with every request.
Key FastAPI Components
FastAPI provides specialized utilities to make implementing OAuth2 Password Flow easy:
OAuth2PasswordBearer: A dependency that extracts the access token from theAuthorization: Bearerheader of incoming requests.OAuth2PasswordRequestForm: A dependency that automatically parses theusernameandpasswordfrom the form data sent during a login request.
We'll combine these with FastAPI's powerful Dependency Injection system.
Setting up OAuth2PasswordBearer
First, we need to initialize OAuth2PasswordBearer. The tokenUrl parameter is crucial; it tells clients where to send their login credentials to obtain an access token.
This URL will be the path to our login endpoint.
from fastapi import FastAPI
from fastapi.security import OAuth2PasswordBearer
app = FastAPI()
# 'token' is the URL path where clients will log in
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
# We will create a @app.post("/token") endpoint next!The Login Endpoint: /token
This is the core endpoint where users will send their username and password. It's typically a POST request.
We use OAuth2PasswordRequestForm as a dependency. FastAPI automatically parses the incoming form data and provides username and password attributes.
from fastapi import Depends, HTTPException, status
from fastapi.security import OAuth2PasswordRequestForm
@app.post("/token")
async def login_for_access_token(
form_data: OAuth2PasswordRequestForm = Depends()
):
# 1. Authenticate user (verify username/password)
# 2. If valid, create an access token
# 3. Return the token
pass # Details coming in the next scene!Full Code: Login & Protected Endpoint
Here's a complete FastAPI application demonstrating the OAuth2 Password Flow. It includes the /token endpoint for login and a /users/me/ endpoint protected by the access token.
Run this code: Save as main.py, then uvicorn main:app --reload. Access docs at http://127.0.0.1:8000/docs.
from fastapi import FastAPI, Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from pydantic import BaseModel
from typing import Optional
app = FastAPI()
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
# --- Mock User & Token Logic (Simplified for this lesson) ---
class UserInDB(BaseModel):
username: str
hashed_password: str
disabled: Optional[bool] = None
class CurrentUser(BaseModel):
username: str
email: Optional[str] = None
full_name: Optional[str] = None
disabled: Optional[bool] = None
fake_users_db = {
"testuser": UserInDB(username="testuser", hashed_password="password123", disabled=False),
"disableduser": UserInDB(username="disableduser", hashed_password="securepass", disabled=True)
}
def get_user_from_db(username: str):
user_data = fake_users_db.get(username)
if user_data:
return CurrentUser(username=user_data.username, full_name=f"{user_data.username} Full", email=f"{user_data.username}@example.com", disabled=user_data.disabled)
return None
def authenticate_user(username: str, password: str):
user_in_db = fake_users_db.get(username)
if not user_in_db or user_in_db.hashed_password != password: # In real app, use password hashing
return None
return get_user_from_db(username)
def create_access_token(data: dict):
# In a real app, use `jwt.encode` with a secret key (from Lesson 1)
return f"mock_jwt_for_{data['sub']}"
# --- End Mock Logic ---
@app.post("/token")
async def login_for_access_token(
form_data: OAuth2PasswordRequestForm = Depends()
):
user = authenticate_user(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"},
)
if user.disabled:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Inactive user"
)
access_token = create_access_token(data={"sub": user.username})
return {"access_token": access_token, "token_type": "bearer"}
# Dependency to get the current user from the token
async def get_current_user(token: str = Depends(oauth2_scheme)):
# In a real app, this would decode and validate the JWT (from Lesson 1)
if not token.startswith("mock_jwt_for_"):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid authentication credentials",
headers={"WWW-Authenticate": "Bearer"},
)
username = token.replace("mock_jwt_for_", "")
user = get_user_from_db(username)
if user is None or user.disabled:
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid authentication credentials or inactive user",
headers={"WWW-Authenticate": "Bearer"},
)
return user
# A Protected Endpoint
@app.get("/users/me/", response_model=CurrentUser)
async def read_users_me(current_user: CurrentUser = Depends(get_current_user)):
return current_userUnderstanding get_current_user
The get_current_user function is a crucial dependency. It performs two main tasks:
- Extract Token: Uses
oauth2_scheme = Depends(OAuth2PasswordBearer(...))to get the token from theAuthorizationheader. - Validate & Fetch User: Decodes and validates the token (using JWT logic from Lesson 1 in a real app). If valid, it fetches and returns the corresponding
Userobject. If invalid or missing, it raises anHTTPException.
How Clients Interact
Here's a typical client interaction with the OAuth2 Password Flow:
- Client (e.g., mobile app) sends a
POSTrequest to/tokenwith username and password in form data. - If successful, the API returns an
access_token(e.g.,{"access_token": "abc.123.xyz", "token_type": "bearer"}). - For subsequent protected requests, the client includes this token in the
Authorizationheader:Authorization: Bearer abc.123.xyz.
Quick Check: OAuth2 Components
Which FastAPI component is primarily responsible for parsing the username and password from an incoming login request (form data)?
Recap: OAuth2 Password Flow
You've successfully integrated the OAuth2 Password Flow in FastAPI!
- You initialized
OAuth2PasswordBearerwith atokenUrl. - You created a
/tokenendpoint usingOAuth2PasswordRequestFormto handle user login. - You understood how to authenticate users and issue access tokens.
- You secured endpoints by using a
get_current_userdependency to extract and validate the access token.
Next, you can explore Role-Based Access Control (RBAC) to add more granular permissions based on user roles!
用 AI 导师学习 JavaScript — 免费
在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。
- 课程
- 22
- 课程
- 92
常见问题解答
「集成 OAuth2 密码流程」课时是免费的吗?
是的 — 「集成 OAuth2 密码流程」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Node.js Backend Development Bootcamp 课程的其余内容,请升级到 CoddyKit PRO。 Node.js Backend Development Bootcamp 课程共包含 6 节课。
「集成 OAuth2 密码流程」这节课中我会学到什么?
在 FastAPI 应用中集成 OAuth2 密码流程,实现用户登录和令牌获取。 你通过在浏览器中直接运行的动手代码来练习 Node.js Backend Development Bootcamp,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Node.js Backend Development Bootcamp 需要有经验吗?
无需任何先前经验。CoddyKit 上的 Node.js Backend Development Bootcamp 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 6 节。
「集成 OAuth2 密码流程」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 Node.js Backend Development Bootcamp 课中编写并运行代码吗?
能。每节 Node.js Backend Development Bootcamp 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。