UaePass

The UAE PASS module provides seamless Single Sign-On (SSO) integration between Drupal and UAE PASS — the national digital identity solution for the United Arab Emirates. It enables passwordless, secure login using verified UAE PASS identities, making it ideal for government, public-sector, citizen-facing, and enterprise portals.

Features

• Passwordless UAE PASS Login: Authenticate users securely using UAE PASS without storing passwords in Drupal.
• User Auto-Provisioning & Sync: Automatically create Drupal user accounts on first login and synchronize profile attributes such as Emirates ID, name, mobile number, and email.
• Configurable Attribute Mapping: Map UAE PASS returned attributes to Drupal core user fields or custom fields.
• Secure Client Secret Storage via Key Module: Client Secret is never stored in Drupal configuration. It is managed by the Key module as per Drupal security best practices.
• Supports All UAE PASS Environments: Sandbox, Pre-Production, and Production environments supported for seamless development to launch transition.
• Multilingual Ready: Works smoothly with Arabic and English Drupal installations.
• Flexible Login Placement: Show the UAE PASS login button on the default login page or via a block, custom route, or menu.
• Developer-Friendly Debugging Mode: Includes configurable logs and debug options to aid with integration and troubleshooting.

Post-Installation

• Install and enable the UAE PASS module.
• Ensure the Key module is enabled and configured before proceeding.
• Create a new Key for storing the Client Secret (e.g., uaepass_client_secret) and configure its storage (recommended: file-based or external key provider).
• Navigate to Configuration → People → UAE PASS Settings to configure the module.
• Enter the required details:
  • Client ID
  • Select the stored Client Secret Key (retrieved via the Key module)
  • Environment selection: Sandbox / Pre-Prod / Production
  • Redirect URL as registered in the UAE PASS portal
• Configure attribute field mappings to match your Drupal user fields.
• Place the UAE PASS Login block or enable the button on the user login page.
• Test the Sandbox login flow and switch to Production once validated.

Note: The Client Secret will not be saved in settings or config. It is securely fetched from the Key module.

Additional Requirements

• Drupal 10 or Drupal 11
• Key module (Required) for secure Client Secret storage
• PHP 8.1+
• Valid UAE PASS developer credentials
• HTTPS strongly recommended for Production deployments

Recommended modules/libraries

• Key module (Required): Without this, the Client Secret cannot be stored securely.
• Token / JWT libraries for extended token-based use cases (optional).
• User Profile/Field enhancement modules if storing additional UAE PASS attribute data.

Similar projects

• Social Auth Modules (Google, Apple, Facebook): Provide login via social platforms, whereas UAE PASS offers government-verified identity authentication suitable for regulated and official services.
• SAML-based SSO: More generic authentication approach. UAE PASS provides UAE-specific, mobile-based, verified identity and digital signature capabilities.

Supporting this Module

• If you wish to support the development, maintenance, or request new features (e.g., UAE PASS QR Login, Digital Signature integration, or enhanced attribute mapping), please raise an issue or contact the maintainer.