,hUTddlmZmZmZmZmZmZddlmZddl m Z ddl m Z ddlmZddlmZddlmZddlmZdd lmZmZdd lmZmZGd d ZGd deZGddeZ Gdde ZGdde ZGddZ y))AnyDictListOptionalUnioncast) HTTPException)OAuth2) OAuthFlows)Form) SecurityBase)get_authorization_scheme_param)Request)HTTP_401_UNAUTHORIZEDHTTP_403_FORBIDDEN) AnnotatedDocc*eZdZdZddddddeeedfededfd eeeed fd eeeed fd eeeedfdeeedfeedfdeeedfeedff dZ y)OAuth2PasswordRequestFormaD This is a dependency class to collect the `username` and `password` as form data for an OAuth2 password flow. The OAuth2 specification dictates that for a password flow the data should be collected using form data (instead of JSON) and that it should have the specific fields `username` and `password`. All the initialization parameters are extracted from the request. Read more about it in the [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/). ## Example ```python from typing import Annotated from fastapi import Depends, FastAPI from fastapi.security import OAuth2PasswordRequestForm app = FastAPI() @app.post("/login") def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]): data = {} data["scopes"] = [] for scope in form_data.scopes: data["scopes"].append(scope) if form_data.client_id: data["client_id"] = form_data.client_id if form_data.client_secret: data["client_secret"] = form_data.client_secret return data ``` Note that for OAuth2 the scope `items:read` is a single scope in an opaque string. You could have custom internal logic to separate it by colon characters (`:`) or similar, and get the two parts `items` and `read`. Many applications do that to group and organize permissions, you could do it as well in your application, just know that that it is application specific, it's not part of the specification. N) grant_typescope client_id client_secretr ^password$patternaD The OAuth2 spec says it is required and MUST be the fixed string "password". Nevertheless, this dependency class is permissive and allows not passing it. If you want to enforce it, use instead the `OAuth2PasswordRequestFormStrict` dependency. username~ `username` string. The OAuth2 spec requires the exact field name `username`. password~ `password` string. The OAuth2 spec requires the exact field name `password". r A single string with actually several scopes separated by spaces. Each scope is also a string. For example, a single string with: ```python "items:read items:write users:read profile openid" ```` would represent the scopes: * `items:read` * `items:write` * `users:read` * `profile` * `openid` r If there's a `client_id`, it can be sent as part of the form fields. But the OAuth2 specification recommends sending the `client_id` and `client_secret` (if any) using HTTP Basic auth. r& If there's a `client_password` (and a `client_id`), they can be sent as part of the form fields. But the OAuth2 specification recommends sending the `client_id` and `client_secret` (if any) using HTTP Basic auth. ct||_||_||_|j|_||_||_yN)rrr splitscopesrr)selfrrr rrrs Y/var/www/html/Resume-Scraper/venv/lib/python3.12/site-packages/fastapi/security/oauth2.py__init__z"OAuth2PasswordRequestForm.__init__=s6f%    kkm "*) __name__ __module__ __qualname____doc__rrstrr rr+r,r*rrsD*t X   cX+ #t)   &     X+  F     X+2  F     3X+F  F    GX+v #t)  F     wX+L! #t)  F     MX+r,rc(eZdZdZ ddeeededfdeeeedfd eeeed fd eeeed fd eeedfeedfdeeedfeedff fd Z xZ S)OAuth2PasswordRequestFormStrictaG This is a dependency class to collect the `username` and `password` as form data for an OAuth2 password flow. The OAuth2 specification dictates that for a password flow the data should be collected using form data (instead of JSON) and that it should have the specific fields `username` and `password`. All the initialization parameters are extracted from the request. The only difference between `OAuth2PasswordRequestFormStrict` and `OAuth2PasswordRequestForm` is that `OAuth2PasswordRequestFormStrict` requires the client to send the form field `grant_type` with the value `"password"`, which is required in the OAuth2 specification (it seems that for no particular reason), while for `OAuth2PasswordRequestForm` `grant_type` is optional. Read more about it in the [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/). ## Example ```python from typing import Annotated from fastapi import Depends, FastAPI from fastapi.security import OAuth2PasswordRequestForm app = FastAPI() @app.post("/login") def login(form_data: Annotated[OAuth2PasswordRequestFormStrict, Depends()]): data = {} data["scopes"] = [] for scope in form_data.scopes: data["scopes"].append(scope) if form_data.client_id: data["client_id"] = form_data.client_id if form_data.client_secret: data["client_secret"] = form_data.client_secret return data ``` Note that for OAuth2 the scope `items:read` is a single scope in an opaque string. You could have custom internal logic to separate it by colon characters (`:`) or similar, and get the two parts `items` and `read`. Many applications do that to group and organize permissions, you could do it as well in your application, just know that that it is application specific, it's not part of the specification. grant_type: the OAuth2 spec says it is required and MUST be the fixed string "password". This dependency is strict about it. If you want to be permissive, use instead the OAuth2PasswordRequestForm dependency class. username: username string. The OAuth2 spec requires the exact field name "username". password: password string. The OAuth2 spec requires the exact field name "password". scope: Optional string. Several scopes (each one a string) separated by spaces. E.g. "items:read items:write users:read profile openid" client_id: optional string. OAuth2 recommends sending the client_id and client_secret (if any) using HTTP Basic auth, as: client_id:client_secret client_secret: optional string. OAuth2 recommends sending the client_id and client_secret (if any) using HTTP Basic auth, as: client_id:client_secret Nrrra The OAuth2 spec says it is required and MUST be the fixed string "password". This dependency is strict about it. If you want to be permissive, use instead the `OAuth2PasswordRequestForm` dependency class. rrr r!rr"rr#rr$c0t|||||||y)N)rrr rrr)superr+)r)rrr rrr __class__s r*r+z(OAuth2PasswordRequestFormStrict.__init__s*d !'  r,)rNN) r-r.r/r0rr1r rrr+ __classcell__r7s@r*r4r4s:=p   aY    &     Y   F     Y 0  F     1Y D  F    EY t #t)  F     uY J! #t)  F     KY Y r,r4c eZdZdZedddddeeeeeeee fffe dfdee ee dfd ee ee d fd ee e d ffd Z dede efdZy)r a This is the base class for OAuth2 authentication, an instance of it would be used as a dependency. All other OAuth2 classes inherit from it and customize it for each OAuth2 flow. You normally would not create a new class inheriting from it but use one of the existing subclasses, and maybe compose them if you want to support multiple flows. Read more about it in the [FastAPI docs for Security](https://fastapi.tiangolo.com/tutorial/security/). NTflows scheme_name description auto_errorr<zA The dictionary of OAuth2 flows. r= Security scheme name. It will be included in the generated OpenAPI (e.g. visible at `/docs`). r> Security scheme description. It will be included in the generated OpenAPI (e.g. visible at `/docs`). r? By default, if no HTTP Authorization header is provided, required for OAuth2 authentication, it will automatically cancel the request and send the client an error. If `auto_error` is set to `False`, when the HTTP Authorization header is not available, instead of erroring out, the dependency result will be `None`. This is useful when you want to have optional authentication. It is also useful when you want to have authentication that can be provided in one of multiple optional ways (for example, with OAuth2 or in a cookie). cttt|||_|xs|jj |_||_y)N)r<r>) OAuth2ModelrOAuthFlowsModelmodelr7r-r=r?)r)r<r=r>r?s r*r+zOAuth2.__init__As=h!.K  'A$..*A*A$r,requestreturncK|jjd}|s|jrttdy|Sw)N AuthorizationNot authenticated) status_codedetail)headersgetr?r r)r)rG authorizations r*__call__zOAuth2.__call__{sB++O< # 2;Ns>A)r-r.r/r0rErrrr1rrrboolr+rrQr2r,r*r r 4s ,    ( e8% /4T#s(^(;#<< =    8% SM     8%* SM     +8%>     ?8%t g (3- r,r ceZdZdZ ddeeedfdeeeedfdeeeeefedfdeeeed fd ee ed ff fd Z d e deefdZ xZ S)OAuth2PasswordBearera) OAuth2 flow for authentication using a bearer token obtained with a password. An instance of it would be used as a dependency. Read more about it in the [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/). tokenUrlz The URL to obtain the OAuth2 token. This would be the *path operation* that has `OAuth2PasswordRequestForm` as a dependency. r=r@r( The OAuth2 scopes that would be required by the *path operations* that use this dependency. r>rAr?rBcn|si}ttt||d}t|||||y)N)rUr()r r;rErrr6r+)r)rUr=r(r>r?r<r7s r*r+zOAuth2PasswordBearer.__init__sGzF#HGH  ##!  r,rGrHcK|jjd}t|\}}|r|jdk7r!|jrt t dddiy|SwNrJbearerrKzWWW-AuthenticateBearer)rLrMrNrNrOrlowerr?r rr)rGrPschemeparams r*rQzOAuth2PasswordBearer.__call__d++O< 6}E  ( :# 5./:  A"A$)NNNT)r-r.r/r0rr1rrrrRr+rrQr8r9s@r*rTrTs 8   ( wG      G  SM     G * T#s(^ $    +G < SM     =G P     QG R g (3- r,rTceZdZdZ ddedeeedfdeeeedfdeeeedfd eeeeefed fd eeeed fd ee edfffd Z de deefdZ xZ S)OAuth2AuthorizationCodeBearerz OAuth2 flow for authentication using a bearer token obtained with an OAuth2 code flow. An instance of it would be used as a dependency. authorizationUrlrUzE The URL to obtain the OAuth2 token. refreshUrlzT The URL to refresh the token and obtain a new one. r=r@r(rVr>rAr?rBc r|si}ttt||||d}t |||||y)N)rfrUrgr()authorizationCoder;rX) r)rfrUrgr=r(r>r?r<r7s r*r+z&OAuth2AuthorizationCodeBearer.__init__sTJF"(8 (",$    ##!  r,rGrHcK|jjd}t|\}}|r|jdk7r!|jrt t dddiy|SwrZr]r_s r*rQz&OAuth2AuthorizationCodeBearer.__call__Grbrc)NNNNT)r-r.r/r0r1rrrrrRr+rrQr8r9s@r*reresD.    ( GW W      W  SM    W & SM     'W : T#s(^ $    ;W L SM     MW `     aW r g (3- r,recBeZdZdZ ddeeeeedffdZ y)SecurityScopesa This is a special class that you can define in a parameter in a dependency to obtain the OAuth2 scopes required by all the dependencies in the same chain. This way, multiple dependencies can have different scopes, even when used in the same *path operation*. And with this, you can access all the scopes required in all those dependencies in a single place. Read more about it in the [FastAPI docs for OAuth2 scopes](https://fastapi.tiangolo.com/advanced/security/oauth2-scopes/). Nr(zA This will be filled by FastAPI. cZ|xsg|_dj|j|_y)N )r(join scope_str)r)r(s r*r+zSecurityScopes.__init__cs+$ Lb HHT[[ ! r,r&) r-r.r/r0rrrr1rr+r2r,r*rlrlVs< * " T#Y     "r,rlN)!typingrrrrrrfastapi.exceptionsr fastapi.openapi.modelsr rDr rEfastapi.param_functionsr fastapi.security.baser fastapi.security.utilsrstarlette.requestsrstarlette.statusrrtyping_extensionsrrrr4rTrerlr2r,r*rzs|99,8@(.A&F-E+E+PY &?Y xP\Pf^6^BkFk\("("r,