Google 致力于为黑人社区推动种族平等。查看具体举措

Создать собственные токены

Firebase дает вам полный контроль над аутентификацией, позволяя аутентифицировать пользователей или устройства с помощью безопасных веб-токенов JSON (JWT). Вы генерировать эти маркеры на сервере, передать их обратно на клиентское устройство, а затем использовать их для проверки подлинности с помощью signInWithCustomToken() метод.

Для этого необходимо создать конечную точку сервера, которая принимает учетные данные для входа, такие как имя пользователя и пароль, и, если учетные данные действительны, возвращает пользовательский JWT. Обычай JWT вернулся с сервера может быть использован клиентским устройством для аутентификации Firebase ( IOS , Android , веб ). После аутентификации этот идентификатор будет использоваться при доступе к другим сервисам Firebase, таким как база данных Firebase Realtime и облачное хранилище. Кроме того, содержание JWT будет доступно в auth объекте в ваших правилах Database Realtime и request.auth объекте в вашем облачных правилах безопасности хранения .

Вы можете создать собственный токен с помощью Firebase Admin SDK или использовать стороннюю библиотеку JWT, если ваш сервер написан на языке, который Firebase изначально не поддерживает.

Прежде чем вы начнете

Пользовательские токены - это подписанные JWT, где закрытый ключ, используемый для подписи, принадлежит учетной записи службы Google. Существует несколько способов указать учетную запись службы Google, которую должен использовать Firebase Admin SDK для подписи пользовательских токенов:

  • Использование JSON файла учетной записи службы - Этот метод может быть использован в любой среде, но требует , чтобы упаковать JSON файл учетной записи службы вместе с кодом. Особое внимание следует уделить тому, чтобы файл JSON учетной записи службы не был открыт для внешних сторон.
  • Сдача администратор SDK открыть учетную запись службы - Этот метод может использоваться в средах , управляемых Google , такие как Google Cloud функции и App Engine. Возможно, вам придется настроить некоторые дополнительные разрешения через Google Cloud Console.
  • Использование учетной записи службы ID - При использовании в Google-управляемой среде , этот метод будет подписывать маркеры с помощью ключа указанной учетной записи услуг. Однако он использует удаленную веб-службу, и вам, возможно, придется настроить дополнительные разрешения для этой учетной записи службы через Google Cloud Console.

Использование JSON-файла служебного аккаунта

Файлы JSON сервисного аккаунта содержат всю информацию, соответствующую сервисным аккаунтам (включая закрытый ключ RSA). Их можно скачать из консоли Firebase. Следуйте Администратор SDK установить инструкции для получения дополнительной информации о том , как инициализировать Admin SDK с JSON файлом учетной записи службы.

Этот метод инициализации подходит для широкого спектра развертываний Admin SDK. Также он позволяет Admin SDK создавать и подписывать пользовательские токены локально, без каких-либо удаленных вызовов API. Главный недостаток этого подхода заключается в том, что он требует, чтобы вы упаковали JSON-файл служебной учетной записи вместе с кодом. Также обратите внимание, что закрытый ключ в файле JSON учетной записи службы является конфиденциальной информацией, и необходимо соблюдать особые меры, чтобы сохранить ее конфиденциальность. В частности, воздержитесь от добавления файлов JSON служебного аккаунта в общедоступный контроль версий.

Разрешение Admin SDK обнаруживать учетную запись службы

Если ваш код развернут в среде, управляемой Google, Admin SDK может попытаться автоматически обнаружить средство подписи пользовательских токенов:

  • Если код развернут в стандартной среде App Engine для Java, Python или Go, администратор SDK может использовать сервис App Удостоверение присутствующий в этой среде подписывать пользовательские маркеры. Служба App Identity подписывает данные с помощью учетной записи службы, предоставленной для вашего приложения с помощью Google App Engine.

  • Если ваш код развернут в какой - либо другой управляемой среде (например , функции Google Cloud, Google Compute Engine), то Firebase Администратор SDK может автоматически обнаружить учетной записи службы строку идентификатора с локального сервера метаданных . Обнаруженный идентификатор учетной записи службы затем используется вместе со службой IAM для удаленной подписи токенов.

Чтобы использовать эти методы подписи, инициализируйте SDK с учетными данными приложения Google по умолчанию и не указывайте строку идентификатора учетной записи службы:

Node.js

admin.initializeApp();

Ява

FirebaseApp.initializeApp();

Python

default_app = firebase_admin.initialize_app()

Идти

app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

C #

FirebaseApp.Create();

Чтобы проверить тот же код локально, скачать файл в формате JSON учетной записи службы и установить GOOGLE_APPLICATION_CREDENTIALS переменного окружение , чтобы указать на него.

Если Firebase Admin SDK должен обнаружить строку идентификатора учетной записи службы, он делает это, когда ваш код впервые создает пользовательский токен. Результат кэшируется и повторно используется для последующих операций подписания токена. Идентификатор автоматически обнаруживаемой учетной записи службы обычно является одной из учетных записей службы по умолчанию, предоставляемых Google Cloud:

Так же , как с явным указанием идентификаторов учетных записей служб, идентификаторы учетных записей автоматически discoverd услуг должны иметь iam.serviceAccounts.signBlob разрешения для пользовательских маркеров создания на работу. Вы , возможно , придется использовать IAM и админ раздел Google Cloud Console для предоставления услуг по умолчанию составляет необходимые разрешения. Более подробную информацию см. В разделе «Устранение неполадок» ниже.

Использование идентификатора сервисного аккаунта

Чтобы поддерживать согласованность между различными частями вашего приложения, вы можете указать идентификатор учетной записи службы, ключи которой будут использоваться для подписи токенов при работе в среде, управляемой Google. Это может сделать политики IAM более простыми и безопасными и избежать необходимости включать JSON-файл служебной учетной записи в код.

Учетная запись службы ID можно найти в Google Cloud Console , или в client_email поле файла учетной записи JSON скачано службы. Идентификаторы учетных записей Сервисные адреса электронной почты , которые имеют следующий формат: <client-id>@<project-id>.iam.gserviceaccount.com . Они однозначно идентифицируют сервисные аккаунты в проектах Firebase и Google Cloud.

Чтобы создать собственные токены с использованием отдельного идентификатора учетной записи службы, инициализируйте SDK, как показано ниже:

Node.js

admin.initializeApp({
  serviceAccountId: 'my-client-id@my-project-id.iam.gserviceaccount.com',
});

Ява

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setServiceAccountId("my-client-id@my-project-id.iam.gserviceaccount.com")
    .build();
FirebaseApp.initializeApp(options);

Python

options = {
    'serviceAccountId': 'my-client-id@my-project-id.iam.gserviceaccount.com',
}
firebase_admin.initialize_app(options=options)

Идти

conf := &firebase.Config{
	ServiceAccountID: "my-client-id@my-project-id.iam.gserviceaccount.com",
}
app, err := firebase.NewApp(context.Background(), conf)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

C #

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
    ServiceAccountId = "my-client-id@my-project-id.iam.gserviceaccount.com",
});

Идентификаторы сервисных аккаунтов не являются конфиденциальной информацией, поэтому их раскрытие несущественно. Однако для подписания пользовательских токенов с помощью указанной учетной записи службы Firebase Admin SDK должен вызывать удаленную службу. Кроме того, вы также должны убедиться , что служба учетной записи администратора SDK использует для того чтобы сделать этот вызов -Обычно {project-name}@appspot.gserviceaccount.com - имеет iam.serviceAccounts.signBlob разрешение . Более подробную информацию см. В разделе «Устранение неполадок» ниже.

Создавайте собственные токены с помощью Firebase Admin SDK

В Firebase Admin SDK есть встроенный метод для создания пользовательских токенов. Как минимум, вы должны предоставить uid пользователя , который может быть любой строкой , но должен однозначно идентифицировать пользователя или устройства , их подлинности. Срок действия этих токенов истекает через час.

Node.js

const uid = 'some-uid';

admin
  .auth()
  .createCustomToken(uid)
  .then((customToken) => {
    // Send token back to client
  })
  .catch((error) => {
    console.log('Error creating custom token:', error);
  });

Ява

String uid = "some-uid";

String customToken = FirebaseAuth.getInstance().createCustomToken(uid);
// Send token back to client

Python

uid = 'some-uid'

custom_token = auth.create_custom_token(uid)

Идти

client, err := app.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

token, err := client.CustomToken(ctx, "some-uid")
if err != nil {
	log.Fatalf("error minting custom token: %v\n", err)
}

log.Printf("Got custom token: %v\n", token)

C #

var uid = "some-uid";

string customToken = await FirebaseAuth.DefaultInstance.CreateCustomTokenAsync(uid);
// Send token back to client

Вы также можете при желании указать дополнительные утверждения, которые будут включены в настраиваемый токен. Например, ниже, premiumAccount поле было добавлено в пользовательский маркер, который будет доступен в auth / request.auth объектов в ваших правилах безопасности:

Node.js

const userId = 'some-uid';
const additionalClaims = {
  premiumAccount: true,
};

admin
  .auth()
  .createCustomToken(userId, additionalClaims)
  .then((customToken) => {
    // Send token back to client
  })
  .catch((error) => {
    console.log('Error creating custom token:', error);
  });

Ява

String uid = "some-uid";
Map<String, Object> additionalClaims = new HashMap<String, Object>();
additionalClaims.put("premiumAccount", true);

String customToken = FirebaseAuth.getInstance()
    .createCustomToken(uid, additionalClaims);
// Send token back to client

Python

uid = 'some-uid'
additional_claims = {
    'premiumAccount': True
}

custom_token = auth.create_custom_token(uid, additional_claims)

Идти

client, err := app.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

claims := map[string]interface{}{
	"premiumAccount": true,
}

token, err := client.CustomTokenWithClaims(ctx, "some-uid", claims)
if err != nil {
	log.Fatalf("error minting custom token: %v\n", err)
}

log.Printf("Got custom token: %v\n", token)

C #

var uid = "some-uid";
var additionalClaims = new Dictionary<string, object>()
{
    { "premiumAccount", true },
};

string customToken = await FirebaseAuth.DefaultInstance
    .CreateCustomTokenAsync(uid, additionalClaims);
// Send token back to client

Войдите в систему с помощью пользовательских токенов на клиентах

После создания пользовательского токена его следует отправить в клиентское приложение. Клиентское приложение проверяет подлинность с обычаем лексема по телефону signInWithCustomToken() :

iOS

Цель-C
[[FIRAuth auth] signInWithCustomToken:customToken
                           completion:^(FIRAuthDataResult * _Nullable authResult,
                                        NSError * _Nullable error) {
  // ...
}];
Быстрый
Auth.auth().signIn(withCustomToken: customToken ?? "") { user, error in
  // ...
}

Android

mAuth.signInWithCustomToken(mCustomToken)
        .addOnCompleteListener(this, new OnCompleteListener<AuthResult>() {
            @Override
            public void onComplete(@NonNull Task<AuthResult> task) {
                if (task.isSuccessful()) {
                    // Sign in success, update UI with the signed-in user's information
                    Log.d(TAG, "signInWithCustomToken:success");
                    FirebaseUser user = mAuth.getCurrentUser();
                    updateUI(user);
                } else {
                    // If sign in fails, display a message to the user.
                    Log.w(TAG, "signInWithCustomToken:failure", task.getException());
                    Toast.makeText(CustomAuthActivity.this, "Authentication failed.",
                            Toast.LENGTH_SHORT).show();
                    updateUI(null);
                }
            }
        });

Единство

auth.SignInWithCustomTokenAsync(custom_token).ContinueWith(task => {
  if (task.IsCanceled) {
    Debug.LogError("SignInWithCustomTokenAsync was canceled.");
    return;
  }
  if (task.IsFaulted) {
    Debug.LogError("SignInWithCustomTokenAsync encountered an error: " + task.Exception);
    return;
  }

  Firebase.Auth.FirebaseUser newUser = task.Result;
  Debug.LogFormat("User signed in successfully: {0} ({1})",
      newUser.DisplayName, newUser.UserId);
});

C ++

firebase::Future<firebase::auth::User*> result =
    auth->SignInWithCustomToken(custom_token);

Интернет

firebase.auth().signInWithCustomToken(token)
  .then((userCredential) => {
    // Signed in
    var user = userCredential.user;
    // ...
  })
  .catch((error) => {
    var errorCode = error.code;
    var errorMessage = error.message;
    // ...
  });

Если аутентификация прошла успешно, ваш пользователь теперь будет подписан в в клиентском приложении с учетной записи , указанной uid , включенной в пользовательский маркер. Если эта учетная запись ранее не существовала, будет создана запись для этого пользователя.

Точно так же , как и с другими знаком в методах (например, signInWithEmailAndPassword() и signInWithCredential() ) auth объект в ваших правилах базы данных Realtime и request.auth объект в ваших правилах безопасности Cloud Storage будут заполняться пользователем uid . В этом случае uid будет тот , который вы указали при создании пользовательских маркеров.

Правила базы данных

{
  "rules": {
    "adminContent": {
      ".read": "auth.uid === 'some-uid'"
    }
  }
}

Правила хранения

service firebase.storage {
  match /b/<your-firebase-storage-bucket>/o {
    match /adminContent/{filename} {
      allow read, write: if request.auth != null && request.auth.uid == "some-uid";
    }
  }
}

Если пользовательский маркер содержит дополнительные требования, они могут ссылаться прочь auth.token (Firebase в режиме реального времени базы данных) или request.auth.token (Cloud Storage) объекта в правилах:

Правила базы данных

{
  "rules": {
    "premiumContent": {
      ".read": "auth.token.premiumAccount === true"
    }
  }
}

Правила хранения

service firebase.storage {
  match /b/<your-firebase-storage-bucket>/o {
    match /premiumContent/{filename} {
      allow read, write: if request.auth.token.premiumAccount == true;
    }
  }
}

Создавайте собственные токены с помощью сторонней библиотеки JWT

Если ваш бэкэнд работает на языке, на котором нет официального Firebase Admin SDK, вы все равно можете вручную создавать собственные токены. Во- первых, найти библиотеку JWT третьих сторон для вашего языка. Затем используйте эту библиотеку JWT для создания JWT, который включает следующие утверждения:

Пользовательские заявки на токены
alg Алгоритм "RS256"
iss Эмитент Адрес электронной почты сервисного аккаунта вашего проекта
sub Предмет Адрес электронной почты сервисного аккаунта вашего проекта
aud Аудитория "https://identitytoolkit.googleapis.com/google.identity.identitytoolkit.v1.IdentityToolkit"
iat Выпущено вовремя Текущее время в секундах с эпохи UNIX.
exp Время окончания срока действия Время в секундах с эпохи UNIX, когда истекает срок действия токена. Это может быть максимум 3600 секунд позже , чем iat .
Примечание: это только контролирует время , когда пользовательский маркер сам по себе истекает. Но как только вы подписать пользователя в использовании signInWithCustomToken() , они будут по- прежнему подписан в в устройство , пока их сеанс не является недействительным или пользователь подписывает из.
uid Уникальный идентификатор вошедшего в систему пользователя должен быть строкой длиной от 1 до 36 символов.
claims ( по желанию) Дополнительные пользовательские требования включить в правила безопасности auth / request.auth переменных

Вот несколько примеров реализации того, как создавать собственные токены на разных языках, которые Firebase Admin SDK не поддерживает:

PHP

Использование php-jwt :

// Requires: composer require firebase/php-jwt
use Firebase\JWT\JWT;

// Get your service account's email address and private key from the JSON key file
$service_account_email = "abc-123@a-b-c-123.iam.gserviceaccount.com";
$private_key = "-----BEGIN PRIVATE KEY-----...";

function create_custom_token($uid, $is_premium_account) {
  global $service_account_email, $private_key;

  $now_seconds = time();
  $payload = array(
    "iss" => $service_account_email,
    "sub" => $service_account_email,
    "aud" => "https://identitytoolkit.googleapis.com/google.identity.identitytoolkit.v1.IdentityToolkit",
    "iat" => $now_seconds,
    "exp" => $now_seconds+(60*60),  // Maximum expiration time is one hour
    "uid" => $uid,
    "claims" => array(
      "premium_account" => $is_premium_account
    )
  );
  return JWT::encode($payload, $private_key, "RS256");
}

Рубин

Использование ruby-jwt :

require "jwt"

# Get your service account's email address and private key from the JSON key file
$service_account_email = "service-account@my-project-abc123.iam.gserviceaccount.com"
$private_key = OpenSSL::PKey::RSA.new "-----BEGIN PRIVATE KEY-----\n..."

def create_custom_token(uid, is_premium_account)
  now_seconds = Time.now.to_i
  payload = {:iss => $service_account_email,
             :sub => $service_account_email,
             :aud => "https://identitytoolkit.googleapis.com/google.identity.identitytoolkit.v1.IdentityToolkit",
             :iat => now_seconds,
             :exp => now_seconds+(60*60), # Maximum expiration time is one hour
             :uid => uid,
             :claims => {:premium_account => is_premium_account}}
  JWT.encode payload, $private_key, "RS256"
end

После создания пользовательского токена отправьте его в клиентское приложение, чтобы использовать его для аутентификации с помощью Firebase. См. Примеры кода выше, чтобы узнать, как это сделать.

Поиск проблемы

В этом разделе описаны некоторые типичные проблемы, с которыми могут столкнуться разработчики при создании пользовательских токенов, и способы их решения.

IAM API не включен

Если вы указываете идентификатор учетной записи службы для подписи токенов, вы можете получить ошибку, подобную следующей:

Identity and Access Management (IAM) API has not been used in project
1234567890 before or it is disabled. Enable it by visiting
https://console.developers.google.com/apis/api/iam.googleapis.com/overview?project=1234567890
then retry. If you enabled this API recently, wait a few minutes for the action
to propagate to our systems and retry.

Firebase Администратор SDK использует IAM API подписать лексемы. Эта ошибка указывает на то, что IAM API в настоящее время не включен для вашего проекта Firebase. Откройте ссылку в сообщении об ошибке в веб-браузере и нажмите кнопку «Включить API», чтобы включить его для вашего проекта.

У служебного аккаунта нет необходимых разрешений

Если служба учетной записи администратора Firebase SDK работает как не имеет iam.serviceAccounts.signBlob разрешение, вы можете получить сообщение об ошибке , подобное следующему:

Permission iam.serviceAccounts.signBlob is required to perform this operation
on service account projects/-/serviceAccounts/{your-service-account-id}.

Самый простой способ решить эту проблему заключается в предоставлении IAM роль «Service Account Токен Creator» для учетной записи службы в вопросе, как правило , {project-name}@appspot.gserviceaccount.com :

  1. Откройте IAM и администратора страницы в Google Cloud Console.
  2. Выберите свой проект и нажмите «Продолжить».
  3. Щелкните значок редактирования, соответствующий учетной записи службы, которую вы хотите обновить.
  4. Щелкните «Добавить другую роль».
  5. Введите «Создатель токена учетной записи службы» в фильтр поиска и выберите его из результатов.
  6. Нажмите «Сохранить», чтобы подтвердить предоставление роли.

Обратитесь к IAM документации для получения более подробной информации об этом процессе, или узнать , как сделать роли обновления с использованием gcloud инструментов командной строки.

Не удалось определить сервисный аккаунт

Если вы получаете сообщение об ошибке, подобное приведенному ниже, значит, Firebase Admin SDK не был должным образом инициализирован.

Failed to determine service account ID. Initialize the SDK with service account
credentials or specify a service account ID with iam.serviceAccounts.signBlob
permission.

Если вы полагаетесь на SDK для автоматического определения идентификатора учетной записи службы, убедитесь, что код развернут в управляемой среде Google с сервером метаданных. В противном случае не забудьте указать файл JSON учетной записи службы или идентификатор учетной записи службы при инициализации SDK.