Google is committed to advancing racial equity for Black communities. See how.
Trang này được dịch bởi Cloud Translation API.
Switch to English

Kiểm soát truy cập với các yêu cầu tùy chỉnh và quy tắc bảo mật

SDK quản trị Firebase hỗ trợ xác định các thuộc tính tùy chỉnh trên tài khoản người dùng. Điều này cung cấp khả năng thực hiện các chiến lược kiểm soát truy cập khác nhau, bao gồm kiểm soát truy cập dựa trên vai trò, trong các ứng dụng Firebase. Các thuộc tính tùy chỉnh này có thể cung cấp cho người dùng các cấp truy cập (vai trò) khác nhau, được thực thi theo các quy tắc bảo mật của ứng dụng.

Vai trò người dùng có thể được xác định cho các trường hợp phổ biến sau:

  • Cung cấp một đặc quyền quản trị người dùng để truy cập dữ liệu và tài nguyên.
  • Xác định các nhóm khác nhau mà người dùng thuộc về.
  • Cung cấp truy cập đa cấp:
    • Phân biệt thuê bao trả / không trả tiền.
    • Phân biệt người điều hành từ người dùng thường xuyên.
    • Ứng dụng giáo viên / học sinh, vv
  • Thêm một định danh bổ sung trên một người dùng. Ví dụ: người dùng Firebase có thể ánh xạ tới một UID khác trong một hệ thống khác.

Hãy xem xét trường hợp bạn muốn giới hạn quyền truy cập vào nút cơ sở dữ liệu "adminContent." Bạn có thể làm điều đó với một tra cứu cơ sở dữ liệu trong danh sách người dùng quản trị. Tuy nhiên, bạn có thể đạt được cùng một mục tiêu hiệu quả hơn bằng cách sử dụng một yêu cầu người dùng tùy chỉnh có tên admin với quy tắc Cơ sở dữ liệu thời gian thực sau đây:

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

Yêu cầu người dùng tùy chỉnh có thể truy cập thông qua mã thông báo xác thực của người dùng. Trong ví dụ trên, chỉ những người dùng có admin được đặt thành true trong yêu cầu mã thông báo của họ mới có quyền truy cập đọc / ghi vào nút adminContent . Vì mã thông báo ID đã chứa các xác nhận này, không cần xử lý hoặc tra cứu bổ sung để kiểm tra quyền của quản trị viên. Ngoài ra, mã thông báo ID là một cơ chế đáng tin cậy để phân phối các khiếu nại tùy chỉnh này. Tất cả quyền truy cập được xác thực phải xác thực mã thông báo ID trước khi xử lý yêu cầu được liên kết.

Các ví dụ và giải pháp mã được mô tả trong trang này rút ra từ cả API xác thực Firebase phía máy khách và API xác thực phía máy chủ được cung cấp bởi SDK quản trị .

Đặt và xác thực các khiếu nại người dùng tùy chỉnh thông qua SDK quản trị

Khiếu nại tùy chỉnh có thể chứa dữ liệu nhạy cảm, do đó, chúng chỉ nên được đặt từ môi trường máy chủ đặc quyền bởi SDK quản trị Firebase.

Node.js

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

admin.auth().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.
 

Con trăn

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

Đi

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

Đối tượng khiếu nại tùy chỉnh không được chứa bất kỳ tên khóa dành riêng OIDC hoặc tên dành riêng cho Firebase. Tải trọng yêu cầu tùy chỉnh không được vượt quá 1000 byte.

Mã thông báo ID được gửi đến máy chủ phụ trợ có thể xác nhận danh tính và cấp truy cập của người dùng bằng cách sử dụng SDK quản trị như sau:

Node.js

 // Verify the ID token first.
admin.auth().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.
}
 

Con trăn

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

Đi

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

 

Bạn cũng có thể kiểm tra khiếu nại tùy chỉnh hiện có của người dùng, có sẵn dưới dạng một thuộc tính trên đối tượng người dùng:

Node.js

 // Lookup the user associated with the specified uid.
admin.auth().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"));
 

Con trăn

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

Đi

 // 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"]);
 

Bạn có thể xóa khiếu nại tùy chỉnh của người dùng bằng cách chuyển null cho customClaims .

Tuyên truyền yêu cầu tùy chỉnh cho khách hàng

Sau khi các khiếu nại mới được sửa đổi trên người dùng thông qua SDK quản trị, chúng sẽ được truyền tới người dùng được xác thực ở phía máy khách thông qua mã thông báo ID theo các cách sau:

  • Người dùng đăng nhập hoặc xác thực lại sau khi yêu cầu tùy chỉnh được sửa đổi. Mã thông báo ID được phát hành do đó sẽ chứa các khiếu nại mới nhất.
  • Phiên người dùng hiện tại được mã thông báo ID được làm mới sau khi mã thông báo cũ hết hạn.
  • Mã thông báo ID được làm mới bằng cách gọi currentUser.getIdToken(true) .

Truy cập yêu cầu tùy chỉnh trên máy khách

Yêu cầu tùy chỉnh chỉ có thể được truy xuất thông qua mã thông báo ID người dùng. Truy cập vào các khiếu nại này có thể cần thiết để sửa đổi giao diện người dùng dựa trên vai trò hoặc cấp độ truy cập của người dùng. Tuy nhiên, quyền truy cập phụ trợ phải luôn được thực thi thông qua mã thông báo ID sau khi xác thực nó và phân tích các khiếu nại của nó. Khiếu nại tùy chỉnh không nên được gửi trực tiếp đến phần phụ trợ, vì chúng không thể được tin cậy bên ngoài mã thông báo.

Khi các khiếu nại mới nhất đã được truyền tới mã thông báo ID của người dùng, bạn có thể nhận được chúng bằng cách truy xuất mã thông báo 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();
    }
  }
});
 

Nhanh

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

Mục tiêu-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];
    }
  }
}];
 

Thực tiễn tốt nhất cho khiếu nại tùy chỉnh

Yêu cầu tùy chỉnh chỉ được sử dụng để cung cấp kiểm soát truy cập. Chúng không được thiết kế để lưu trữ dữ liệu bổ sung (như hồ sơ và dữ liệu tùy chỉnh khác). Mặc dù điều này có vẻ như là một cơ chế thuận tiện để làm như vậy, nhưng nó không được khuyến khích vì những khiếu nại này được lưu trữ trong mã thông báo ID và có thể gây ra sự cố về hiệu suất vì tất cả các yêu cầu được xác thực luôn chứa mã thông báo ID Firebase tương ứng với người dùng đã đăng nhập.

  • Sử dụng khiếu nại tùy chỉnh để lưu trữ dữ liệu chỉ kiểm soát quyền truy cập của người dùng. Tất cả các dữ liệu khác phải được lưu trữ riêng thông qua cơ sở dữ liệu thời gian thực hoặc lưu trữ phía máy chủ khác.
  • Yêu cầu tùy chỉnh được giới hạn về kích thước. Vượt qua một tải trọng yêu cầu tùy chỉnh lớn hơn 1000 byte sẽ gây ra lỗi.

Ví dụ và trường hợp sử dụng

Các ví dụ sau minh họa các khiếu nại tùy chỉnh trong bối cảnh các trường hợp sử dụng Firebase cụ thể.

Xác định vai trò thông qua Chức năng Firebase trong việc tạo người dùng

Trong ví dụ này, khiếu nại tùy chỉnh được đặt cho người dùng khi tạo bằng cách sử dụng Hàm đám mây.

Yêu cầu tùy chỉnh có thể được thêm bằng cách sử dụng Hàm đám mây và được truyền bá ngay lập tức với Cơ sở dữ liệu thời gian thực. Hàm chỉ được gọi khi đăng ký bằng trình kích hoạt onCreate . Khi các yêu cầu tùy chỉnh được đặt, chúng sẽ truyền tới tất cả các phiên hiện tại và tương lai. Lần sau khi người dùng đăng nhập bằng thông tin xác thực người dùng, mã thông báo chứa các khiếu nại tùy chỉnh.

Triển khai phía máy khách (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);
  }
});
 

Logic Hàm đám mây

Một nút cơ sở dữ liệu mới (siêu dữ liệu / ($ uid)} với việc đọc / ghi bị hạn chế đối với người dùng được xác thực được thêm vào.

 const functions = require('firebase-functions');

const admin = require('firebase-admin');
admin.initializeApp();

// On sign up.
exports.processSignUp = functions.auth.user().onCreate((user) => {
  // Check if user meets role criteria.
  if (user.email &&
      user.email.endsWith('@admin.example.com') &&
      user.emailVerified) {
    const customClaims = {
      admin: true,
      accessLevel: 9
    };
    // Set custom user claims on this newly created user.
    return admin.auth().setCustomUserClaims(user.uid, customClaims)
      .then(() => {
        // Update real-time database to notify client to force refresh.
        const metadataRef = admin.database().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.
        return metadataRef.set({refreshTime: new Date().getTime()});
      })
      .catch(error => {
        console.log(error);
      });
  }
});
 

Quy tắc cơ sở dữ liệu

 {
  "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
      }
    }
  }
}
 

Xác định vai trò thông qua yêu cầu HTTP

Ví dụ sau đặt yêu cầu người dùng tùy chỉnh đối với người dùng mới đăng nhập thông qua yêu cầu HTTP.

Triển khai phía máy khách (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);
});
 

Triển khai cuối cùng (SDK quản trị)

 app.post('/setCustomClaims', (req, res) => {
  // Get the ID token passed.
  const idToken = req.body.idToken;
  // Verify the ID token and decode its payload.
  admin.auth().verifyIdToken(idToken).then((claims) => {
    // 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.
      admin.auth().setCustomUserClaims(claims.sub, {
        admin: true
      }).then(function() {
        // Tell client to refresh token on user.
        res.end(JSON.stringify({
          status: 'success'
        });
      });
    } else {
      // Return nothing.
      res.end(JSON.stringify({status: 'ineligible'});
    }
  });
});
 

Luồng tương tự có thể được sử dụng khi nâng cấp cấp truy cập của người dùng hiện có. Lấy ví dụ một người dùng miễn phí nâng cấp lên một thuê bao trả phí. Mã thông báo ID người dùng được gửi cùng với thông tin thanh toán đến máy chủ phụ trợ thông qua yêu cầu HTTP. Khi thanh toán được xử lý thành công, người dùng được đặt làm thuê bao trả phí thông qua SDK quản trị. Một phản hồi HTTP thành công được trả về máy khách để buộc làm mới mã thông báo.

Xác định vai trò thông qua kịch bản phụ trợ

Tập lệnh định kỳ (không được khởi tạo từ máy khách) có thể được đặt để chạy để cập nhật khiếu nại tùy chỉnh của người dùng:

Node.js

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

Con trăn

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

Đi

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

 

Yêu cầu tùy chỉnh cũng có thể được sửa đổi tăng dần thông qua SDK quản trị:

Node.js

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

Con trăn

 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)
 

Đi

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