Kiểm soát quyền truy cập bằng các xác nhận quyền sở hữ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 triển khai các chiến lược kiểm soát truy cập khác nhau, bao gồm cả 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 trong 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:

  • Cấp cho người dùng đặc quyền quản trị để truy cập dữ liệu và tài nguyên.
  • Xác định các nhóm khác nhau mà một người dùng thuộc về.
  • Cung cấp quyền truy cập đa cấp:
    • Phân biệt thuê bao trả phí / chưa trả phí.
    • Phân biệt người kiểm duyệt với người dùng thông thường.
    • Ứng dụng của giáo viên / học sinh, v.v.
  • Thêm một số nhận dạng bổ sung cho 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 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 đó bằng cách tra cứu cơ sở dữ liệu trên danh sách người dùng quản trị. Tuy nhiên, bạn có thể đạt được mục tiêu tương tự hiệu quả hơn bằng cách sử dụng xác nhận quyền sở hữu người dùng tùy chỉnh có tên là admin với quy tắc Cơ sở dữ liệu thời gian thực sau:

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

Các xác nhận quyền sở hữu của người dùng tùy chỉnh có thể truy cập được 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 xác nhận quyền sở hữ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 nên không cần xử lý hoặc tra cứu bổ sung để kiểm tra quyền quản trị. Ngoài ra, mã thông báo ID là một cơ chế đáng tin cậy để gửi các xác nhận quyền sở hữu tùy chỉnh này. Tất cả quyền truy cập đã 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 liên quan.

Các ví dụ mã và giải pháp được mô tả trong trang này lấy 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ủ do SDK quản trị cung cấp.

Đặt và xác thực các xác nhận quyền sở hữu của người dùng tùy chỉnh thông qua SDK quản trị

Xác nhận quyền sở hữu 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ị viên Firebase.

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.

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

Đối tượng xác nhận quyền sở hữu tùy chỉnh không được chứa bất kỳ tên khóa dành riêng nào của OIDC hoặc tên dành riêng cho Firebase . Tải trọng xác nhận quyền sở hữ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 SDK quản trị viên như sau:

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

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

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

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

Đ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)
	}
}
auth.go

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 xác nhận quyền sở hữu tùy chỉnh của người dùng bằng cách chuyển null cho customClaims cầu tùy chỉnh.

Tuyên truyền các xác nhận quyền sở hữu tùy chỉnh cho khách hàng

Sau khi các xác nhận quyền sở hữu mới được sửa đổi đối với người dùng thông qua SDK quản trị, chúng sẽ được truyền tới người dùng đã 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 các xác nhận quyền sở hữu tùy chỉnh được sửa đổi. Do đó, mã thông báo ID được phát hành sẽ chứa các xác nhận quyền sở hữu mới nhất.
  • Một phiên người dùng hiện tại được làm mới mã thông báo ID của nó sau khi mã thông báo cũ hơn hết hạn.
  • Mã thông báo ID được buộc làm mới bằng cách gọi currentUser.getIdToken(true) .

Truy cập các xác nhận quyền sở hữu tùy chỉnh trên khách hàng

Các xác nhận quyền sở hữu tùy chỉnh chỉ có thể được truy xuất thông qua mã thông báo ID của người dùng. Có thể cần quyền truy cập vào các xác nhận quyền sở hữu này để sửa đổi giao diện người dùng ứng dụng khách 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 yêu cầu của nó. Các xác nhận quyền sở hữu 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.

Sau khi các thông báo xác nhận quyền sở hữu mới nhất được truyền đến mã thông báo ID của người dùng, bạn có thể lấy 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()
  }
})

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

Các phương pháp hay nhất cho các xác nhận quyền sở hữu tùy chỉnh

Các xác nhận quyền sở hữ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 (chẳng hạn như hồ sơ và dữ liệu tùy chỉnh khác). Mặc dù đây có vẻ là một cơ chế thuận tiện để làm như vậy, nhưng nó thực sự không được khuyến khích vì những xác nhận quyền sở hữu này được lưu trữ trong mã thông báo ID và có thể gây ra các vấn đề về hiệu suất vì tất cả các yêu cầu đã 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 xác nhận quyền sở hữu tùy chỉnh để lưu trữ dữ liệu chỉ nhằm 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 biệt thông qua cơ sở dữ liệu thời gian thực hoặc bộ lưu trữ phía máy chủ khác.
  • Yêu cầu tùy chỉnh có kích thước giới hạn. Chuyển một xác nhận quyền sở hữu tùy chỉnh trọng tải lớn hơn 1000 byte sẽ gây ra lỗi.

Các ví dụ và trường hợp sử dụng

Các ví dụ sau minh họa xác nhận quyền sở hữu tùy chỉnh trong ngữ cảnh của các trường hợp sử dụng Firebase cụ thể.

Xác định vai trò thông qua Các chức năng của Firebase khi tạo người dùng

Trong ví dụ này, xác nhận quyền sở hữu tùy chỉnh được đặt trên người dùng khi sáng tạo bằng Chức năng đám mây.

Các xác nhận quyền sở hữu tùy chỉnh có thể được thêm bằng cách sử dụng Chức năng đám mây và được phổ biến 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 cách sử dụng trình kích hoạt onCreate . Sau khi xác nhận quyền sở hữu tùy chỉnh được đặt, chúng sẽ phổ biến cho tất cả các phiên hiện tại và trong tương lai. Vào lần tiếp theo người dùng đăng nhập bằng thông tin đăng nhập người dùng, mã thông báo sẽ chứa các xác nhận quyền sở hữu 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 chức năng đám mây

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

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

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 một yêu cầu HTTP

Ví dụ sau đặt các xác nhận quyền sở hữu của người dùng tùy chỉnh đối với người dùng mới đăng nhập thông qua một 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 phụ trợ (SDK quản trị)

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

Quy trình 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 tại. Lấy ví dụ một người dùng miễn phí nâng cấp lên đăng ký trả phí. Mã thông báo ID của 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 một yêu cầu HTTP. Khi thanh toán được xử lý thành công, người dùng được đặt làm người đăng ký trả phí thông qua SDK quản trị. Một phản hồi HTTP thành công được trả lại cho máy khách để buộc làm mới mã thông báo.

Xác định vai trò thông qua tập lệnh phụ trợ

Một tập lệnh lặp lại (không được khởi tạo từ máy khách) có thể được đặt để chạy để cập nhật các xác nhận quyền sở hữu tùy chỉnh của người dùng:

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

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

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

Các xác nhận quyền sở hữu tùy chỉnh cũng có thể được sửa đổi dần dần thông qua SDK quản trị viên:

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)

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

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