カスタム クレームとセキュリティ ルールによるアクセスの制御

Firebase Admin SDK では、ユーザー アカウントのカスタム属性の定義がサポートされています。これにより、Firebase アプリにさまざまなアクセス制御戦略（役割ベースのアクセス制御など）を実装できます。カスタム属性を使用することで、ユーザーにさまざまなアクセスレベル（役割）を付与できます。このようなアクセスレベルは、アプリケーションのセキュリティ ルールに適用されます。

ユーザー役割は、以下の一般的な状況で定義できます。

  • データとリソースにアクセスするための管理者権限をユーザーに付与する。
  • ユーザーが属するさまざまなグループを定義する。
  • マルチレベル アクセス権限を指定する。
    • 有料 / 無料のサブスクライバーの区別。
    • 通常のユーザーとモデレータの区別。
    • 教師 / 学生のアプリケーションなど。
  • ユーザーに ID を追加する。たとえば Firebase ユーザーは、別のシステムの異なる UID にマップできます。

データベース ノード "adminContent" へのアクセスを制限する状況について考えてみましょう。これは、管理者ユーザーのリストに対するデータベース検索により行えます。ただし、次の Realtime Database ルールで admin というカスタム ユーザー クレームを使用すると、同じ目的をより効率的に達成できます。

{
  "rules": {
    "adminContent": {
      ".read": "auth.token.admin === true",
      ".write": "auth.token.admin === true",
    }
  }
}

カスタム ユーザー クレームは、ユーザーの認証トークンを使用してアクセスできます。 上記の例では、トークン クレームで admin が true に設定されているユーザーにのみ、adminContent ノードへの読み取り / 書き込みアクセス権限があります。ID トークンにはすでにこのようなアサーションが含まれているため、管理者権限を確認するための追加の処理や検索は不要です。また、ID トークンはカスタム クレームを配信するための信頼できる配信メカニズムです。すべての認証済みアクセスでは、関連付けられているリクエストを処理する前に、ID トークンを検証する必要があります。

このページで説明するコード例と解決策は、Admin SDK によって提供されるクライアント側の Firebase Auth API とサーバー側の Auth API の両方から得られるものです。

Admin SDK でのカスタム ユーザー クレームの設定と検証

カスタム クレームには機密データが含まれている可能性があるため、Firebase Admin SDK によって特権サーバー環境からのみ設定される必要があります。

Node.js

// Set admin privilege on the user corresponding to uid.

getAuth()
  .setCustomUserClaims(uid, { admin: true })
  .then(() => {
    // The new custom claims will propagate to the user's ID token the
    // next time a new one is issued.
  });

Java

// Set admin privilege on the user corresponding to uid.
Map<String, Object> claims = new HashMap<>();
claims.put("admin", true);
FirebaseAuth.getInstance().setCustomUserClaims(uid, claims);
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

Python

# Set admin privilege on the user corresponding to uid.
auth.set_custom_user_claims(uid, {'admin': True})
# The new custom claims will propagate to the user's ID token the
# next time a new one is issued.

Go

// Get an auth client from the firebase.App
client, err := app.Auth(ctx)
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

// Set admin privilege on the user corresponding to uid.
claims := map[string]interface{}{"admin": true}
err = client.SetCustomUserClaims(ctx, uid, claims)
if err != nil {
	log.Fatalf("error setting custom claims %v\n", err)
}
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.
auth.go

C#

// Set admin privileges on the user corresponding to uid.
var claims = new Dictionary<string, object>()
{
    { "admin", true },
};
await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(uid, claims);
// The new custom claims will propagate to the user's ID token the
// next time a new one is issued.

カスタム クレーム オブジェクトには OIDC 予約キー名や Firebase 予約名を含めないでください。カスタム クレームのペイロードは 1,000 バイト以下でなければなりません。

次のように Admin SDK を使用して、バックエンド サーバーに送信される ID トークンにより、ユーザーの ID とアクセスレベルを確認できます。

Node.js

// Verify the ID token first.
getAuth()
  .verifyIdToken(idToken)
  .then((claims) => {
    if (claims.admin === true) {
      // Allow access to requested admin resource.
    }
  });

Java

// Verify the ID token first.
FirebaseToken decoded = FirebaseAuth.getInstance().verifyIdToken(idToken);
if (Boolean.TRUE.equals(decoded.getClaims().get("admin"))) {
  // Allow access to requested admin resource.
}

Python

# Verify the ID token first.
claims = auth.verify_id_token(id_token)
if claims['admin'] is True:
    # Allow access to requested admin resource.
    pass

Go

// Verify the ID token first.
token, err := client.VerifyIDToken(ctx, idToken)
if err != nil {
	log.Fatal(err)
}

claims := token.Claims
if admin, ok := claims["admin"]; ok {
	if admin.(bool) {
		//Allow access to requested admin resource.
	}
}
auth.go

C#

// Verify the ID token first.
FirebaseToken decoded = await FirebaseAuth.DefaultInstance.VerifyIdTokenAsync(idToken);
object isAdmin;
if (decoded.Claims.TryGetValue("admin", out isAdmin))
{
    if ((bool)isAdmin)
    {
        // Allow access to requested admin resource.
    }
}

ユーザーの既存のカスタム クレームも確認できます。これはユーザー オブジェクトのプロパティとして取得できます。

Node.js

// Lookup the user associated with the specified uid.
getAuth()
  .getUser(uid)
  .then((userRecord) => {
    // The claims can be accessed on the user record.
    console.log(userRecord.customClaims['admin']);
  });

Java

// Lookup the user associated with the specified uid.
UserRecord user = FirebaseAuth.getInstance().getUser(uid);
System.out.println(user.getCustomClaims().get("admin"));

Python

# Lookup the user associated with the specified uid.
user = auth.get_user(uid)
# The claims can be accessed on the user record.
print(user.custom_claims.get('admin'))

Go

// Lookup the user associated with the specified uid.
user, err := client.GetUser(ctx, uid)
if err != nil {
	log.Fatal(err)
}
// The claims can be accessed on the user record.
if admin, ok := user.CustomClaims["admin"]; ok {
	if admin.(bool) {
		log.Println(admin)
	}
}
auth.go

C#

// Lookup the user associated with the specified uid.
UserRecord user = await FirebaseAuth.DefaultInstance.GetUserAsync(uid);
Console.WriteLine(user.CustomClaims["admin"]);

ユーザーのカスタム クレームを削除するには、customClaims に null を渡します。

クライアントへカスタム クレームを伝播する

Admin SDK でユーザーの新しいクレームが変更されると、次のように ID トークンによってクライアント側の認証済みユーザーに伝播されます。

  • カスタム クレームの変更後に、ユーザーがログインまたは再認証する。その結果として発行された ID トークンには最新のクレームが含まれる。
  • 古いトークンが期限切れになると、既存のユーザー セッションでその ID トークンが更新される。
  • currentUser.getIdToken(true) を呼び出して ID トークンが強制的に更新される。

クライアントのカスタム クレームにアクセスする

カスタム クレームは、ユーザーの ID トークンでのみ取得できます。ユーザーの役割やアクセスレベルに基づいてクライアント UI を変更するには、カスタム クレームへのアクセスが必要となります。一方、バックエンド アクセスは常に ID トークンの検証とそのクレームの解析の完了後に、ID トークンによって適用される必要があります。カスタム クレームはトークンの外部では信頼できないため、バックエンドに直接送信しないでください。

最新のクレームがユーザーの ID トークンに伝播されたら、ID トークンを取得することによりクレームを取得できます。

JavaScript

firebase.auth().currentUser.getIdTokenResult()
  .then((idTokenResult) => {
     // Confirm the user is an Admin.
     if (!!idTokenResult.claims.admin) {
       // Show admin UI.
       showAdminUI();
     } else {
       // Show regular user UI.
       showRegularUI();
     }
  })
  .catch((error) => {
    console.log(error);
  });

Android

user.getIdToken(false).addOnSuccessListener(new OnSuccessListener<GetTokenResult>() {
  @Override
  public void onSuccess(GetTokenResult result) {
    boolean isAdmin = result.getClaims().get("admin");
    if (isAdmin) {
      // Show admin UI.
      showAdminUI();
    } else {
      // Show regular user UI.
      showRegularUI();
    }
  }
});

Swift

user.getIDTokenResult(completion: { (result, error) in
  guard let admin = result?.claims?["admin"] as? NSNumber else {
    // Show regular user UI.
    showRegularUI()
    return
  }
  if admin.boolValue {
    // Show admin UI.
    showAdminUI()
  } else {
    // Show regular user UI.
    showRegularUI()
  }
})

Objective-C

user.getIDTokenResultWithCompletion:^(FIRAuthTokenResult *result,
                                      NSError *error) {
  if (error != nil) {
    BOOL *admin = [result.claims[@"admin"] boolValue];
    if (admin) {
      // Show admin UI.
      [self showAdminUI];
    } else {
      // Show regular user UI.
      [self showRegularUI];
    }
  }
}];

カスタム クレームのベスト プラクティス

カスタム クレームは、アクセス制御を提供するためだけに使用されます。追加のデータ（プロファイルやその他のカスタムデータなど）を格納するようには設計されていません。追加のデータを格納するための便利なメカニズムに見えますが、このような目的で使用することは推奨されません。これは、カスタム クレームが ID トークンに含まれており、またすべての認証済みリクエストにはログイン ユーザーに対応する Firebase ID トークンが常に含まれていることが原因で、パフォーマンスの問題を引き起こす可能性があるからです。

  • カスタム クレームは、ユーザー アクセス制御のためのデータを格納する目的でのみ使用します。その他のデータはすべて、Realtime Database またはその他のサーバー側ストレージに個別に格納する必要があります。
  • カスタム クレームのサイズは制限されています。1,000 バイトを超えるカスタム クレームのペイロードを渡すと、エラーがスローされます。

例とユースケース

特定の Firebase ユースケースにおけるカスタム クレームを以下の例に示します。

ユーザー作成時の Firebase Functions を使用したロールの定義

この例では、Cloud Functions を使用してユーザー作成時にカスタム クレームをそのユーザーに設定します。

カスタム クレームは Cloud Functions を使用して追加できます。また、Realtime Database を使用してカスタム クレームを即時に伝播できます。この関数は、onCreate トリガーを使用してログインする場合にのみ呼び出されます。設定されたカスタム クレームは、すべての既存のセッションおよび今後のセッションに伝播されます。次回ユーザーがユーザー認証情報を使用してログインすると、トークンにはカスタム クレームが含まれています。

クライアント側の実装（JavaScript）

const provider = new firebase.auth.GoogleAuthProvider();
firebase.auth().signInWithPopup(provider)
.catch(error => {
  console.log(error);
});

let callback = null;
let metadataRef = null;
firebase.auth().onAuthStateChanged(user => {
  // Remove previous listener.
  if (callback) {
    metadataRef.off('value', callback);
  }
  // On user login add new listener.
  if (user) {
    // Check if refresh is required.
    metadataRef = firebase.database().ref('metadata/' + user.uid + '/refreshTime');
    callback = (snapshot) => {
      // Force refresh to pick up the latest custom claims changes.
      // Note this is always triggered on first call. Further optimization could be
      // added to avoid the initial trigger when the token is issued and already contains
      // the latest claims.
      user.getIdToken(true);
    };
    // Subscribe new listener to changes on that node.
    metadataRef.on('value', callback);
  }
});

Cloud Functions Logic

読み取り / 書き込みが認証済みユーザーに制限された新しいデータベース ノード（metadata/($uid)）が追加されます。

const functions = require('firebase-functions');
const { initializeApp } = require('firebase-admin/app');
const { getAuth } = require('firebase-admin/auth');
const { getDatabase } = require('firebase-admin/database');

initializeApp();

// On sign up.
exports.processSignUp = functions.auth.user().onCreate(async (user) => {
  // Check if user meets role criteria.
  if (
    user.email &&
    user.email.endsWith('@admin.example.com') &&
    user.emailVerified
  ) {
    const customClaims = {
      admin: true,
      accessLevel: 9
    };

    try {
      // Set custom user claims on this newly created user.
      await getAuth().setCustomUserClaims(user.uid, customClaims);

      // Update real-time database to notify client to force refresh.
      const metadataRef = getDatabase().ref('metadata/' + user.uid);

      // Set the refresh time to the current UTC timestamp.
      // This will be captured on the client to force a token refresh.
      await  metadataRef.set({refreshTime: new Date().getTime()});
    } catch (error) {
      console.log(error);
    }
  }
});

データベース ルール

{
  "rules": {
    "metadata": {
      "$user_id": {
        // Read access only granted to the authenticated user.
        ".read": "$user_id === auth.uid",
        // Write access only via Admin SDK.
        ".write": false
      }
    }
  }
}

HTTP リクエストを使用した役割の定義

以下の例では、HTTP リクエストを使用して、新しくログインしたユーザーにカスタム ユーザー クレームを設定します。

クライアント側の実装（JavaScript）

const provider = new firebase.auth.GoogleAuthProvider();
firebase.auth().signInWithPopup(provider)
.then((result) => {
  // User is signed in. Get the ID token.
  return result.user.getIdToken();
})
.then((idToken) => {
  // Pass the ID token to the server.
  $.post(
    '/setCustomClaims',
    {
      idToken: idToken
    },
    (data, status) => {
      // This is not required. You could just wait until the token is expired
      // and it proactively refreshes.
      if (status == 'success' && data) {
        const json = JSON.parse(data);
        if (json && json.status == 'success') {
          // Force token refresh. The token claims will contain the additional claims.
          firebase.auth().currentUser.getIdToken(true);
        }
      }
    });
}).catch((error) => {
  console.log(error);
});

バックエンドの実装（Admin SDK）

app.post('/setCustomClaims', async (req, res) => {
  // Get the ID token passed.
  const idToken = req.body.idToken;

  // Verify the ID token and decode its payload.
  const claims = await getAuth().verifyIdToken(idToken);

  // Verify user is eligible for additional privileges.
  if (
    typeof claims.email !== 'undefined' &&
    typeof claims.email_verified !== 'undefined' &&
    claims.email_verified &&
    claims.email.endsWith('@admin.example.com')
  ) {
    // Add custom claims for additional privileges.
    await getAuth().setCustomUserClaims(claims.sub, {
      admin: true
    });

    // Tell client to refresh token on user.
    res.end(JSON.stringify({
      status: 'success'
    }));
  } else {
    // Return nothing.
    res.end(JSON.stringify({ status: 'ineligible' }));
  }
});

既存のユーザーのアクセスレベルをアップグレードするときには、同じフローを使用できます。 無料ユーザーから有料サブスクリプションにアップグレードする例で説明します。ユーザーの ID トークンは、支払い情報とともに HTTP リクエストによりバックエンド サーバーに送信されます。支払いが正常に処理されると、Admin SDK によりユーザーは有料サブスクライバーとして設定されます。成功を示す HTTP レスポンスがクライアントに返され、トークンが強制的に更新されます。

バックエンド スクリプトによる役割の定義

ユーザーのカスタム クレームを更新するために繰り返しスクリプト（クライアントから開始されないスクリプト）を実行するように設定できます。

Node.js

getAuth()
  .getUserByEmail('user@admin.example.com')
  .then((user) => {
    // Confirm user is verified.
    if (user.emailVerified) {
      // Add custom claims for additional privileges.
      // This will be picked up by the user on token refresh or next sign in on new device.
      return getAuth().setCustomUserClaims(user.uid, {
        admin: true,
      });
    }
  })
  .catch((error) => {
    console.log(error);
  });

Java

UserRecord user = FirebaseAuth.getInstance()
    .getUserByEmail("user@admin.example.com");
// Confirm user is verified.
if (user.isEmailVerified()) {
  Map<String, Object> claims = new HashMap<>();
  claims.put("admin", true);
  FirebaseAuth.getInstance().setCustomUserClaims(user.getUid(), claims);
}

Python

user = auth.get_user_by_email('user@admin.example.com')
# Confirm user is verified
if user.email_verified:
    # Add custom claims for additional privileges.
    # This will be picked up by the user on token refresh or next sign in on new device.
    auth.set_custom_user_claims(user.uid, {
        'admin': True
    })

Go

user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Confirm user is verified
if user.EmailVerified {
	// Add custom claims for additional privileges.
	// This will be picked up by the user on token refresh or next sign in on new device.
	err := client.SetCustomUserClaims(ctx, user.UID, map[string]interface{}{"admin": true})
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}
auth.go

C#

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("user@admin.example.com");
// Confirm user is verified.
if (user.EmailVerified)
{
    var claims = new Dictionary<string, object>()
    {
        { "admin", true },
    };
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}

カスタム クレームは、Admin SDK により段階的に変更することもできます。

Node.js

getAuth()
  .getUserByEmail('user@admin.example.com')
  .then((user) => {
    // Add incremental custom claim without overwriting existing claims.
    const currentCustomClaims = user.customClaims;
    if (currentCustomClaims['admin']) {
      // Add level.
      currentCustomClaims['accessLevel'] = 10;
      // Add custom claims for additional privileges.
      return getAuth().setCustomUserClaims(user.uid, currentCustomClaims);
    }
  })
  .catch((error) => {
    console.log(error);
  });

Java

UserRecord user = FirebaseAuth.getInstance()
    .getUserByEmail("user@admin.example.com");
// Add incremental custom claim without overwriting the existing claims.
Map<String, Object> currentClaims = user.getCustomClaims();
if (Boolean.TRUE.equals(currentClaims.get("admin"))) {
  // Add level.
  currentClaims.put("level", 10);
  // Add custom claims for additional privileges.
  FirebaseAuth.getInstance().setCustomUserClaims(user.getUid(), currentClaims);
}

Python

user = auth.get_user_by_email('user@admin.example.com')
# Add incremental custom claim without overwriting existing claims.
current_custom_claims = user.custom_claims
if current_custom_claims.get('admin'):
    # Add level.
    current_custom_claims['accessLevel'] = 10
    # Add custom claims for additional privileges.
    auth.set_custom_user_claims(user.uid, current_custom_claims)

Go

user, err := client.GetUserByEmail(ctx, "user@admin.example.com")
if err != nil {
	log.Fatal(err)
}
// Add incremental custom claim without overwriting existing claims.
currentCustomClaims := user.CustomClaims
if currentCustomClaims == nil {
	currentCustomClaims = map[string]interface{}{}
}

if _, found := currentCustomClaims["admin"]; found {
	// Add level.
	currentCustomClaims["accessLevel"] = 10
	// Add custom claims for additional privileges.
	err := client.SetCustomUserClaims(ctx, user.UID, currentCustomClaims)
	if err != nil {
		log.Fatalf("error setting custom claims %v\n", err)
	}

}
auth.go

C#

UserRecord user = await FirebaseAuth.DefaultInstance
    .GetUserByEmailAsync("user@admin.example.com");
// Add incremental custom claims without overwriting the existing claims.
object isAdmin;
if (user.CustomClaims.TryGetValue("admin", out isAdmin) && (bool)isAdmin)
{
    var claims = user.CustomClaims.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
    // Add level.
    var level = 10;
    claims["level"] = level;
    // Add custom claims for additional privileges.
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}