Firebase Summit에서 발표된 모든 내용을 살펴보고 Firebase로 앱을 빠르게 개발하고 안심하고 앱을 실행하는 방법을 알아보세요. 자세히 알아보기

사용자 지정 클레임 및 보안 규칙으로 액세스 제어

Firebase Admin SDK는 사용자 계정에 대한 맞춤 속성 정의를 지원합니다. 이를 통해 Firebase 앱에서 역할 기반 액세스 제어를 비롯한 다양한 액세스 제어 전략을 구현할 수 있습니다. 이러한 사용자 정의 속성은 사용자에게 애플리케이션의 보안 규칙에 적용되는 다양한 수준의 액세스(역할)를 제공할 수 있습니다.

다음과 같은 일반적인 경우에 대해 사용자 역할을 정의할 수 있습니다.

  • 사용자에게 데이터 및 리소스에 액세스할 수 있는 관리 권한을 부여합니다.
  • 사용자가 속한 다른 그룹을 정의합니다.
  • 다단계 액세스 제공:
    • 유료/무급 가입자 구분.
    • 일반 사용자와 중재자를 구별합니다.
    • 교사/학생 지원서 등
  • 사용자에 대한 추가 식별자를 추가합니다. 예를 들어 Firebase 사용자는 다른 시스템의 다른 UID에 매핑할 수 있습니다.

데이터베이스 노드 "adminContent"에 대한 액세스를 제한하려는 경우를 고려해 보겠습니다. 관리 사용자 목록에 대한 데이터베이스 조회로 이를 수행할 수 있습니다. 그러나 다음 실시간 데이터베이스 규칙과 함께 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를 통해 권한이 있는 서버 환경에서만 설정해야 합니다.

노드.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.
  });

자바

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

파이썬

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

씨#

// 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 토큰은 다음과 같이 Admin SDK를 사용하여 사용자의 ID 및 액세스 수준을 확인할 수 있습니다.

노드.js

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

자바

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

파이썬

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

씨#

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

사용자 개체의 속성으로 사용할 수 있는 사용자의 기존 사용자 지정 클레임을 확인할 수도 있습니다.

노드.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']);
  });

자바

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

파이썬

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

씨#

// 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 토큰을 검색하여 얻을 수 있습니다.

자바스크립트

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

오브젝티브-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 Functions를 통한 역할 정의

이 예시에서 커스텀 클레임은 Cloud Functions를 사용하여 생성할 때 사용자에 대해 설정됩니다.

Cloud Functions를 사용하여 커스텀 클레임을 추가하고 실시간 데이터베이스를 사용하여 즉시 전파할 수 있습니다. 이 함수는 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 로직

인증된 사용자에게만 읽기/쓰기가 제한된 새 데이터베이스 노드(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' }));
  }
});

기존 사용자의 액세스 수준을 업그레이드할 때도 동일한 흐름을 사용할 수 있습니다. 예를 들어 무료 사용자가 유료 구독으로 업그레이드한다고 가정해 보겠습니다. HTTP 요청을 통해 사용자의 ID 토큰이 결제 정보와 함께 백엔드 서버로 전송됩니다. 결제가 성공적으로 처리되면 사용자는 Admin SDK를 통해 유료 구독자로 설정됩니다. 토큰 새로 고침을 강제 실행하기 위해 성공적인 HTTP 응답이 클라이언트에 반환됩니다.

백엔드 스크립트를 통한 역할 정의

반복 스크립트(클라이언트에서 시작되지 않음)는 사용자 맞춤 클레임을 업데이트하기 위해 실행되도록 설정할 수 있습니다.

노드.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);
  });

자바

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

파이썬

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

}

씨#

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를 통해 점진적으로 수정할 수도 있습니다.

노드.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);
  });

자바

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

파이썬

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

}

씨#

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