https://github.com/smartmovesystems/firebase-keycloak-importer

Tool for importing exported Firebase users to Keycloak
https://github.com/smartmovesystems/firebase-keycloak-importer

Last synced: 2 days ago
JSON representation

Tool for importing exported Firebase users to Keycloak

• Host: GitHub
• URL: https://github.com/smartmovesystems/firebase-keycloak-importer
• Owner: SmartMoveSystems
• License: mit
• Created: 2020-09-15T06:23:11.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-18T00:54:02.000Z (over 3 years ago)
• Last Synced: 2023-07-15T16:38:57.694Z (over 1 year ago)
• Language: Kotlin
• Size: 102 KB
• Stars: 8
• Watchers: 5
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Firebase User export to Keycloak import

Utility for importing exported Firebase users to an appropriately configured Keycloak instance.

To be used on a Keycloak instance configured with with the [Keycloak Firebase Scrypt](https://github.com/SmartMoveSystems/keycloak-firebase-scrypt) extension.

## Build

```bash

./gradlew build

```

## Download latest release

```

curl -L https://github.com/SmartMoveSystems/firebase-keycloak-importer/releases/download/1.0.1/firebase-keycloak-importer-1.0.1.jar > firebase-keycloak-importer-1.0.1.jar

```

## Usage

Export your Firebase user database to a JSON file using the [Firebase CLI](https://firebase.google.com/docs/cli/auth)

Export your Firebase project's hash parameters to a JSON file with the format:

```

{

    "hash_config": {

      "algorithm": "SCRYPT",

      "base64_signer_key": "jxspr8Ki0RYycVU8zykbdLGjFQ3McFUH0uiiTvC8pVMXAn210wjLNmdZJzxUECKbm0QsEmYUSDzZvpjeJ9WmXA==",

      "base64_salt_separator": "Bw==",

      "rounds": 8,

      "mem_cost": 14,

    }

}

```

Run the following (the args `"--clientId", "--roles", "--clientSecret", "--default", "--debug"` are optional):

```bash

java -jar build\libs\firebase-keycloak-importer-1.0.1.jar --usersFile example_users.json --hashParamsFile example_hash_config.json --adminUser [email protected] --adminPassword admin --realm smartmove --serverUrl http://localhost:8080/auth --default true

```

The `default` argument specifies that the imported hash parameters will be the ones used for future users.

If you are only importing from one Firebase project, you must set this argument to `true`.

The client with the specified `clientId` and all specified `roles` must already exist in your Keycloak configuration.

## Importing from multiple projects

If there is a user with the same email address between multiple imported projects, the first imported user record wins.

The only difference is that the `phone_verified` claim is set to false if the imported phone numbers differ between projects.