ceos/fastmcp
1
0
Fork 0
mirror of https://github.com/PrefectHQ/fastmcp.git synced 2026-08-22 05:24:18 +02:00
Code Issues Projects Releases Packages Wiki Activity

📝 Add docstrings to enhancement/support-jwt-multiple-issuers (#2282)

Browse source 
* 📝 Add docstrings to `enhancement/support-jwt-multiple-issuers`

Docstrings generation was requested by @jlowin.

* https://github.com/jlowin/fastmcp/pull/2233#issuecomment-3453446122

The following files were modified:

* `src/fastmcp/server/auth/providers/jwt.py`

* Fix formatting issues in JWT provider docstrings

Co-authored-by: Jeremiah Lowin <jlowin@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Jeremiah Lowin <153965+jlowin@users.noreply.github.com>
Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: Jeremiah Lowin <jlowin@users.noreply.github.com>
This commit is contained in:
coderabbitai[bot] 2025-10-27 19:26:25 -04:00 • committed by GitHub
commit 4ea896c246
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

32
src/fastmcp/server/auth/providers/jwt.py
View file

@ -193,19 +193,19 @@ class JWTVerifier(TokenVerifier):
base_url: AnyHttpUrl | str | NotSetT | None = NotSet,
):
"""
Initialize the JWT token verifier.
Initialize a JWTVerifier configured to validate JWTs using either a static key or a JWKS endpoint.
Args:
public_key: For asymmetric algorithms (RS256, ES256, etc.): PEM-encoded public key.
For symmetric algorithms (HS256, HS384, HS512): The shared secret string.
jwks_uri: URI to fetch JSON Web Key Set (only for asymmetric algorithms)
issuer: Expected issuer claim
audience: Expected audience claim(s)
algorithm: JWT signing algorithm. Supported algorithms:
- Asymmetric: RS256/384/512, ES256/384/512, PS256/384/512 (default: RS256)
- Symmetric: HS256, HS384, HS512
required_scopes: Required scopes for all tokens
base_url: Base URL for TokenVerifier protocol
Parameters:
public_key (str | NotSetT | None): PEM-encoded public key for asymmetric algorithms or shared secret for symmetric algorithms.
jwks_uri (str | NotSetT | None): URI to fetch a JSON Web Key Set; used when verifying tokens with remote JWKS.
issuer (str | list[str] | NotSetT | None): Expected issuer claim value or list of allowed issuer values.
audience (str | list[str] | NotSetT | None): Expected audience claim value or list of allowed audience values.
algorithm (str | NotSetT | None): JWT signing algorithm to accept (default: "RS256"). Supported: HS256/384/512, RS256/384/512, ES256/384/512, PS256/384/512.
required_scopes (list[str] | NotSetT | None): Scopes that must be present in validated tokens.
base_url (AnyHttpUrl | str | NotSetT | None): Base URL passed to the parent TokenVerifier.
Raises:
ValueError: If neither or both of `public_key` and `jwks_uri` are provided, or if `algorithm` is unsupported.
"""
settings = JWTVerifierSettings.model_validate(
{
@ -366,13 +366,13 @@ class JWTVerifier(TokenVerifier):
async def load_access_token(self, token: str) -> AccessToken | None:
"""
Validates the provided JWT bearer token.
Validate a JWT bearer token and return an AccessToken when the token is valid.
Args:
token: The JWT token string to validate
Parameters:
token (str): The JWT bearer token string to validate.
Returns:
AccessToken object if valid, None if invalid or expired
AccessToken | None: An AccessToken populated from token claims if the token is valid; `None` if the token is expired, has an invalid signature or format, fails issuer/audience/scope validation, or any other validation error occurs.
"""
try:
# Get verification key (static or from JWKS)