failed WRONG_FIX UNSUBMITTED wrong_fix_unsubmitted(budget) · 16 tool calls · 300 s · fastapi/fastapi
🐛 Use `401` status code in security classes when credentials are missing
## Warning
This description is partially outdated after changes described in [this comment](https://github.com/fastapi/fastapi/pull/13786#pullrequestreview-3501695067).
## Description
This PR is an attempt to finally solve the issue with security tools returning error responses with status code `403` instead of `401` when credentials are not provided.
## Breaking changes and workaround
These changes can break projects that rely on old behavior.
In order to mitigate this, the `not_authenticated_status_code` is introduced. If set to `403`, it will make it work the same way as it was before changes (return `403` status code).
This option should be treated as a temporary workaround to give developers more time to update Clients to follow the new behavior.
## Changes and reasoning
### APIKeyQuery, APIKeyHeader, APIKeyCookie
* **Standard:**
* These schemes are not covered by standards, but developers usually follow the same rules as for other standards
* **Actions:**
* The default status code for not providing API key was changed from 403 to 401.
* Temporary `not_authenticated_status_code` parameter can be used to revert this behavior back to returning 403 error code without sending `WWW-Authenticate`.
* **Notes:**
* It’s considered to be a good practice to include in `WWW-Authenticate` information needed to understand how the key is supposed to be passed. I implemented default format (`WWW-Authenticate: ApiKey in="...", name="..."` ), but it’s possible to override the template for `WWW-Authenticate` by subclassing and defining the `format_www_authenticate_header_value` method
### HTTP Basic
* **Standard:**
* https://datatracker.ietf.org/doc/html/rfc7617
* **Actions:**
* No needed. This scheme already acts according to the standard in terms of returning 401 status code with `WWW-Authenticate` header on a lack of credentials
* **Notes:**
* `realm` is required according to the RFC, but optional in the current implementation. Fixing this would introduce breaking changes. Considering this is not a problem for people who want to follow the standard, I suggest we leave it as it is.
### HTTP Digest
* **Standard:**
* https://datatracker.ietf.org/doc/html/rfc7616
* **Actions:**
* The default status code for not providing the authorization parameter was changed from 403 to 401.
* `WWW-Authenticate` is just a stub for now (just `WWW-Authenticate: Digest`) (see notes)
* Temporary `not_authenticated_status_code` parameter can be used to revert this behavior back to returning 403 error code without sending `WWW-Authenticate`.
* **Notes:**
* Since the current `HTTPDigest` implementation is just a stub, we can’t follow standards (we don’t generate `nonce`'s, don’t have `realm`, …). I suggest we just change the error status code and add a stub for `WWW-Authenticate` (just `WWW-Authenticate: Digest`). For now `HTTPDigest` can’t be used as it is, so, this is not a problem.
* We can later add full implementation of `Digest` scheme. There have been made several attempts to implement it (#9825, #3071)
* Should we add a note that `HTTPDigest` is just a stub?
### HTTP Bearer, OAuth2 schemes, OIDC
* **Standard:**
* https://datatracker.ietf.org/doc/html/rfc6750
* **Actions:**
* For `OAuth2PasswordBearer` and `OAuth2AuthorizationCodeBearer`: not needed.
* They already return a 401 error code. Implementation is probably not 100% correct (see notes), but considering nobody argued, I think we can leave it as it is for now.
* For `HTTPBearer` and `OpenIdConnect`:
* The default status code for not providing the authorization parameter was changed from 403 to 401. The suggested implementation will be in line with the current implementations of `OAuth2PasswordBearer` and `OAuth2AuthorizationCodeBearer`.
* Temporary `not_authenticated_status_code` parameter added to `HTTPBearer` can be used to revert this behavior back to returning 403 error code without sending `WWW-Authenticate`.
* **Notes:**
* It’s [recommended to return 400 error response](https://datatracker.ietf.org/doc/html/rfc6750#section-3.1) if the parameter is missed or of an unsupported type, but this is not a strict requirement (word SHOULD is used). I suggest we ignore this and follow the approach that is consistent with other schemes.
* The format of `WWW-Authenticate` is not clearly described: It’s said that the value "Bearer" MUST be followed by one or more auth-param values. At the same time, all auth-param attributes are optional. In examples they always add `realm`. Since we don’t have `realm`, I suggest we just skip it and send just `WWW-Authenticate: Bearer`
* We can later improve the `WWW-Authenticate` format by adding `realm` and `scope`
## Links
* https://github.com/fastapi/fastapi/issues/10177
* https://github.com/fastapi/fastapi/pull/2120
* https://github.com/fastapi/fastapi/pull/5332
* https://github.com/fastapi/fastapi/pull/12507
* https://github.com/fastapi/fastapi/pull/5310
* https://github.com/fastapi/fastapi/pull/13729
* https://github.com/fastapi/fastapi/pull/13514
* https://github.com/fastapi/fastapi/pull/13326
| # | Tool | Arguments | Result |
|---|---|---|---|
| 1 | run_command | {
"command": "grep -rn \"HTTPException\" fastapi/security | head -20"
} | {"status": "ok", "stdout": "fastapi/security/api_key.py:6:from starlette.exceptions import HTTPException\nfastapi/security/api_key.py:17: raise HTTPException(\nfull{"status": "ok", "stdout": "fastapi/security/api_key.py:6:from starlette.exceptions import HTTPException\nfastapi/security/api_key.py:17: raise HTTPException(\nfastapi/security/open_id_connect_url.py:6:from starlette.exceptions import HTTPException\nfastapi/security/open_id_connect_url.py:80: raise HTTPException(\nfastapi/security/oauth2.py:4:from fastapi.exceptions import HTTPException\nfastapi/security/oauth2.py:384: raise HTTPException(\nfastapi/security/oauth2.py:494: raise HTTPException(\nfastapi/security/oauth2.py:604: raise HTTPException(\nfastapi/security/http.py:6:from fastapi.exceptions import HTTPException\nfastapi/security/http.py:90: raise HTTPException(\nfastapi/security/http.py:199: raise HTTPException(\nfastapi/security/http.py:206: invalid_user_credentials_exc = HTTPException(\nfastapi/security/http.py:309: raise HTTPException(\nfastapi/security/http.py:316: raise HTTPException(\nfastapi/security/http.py:411: raise HTTPException(\nfastapi/security/http.py:418: raise HTTPException(\n", "exit_code": 0} |
| 2-3 ×2 | read_file | {
"filepath": "fastapi/security/api_key.py"
} | {"status": "ok", "filepath": "fastapi/security/api_key.py", "content": "from typing import Optional\n\nfrom annotated_doc import Doc\nfrom fastapi.openapi.modelfull{"status": "ok", "filepath": "fastapi/security/api_key.py", "content": "from typing import Optional\n\nfrom annotated_doc import Doc\nfrom fastapi.openapi.models import APIKey, APIKeyIn\nfrom fastapi.security.base import SecurityBase\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.status import HTTP_403_FORBIDDEN\nfrom typing_extensions import Annotated\n\n\nclass APIKeyBase(SecurityBase):\n @staticmethod\n def check_api_key(api_key: Optional[str], auto_error: bool) -> Optional[str]:\n if not api_key:\n if auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n )\n return None\n return api_key\n\n\nclass APIKeyQuery(APIKeyBase):\n \"\"\"\n API key authentication using a query parameter.\n\n This defines the name of the query parameter that should be provided in the request\n with the API key and integrates that into the OpenAPI documentation. It extracts\n the key value sent in the query parameter automatically and provides it as the\n dependency result. But it doesn't define how to send that API key to the client.\n\n ## Usage\n\n Create an instance object and use that object as the dependency in `Depends()`.\n\n The dependency result will be a string containing the key value.\n\n ## Example\n\n ```python\n from fastapi import Depends, FastAPI\n from fastapi.security import APIKeyQuery\n\n app = FastAPI()\n\n query_scheme = APIKeyQuery(name=\"api_key\")\n\n\n @app.get(\"/items/\")\n async def read_items(api_key: str = Depends(query_scheme)):\n return {\"api_key\": api_key}\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n name: Annotated[\n str,\n Doc(\"Query parameter name.\"),\n ],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n |
| 4 | read_file | {
"filepath": "fastapi/security/api_key.py",
"start_line": 151
} | {"status": "ok", "filepath": "fastapi/security/api_key.py", "content": " name: Annotated[str, Doc(\"Header name.\")],\n scheme_name: Annotated[\n Optional[str],full{"status": "ok", "filepath": "fastapi/security/api_key.py", "content": " name: Annotated[str, Doc(\"Header name.\")],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the header is not provided, `APIKeyHeader` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the header is not available,\n instead of erroring out, the dependency result will be `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a header or\n in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.header},\n name=name,\n description=description,\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n\n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.headers.get(self.model.name)\n return self.check_api_key(api_key, self.auto_error)\n\n\nclass APIKeyCookie(APIKeyBase):\n \"\"\"\n A |
| 5 | read_file | {
"filepath": "fastapi/security/http.py"
} | {"status": "ok", "filepath": "fastapi/security/http.py", "content": "import binascii\nfrom base64 import b64decode\nfrom typing import Optional\n\nfrom annotatefull{"status": "ok", "filepath": "fastapi/security/http.py", "content": "import binascii\nfrom base64 import b64decode\nfrom typing import Optional\n\nfrom annotated_doc import Doc\nfrom fastapi.exceptions import HTTPException\nfrom fastapi.openapi.models import HTTPBase as HTTPBaseModel\nfrom fastapi.openapi.models import HTTPBearer as HTTPBearerModel\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.utils import get_authorization_scheme_param\nfrom pydantic import BaseModel\nfrom starlette.requests import Request\nfrom starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN\nfrom typing_extensions import Annotated\n\n\nclass HTTPBasicCredentials(BaseModel):\n \"\"\"\n The HTTP Basic credentials given as the result of using `HTTPBasic` in a\n dependency.\n\n Read more about it in the\n [FastAPI docs for HTTP Basic Auth](https://fastapi.tiangolo.com/advanced/security/http-basic-auth/).\n \"\"\"\n\n username: Annotated[str, Doc(\"The HTTP Basic username.\")]\n password: Annotated[str, Doc(\"The HTTP Basic password.\")]\n\n\nclass HTTPAuthorizationCredentials(BaseModel):\n \"\"\"\n The HTTP authorization credentials in the result of using `HTTPBearer` or\n `HTTPDigest` in a dependency.\n\n The HTTP authorization header value is split by the first space.\n\n The first part is the `scheme`, the second part is the `credentials`.\n\n For example, in an HTTP Bearer token scheme, the client will send a header\n like:\n\n ```\n Authorization: Bearer deadbeef12346\n ```\n\n In this case:\n\n * `scheme` will have the value `\"Bearer\"`\n * `credentials` will have the value `\"deadbeef12346\"`\n \"\"\"\n\n scheme: Annotated[\n str,\n Doc(\n \"\"\"\n The HTTP authorization scheme extracted from the header value.\n \"\"\"\n ),\n ]\n credentials: Annotated[\n str,\n Doc(\n \"\"\"\n The HTTP a |
| 6 | read_file | {
"filepath": "fastapi/security/http.py",
"start_line": 151
} | {"status": "ok", "filepath": "fastapi/security/http.py", "content": " ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme desfull{"status": "ok", "filepath": "fastapi/security/http.py", "content": " ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the HTTP Basic authentication is not provided (a\n header), `HTTPBasic` will automatically cancel the request and send the\n client an error.\n\n If `auto_error` is set to `False`, when the HTTP Basic authentication\n is not available, instead of erroring out, the dependency result will\n be `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in HTTP Basic\n authentication or in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n ):\n self.model = HTTPBaseModel(scheme=\"basic\", description=description)\n self.scheme_name = scheme_name or self.__class__.__name__\n self.realm = realm\n self.auto_error = auto_error\n\n async def __call__( # type: ignore\n self, request: Request\n ) -> Optional[HTTPBasicCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, param = get_authorization_scheme_param(authorization)\n if self.realm:\n unauthorized_headers = {\"WWW-Authenticate\": f'Basic realm=\"{self.realm}\"'}\n else:\n unauthorized_headers = {\"WWW-Authenticate\": \"Basic\"}\n if not authorization or scheme.lower() != \"basic\":\n |
| 7 | read_file | {
"filepath": "fastapi/security/http.py",
"start_line": 301
} | {"status": "ok", "filepath": "fastapi/security/http.py", "content": "\n async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentialfull{"status": "ok", "filepath": "fastapi/security/http.py", "content": "\n async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"bearer\":\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN,\n detail=\"Invalid authentication credentials\",\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)\n\n\nclass HTTPDigest(HTTPBase):\n \"\"\"\n HTTP Digest authentication.\n\n ## Usage\n\n Create an instance object and use that object as the dependency in `Depends()`.\n\n The dependency result will be an `HTTPAuthorizationCredentials` object containing\n the `scheme` and the `credentials`.\n\n ## Example\n\n ```python\n from typing import Annotated\n\n from fastapi import Depends, FastAPI\n from fastapi.security import HTTPAuthorizationCredentials, HTTPDigest\n\n app = FastAPI()\n\n security = HTTPDigest()\n\n\n @app.get(\"/users/me\")\n def read_current_user(\n credentials: Annotated[HTTPAuthorizationCredentials, Depends(security)]\n ):\n return {\"scheme\": credentials.scheme, \"credentials\": credentials.credentials}\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n |
| 8 | read_file | {
"filepath": "fastapi/security/open_id_connect_url.py"
} | {"status": "ok", "filepath": "fastapi/security/open_id_connect_url.py", "content": "from typing import Optional\n\nfrom annotated_doc import Doc\nfrom fastapi.ofull{"status": "ok", "filepath": "fastapi/security/open_id_connect_url.py", "content": "from typing import Optional\n\nfrom annotated_doc import Doc\nfrom fastapi.openapi.models import OpenIdConnect as OpenIdConnectModel\nfrom fastapi.security.base import SecurityBase\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.status import HTTP_403_FORBIDDEN\nfrom typing_extensions import Annotated\n\n\nclass OpenIdConnect(SecurityBase):\n \"\"\"\n OpenID Connect authentication class. An instance of it would be used as a\n dependency.\n \"\"\"\n\n def __init__(\n self,\n *,\n openIdConnectUrl: Annotated[\n str,\n Doc(\n \"\"\"\n The OpenID Connect URL.\n \"\"\"\n ),\n ],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if no HTTP Authorization header is provided, required for\n OpenID Connect authentication, it will automatically cancel the request\n and send the client an error.\n\n If `auto_error` is set to `False`, when the HTTP Authorization header\n is not available, instead of erroring out, the dependency result will\n be `None`.\n\n This is useful when you want to have |
| 9 | edit_file | {
"filepath": "fastapi/security/api_key.py",
"new_string": "from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN",
"old_string": "from starlette.status import HTTP_403_FORBIDDEN"
} | {"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/secfull{"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/security/api_key.py\n@@ -5,7 +5,7 @@\n from fastapi.security.base import SecurityBase\n from starlette.exceptions import HTTPException\n from starlette.requests import Request\n-from starlette.status import HTTP_403_FORBIDDEN\n+from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN\n from typing_extensions import Annotated\n \n \n", "is_truncated": false} |
| 10 | edit_file | {
"filepath": "fastapi/security/api_key.py",
"new_string": "class APIKeyBase(SecurityBase):\n @staticmethod\n def check_api_key(\n api_key: Optional[str], auto_error: bool, not_authenticated_status_code: int = HTTP_401_UNAUTHORIZED\n ) -> Optional[str]:\n if not api_key:\n if auto_error:\n raise HTTPException(\n status_code=not_authenticated_status_code, detail=\"Not authenticated\"\n )\n return None\n return api_key",
"old_string": "class APIKeyBase(SecurityBase):\n @staticmethod\n def check_api_key(api_key: Optional[str], auto_error: bool) -> Optional[str]:\n if not api_key:\n if auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n )\n return None\n return api_key"
} | {"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/secfull{"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/security/api_key.py\n@@ -11,11 +11,13 @@\n \n class APIKeyBase(SecurityBase):\n @staticmethod\n- def check_api_key(api_key: Optional[str], auto_error: bool) -> Optional[str]:\n+ def check_api_key(\n+ api_key: Optional[str], auto_error: bool, not_authenticated_status_code: int = HTTP_401_UNAUTHORIZED\n+ ) -> Optional[str]:\n if not api_key:\n if auto_error:\n raise HTTPException(\n- status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n+ status_code=not_authenticated_status_code, detail=\"Not authenticated\"\n )\n return None\n return api_key\n", "is_truncated": false} |
| 11 | edit_file | {
"filepath": "fastapi/security/api_key.py",
"new_string": " def __init__(\n self,\n *,\n name: Annotated[\n str,\n Doc(\"Query parameter name.\"),\n ],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the query parameter is not provided, `APIKeyQuery` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the query parameter is not\n available, instead of erroring out, the dependency result will be\n `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a query\n parameter or in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n not_authenticated_status_code: Annotated[\n int,\n Doc(\"Status code to use when the API key is missing.\"),\n ] = HTTP_401_UNAUTHORIZED,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.query},\n name=name,\n description=description,\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n self.not_authenticated_status_code = not_authenticated_status_code\n\n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.query_params.get(self.model.name)\n return self.check_api_key(\n api_key, self.auto_error, self.not_authenticated_status_code\n )",
"old_string": " def __init__(\n self,\n *,\n name: Annotated[\n str,\n Doc(\"Query parameter name.\"),\n ],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the query parameter is not provided, `APIKeyQuery` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the query parameter is not\n available, instead of erroring out, the dependency result will be\n `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a query\n parameter or in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n ):\n self.model: APIKey = | {"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/secfull{"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/security/api_key.py\n@@ -101,6 +101,10 @@\n \"\"\"\n ),\n ] = True,\n+ not_authenticated_status_code: Annotated[\n+ int,\n+ Doc(\"Status code to use when the API key is missing.\"),\n+ ] = HTTP_401_UNAUTHORIZED,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.query},\n@@ -109,10 +113,13 @@\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n+ self.not_authenticated_status_code = not_authenticated_status_code\n \n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.query_params.get(self.model.name)\n- return self.check_api_key(api_key, self.auto_error)\n+ return self.check_api_key(\n+ api_key, self.auto_error, self.not_authenticated_status_code\n+ )\n \n \n class APIKeyHeader(APIKeyBase):\n", "is_truncated": false} |
| 12 | edit_file | {
"filepath": "fastapi/security/api_key.py",
"new_string": " def __init__(\n self,\n *,\n name: Annotated[str, Doc(\"Header name.\")],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the header is not provided, `APIKeyHeader` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the header is not available,\n instead of erroring out, the dependency result will be `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a header or\n in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n not_authenticated_status_code: Annotated[\n int,\n Doc(\"Status code to use when the API key is missing.\"),\n ] = HTTP_401_UNAUTHORIZED,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.header},\n name=name,\n description=description,\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n self.not_authenticated_status_code = not_authenticated_status_code\n\n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.headers.get(self.model.name)\n return self.check_api_key(\n api_key, self.auto_error, self.not_authenticated_status_code\n )",
"old_string": " def __init__(\n self,\n *,\n name: Annotated[str, Doc(\"Header name.\")],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the header is not provided, `APIKeyHeader` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the header is not available,\n instead of erroring out, the dependency result will be `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a header or\n in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.header},\n name=name,\n description=description,\n )\n self.scheme_name = scheme_name or self.__class__.__ | {"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/secfull{"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/security/api_key.py\n@@ -196,6 +196,10 @@\n \"\"\"\n ),\n ] = True,\n+ not_authenticated_status_code: Annotated[\n+ int,\n+ Doc(\"Status code to use when the API key is missing.\"),\n+ ] = HTTP_401_UNAUTHORIZED,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.header},\n@@ -204,10 +208,13 @@\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n+ self.not_authenticated_status_code = not_authenticated_status_code\n \n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.headers.get(self.model.name)\n- return self.check_api_key(api_key, self.auto_error)\n+ return self.check_api_key(\n+ api_key, self.auto_error, self.not_authenticated_status_code\n+ )\n \n \n class APIKeyCookie(APIKeyBase):\n", "is_truncated": false} |
| 13 | edit_file | {
"filepath": "fastapi/security/api_key.py",
"new_string": " def __init__(\n self,\n *,\n name: Annotated[str, Doc(\"Cookie name.\")],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the cookie is not provided, `APIKeyCookie` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the cookie is not available,\n instead of erroring out, the dependency result will be `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a cookie or\n in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n not_authenticated_status_code: Annotated[\n int,\n Doc(\"Status code to use when the API key is missing.\"),\n ] = HTTP_401_UNAUTHORIZED,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.cookie},\n name=name,\n description=description,\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n self.not_authenticated_status_code = not_authenticated_status_code\n\n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.cookies.get(self.model.name)\n return self.check_api_key(\n api_key, self.auto_error, self.not_authenticated_status_code\n )",
"old_string": " def __init__(\n self,\n *,\n name: Annotated[str, Doc(\"Cookie name.\")],\n scheme_name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme name.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Security scheme description.\n\n It will be included in the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n auto_error: Annotated[\n bool,\n Doc(\n \"\"\"\n By default, if the cookie is not provided, `APIKeyCookie` will\n automatically cancel the request and send the client an error.\n\n If `auto_error` is set to `False`, when the cookie is not available,\n instead of erroring out, the dependency result will be `None`.\n\n This is useful when you want to have optional authentication.\n\n It is also useful when you want to have authentication that can be\n provided in one of multiple optional ways (for example, in a cookie or\n in an HTTP Bearer token).\n \"\"\"\n ),\n ] = True,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.cookie},\n name=name,\n description=description,\n )\n self.scheme_name = scheme_name or self.__class__.__ | {"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/secfull{"status": "ok", "filepath": "fastapi/security/api_key.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/api_key.py\n+++ b/fastapi/security/api_key.py\n@@ -291,6 +291,10 @@\n \"\"\"\n ),\n ] = True,\n+ not_authenticated_status_code: Annotated[\n+ int,\n+ Doc(\"Status code to use when the API key is missing.\"),\n+ ] = HTTP_401_UNAUTHORIZED,\n ):\n self.model: APIKey = APIKey(\n **{\"in\": APIKeyIn.cookie},\n@@ -299,7 +303,10 @@\n )\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n+ self.not_authenticated_status_code = not_authenticated_status_code\n \n async def __call__(self, request: Request) -> Optional[str]:\n api_key = request.cookies.get(self.model.name)\n- return self.check_api_key(api_key, self.auto_error)\n+ return self.check_api_key(\n+ api_key, self.auto_error, self.not_authenticated_status_code\n+ )\n", "is_truncated": false} |
| 14 | edit_file | {
"filepath": "fastapi/security/http.py",
"new_string": "class HTTPBase(SecurityBase):\n def __init__(\n self,\n *,\n scheme: str,\n scheme_name: Optional[str] = None,\n description: Optional[str] = None,\n auto_error: bool = True,\n not_authenticated_status_code: int = HTTP_401_UNAUTHORIZED,\n ):\n self.model = HTTPBaseModel(scheme=scheme, description=description)\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n self.not_authenticated_status_code = not_authenticated_status_code\n\n async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=self.not_authenticated_status_code, detail=\"Not authenticated\"\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)",
"old_string": "class HTTPBase(SecurityBase):\n def __init__(\n self,\n *,\n scheme: str,\n scheme_name: Optional[str] = None,\n description: Optional[str] = None,\n auto_error: bool = True,\n ):\n self.model = HTTPBaseModel(scheme=scheme, description=description)\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n\n async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)"
} | {"status": "ok", "filepath": "fastapi/security/http.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/http.py\n+++ b/fastapi/security/full{"status": "ok", "filepath": "fastapi/security/http.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/http.py\n+++ b/fastapi/security/http.py\n@@ -75,10 +75,12 @@\n scheme_name: Optional[str] = None,\n description: Optional[str] = None,\n auto_error: bool = True,\n+ not_authenticated_status_code: int = HTTP_401_UNAUTHORIZED,\n ):\n self.model = HTTPBaseModel(scheme=scheme, description=description)\n self.scheme_name = scheme_name or self.__class__.__name__\n self.auto_error = auto_error\n+ self.not_authenticated_status_code = not_authenticated_status_code\n \n async def __call__(\n self, request: Request\n@@ -88,7 +90,7 @@\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n- status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n+ status_code=self.not_authenticated_status_code, detail=\"Not authenticated\"\n )\n else:\n return None\n", "is_truncated": false} |
| 15 | edit_file | {
"filepath": "fastapi/security/http.py",
"new_string": " async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=self.not_authenticated_status_code, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"bearer\":\n if self.auto_error:\n raise HTTPException(\n status_code=self.not_authenticated_status_code,\n detail=\"Invalid authentication credentials\",\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)",
"old_string": " async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"bearer\":\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN,\n detail=\"Invalid authentication credentials\",\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)"
} | {"status": "ok", "filepath": "fastapi/security/http.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/http.py\n+++ b/fastapi/security/full{"status": "ok", "filepath": "fastapi/security/http.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/http.py\n+++ b/fastapi/security/http.py\n@@ -309,14 +309,14 @@\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n- status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n+ status_code=self.not_authenticated_status_code, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"bearer\":\n if self.auto_error:\n raise HTTPException(\n- status_code=HTTP_403_FORBIDDEN,\n+ status_code=self.not_authenticated_status_code,\n detail=\"Invalid authentication credentials\",\n )\n else:\n", "is_truncated": false} |
| 16 | edit_file | {
"filepath": "fastapi/security/http.py",
"new_string": " async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=self.not_authenticated_status_code, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"digest\":\n if self.auto_error:\n raise HTTPException(\n status_code=self.not_authenticated_status_code,\n detail=\"Invalid authentication credentials\",\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)",
"old_string": " async def __call__(\n self, request: Request\n ) -> Optional[HTTPAuthorizationCredentials]:\n authorization = request.headers.get(\"Authorization\")\n scheme, credentials = get_authorization_scheme_param(authorization)\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"digest\":\n if self.auto_error:\n raise HTTPException(\n status_code=HTTP_403_FORBIDDEN,\n detail=\"Invalid authentication credentials\",\n )\n else:\n return None\n return HTTPAuthorizationCredentials(scheme=scheme, credentials=credentials)"
} | {"status": "ok", "filepath": "fastapi/security/http.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/http.py\n+++ b/fastapi/security/full{"status": "ok", "filepath": "fastapi/security/http.py", "occurrences": 1, "strategy": "exact", "diff": "--- a/fastapi/security/http.py\n+++ b/fastapi/security/http.py\n@@ -411,14 +411,14 @@\n if not (authorization and scheme and credentials):\n if self.auto_error:\n raise HTTPException(\n- status_code=HTTP_403_FORBIDDEN, detail=\"Not authenticated\"\n+ status_code=self.not_authenticated_status_code, detail=\"Not authenticated\"\n )\n else:\n return None\n if scheme.lower() != \"digest\":\n if self.auto_error:\n raise HTTPException(\n- status_code=HTTP_403_FORBIDDEN,\n+ status_code=self.not_authenticated_status_code,\n detail=\"Invalid authentication credentials\",\n )\n else:\n", "is_truncated": false} |
diff --git a/fastapi/security/api_key.py b/fastapi/security/api_key.py
index 496c815a..5b6e6646 100644
--- a/fastapi/security/api_key.py
+++ b/fastapi/security/api_key.py
@@ -5,17 +5,19 @@ 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
+from starlette.status import HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN
from typing_extensions import Annotated
class APIKeyBase(SecurityBase):
@staticmethod
- def check_api_key(api_key: Optional[str], auto_error: bool) -> Optional[str]:
+ def check_api_key(
+ api_key: Optional[str], auto_error: bool, not_authenticated_status_code: int = HTTP_401_UNAUTHORIZED
+ ) -> Optional[str]:
if not api_key:
if auto_error:
raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
+ status_code=not_authenticated_status_code, detail="Not authenticated"
)
return None
return api_key
@@ -99,6 +101,10 @@ class APIKeyQuery(APIKeyBase):
"""
),
] = True,
+ not_authenticated_status_code: Annotated[
+ int,
+ Doc("Status code to use when the API key is missing."),
+ ] = HTTP_401_UNAUTHORIZED,
):
self.model: APIKey = APIKey(
**{"in": APIKeyIn.query},
@@ -107,10 +113,13 @@ class APIKeyQuery(APIKeyBase):
)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ self.not_authenticated_status_code = not_authenticated_status_code
async def __call__(self, request: Request) -> Optional[str]:
api_key = request.query_params.get(self.model.name)
- return self.check_api_key(api_key, self.auto_error)
+ return self.check_api_key(
+ api_key, self.auto_error, self.not_authenticated_status_code
+ )
class APIKeyHeader(APIKeyBase):
@@ -187,6 +196,10 @@ class APIKeyHeader(APIKeyBase):
"""
),
] = True,
+ not_authenticated_status_code: Annotated[
+ int,
+ Doc("Status code to use when the API key is missing."),
+ ] = HTTP_401_UNAUTHORIZED,
):
self.model: APIKey = APIKey(
**{"in": APIKeyIn.header},
@@ -195,10 +208,13 @@ class APIKeyHeader(APIKeyBase):
)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ self.not_authenticated_status_code = not_authenticated_status_code
async def __call__(self, request: Request) -> Optional[str]:
api_key = request.headers.get(self.model.name)
- return self.check_api_key(api_key, self.auto_error)
+ return self.check_api_key(
+ api_key, self.auto_error, self.not_authenticated_status_code
+ )
class APIKeyCookie(APIKeyBase):
@@ -275,6 +291,10 @@ class APIKeyCookie(APIKeyBase):
"""
),
] = True,
+ not_authenticated_status_code: Annotated[
+ int,
+ Doc("Status code to use when the API key is missing."),
+ ] = HTTP_401_UNAUTHORIZED,
):
self.model: APIKey = APIKey(
**{"in": APIKeyIn.cookie},
@@ -283,7 +303,10 @@ class APIKeyCookie(APIKeyBase):
)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ self.not_authenticated_status_code = not_authenticated_status_code
async def __call__(self, request: Request) -> Optional[str]:
api_key = request.cookies.get(self.model.name)
- return self.check_api_key(api_key, self.auto_error)
+ return self.check_api_key(
+ api_key, self.auto_error, self.not_authenticated_status_code
+ )
diff --git a/fastapi/security/http.py b/fastapi/security/http.py
index 3a598565..295e53a2 100644
--- a/fastapi/security/http.py
+++ b/fastapi/security/http.py
@@ -75,10 +75,12 @@ class HTTPBase(SecurityBase):
scheme_name: Optional[str] = None,
description: Optional[str] = None,
auto_error: bool = True,
+ not_authenticated_status_code: int = HTTP_401_UNAUTHORIZED,
):
self.model = HTTPBaseModel(scheme=scheme, description=description)
self.scheme_name = scheme_name or self.__class__.__name__
self.auto_error = auto_error
+ self.not_authenticated_status_code = not_authenticated_status_code
async def __call__(
self, request: Request
@@ -88,7 +90,7 @@ class HTTPBase(SecurityBase):
if not (authorization and scheme and credentials):
if self.auto_error:
raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
+ status_code=self.not_authenticated_status_code, detail="Not authenticated"
)
else:
return None
@@ -307,14 +309,14 @@ class HTTPBearer(HTTPBase):
if not (authorization and scheme and credentials):
if self.auto_error:
raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
+ status_code=self.not_authenticated_status_code, detail="Not authenticated"
)
else:
return None
if scheme.lower() != "bearer":
if self.auto_error:
raise HTTPException(
- status_code=HTTP_403_FORBIDDEN,
+ status_code=self.not_authenticated_status_code,
detail="Invalid authentication credentials",
)
else:
@@ -409,14 +411,14 @@ class HTTPDigest(HTTPBase):
if not (authorization and scheme and credentials):
if self.auto_error:
raise HTTPException(
- status_code=HTTP_403_FORBIDDEN, detail="Not authenticated"
+ status_code=self.not_authenticated_status_code, detail="Not authenticated"
)
else:
return None
if scheme.lower() != "digest":
if self.auto_error:
raise HTTPException(
- status_code=HTTP_403_FORBIDDEN,
+ status_code=self.not_authenticated_status_code,
detail="Invalid authentication credentials",
)
else:
.F
=================================== FAILURES ===================================
_________________________ test_security_api_key_no_key _________________________
def test_security_api_key_no_key():
client = TestClient(app)
response = client.get("/users/me")
assert response.status_code == 401, response.text
assert response.json() == {"detail": "Not authenticated"}
> assert response.headers["WWW-Authenticate"] == "APIKey"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tests/test_security_api_key_cookie.py:37:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
self = Headers({'content-length': '30', 'content-type': 'application/json'})
key = 'WWW-Authenticate'
def __getitem__(self, key: str) -> str:
"""
Return a single header value.
If there are multiple headers with the same key, then we concatenate
them with commas. See: https://tools.ietf.org/html/rfc7230#section-3.2.2
"""
normalized_key = key.lower().encode(self.encoding)
items = [
header_value.decode(self.encoding)
for _, header_key, header_value in self._list
if header_key == normalized_key
]
if items:
return ", ".join(items)
> raise KeyError(key)
E KeyError: 'WWW-Authenticate'
/kaggle/tmp/envs/fastapi/lib/python3.13/site-packages/httpx/_models.py:302: KeyError
=============================== warnings summary ===============================
../../../../../../kaggle/tmp/envs/overlays/starlette-0.50.0-py3-none-any/starlette/testclient.py:45
/kaggle/tmp/envs/overlays/starlette-0.50.0-py3-none-any/starlette/testclient.py:45: DeprecationWarning: The anyio.abc.BlockingPortal alias is deprecated, use anyio.from_thread.BlockingPortal instead.
_PortalFactoryType = Callable[[], AbstractContextManager[anyio.abc.BlockingPortal]]
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
1 failed, 1 passed, 1 warning in 1.14s