Firebase Summit で発表されたすべての情報をご覧ください。Firebase を使用してアプリ開発を加速し、自信を持ってアプリを実行する方法を紹介しています。詳細

カスタムクレームとセキュリティルールでアクセスを制御する

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

ユーザーロールは、次の一般的なケースで定義できます。

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

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

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

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

このページで説明するコード例とソリューションは、AdminSDKによって提供されるクライアント側のFirebaseAuthAPIとサーバー側のAuthAPIの両方から取得されます

AdminSDKを介してカスタムユーザークレームを設定および検証します

カスタムクレームには機密データを含めることができるため、Firebase AdminSDKによって特権サーバー環境からのみ設定する必要があります。

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.

行け

// 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.

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の予約済みキー名を含めることはできません。カスタムクレームペイロードは1000バイトを超えてはなりません。

バックエンドサーバーに送信されたIDトークンは、次のようにAdminSDKを使用してユーザーの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

行け

// 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.
	}
}

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'))

行け

// 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)
	}
}

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トークンを更新します。
  • IDトークンは、 currentUser.getIdToken(true)を呼び出すことによって強制的に更新されます。

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

カスタムクレームは、ユーザーの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);
  });

アンドロイド

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();
    }
  }
});

迅速

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トークンが含まれているため、パフォーマンスの問題が発生する可能性があるため、お勧めしません。

  • カスタムクレームを使用して、ユーザーアクセスのみを制御するためのデータを保存します。他のすべてのデータは、リアルタイムデータベースまたは他のサーバー側ストレージを介して個別に保存する必要があります。
  • カスタムクレームのサイズには制限があります。 1000バイトを超えるカスタムクレームペイロードを渡すと、エラーがスローされます。

例と使用例

次の例は、特定のFirebaseユースケースのコンテキストでのカスタムクレームを示しています。

ユーザー作成時にFirebase関数を介してロールを定義する

この例では、CloudFunctionsを使用して作成するユーザーにカスタムクレームが設定されています。

カスタムクレームは、Cloud Functionsを使用して追加し、RealtimeDatabaseですぐに伝達できます。この関数は、 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);
  }
});

クラウド関数ロジック

認証されたユーザーに読み取り/書き込みが制限された新しいデータベースノード(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);
});

バックエンドの実装(管理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リクエストを介してバックエンドサーバーに送信されます。支払いが正常に処理されると、ユーザーはAdminSDKを介して有料サブスクライバーとして設定されます。成功した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
    })

行け

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)
	}

}

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);
}

カスタムクレームは、AdminSDKを介して段階的に変更することもできます。

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)

行け

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)
	}

}

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 = new Dictionary<string, object>(user.CustomClaims);
    // Add level.
    claims["level"] = 10;
    // Add custom claims for additional privileges.
    await FirebaseAuth.DefaultInstance.SetCustomUserClaimsAsync(user.Uid, claims);
}