콘텐츠 스크립트

콘텐츠 스크립트는 웹페이지 컨텍스트에서 실행되는 파일입니다. 표준 문서 객체 모델 (DOM)을 사용하여 브라우저가 방문하는 웹페이지의 세부정보를 읽고, 이를 변경하고, 상위 확장 프로그램에 정보를 전달할 수 있습니다.

콘텐츠 스크립트 기능 이해하기

콘텐츠 스크립트는 확장 프로그램과 메시지를 교환하여 상위 확장 프로그램에서 사용하는 Chrome API에 액세스할 수 있습니다. chrome.runtime.getURL()를 사용하여 확장 프로그램 파일의 URL에 액세스하고 다른 URL과 동일한 결과를 사용할 수도 있습니다.

// Code for displaying EXTENSION_DIR/images/myimage.png:
var imgURL = chrome.runtime.getURL("images/myimage.png");
document.getElementById("someImage").src = imgURL;

또한 콘텐츠 스크립트는 다음 Chrome API에 직접 액세스할 수 있습니다.

콘텐츠 스크립트는 다른 API에 직접 액세스할 수 없습니다.

격리된 환경에서 작업

콘텐츠 스크립트는 격리된 환경에 있으므로 콘텐츠 스크립트가 페이지나 추가 콘텐츠 스크립트와 충돌하지 않고 JavaScript 환경을 변경할 수 있습니다.

확장 프로그램은 아래 예와 유사한 코드로 웹페이지에서 실행될 수 있습니다.

<html>
  <button id="mybutton">click me</button>
  <script>
    var greeting = "hello, ";
    var button = document.getElementById("mybutton");
    button.person_name = "Bob";
    button.addEventListener("click", function() {
      alert(greeting + button.person_name + ".");
    }, false);
  </script>
</html>

이 확장 프로그램은 다음 콘텐츠 스크립트를 삽입할 수 있습니다.

var greeting = "hola, ";
var button = document.getElementById("mybutton");
button.person_name = "Roberto";
button.addEventListener("click", function() {
  alert(greeting + button.person_name + ".");
}, false);

버튼을 누르면 두 알림이 모두 표시됩니다.

격리된 세계에서는 콘텐츠 스크립트, 확장 프로그램, 웹페이지가 다른 항목에서 만든 변수나 함수에 액세스할 수 없습니다. 또한 콘텐츠 스크립트는 웹페이지에서 액세스할 수 없는 기능을 사용 설정할 수 있습니다.

스크립트 삽입

콘텐츠 스크립트는 프로그래매틱 방식으로 또는 선언 방식으로 삽입할 수 있습니다.

프로그래매틱 방식으로 삽입

특정 경우에 실행해야 하는 콘텐츠 스크립트에 프로그래매틱 삽입을 사용합니다.

프로그래매틱 콘텐츠 스크립트를 삽입하려면 매니페스트에 activeTab 권한을 제공합니다. 이렇게 하면 활성 사이트의 호스트에 대한 안전한 액세스 권한과 탭 권한에 대한 임시 액세스 권한이 부여되므로 콘텐츠 스크립트가 교차 출처 권한을 지정하지 않고도 현재 활성 탭에서 실행될 수 있습니다.

{
  "name": "My extension",
  ...
  "permissions": [
    "activeTab"
  ],
  ...
}

콘텐츠 스크립트는 코드로 삽입할 수 있습니다.

chrome.runtime.onMessage.addListener(
  function(message, callback) {
    if (message == "changeColor"){
      chrome.tabs.executeScript({
        code: 'document.body.style.backgroundColor="orange"'
      });
    }
  });

또는 전체 파일을 삽입할 수 있습니다.

chrome.runtime.onMessage.addListener(
  function(message, callback) {
    if (message == "runContentScript"){
      chrome.tabs.executeScript({
        file: 'contentScript.js'
      });
    }
  });

선언적 삽입

지정된 페이지에서 자동으로 실행되어야 하는 콘텐츠 스크립트에 선언적 삽입을 사용합니다.

선언적으로 삽입된 스크립트는 매니페스트의 "content_scripts" 필드 아래에 등록됩니다. JavaScript 파일, CSS 파일 또는 둘 다를 포함할 수 있습니다. 모든 자동 실행 콘텐츠 스크립트는 일치 패턴을 지정해야 합니다.

{
 "name": "My extension",
 ...
 "content_scripts": [
   {
     "matches": ["http://*.nytimes.com/*"],
     "css": ["myStyles.css"],
     "js": ["contentScript.js"]
   }
 ],
 ...
}
이름 유형 설명
matches {: #matches } 문자열 배열 필수사항. 이 콘텐츠 스크립트가 삽입될 페이지를 지정합니다. 이러한 문자열의 문법에 관한 자세한 내용은 일치 패턴을 참고하고 URL을 제외하는 방법에 관한 자세한 내용은 일치 패턴 및 글롭을 참고하세요.
css {: #css } 문자열 배열 선택사항. 일치하는 페이지에 삽입할 CSS 파일 목록입니다. 이러한 스크립트는 페이지의 DOM이 생성되거나 표시되기 전에 이 배열에 표시된 순서대로 삽입됩니다.
js {: #js } 문자열 배열 선택사항. 일치하는 페이지에 삽입할 JavaScript 파일 목록입니다. 이 배열에 표시된 순서대로 삽입됩니다.
match_about_blank {: #match_about_blank } 부울 선택사항. 상위 요소 또는 opener 프레임이 matches에 선언된 패턴 중 하나와 일치하는 about:blank 프레임에 스크립트를 삽입해야 하는지 여부입니다. 기본값은 false입니다.

일치 및 글러브 제외

지정된 페이지 일치는 매니페스트 등록에 다음 필드를 포함하여 맞춤설정할 수 있습니다.

이름 유형 설명
exclude_matches {: #exclude_matches } 문자열 배열 선택사항. 이 콘텐츠 스크립트가 삽입될 페이지를 제외합니다. 이러한 문자열의 문법에 관한 자세한 내용은 일치 패턴을 참고하세요.
include_globs {: #include_globs } 문자열 배열 선택사항. 이 글롭과도 일치하는 URL만 포함하도록 matches 뒤에 적용됩니다. @include Greasemonkey 키워드를 에뮬레이션하기 위한 용도입니다.
exclude_globs {: #exclude_globs } 문자열 배열 선택사항. 이 글롭과 일치하는 URL을 제외하기 위해 matches 뒤에 적용됩니다. @excludeGreasemonkey 키워드를 에뮬레이션하기 위한 용도입니다.

URL이 exclude_matches 또는 exclude_globs 패턴과 일치하지 않는 한 URL이 matches 패턴과 include_globs 패턴과 일치하는 경우 콘텐츠 스크립트가 페이지에 삽입됩니다.

matches 속성이 필요하므로 exclude_matches, include_globs, exclude_globs는 영향을 받는 페이지를 제한하는 데만 사용할 수 있습니다.

다음 확장 프로그램은 콘텐츠 스크립트를 http://www.nytimes.com/ health에는 삽입했지만 http://www.nytimes.com/ business에는 삽입하지 않았습니다 .

{
  "name": "My extension",
  ...
  "content_scripts": [
    {
      "matches": ["http://*.nytimes.com/*"],
      "exclude_matches": ["*://*/*business*"],
      "js": ["contentScript.js"]
    }
  ],
  ...
}

glob 속성은 일치 패턴과는 다른, 더 유연한 문법을 따릅니다. 허용되는 글러브 문자열은 '와일드 카드' 별표 및 물음표가 포함될 수 있는 URL입니다. 별표(*)는 빈 문자열을 포함하여 모든 길이의 문자열과 일치하며, 물음표(?)는 단일 문자와 일치합니다.

예를 들어 글로브 http:// ??? .example.com/foo/ *는 다음 중 하나와 일치합니다.

  • http:// www .example.com/foo /bar
  • http:// the .example.com/foo /

하지만 다음과는 일치하지 않습니다.

  • http:// my .example.com/foo/bar
  • http:// example .com/foo/
  • http://www.example.com/foo

이 확장 프로그램은 콘텐츠 스크립트를 http:/www.nytimes.com/ arts /index.html 및 http://www.nytimes.com/ jobs /index.html에 삽입하지만 http://www.nytimes.com/ sports/index.html에는 삽입하지 않습니다.

{
  "name": "My extension",
  ...
  "content_scripts": [
    {
      "matches": ["http://*.nytimes.com/*"],
      "include_globs": ["*nytimes.com/???s/*"],
      "js": ["contentScript.js"]
    }
  ],
  ...
}

이 확장 프로그램은 콘텐츠 스크립트를 http:// history .nytimes.com 및 http://.nytimes.com/ history에 삽입하지만 http:// science .nytimes.com 또는 http://www.nytimes.com/ science에는 삽입하지 않습니다 .

{
  "name": "My extension",
  ...
  "content_scripts": [
    {
      "matches": ["http://*.nytimes.com/*"],
      "exclude_globs": ["*science*"],
      "js": ["contentScript.js"]
    }
  ],
  ...
}

올바른 범위를 달성하기 위해 이 중 하나 또는 전부를 포함할 수 있습니다.

{
  "name": "My extension",
  ...
  "content_scripts": [
    {
      "matches": ["http://*.nytimes.com/*"],
      "exclude_matches": ["*://*/*business*"],
      "include_globs": ["*nytimes.com/???s/*"],
      "exclude_globs": ["*science*"],
      "js": ["contentScript.js"]
    }
  ],
  ...
}

운영 기간

JavaScript 파일이 웹페이지에 삽입되는 시점은 run_at 필드에 의해 제어됩니다. 기본 필드는 "document_idle"이지만 필요한 경우 "document_start" 또는 "document_end"로 지정할 수도 있습니다.

{
  "name": "My extension",
  ...
  "content_scripts": [
    {
      "matches": ["http://*.nytimes.com/*"],
      "run_at": "document_idle",
      "js": ["contentScript.js"]
    }
  ],
  ...
}
이름 유형 설명
document_idle {: #document_idle } 문자열 선호. 가능하면 "document_idle"를 사용하세요.

브라우저는 "document_end"와 windowonload 이벤트가 발생한 직후 사이에 스크립트를 삽입할 시간을 선택합니다. 정확한 삽입 시점은 문서의 복잡도와 로드하는 데 걸리는 시간에 따라 다르며 페이지 로드 속도에 맞게 최적화됩니다.

"document_idle"에서 실행되는 콘텐츠 스크립트는 window.onload 이벤트를 수신 대기할 필요가 없습니다. DOM이 완료된 후에 실행되기 때문입니다. 스크립트가 window.onload 후에 실행되어야 하는 경우 확장 프로그램은 document.readyState 속성을 사용하여 onload가 이미 실행되었는지 확인할 수 있습니다.
document_start {: #document_start } 문자열 스크립트는 css의 파일 뒤에, 다른 DOM이 생성되거나 다른 스크립트가 실행되기 전에 삽입됩니다.
document_end {: #document_end } 문자열 스크립트는 DOM이 완료된 직후, 하지만 이미지 및 프레임과 같은 하위 리소스가 로드되기 전에 삽입됩니다.

프레임 지정

"all_frames" 필드를 사용하면 확장 프로그램에서 JavaScript 및 CSS 파일을 지정된 URL 요구사항과 일치하는 모든 프레임에 삽입해야 하는지 또는 탭의 최상위 프레임에만 삽입해야 하는지 지정할 수 있습니다.

{
  "name": "My extension",
  ...
  "content_scripts": [
    {
      "matches": ["http://*.nytimes.com/*"],
      "all_frames": true,
      "js": ["contentScript.js"]
    }
  ],
  ...
}
이름 유형 설명
all_frames {: #all_frames } 부울 선택사항. 기본값은 false로, 이는 최상위 프레임만 일치함을 의미합니다.

true를 지정하면 프레임이 탭에서 최상위 프레임이 아니더라도 모든 프레임에 삽입됩니다. 각 프레임은 URL 요구사항에 대해 개별적으로 확인되며, URL 요구사항이 충족되지 않으면 하위 프레임에 삽입되지 않습니다.

삽입 페이지와의 통신

콘텐츠 스크립트의 실행 환경과 이를 호스팅하는 페이지는 서로 격리되어 있지만 페이지의 DOM에 대한 액세스 권한은 공유합니다. 페이지가 콘텐츠 스크립트와 통신하거나 콘텐츠 스크립트를 통해 확장 프로그램과 통신하려면 공유 DOM을 통해야 합니다.

예를 들어 window.postMessage을 사용하면 다음과 같이 할 수 있습니다.

var port = chrome.runtime.connect();

window.addEventListener("message", function(event) {
  // We only accept messages from ourselves
  if (event.source != window)
    return;

  if (event.data.type && (event.data.type == "FROM_PAGE")) {
    console.log("Content script received: " + event.data.text);
    port.postMessage(event.data.text);
  }
}, false);

document.getElementById("theButton").addEventListener("click",
    function() {
  window.postMessage({ type: "FROM_PAGE", text: "Hello from the webpage!" }, "*");
}, false);

확장 프로그램이 아닌 페이지인 example.html이 자체적으로 메시지를 게시합니다. 이 메시지는 콘텐츠 스크립트에 의해 가로채지고 검사된 후 확장 프로그램 프로세스에 게시됩니다. 이렇게 하면 페이지가 확장 프로그램 프로세스와의 통신 라인을 설정합니다. 유사한 방법으로 역전도 가능합니다.

보안 유지

격리된 세계는 한 층의 보호를 제공하지만 콘텐츠 스크립트를 사용하면 확장 프로그램과 웹페이지에 취약점이 발생할 수 있습니다. 콘텐츠 스크립트가 별도의 웹사이트에서 콘텐츠를 수신하는 경우(예: XMLHttpRequest 만들기) 콘텐츠를 삽입하기 전에 콘텐츠 교차 사이트 스크립팅 공격을 필터링해야 합니다. "man-in-the-middle" 공격을 방지하려면 HTTPS를 통해서만 통신하세요.

악성 웹페이지를 필터링해야 합니다. 예를 들어 다음 패턴은 위험합니다.

var data = document.getElementById("json-data")
// WARNING! Might be evaluating an evil script!
var parsed = eval("(" + data + ")")

var elmt_id = ...
// WARNING! elmt_id might be "); ... evil script ... //"!
window.setTimeout("animate(" + elmt_id + ")", 200);

대신 스크립트를 실행하지 않는 더 안전한 API를 사용하세요.

var data = document.getElementById("json-data")
// JSON.parse does not evaluate the attacker's scripts.
var parsed = JSON.parse(data);

var elmt_id = ...
// The closure form of setTimeout does not evaluate scripts.
window.setTimeout(function() {
  animate(elmt_id);
}, 200);