chrome.permissions

Mô tả

Sử dụng API chrome.permissions để yêu cầu các quyền không bắt buộc đã khai báo tại thời gian chạy thay vì thời gian cài đặt, để người dùng hiểu lý do cần có các quyền và chỉ cấp những quyền cần thiết.

Khái niệm và cách sử dụng

Cảnh báo về quyền nhằm mô tả các chức năng mà một API cấp, nhưng một số cảnh báo trong số này có thể không rõ ràng. Permissions API cho phép nhà phát triển giải thích các cảnh báo về quyền và giới thiệu dần các tính năng mới, giúp người dùng làm quen với tiện ích mà không gặp rủi ro. Bằng cách này, người dùng có thể chỉ định mức độ truy cập mà họ sẵn sàng cấp và những tính năng họ muốn bật.

Ví dụ: chức năng cốt lõi của tiện ích có quyền không bắt buộc là ghi đè trang thẻ mới. Một tính năng là hiển thị mục tiêu trong ngày của người dùng. Tính năng này chỉ yêu cầu quyền lưu trữ và không có cảnh báo. Tiện ích này có thêm một tính năng mà người dùng có thể bật bằng cách nhấp vào nút sau:

Một nút tiện ích cho phép dùng các tính năng bổ sung.
Một nút tiện ích cho phép dùng các tính năng bổ sung.

Để hiển thị các trang web hàng đầu của người dùng, bạn cần có quyền topSites. Quyền này có cảnh báo sau.

Cảnh báo Axtension cho API topSites.
Cảnh báo về tiện ích cho API topSites

Triển khai các quyền không bắt buộc

Bước 1: Quyết định xem quyền nào là bắt buộc và quyền nào là không bắt buộc

Tiện ích có thể khai báo cả quyền bắt buộc và không bắt buộc. Nhìn chung, bạn nên:

  • Sử dụng các quyền bắt buộc khi cần thiết cho chức năng cơ bản của tiện ích.
  • Sử dụng các quyền không bắt buộc khi cần cho các tính năng không bắt buộc trong tiện ích.

Ưu điểm của các quyền bắt buộc:

  • Ít lời nhắc hơn: Tiện ích có thể nhắc người dùng chấp nhận tất cả các quyền một lần.
  • Phát triển đơn giản hơn: Đảm bảo có các quyền bắt buộc.

Ưu điểm của quyền không bắt buộc:

  • Bảo mật tốt hơn: Các tiện ích chạy với ít quyền hơn vì người dùng chỉ bật những quyền cần thiết.
  • Cung cấp thông tin đầy đủ hơn cho người dùng: Tiện ích có thể giải thích lý do cần có một quyền cụ thể khi người dùng bật tính năng có liên quan.
  • Nâng cấp dễ dàng hơn: Khi bạn nâng cấp tiện ích, Chrome sẽ không tắt tiện ích đó cho người dùng nếu bản nâng cấp thêm các quyền không bắt buộc thay vì bắt buộc.

Bước 2: Khai báo các quyền không bắt buộc trong tệp kê khai

Khai báo các quyền không bắt buộc trong tệp kê khai tiện ích bằng khoá optional_permissions, sử dụng cùng một định dạng như trường permissions:

{   "name": "My extension",   ...   "optional_permissions": ["tabs"],   "optional_host_permissions": ["https://www.google.com/"],   ... } 

Nếu bạn muốn yêu cầu các máy chủ mà bạn chỉ phát hiện được trong thời gian chạy, hãy thêm "https://*/*" vào trường optional_host_permissions của tiện ích. Điều này cho phép bạn chỉ định bất kỳ nguồn nào trong "Permissions.origins" miễn là nguồn đó có một lược đồ phù hợp.

Các quyền không thể được chỉ định là không bắt buộc

Bạn có thể chỉ định hầu hết các quyền của tiện ích Chrome là không bắt buộc, ngoại trừ những trường hợp sau.

Quyền Mô tả
"debugger" API chrome.debugger đóng vai trò là một phương thức truyền tải thay thế cho giao thức gỡ lỗi từ xa của Chrome.
"declarativeNetRequest" Cấp cho tiện ích quyền truy cập vào API chrome.declarativeNetRequest.
"devtools" Cho phép tiện ích mở rộng chức năng Chrome DevTools.
"geolocation" Cho phép tiện ích sử dụng API vị trí địa lý HTML5.
"mdns" Cấp cho tiện ích quyền truy cập vào API chrome.mdns.
"proxy" Cấp cho tiện ích quyền truy cập vào API chrome.proxy để quản lý chế độ cài đặt proxy của Chrome.
"tts" API chrome.tts phát văn bản được tổng hợp thành lời nói (TTS).
"ttsEngine" API chrome.ttsEngine triển khai một công cụ chuyển văn bản sang lời nói (TTS) bằng cách sử dụng một tiện ích.
"wallpaper" Chỉ dành cho ChromeOS. Sử dụng API chrome.wallpaper để thay đổi hình nền ChromeOS.

Xem phần Khai báo quyền để biết thêm thông tin về các quyền hiện có và cảnh báo của các quyền đó.

Bước 3: Yêu cầu cấp quyền không bắt buộc

Yêu cầu cấp quyền trong cử chỉ của người dùng bằng cách sử dụng permissions.request():

document.querySelector('#my-button').addEventListener('click', (event) => {   // Permissions must be requested from inside a user gesture, like a button's   // click handler.   chrome.permissions.request({     permissions: ['tabs'],     origins: ['https://www.google.com/']   }, (granted) => {     // The callback argument will be true if the user granted the permissions.     if (granted) {       doSomething();     } else {       doSomethingElse();     }   }); }); 

Chrome sẽ nhắc người dùng nếu việc thêm các quyền dẫn đến thông báo cảnh báo khác với những thông báo mà người dùng đã thấy và chấp nhận. Ví dụ: mã trước đó có thể dẫn đến một lời nhắc như sau:

Ví dụ về lời nhắc xác nhận quyền.
Ví dụ về lời nhắc xác nhận quyền.

Bước 4: Kiểm tra các quyền hiện tại của tiện ích

Để kiểm tra xem tiện ích của bạn có một quyền cụ thể hay một nhóm quyền hay không, hãy sử dụng permission.contains():

chrome.permissions.contains({   permissions: ['tabs'],   origins: ['https://www.google.com/'] }, (result) => {   if (result) {     // The extension has the permissions.   } else {     // The extension doesn't have the permissions.   } }); 

Bước 5: Xoá các quyền

Bạn nên xoá các quyền khi không cần dùng đến nữa. Sau khi một quyền bị xoá, việc gọi permissions.request() thường sẽ thêm lại quyền mà không nhắc người dùng.

chrome.permissions.remove({   permissions: ['tabs'],   origins: ['https://www.google.com/'] }, (removed) => {   if (removed) {     // The permissions have been removed.   } else {     // The permissions have not been removed (e.g., you tried to remove     // required permissions).   } }); 

Loại

Permissions

Thuộc tính

  • nguồn gốc

    string[] không bắt buộc

    Danh sách quyền từ phía máy chủ, bao gồm cả những quyền được chỉ định trong các khoá optional_permissions hoặc permissions trong tệp kê khai và những quyền được liên kết với Tập lệnh nội dung.

  • quyền

    string[] không bắt buộc

    Danh sách các quyền được đặt tên (không bao gồm máy chủ lưu trữ hoặc nguồn).

Phương thức

addHostAccessRequest()

Chrome 133 trở lên MV3 trở lên
chrome.permissions.addHostAccessRequest(
  request: object,
)
: Promise<void>

Thêm yêu cầu truy cập vào máy chủ lưu trữ. Yêu cầu sẽ chỉ được báo hiệu cho người dùng nếu tiện ích có thể được cấp quyền truy cập vào máy chủ trong yêu cầu. Yêu cầu sẽ được đặt lại khi điều hướng trên nhiều nguồn gốc. Khi được chấp nhận, yêu cầu này sẽ cấp quyền truy cập liên tục vào nguồn gốc hàng đầu của trang web

Thông số

  • request

    đối tượng

    • documentId

      chuỗi không bắt buộc

      Mã nhận dạng của một tài liệu mà yêu cầu quyền truy cập vào máy chủ lưu trữ có thể xuất hiện. Phải là tài liệu cấp cao nhất trong một thẻ. Nếu được cung cấp, yêu cầu sẽ xuất hiện trên thẻ của tài liệu được chỉ định và bị xoá khi tài liệu chuyển đến một nguồn gốc mới. Khi bạn thêm yêu cầu mới, yêu cầu đó sẽ thay thế mọi yêu cầu hiện có cho tabId. Bạn phải chỉ định thuộc tính này hoặc tabId.

    • hình mở khóa

      chuỗi không bắt buộc

      Mẫu URL nơi có thể hiển thị các yêu cầu truy cập vào máy chủ lưu trữ. Nếu được cung cấp, các yêu cầu truy cập của máy chủ lưu trữ sẽ chỉ xuất hiện trên những URL khớp với mẫu này.

    • tabId

      number không bắt buộc

      Mã nhận dạng của thẻ nơi có thể hiển thị các yêu cầu truy cập vào máy chủ lưu trữ. Nếu được cung cấp, yêu cầu sẽ xuất hiện trên thẻ được chỉ định và bị xoá khi thẻ chuyển đến một nguồn gốc mới. Việc thêm một yêu cầu mới sẽ ghi đè yêu cầu hiện có cho documentId. Bạn phải chỉ định thuộc tính này hoặc documentId.

Giá trị trả về

  • Promise<void>

contains()

chrome.permissions.contains(
  permissions: Permissions,
)
: Promise<boolean>

Kiểm tra xem tiện ích có các quyền được chỉ định hay không.

Thông số

Giá trị trả về

  • Promise<boolean>

    Chrome 96 trở lên

getAll()

chrome.permissions.getAll(): Promise<Permissions>

Lấy tập hợp các quyền hiện tại của tiện ích.

Giá trị trả về

remove()

chrome.permissions.remove(
  permissions: Permissions,
)
: Promise<boolean>

Xoá quyền truy cập vào các quyền được chỉ định. Nếu có vấn đề khi xoá các quyền, runtime.lastError sẽ được đặt.

Thông số

Giá trị trả về

  • Promise<boolean>

    Chrome 96 trở lên

removeHostAccessRequest()

Chrome 133 trở lên MV3 trở lên
chrome.permissions.removeHostAccessRequest(
  request: object,
)
: Promise<void>

Xoá yêu cầu truy cập của người tổ chức, nếu có.

Thông số

  • request

    đối tượng

    • documentId

      chuỗi không bắt buộc

      Mã nhận dạng của một tài liệu mà yêu cầu quyền truy cập vào máy chủ lưu trữ sẽ bị xoá. Phải là tài liệu cấp cao nhất trong một thẻ. Bạn phải chỉ định thuộc tính này hoặc tabId.

    • hình mở khóa

      chuỗi không bắt buộc

      Mẫu URL nơi yêu cầu truy cập của máy chủ lưu trữ sẽ bị xoá. Nếu được cung cấp, giá trị này phải khớp chính xác với mẫu của một yêu cầu hiện có về quyền truy cập vào máy chủ lưu trữ.

    • tabId

      number không bắt buộc

      Mã nhận dạng của thẻ nơi yêu cầu truy cập của người tổ chức sẽ bị xoá. Bạn phải chỉ định thuộc tính này hoặc documentId.

Giá trị trả về

  • Promise<void>

request()

chrome.permissions.request(
  permissions: Permissions,
)
: Promise<boolean>

Yêu cầu cấp quyền truy cập vào các quyền được chỉ định, hiển thị lời nhắc cho người dùng nếu cần. Các quyền này phải được xác định trong trường optional_permissions của tệp kê khai hoặc là các quyền bắt buộc mà người dùng đã giữ lại. Đường dẫn trên mẫu nguồn gốc sẽ bị bỏ qua. Bạn có thể yêu cầu các tập hợp con của quyền truy cập vào nguồn gốc không bắt buộc; ví dụ: nếu chỉ định *://*\/* trong phần optional_permissions của tệp kê khai, bạn có thể yêu cầu http://example.com/. Nếu có vấn đề khi yêu cầu các quyền, runtime.lastError sẽ được đặt.

Thông số

Giá trị trả về

  • Promise<boolean>

    Chrome 96 trở lên

Sự kiện

onAdded

chrome.permissions.onAdded.addListener(
  callback: function,
)

Được kích hoạt khi tiện ích nhận được các quyền mới.

Thông số

onRemoved

chrome.permissions.onRemoved.addListener(
  callback: function,
)

Được kích hoạt khi quyền truy cập vào các quyền đã bị xoá khỏi tiện ích.

Thông số