OAuth Authz Code Browser Authentication with Escape¶

Description¶

The 'OAuth Authorization Code Browser' preset implements the OAuth 2.0 Authorization Code grant type (RFC 6749, Section 4.1):

• Authorization Endpoint: Users are automatically redirected to the OAuth provider's authorization server where they authenticate.
• Browser Automation: The system automatically fills in user credentials and handles the authorization flow without user interaction.
• Code Exchange: Authorization codes are automatically extracted from the redirect URI and exchanged for access tokens.
• PKCE Support: Implements Proof Key for Code Exchange (RFC 7636) for enhanced security by default.
• Token Management: Automatically handles access tokens and refresh tokens, injecting Bearer tokens into authenticated requests.

Performance Note: This authentication method requires browser automation to handle the interactive authorization flow, making it less efficient than API-only methods like OAuth Client Credentials or Resource Owner Password Credentials that use only programmatic HTTP requests. Use this method when the OAuth provider requires user interaction or when maximum security is needed.

Security: This flow is the most secure OAuth 2.0 grant type as it never exposes user credentials to the client application and includes PKCE protection against authorization code interception attacks.

Use Cases: Ideal for web applications, mobile apps, and any scenario where you need to authenticate users through third-party OAuth providers (Google, GitHub, Auth0, etc.) while maintaining the highest security standards.

Examples¶

presets:
-   type: oauth_authz_code_browser
    authorization_url: https://auth.example.com/oauth/authorize
    token_url: https://auth.example.com/oauth/token
    client_id: your_client_id
    client_secret: your_client_secret
    login_timeout: 30
    redirect_uri: https://your-app.com/callback
    use_pkce: true
    scopes:
    - read
    - write
    users:
    -   username: user1
        password: pass1
    -   username: user2
        password: pass2
    -   username: user3
        password: pass3
        scopes:
        - admin

Extensive Configuration¶

Objects¶

OAuthAuthorizationCodeBrowserUserPreset¶