Keycloak

MedusaJS Keycloak Authentication

🔐 Seamless Keycloak Identity and Access Management for MedusaJS

🌟 Features

• Native Keycloak authentication integration
• Multi-provider authentication support
• Secure OAuth 2.0 / OpenID Connect implementation
• Flexible configuration options
• Role-based access control
• Single Sign-On (SSO) capabilities

🏗️ Authentication Architecture

123456
graph TD
    A[User] -->|Login Request| B[MedusaJS]
    B -->|Redirect| C[Keycloak]
    C -->|Authentication| D[Identity Verification]
    D -->|Token| B
    B -->|Access Granted| A

📦 Installation

Install the package using npm:

1
npm install @vymalo/medusa-keycloak

Or using yarn:

1
yarn add @vymalo/medusa-keycloak

🚀 Configuration Example

1234567891011121314151617181920
modules: [
  {
    resolve: '@medusajs/medusa/auth',
    options: {
      providers: [
        // Keycloak Authentication Provider
        {
          resolve: `@vymalo/medusa-keycloak`,
          id: 'vymalo-keycloak',
          options: {
            // Keycloak Server Configuration
            url: process.env.KEYCLOAK_URL,
            realm: process.env.KEYCLOAK_REALM,
            clientId: process.env.KEYCLOAK_CLIENT_ID,
            clientSecret: process.env.KEYCLOAK_CLIENT_SECRET,
            
            // Optional Advanced Configuration
            scope: 'openid profile email', // default
            default_redirect_uri: process.env.KEYCLOAK_CALLBACK_URL,
          }

🔧 Environment Variables

Required Configuration:

• Copy to clipboardKEYCLOAK_URL: Keycloak server base URL
• Copy to clipboardKEYCLOAK_REALM: Keycloak realm name
• Copy to clipboardKEYCLOAK_CLIENT_ID: Application client ID
• Copy to clipboardKEYCLOAK_CLIENT_SECRET: Client secret

Optional Configuration:

• Copy to clipboardKEYCLOAK_SCOPE: Authentication scopes
• Copy to clipboardKEYCLOAK_CALLBACK_URL: Custom callback URL

🛡️ Security Considerations

• Use environment variables for sensitive credentials
• Implement proper scope restrictions
• Rotate client secrets periodically
• Configure appropriate token lifetimes

🌐 Advanced Integration Options

Authentication Flow Customization

• Support multiple authentication providers
• Fallback mechanisms
• Role-based access control
• Custom claim mapping

Token Management

• Access token validation
• Refresh token handling
• Session management
• Single sign-on (SSO) support

📊 Supported Authentication Flows

• Authorization Code Flow
• Implicit Flow
• Hybrid Flow
• Client Credentials Flow
• Direct Access Grants

🤝 Contributing

Contributions are welcome!

• Improve authentication logic
• Add new Keycloak configuration options
• Enhance security features
• Provide more robust error handling

🐛 Troubleshooting

• Verify Keycloak server connectivity
• Check client configuration
• Validate environment variables
• Review network and CORS settings

📄 License

Check the license

🔗 Related Resources

• Keycloak Documentation
• OAuth 2.0 Specification
• OpenID Connect
• MedusaJS