Kiểm soát quyền truy cập bằng thông báo xác nhận quyền sở hữu tuỳ chỉnh và quy tắc bảo mật

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

Bạn có thể xác định vai trò của người dùng 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 vào dữ liệu và tài nguyên.
  • Xác định các nhóm mà người dùng thuộc về.
  • Cung cấp quyền truy cập nhiều cấp:
    • Phân biệt người đăng ký có trả phí/không 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 dành cho giáo viên/học viên, v.v.
  • Thêm một giá trị nhận dạng bổ sung cho người dùng. Ví dụ: người dùng Firebase có thể liên kết vớ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ể thực hiện việc này 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 cùng một mục tiêu một cách hiệu quả hơn bằng cách sử dụng một tuyên bố quyền sở hữu tuỳ chỉnh của người dùng có tên là admin với quy tắc Realtime Database sau:

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

Bạn có thể truy cập vào thông báo xác nhận tuỳ chỉnh của người dùng 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 đúng trong thông báo xác nhận mã thông báo mới có quyền đọc/ghi vào nút adminContent. Vì mã thông báo nhận dạng đã chứa các xác nhận này, nên bạn không cần xử lý hoặc tra cứu thêm để kiểm tra quyền quản trị. Ngoài ra, mã thông báo nhận dạng là một cơ chế đáng tin cậy để phân phối các thông báo xác nhận tuỳ 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 nhận dạng trước khi xử lý yêu cầu liên quan.

Các ví dụ về 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 dành cho quản trị viên cung cấp.

Thiết lập và xác thực thông báo xác nhận tuỳ chỉnh của người dùng thông qua SDK dành cho quản trị viên

Tuyên bố tuỳ chỉnh có thể chứa dữ liệu nhạy cảm, do đó, SDK quản trị Firebase chỉ nên đặt các tuyên bố này từ môi trường máy chủ đặc quyền.

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.

Tiến hành

// 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 thông báo xác nhận tuỳ chỉnh không được chứa tên khoá dành riêng cho OIDC hoặc tên dành riêng cho Firebase. Trọng tải của thông báo xác nhận quyền sở hữu tuỳ chỉnh không được vượt quá 1000 byte.

Mã thông báo nhận dạng đượ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 dành cho 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

Tiến hành

// 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 tuyên bố tuỳ chỉnh hiện có của người dùng. Các tuyên bố này 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.
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'))

Tiến hành

// 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ể xoá thông báo xác nhận tuỳ chỉnh của người dùng bằng cách truyền giá trị rỗng cho customClaims.

Truyền tải các thông báo xác nhận tuỳ chỉnh đến ứng dụng

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

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

Truy cập vào các thông báo xác nhận tuỳ chỉnh trên ứng dụng

Bạn chỉ có thể truy xuất thông báo xác nhận tuỳ chỉnh thông qua mã thông báo nhận dạng của người dùng. Bạn có thể cần quyền truy cập vào các tuyên bố này để sửa đổi giao diện người dùng của ứng 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 vào phần phụ trợ phải luôn được thực thi thông qua mã thông báo nhận dạng sau khi xác thực và phân tích cú pháp các thông báo xác nhận của mã thông báo đó. Không được gửi trực tiếp thông báo xác nhận quyền sở hữu tuỳ chỉnh đế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 mới nhất được truyền đến mã thông báo nhận dạng của người dùng, bạn có thể lấy các thông báo đó bằng cách truy xuất mã thông báo nhận dạng:

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

Các phương pháp hay nhất về thông báo xác nhận quyền sở hữu tuỳ chỉnh

Thông báo xác nhận quyền sở hữu tuỳ chỉnh chỉ được dùng để cung cấp quyền kiểm soát truy cập. Các tệp này 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 tuỳ chỉnh khác). Mặc dù đây có vẻ là một cơ chế thuận tiện để thực hiện việc này, nhưng bạn không nên sử dụng vì các thông báo xác nhận quyền sở hữu này được lưu trữ trong mã thông báo nhận dạng 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 nhận dạng Firebase tương ứng với người dùng đã đăng nhập.

  • Sử dụng thông báo xác nhận tuỳ chỉnh để chỉ lưu trữ dữ liệu nhằm kiểm soát quyền truy cập của người dùng. Tất cả dữ liệu khác phải được lưu trữ riêng qua cơ sở dữ liệu theo thời gian thực hoặc bộ nhớ phía máy chủ khác.
  • Tuyên bố quyền sở hữu tuỳ chỉnh có giới hạn về kích thước. Việc truyền tải trọng tuyên bố tuỳ 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 đây minh hoạ các tuyên bố tuỳ chỉnh trong bối cảnh của các trường hợp sử dụng Firebase cụ thể.

Xác định vai trò thông qua Hàm Firebase khi tạo người dùng

Trong ví dụ này, thông báo xác nhận quyền sở hữu tuỳ chỉnh được đặt cho người dùng khi tạo bằng cách sử dụng Cloud Functions.

Bạn có thể thêm thông báo xác nhận quyền sở hữu tuỳ chỉnh bằng Cloud Functions và truyền tải ngay bằng Realtime Database. Hàm này chỉ được gọi khi đăng ký bằng trình kích hoạt onCreate. Sau khi bạn đặt thông báo xác nhận quyền sở hữu tuỳ chỉnh, các thông báo này sẽ được truyền đến tất cả các phiên hiện tại và trong tương lai. Lần tiếp theo người dùng đăng nhập bằng thông tin xác thực của người dùng, mã thông báo sẽ chứa các thông báo xác nhận tuỳ 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 Cloud Functions

Một nút cơ sở dữ liệu mới (metadata/($uid)} với quyền đọc/ghi bị hạn chế đối với người dùng đã xác thực sẽ đượ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 yêu cầu HTTP

Ví dụ sau đây thiết lập các tuyên bố tuỳ chỉnh của người dùng trên một 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ần phụ trợ (SDK dành cho quản trị viên)

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

Bạn có thể sử dụng quy trình tương tự khi nâng cấp cấp truy cập của người dùng hiện tại. Ví dụ: người dùng miễn phí nâng cấp lên gói thuê bao có tính phí. Mã thông báo mã nhận dạng 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 hệ thống xử lý xong khoản thanh toán, người dùng sẽ được đặt làm người đăng ký trả phí thông qua SDK quản trị. Phản hồi HTTP thành công sẽ được trả về cho ứng dụng để 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ợ

Bạn có thể thiết lập một tập lệnh định kỳ (không được bắt đầu từ ứng dụng) để chạy nhằm cập nhật các tuyên bố tuỳ 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
    })

Tiến hành

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

Bạn cũng có thể sửa đổi dần các tuyên bố tuỳ chỉnh thông qua SDK quản trị:

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)

Tiến hành

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