chrome.permissions

설명

chrome.permissions API를 사용하여 설치 시간보다는 런타임에 선언된 선택적 권한을 요청하여 사용자가 권한이 필요한 이유를 이해하고 필요한 권한만 부여하도록 합니다.

개념 및 사용

권한 경고는 API에서 부여하는 기능을 설명하기 위해 존재하지만 이러한 경고 중 일부는 명확하지 않을 수 있습니다. 권한 API를 사용하면 개발자가 권한 경고를 설명하고 새로운 기능을 점진적으로 도입하여 사용자에게 위험 부담 없이 확장 프로그램을 소개할 수 있습니다. 이렇게 하면 사용자가 부여할 액세스 수준과 사용 설정할 기능을 지정할 수 있습니다.

예를 들어 선택적 권한 확장 프로그램의 핵심 기능은 새 탭 페이지를 재정의하는 것입니다. 한 기능은 사용자의 일일 목표를 표시합니다. 이 기능에는 경고가 포함되지 않은 저장소 권한만 필요합니다. 확장 프로그램에는 사용자가 다음 버튼을 클릭하여 사용 설정할 수 있는 추가 기능이 있습니다.

추가 기능을 사용 설정하는 확장 프로그램 버튼
추가 기능을 사용 설정하는 확장 프로그램 버튼

사용자의 인기 사이트를 표시하려면 topSites 권한이 필요하며, 이 권한에는 다음 경고가 있습니다.

topSites API의 확장 프로그램 경고
topSites API의 확장 프로그램 경고

선택적 권한 구현

1단계: 필수 권한과 선택적 권한 결정

확장 프로그램은 필수 권한과 선택적 권한을 모두 선언할 수 있습니다. 일반적으로 다음과 같이 해야 합니다.

  • 확장 프로그램의 기본 기능에 필요한 경우 필수 권한을 사용합니다.
  • 확장 프로그램의 선택적 기능에 필요한 경우 선택적 권한을 사용합니다.

필수 권한의 장점:

  • 프롬프트 감소: 확장 프로그램은 사용자에게 모든 권한을 수락하도록 한 번만 요청할 수 있습니다.
  • 간단한 개발: 필수 권한이 보장됩니다.

선택적 권한의 장점:

  • 보안 강화: 사용자는 필요한 권한만 사용 설정하므로 확장 프로그램은 더 적은 권한으로 실행됩니다.
  • 사용자를 위한 더 나은 정보: 사용자가 관련 기능을 사용 설정할 때 확장 프로그램은 특정 권한이 필요한 이유를 설명할 수 있습니다.
  • 간편한 업그레이드: 확장 프로그램을 업그레이드할 때 업그레이드에서 필수 권한이 아닌 선택적 권한을 추가하는 경우 Chrome에서 사용자를 위해 확장 프로그램을 사용 중지하지 않습니다.

2단계: 매니페스트에서 선택적 권한 선언

permissions 필드와 동일한 형식을 사용하여 optional_permissions 키로 확장 프로그램 매니페스트에서 선택적 권한을 선언합니다.

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

런타임에만 검색되는 호스트를 요청하려면 확장 프로그램의 optional_host_permissions 필드에 "https://*/*"를 포함하세요. 이렇게 하면 일치하는 스킴이 있는 한 "Permissions.origins"에서 출처를 지정할 수 있습니다.

선택사항으로 지정할 수 없는 권한

다음 예외를 제외하고 대부분의 Chrome 확장 프로그램 권한은 선택사항으로 지정할 수 있습니다.

권한 설명
"debugger" chrome.debugger API는 Chrome의 원격 디버깅 프로토콜의 대체 전송으로 사용됩니다.
"declarativeNetRequest" 확장 프로그램에 chrome.declarativeNetRequest API에 대한 액세스 권한을 부여합니다.
"devtools" 확장 프로그램이 Chrome DevTools 기능을 확장할 수 있도록 허용합니다.
"geolocation" 확장이 HTML5 위치정보 API를 사용할 수 있도록 허용합니다.
"mdns" 확장 프로그램에 chrome.mdns API에 대한 액세스 권한을 부여합니다.
"proxy" Chrome의 프록시 설정을 관리하기 위해 확장 프로그램에 chrome.proxy API에 대한 액세스 권한을 부여합니다.
"tts" chrome.tts API는 합성된 텍스트 음성 변환 (TTS)을 재생합니다.
"ttsEngine" chrome.ttsEngine API는 확장 프로그램을 사용하여 텍스트 음성 변환 (TTS) 엔진을 구현합니다.
"wallpaper" ChromeOS만 해당 chrome.wallpaper API를 사용하여 ChromeOS 배경화면을 변경합니다.

사용 가능한 권한 및 경고에 관한 자세한 내용은 권한 선언을 참고하세요.

3단계: 선택적 권한 요청

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에서 사용자에게 메시지를 표시합니다. 예를 들어 이전 코드는 다음과 같은 프롬프트를 생성할 수 있습니다.

권한 확인 프롬프트의 예
권한 확인 프롬프트의 예

4단계: 확장 프로그램의 현재 권한 확인

확장 프로그램에 특정 권한 또는 권한 집합이 있는지 확인하려면 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.
  }
});

5단계: 권한 삭제

더 이상 필요하지 않은 권한은 삭제해야 합니다. 권한이 삭제된 후 permissions.request()를 호출하면 사용자에게 메시지를 표시하지 않고 권한이 다시 추가됩니다.

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

유형

Permissions

속성

  • origins

    string[] 선택사항

    매니페스트의 optional_permissions 또는 permissions 키에 지정된 권한과 콘텐츠 스크립트와 연결된 권한을 포함한 호스트 권한 목록입니다.

  • 권한

    string[] 선택사항

    이름이 지정된 권한 목록입니다 (호스트 또는 출처는 포함되지 않음).

메서드

addHostAccessRequest()

Chrome 133 이상 MV3 이상
chrome.permissions.addHostAccessRequest(
  request: object,
)
: Promise<void>

호스트 액세스 요청을 추가합니다. 요청에서 확장 프로그램에 호스트 액세스 권한을 부여할 수 있는 경우에만 사용자에게 요청이 전달됩니다. 요청은 교차 출처 탐색 시 재설정됩니다. 수락되면 사이트의 최상위 출처에 지속적인 액세스 권한을 부여합니다.

매개변수

  • 요청

    객체

    • documentId

      문자열 선택사항

      호스트 액세스 요청이 표시될 수 있는 문서의 ID입니다. 탭 내의 최상위 문서여야 합니다. 제공된 경우 요청은 지정된 문서의 탭에 표시되며 문서가 새 출처로 이동하면 삭제됩니다. 새 요청을 추가하면 tabId에 대한 기존 요청이 재정의됩니다. 이 값 또는 tabId을 지정해야 합니다.

    • 패턴

      문자열 선택사항

      호스트 액세스 요청이 표시될 수 있는 URL 패턴입니다. 제공된 경우 호스트 액세스 요청은 이 패턴과 일치하는 URL에만 표시됩니다.

    • tabId

      번호 선택사항

      호스트 액세스 요청이 표시될 수 있는 탭의 ID입니다. 제공된 경우 요청은 지정된 탭에 표시되며 탭이 새 출처로 이동하면 삭제됩니다. 새 요청을 추가하면 documentId에 대한 기존 요청이 재정의됩니다. 이 값 또는 documentId을 지정해야 합니다.

반환 값

  • Promise<void>

contains()

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

확장 프로그램에 지정된 권한이 있는지 확인합니다.

매개변수

반환 값

  • Promise<boolean>

    Chrome 96 이상

getAll()

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

확장 프로그램의 현재 권한 집합을 가져옵니다.

반환 값

remove()

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

지정된 권한에 대한 액세스 권한을 삭제합니다. 권한을 삭제하는 데 문제가 있으면 runtime.lastError이 설정됩니다.

매개변수

반환 값

  • Promise<boolean>

    Chrome 96 이상

removeHostAccessRequest()

Chrome 133 이상 MV3 이상
chrome.permissions.removeHostAccessRequest(
  request: object,
)
: Promise<void>

호스트 액세스 요청이 있는 경우 삭제합니다.

매개변수

  • 요청

    객체

    • documentId

      문자열 선택사항

      호스트 액세스 요청이 삭제될 문서의 ID입니다. 탭 내의 최상위 문서여야 합니다. 이 값 또는 tabId을 지정해야 합니다.

    • 패턴

      문자열 선택사항

      호스트 액세스 요청이 삭제될 URL 패턴입니다. 제공되는 경우 기존 호스트 액세스 요청의 패턴과 정확하게 일치해야 합니다.

    • tabId

      번호 선택사항

      호스트 액세스 요청이 삭제될 탭의 ID입니다. 이 값 또는 documentId을 지정해야 합니다.

반환 값

  • Promise<void>

request()

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

지정된 권한에 대한 액세스를 요청하고 필요한 경우 사용자에게 메시지를 표시합니다. 이러한 권한은 매니페스트의 optional_permissions 필드에 정의되어 있거나 사용자가 보류한 필수 권한이어야 합니다. 출처 패턴의 경로는 무시됩니다. 선택적 출처 권한의 하위 집합을 요청할 수 있습니다. 예를 들어 매니페스트의 optional_permissions 섹션에 *://*\/*를 지정하면 http://example.com/를 요청할 수 있습니다. 권한 요청에 문제가 있으면 runtime.lastError이 설정됩니다.

매개변수

반환 값

  • Promise<boolean>

    Chrome 96 이상

이벤트

onAdded

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

확장 프로그램이 새 권한을 획득할 때 발생합니다.

매개변수

  • callback

    함수

    callback 매개변수는 다음과 같습니다.

    (permissions: Permissions) => void

onRemoved

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

확장에서 권한에 대한 액세스가 삭제될 때 발생합니다.

매개변수

  • callback

    함수

    callback 매개변수는 다음과 같습니다.

    (permissions: Permissions) => void