60e0ffc959
Upgrade checks / Notify on failure (push) Has been cancelled
Upgrade checks / Close issue on success (push) Has been cancelled
Schema Crash Test / Real-world schema crash test (232K schemas) (push) Has been cancelled
Run static analysis / static_analysis (push) Has been cancelled
Tests / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Tests / Tests with lowest-direct dependencies (push) Has been cancelled
Tests / MCP conformance tests (push) Has been cancelled
Tests / Integration tests (push) Has been cancelled
Tests / Package install smoke (push) Has been cancelled
Upgrade checks / Static analysis (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Upgrade checks / Integration tests (push) Has been cancelled
Update MCPServerConfig Schema / update-config-schema (push) Has been cancelled
Update SDK Documentation / update-sdk-docs (push) Has been cancelled
278 lines
11 KiB
Plaintext
278 lines
11 KiB
Plaintext
---
|
|
title: AWS Cognito OAuth 🤝 FastMCP
|
|
sidebarTitle: AWS Cognito
|
|
description: Secure your FastMCP server with AWS Cognito user pools
|
|
icon: aws
|
|
---
|
|
|
|
import { VersionBadge } from "/snippets/version-badge.mdx"
|
|
|
|
<VersionBadge version="2.12.4" />
|
|
|
|
This guide shows you how to secure your FastMCP server using **AWS Cognito user pools**. Since AWS Cognito doesn't support Dynamic Client Registration, this integration uses the [**OAuth Proxy**](/servers/auth/oauth-proxy) pattern to bridge AWS Cognito's traditional OAuth with MCP's authentication requirements. It also includes robust JWT token validation, ensuring enterprise-grade authentication.
|
|
|
|
## Configuration
|
|
|
|
### Prerequisites
|
|
|
|
Before you begin, you will need:
|
|
1. An **[AWS Account](https://aws.amazon.com/)** with access to create AWS Cognito user pools
|
|
2. Basic familiarity with AWS Cognito concepts (user pools, app clients)
|
|
3. Your FastMCP server's URL (can be localhost for development, e.g., `http://localhost:8000`)
|
|
|
|
### Step 1: Create an AWS Cognito User Pool and App Client
|
|
|
|
Set up AWS Cognito user pool with an app client to get the credentials needed for authentication:
|
|
|
|
<Steps>
|
|
<Step title="Navigate to AWS Cognito">
|
|
Go to the **[AWS Cognito Console](https://console.aws.amazon.com/cognito/)** and ensure you're in your desired AWS region.
|
|
|
|
Select **"User pools"** from the side navigation (click on the hamburger icon at the top left in case you don't see any), and click **"Create user pool"** to create a new user pool.
|
|
</Step>
|
|
|
|
<Step title="Define Your Application">
|
|
AWS Cognito now provides a streamlined setup experience:
|
|
|
|
1. **Application type**: Select **"Traditional web application"** (this is the correct choice for FastMCP server-side authentication)
|
|
2. **Name your application**: Enter a descriptive name (e.g., `FastMCP Server`)
|
|
|
|
The traditional web application type automatically configures:
|
|
- Server-side authentication with client secrets
|
|
- Authorization code grant flow
|
|
- Appropriate security settings for confidential clients
|
|
|
|
<Info>
|
|
Choose "Traditional web application" rather than SPA, Mobile app, or Machine-to-machine options. This ensures proper OAuth 2.0 configuration for FastMCP.
|
|
</Info>
|
|
</Step>
|
|
|
|
<Step title="Configure Options">
|
|
AWS will guide you through configuration options:
|
|
|
|
- **Sign-in identifiers**: Choose how users will sign in (email, username, or phone)
|
|
- **Required attributes**: Select any additional user information you need
|
|
- **Return URL**: Add your callback URL (e.g., `http://localhost:8000/auth/callback` for development)
|
|
|
|
<Tip>
|
|
The simplified interface handles most OAuth security settings automatically based on your application type selection.
|
|
</Tip>
|
|
</Step>
|
|
|
|
<Step title="Review and Create">
|
|
Review your configuration and click **"Create user pool"**.
|
|
|
|
After creation, you'll see your user pool details. Save these important values:
|
|
- **User pool ID** (format: `eu-central-1_XXXXXXXXX`)
|
|
- **Client ID** (found under → "Applications" → "App clients" in the side navigation → \<Your application name, e.g., `FastMCP Server`\> → "App client information")
|
|
- **Client Secret** (found under → "Applications" → "App clients" in the side navigation → \<Your application name, e.g., `FastMCP Server`\> → "App client information")
|
|
|
|
<Tip>
|
|
The user pool ID and app client credentials are all you need for FastMCP configuration.
|
|
</Tip>
|
|
</Step>
|
|
|
|
<Step title="Configure OAuth Settings">
|
|
Under "Login pages" in your app client's settings, you can double check and adjust the OAuth configuration:
|
|
|
|
- **Allowed callback URLs**: Add your server URL + `/auth/callback` (e.g., `http://localhost:8000/auth/callback`)
|
|
- **Allowed sign-out URLs**: Optional, for logout functionality
|
|
- **OAuth 2.0 grant types**: Ensure "Authorization code grant" is selected
|
|
- **OpenID Connect scopes**: Select scopes your application needs (e.g., `openid`, `email`, `profile`)
|
|
|
|
<Tip>
|
|
For local development, you can use `http://localhost` URLs. For production, you must use HTTPS.
|
|
</Tip>
|
|
</Step>
|
|
|
|
<Step title="Configure Resource Server">
|
|
AWS Cognito requires a resource server entry to support OAuth with protected resources. Without this, token exchange will fail with an `invalid_grant` error.
|
|
|
|
Navigate to **"Branding" → "Domain"** in the side navigation, then:
|
|
|
|
1. Click **"Create resource server"**
|
|
2. **Resource server name**: Enter a descriptive name (e.g., `My MCP Server`)
|
|
3. **Resource server identifier**: Enter your MCP endpoint URL exactly as it will be accessed (e.g., `http://localhost:8000/mcp` for development, or `https://your-server.com/mcp` for production)
|
|
4. Click **"Create resource server"**
|
|
|
|
<Warning>
|
|
The resource server identifier must exactly match your `base_url + mcp_path`. For the default configuration with `base_url="http://localhost:8000"` and `path="/mcp"`, use `http://localhost:8000/mcp`.
|
|
</Warning>
|
|
</Step>
|
|
|
|
<Step title="Save Your Credentials">
|
|
After setup, you'll have:
|
|
|
|
- **User Pool ID**: Format like `eu-central-1_XXXXXXXXX`
|
|
- **Client ID**: Your application's client identifier
|
|
- **Client Secret**: Generated client secret (keep secure)
|
|
- **AWS Region**: Where Your AWS Cognito user pool is located
|
|
|
|
<Tip>
|
|
Store these credentials securely. Never commit them to version control. Use environment variables or AWS Secrets Manager in production.
|
|
</Tip>
|
|
</Step>
|
|
</Steps>
|
|
|
|
### Step 2: FastMCP Configuration
|
|
|
|
Create your FastMCP server using the `AWSCognitoProvider`, which handles AWS Cognito's JWT tokens and user claims automatically:
|
|
|
|
```python server.py
|
|
from fastmcp import FastMCP
|
|
from fastmcp.server.auth.providers.aws import AWSCognitoProvider
|
|
from fastmcp.server.dependencies import get_access_token
|
|
|
|
# The AWSCognitoProvider handles JWT validation and user claims
|
|
auth_provider = AWSCognitoProvider(
|
|
user_pool_id="eu-central-1_XXXXXXXXX", # Your AWS Cognito user pool ID
|
|
aws_region="eu-central-1", # AWS region (defaults to eu-central-1)
|
|
client_id="your-app-client-id", # Your app client ID
|
|
client_secret="your-app-client-secret", # Your app client Secret
|
|
base_url="http://localhost:8000", # Must match your callback URL
|
|
# redirect_path="/auth/callback" # Default value, customize if needed
|
|
)
|
|
|
|
mcp = FastMCP(name="AWS Cognito Secured App", auth=auth_provider)
|
|
|
|
# Add a protected tool to test authentication
|
|
@mcp.tool
|
|
async def get_access_token_claims() -> dict:
|
|
"""Get the authenticated user's access token claims."""
|
|
token = get_access_token()
|
|
return {
|
|
"sub": token.claims.get("sub"),
|
|
"username": token.claims.get("username"),
|
|
"cognito:groups": token.claims.get("cognito:groups", []),
|
|
}
|
|
```
|
|
|
|
## Testing
|
|
|
|
### Running the Server
|
|
|
|
Start your FastMCP server with HTTP transport to enable OAuth flows:
|
|
|
|
```bash
|
|
fastmcp run server.py --transport http --port 8000
|
|
```
|
|
|
|
Your server is now running and protected by AWS Cognito OAuth authentication.
|
|
|
|
### Testing with a Client
|
|
|
|
Create a test client that authenticates with Your AWS Cognito-protected server:
|
|
|
|
```python test_client.py
|
|
from fastmcp import Client
|
|
import asyncio
|
|
|
|
async def main():
|
|
# The client will automatically handle AWS Cognito OAuth
|
|
async with Client("http://localhost:8000/mcp", auth="oauth") as client:
|
|
# First-time connection will open AWS Cognito login in your browser
|
|
print("✓ Authenticated with AWS Cognito!")
|
|
|
|
# Test the protected tool
|
|
print("Calling protected tool: get_access_token_claims")
|
|
result = await client.call_tool("get_access_token_claims")
|
|
user_data = result.data
|
|
print("Available access token claims:")
|
|
print(f"- sub: {user_data.get('sub', 'N/A')}")
|
|
print(f"- username: {user_data.get('username', 'N/A')}")
|
|
print(f"- cognito:groups: {user_data.get('cognito:groups', [])}")
|
|
|
|
if __name__ == "__main__":
|
|
asyncio.run(main())
|
|
```
|
|
|
|
When you run the client for the first time:
|
|
1. Your browser will open to AWS Cognito's hosted UI login page
|
|
2. After you sign in (or sign up), you'll be redirected back to your MCP server
|
|
3. The client receives the JWT token and can make authenticated requests
|
|
|
|
<Info>
|
|
The client caches tokens locally, so you won't need to re-authenticate for subsequent runs unless the token expires or you explicitly clear the cache.
|
|
</Info>
|
|
|
|
## Production Configuration
|
|
|
|
<VersionBadge version="2.13.0" />
|
|
|
|
For production deployments with persistent token management across server restarts, configure `jwt_signing_key`, and `client_storage`:
|
|
|
|
```python server.py
|
|
import os
|
|
from fastmcp import FastMCP
|
|
from fastmcp.server.auth.providers.aws import AWSCognitoProvider
|
|
from key_value.aio.stores.redis import RedisStore
|
|
from key_value.aio.wrappers.encryption import FernetEncryptionWrapper
|
|
from cryptography.fernet import Fernet
|
|
|
|
# Production setup with encrypted persistent token storage
|
|
auth_provider = AWSCognitoProvider(
|
|
user_pool_id="eu-central-1_XXXXXXXXX",
|
|
aws_region="eu-central-1",
|
|
client_id="your-app-client-id",
|
|
client_secret="your-app-client-secret",
|
|
base_url="https://your-production-domain.com",
|
|
|
|
# Production token management
|
|
jwt_signing_key=os.environ["JWT_SIGNING_KEY"],
|
|
client_storage=FernetEncryptionWrapper(
|
|
key_value=RedisStore(
|
|
host=os.environ["REDIS_HOST"],
|
|
port=int(os.environ["REDIS_PORT"])
|
|
),
|
|
fernet=Fernet(os.environ["STORAGE_ENCRYPTION_KEY"])
|
|
)
|
|
)
|
|
|
|
mcp = FastMCP(name="Production AWS Cognito App", auth=auth_provider)
|
|
```
|
|
|
|
<Note>
|
|
Parameters (`jwt_signing_key` and `client_storage`) work together to ensure tokens and client registrations survive server restarts. **Wrap your storage in `FernetEncryptionWrapper` to encrypt sensitive OAuth tokens at rest** - without it, tokens are stored in plaintext. Store secrets in environment variables and use a persistent storage backend like Redis for distributed deployments.
|
|
|
|
For complete details on these parameters, see the [OAuth Proxy documentation](/servers/auth/oauth-proxy#configuration-parameters).
|
|
</Note>
|
|
|
|
## Features
|
|
|
|
### JWT Token Validation
|
|
|
|
The AWS Cognito provider includes robust JWT token validation:
|
|
|
|
- **Signature Verification**: Validates tokens against AWS Cognito's public keys (JWKS)
|
|
- **Expiration Checking**: Automatically rejects expired tokens
|
|
- **Issuer Validation**: Ensures tokens come from your specific AWS Cognito user pool
|
|
- **Scope Enforcement**: Verifies required OAuth scopes are present
|
|
|
|
### User Claims and Groups
|
|
|
|
Access rich user information from AWS Cognito JWT tokens:
|
|
|
|
```python
|
|
from fastmcp.server.dependencies import get_access_token
|
|
|
|
@mcp.tool
|
|
async def admin_only_tool() -> str:
|
|
"""A tool only available to admin users."""
|
|
token = get_access_token()
|
|
user_groups = token.claims.get("cognito:groups", [])
|
|
|
|
if "admin" not in user_groups:
|
|
raise ValueError("This tool requires admin access")
|
|
|
|
return "Admin access granted!"
|
|
```
|
|
|
|
### Enterprise Integration
|
|
|
|
Perfect for enterprise environments with:
|
|
|
|
- **Single Sign-On (SSO)**: Integrate with corporate identity providers
|
|
- **Multi-Factor Authentication (MFA)**: Leverage AWS Cognito's built-in MFA
|
|
- **User Groups**: Role-based access control through AWS Cognito groups
|
|
- **Custom Attributes**: Access custom user attributes defined in your AWS Cognito user pool
|
|
- **Compliance**: Meet enterprise security and compliance requirements |