chrome.proxy

refresh date: 2026-09-25 robots: noindex

Mô tả

Sử dụng API chrome.proxy để quản lý chế độ cài đặt proxy của Chrome. API này dựa vào nguyên mẫu ChromeSetting của API loại để lấy và đặt cấu hình proxy.

Quyền

proxy

Tệp kê khai

Bạn phải khai báo quyền "proxy" trong manifest của tiện ích để sử dụng API cài đặt proxy. Ví dụ:

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

Đối tượng và thuộc tính

Chế độ cài đặt proxy được xác định trong đối tượng proxy.ProxyConfig. Tuỳ thuộc vào chế độ cài đặt proxy của Chrome, chế độ cài đặt có thể chứa proxy.ProxyRules hoặc proxy.PacScript.

Chế độ proxy

Thuộc tính mode của đối tượng ProxyConfig xác định hành vi tổng thể của Chrome liên quan đến việc sử dụng proxy. Thuộc tính này có thể nhận các giá trị sau:

direct
Ở chế độ direct, tất cả các kết nối đều được tạo trực tiếp mà không cần proxy. Chế độ này không cho phép thêm tham số nào khác trong đối tượng ProxyConfig.
auto_detect
Trong chế độ auto_detect, cấu hình proxy được xác định bằng một tập lệnh PAC có thể tải xuống tại http://wpad/wpad.dat. Chế độ này không cho phép thêm tham số nào khác trong đối tượng ProxyConfig.
pac_script
Ở chế độ pac_script, cấu hình proxy được xác định bằng một tập lệnh PAC được truy xuất từ URL được chỉ định trong đối tượng proxy.PacScript hoặc được lấy theo nghĩa đen từ phần tử data được chỉ định trong đối tượng proxy.PacScript. Ngoài ra, chế độ này không cho phép thêm tham số nào khác trong đối tượng ProxyConfig.
fixed_servers
Ở chế độ fixed_servers, cấu hình proxy được mã hoá trong đối tượng proxy.ProxyRules. Cấu trúc của tệp này được mô tả trong phần Quy tắc proxy. Ngoài ra, chế độ fixed_servers không cho phép thêm tham số nào khác trong đối tượng ProxyConfig.
system
Ở chế độ system, cấu hình proxy được lấy từ hệ điều hành. Chế độ này không cho phép thêm tham số nào khác trong đối tượng ProxyConfig. Xin lưu ý rằng chế độ system khác với việc không đặt cấu hình proxy. Trong trường hợp sau, Chrome chỉ quay lại chế độ cài đặt hệ thống nếu không có tuỳ chọn dòng lệnh nào ảnh hưởng đến cấu hình proxy.

Quy tắc proxy

Đối tượng proxy.ProxyRules có thể chứa thuộc tính singleProxy hoặc một tập hợp con của proxyForHttp, proxyForHttps, proxyForFtp và fallbackProxy.

Trong trường hợp đầu tiên, lưu lượng truy cập HTTP, HTTPS và FTP được chuyển qua máy chủ proxy được chỉ định. Lưu lượng truy cập khác được gửi trực tiếp. Trong trường hợp sau, hành vi sẽ tinh tế hơn một chút: Nếu máy chủ proxy được định cấu hình cho giao thức HTTP, HTTPS hoặc FTP, thì lưu lượng truy cập tương ứng sẽ được chuyển qua máy chủ được chỉ định. Nếu không có máy chủ proxy nào được chỉ định hoặc lưu lượng truy cập sử dụng một giao thức khác với HTTP, HTTPS hoặc FTP, thì fallbackProxy sẽ được sử dụng. Nếu bạn không chỉ định fallbackProxy, thì lưu lượng truy cập sẽ được gửi trực tiếp mà không cần máy chủ proxy.

Đối tượng máy chủ proxy

Máy chủ proxy được định cấu hình trong đối tượng proxy.ProxyServer. Kết nối với máy chủ proxy (do thuộc tính host xác định) sử dụng giao thức được xác định trong thuộc tính scheme. Nếu không có scheme nào được chỉ định, thì kết nối proxy sẽ mặc định là http.

Nếu không có port nào được xác định trong đối tượng proxy.ProxyServer, thì cổng sẽ được lấy từ giao thức. Các cổng mặc định là:

Lược đồCổng
http80
https443
socks41080
socks51080

Danh sách được phép bỏ qua

Bạn có thể loại trừ từng máy chủ khỏi việc được uỷ quyền bằng bypassList. Danh sách này có thể chứa các mục sau:

[SCHEME://]HOST_PATTERN[:PORT]

Khớp với tất cả tên máy chủ khớp với mẫu HOST_PATTERN. "." ở đầu được hiểu là "*.".

Ví dụ: "foobar.com", "*foobar.com", "*.foobar.com", "*foobar.com:99", "https://x.*.y.com:99".

MẫuLiên kếtKết quả không khớp
".foobar.com""www.foobar.com""foobar.com"
"*.foobar.com""www.foobar.com""foobar.com"
"foobar.com""foobar.com""www.foobar.com"
"*foobar.com""foobar.com", "www.foobar.com", "foofoobar.com"
[SCHEME://]IP_LITERAL[:PORT]

Khớp với các URL là giá trị cố định dạng địa chỉ IP. Về mặt lý thuyết, điều này tương tự như trường hợp đầu tiên, nhưng có các trường hợp đặc biệt để xử lý việc chuẩn hoá giá trị cố định IP. Ví dụ: việc so khớp trên "[0:0:0::1]" cũng giống như so khớp trên "[::1]" vì quá trình chuẩn hoá IPv6 được thực hiện nội bộ.

Ví dụ: 127.0.1, [0:0::1], [::1]:80, https://[::1]:443

IP_LITERAL/PREFIX_LENGTH_IN_BITS

Khớp với bất kỳ URL nào chứa giá trị cố định IP (IP_LITERAL) trong phạm vi đã cho. Dải IP (PREFIX_LENGTH_IN_BITS) được chỉ định bằng ký hiệu CIDR.

Khớp với mọi URL chứa giá trị cố định IP trong dải ô đã cho. Dải IP được chỉ định bằng ký hiệu CIDR. Ví dụ: "192.168.1.1/16", "fefe:13::abc/33"

<local>

Chuỗi cố định <local> khớp với tên máy chủ đơn giản. Tên máy chủ đơn giản là tên không chứa dấu chấm và không phải là giá trị cố định kiểu IP. Ví dụ: example và localhost là tên máy chủ đơn giản, trong khi example.com, example. và [::1] thì không.

Ví dụ: "<local>"

Ví dụ

Mã sau đây đặt proxy SOCKS 5 cho các kết nối HTTP đến tất cả máy chủ ngoại trừ foobar.com và sử dụng kết nối trực tiếp cho tất cả các giao thức khác. Các chế độ cài đặt này áp dụng cho cả cửa sổ thông thường và cửa sổ ẩn danh, vì cửa sổ ẩn danh kế thừa chế độ cài đặt của cửa sổ thông thường. Vui lòng tham khảo tài liệu về Types API.

var config = {
  mode: "fixed_servers",
  rules: {
    proxyForHttp: {
      scheme: "socks5",
      host: "1.2.3.4"
    },
    bypassList: ["foobar.com"]
  }
};
chrome.proxy.settings.set(
  {value: config, scope: 'regular'},
  function() {}
);

Đoạn mã sau đây đặt tập lệnh PAC tuỳ chỉnh.

var config = {
  mode: "pac_script",
  pacScript: {
    data: "function FindProxyForURL(url, host) {\n" +
          "  if (host == 'foobar.com')\n" +
          "    return 'PROXY blackhole:80';\n" +
          "  return 'DIRECT';\n" +
          "}"
  }
};
chrome.proxy.settings.set(
  {value: config, scope: 'regular'},
  function() {}
);

Đoạn mã tiếp theo truy vấn các chế độ cài đặt proxy hiện có hiệu lực. Chế độ cài đặt proxy có hiệu lực có thể do một tiện ích khác hoặc một chính sách xác định. Hãy xem tài liệu về Types API để biết thông tin chi tiết.

chrome.proxy.settings.get(
  {'incognito': false},
  function(config) {
    console.log(JSON.stringify(config));
  }
);

Lưu ý rằng đối tượng value được truyền đến set() không giống với đối tượng value được truyền đến hàm callback của get(). Phần tử sau sẽ chứa một phần tử rules.proxyForHttp.port.

Loại

Mode

Chrome 54 trở lên

Enum

"direct"

"auto_detect"

"pac_script"

"fixed_servers"

"system"

PacScript

Một đối tượng chứa thông tin cấu hình tự động proxy. Chỉ được để trống một trong các trường.

Thuộc tính

  • khác

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

    Tập lệnh PAC.

  • bắt buộc

    boolean không bắt buộc

    Nếu bạn đặt chính sách này thành true, thì một tập lệnh PAC không hợp lệ sẽ ngăn bộ phần cứng và phần mềm mạng quay lại kết nối trực tiếp. Giá trị mặc định là false.

  • url

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

    URL của tệp PAC sẽ được sử dụng.

ProxyConfig

Một đối tượng đóng gói cấu hình proxy hoàn chỉnh.

Thuộc tính

  • chế độ

    "direct" = Không bao giờ sử dụng proxy "auto_detect" = Tự động phát hiện chế độ cài đặt proxy "pac_script" = Sử dụng tập lệnh PAC đã chỉ định "fixed_servers" = Chỉ định máy chủ proxy theo cách thủ công "system" = Sử dụng chế độ cài đặt proxy của hệ thống

  • pacScript

    PacScript không bắt buộc

    Tập lệnh cấu hình tự động proxy (PAC) cho cấu hình này. Sử dụng chế độ này cho chế độ "pac_script".

  • quy tắc

    ProxyRules không bắt buộc

    Quy tắc proxy mô tả cấu hình này. Sử dụng chế độ này cho chế độ "fixed_servers".

ProxyRules

Một đối tượng đóng gói tập hợp các quy tắc proxy cho tất cả giao thức. Sử dụng "singleProxy" hoặc (một nhóm nhỏ) "proxyForHttp", "proxyForHttps", "proxyForFtp" và "fallbackProxy".

Thuộc tính

  • bypassList

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

    Danh sách máy chủ cần kết nối mà không cần máy chủ proxy.

  • fallbackProxy

    ProxyServer không bắt buộc

    Máy chủ proxy được dùng cho mọi thứ khác hoặc nếu không có proxyFor... cụ thể nào được chỉ định.

  • proxyForFtp

    ProxyServer không bắt buộc

    Máy chủ proxy sẽ được dùng cho các yêu cầu FTP.

  • proxyForHttp

    ProxyServer không bắt buộc

    Máy chủ proxy sẽ được dùng cho các yêu cầu HTTP.

  • proxyForHttps

    ProxyServer không bắt buộc

    Máy chủ proxy được dùng cho các yêu cầu HTTPS.

  • singleProxy

    ProxyServer không bắt buộc

    Máy chủ proxy được dùng cho tất cả yêu cầu theo URL (tức là http, https và ftp).

ProxyServer

Một đối tượng đóng gói thông số kỹ thuật của một máy chủ proxy.

Thuộc tính

  • người tổ chức

    chuỗi

    Tên máy chủ hoặc địa chỉ IP của máy chủ proxy. Tên máy chủ phải ở dạng ASCII (theo định dạng Punycode). IDNA chưa được hỗ trợ.

  • cổng

    number không bắt buộc

    Cổng của máy chủ proxy. Giá trị mặc định là một cổng phụ thuộc vào lược đồ.

  • lược đồ

    Lược đồ không bắt buộc

    Lược đồ (giao thức) của chính máy chủ proxy. Giá trị mặc định là "http".

Scheme

Chrome 54 trở lên

Enum

"http"

"https"

"quic"

"socks4"

"socks5"

Thuộc tính

settings

Chế độ cài đặt proxy sẽ được sử dụng. Giá trị của chế độ cài đặt này là một đối tượng ProxyConfig.

Sự kiện

onProxyError

chrome.proxy.onProxyError.addListener(
  callback: function,
)

Thông báo về lỗi proxy.

Thông số

  • callback

    hàm

    Tham số callback có dạng như sau:

    (details: object) => void

    • chi tiết

      đối tượng

      • chi tiết

        chuỗi

        Thông tin chi tiết khác về lỗi, chẳng hạn như lỗi thời gian chạy JavaScript.

      • error

        chuỗi

        Nội dung mô tả về lỗi.

      • fatal

        boolean

        Nếu đúng, lỗi này là nghiêm trọng và giao dịch mạng đã bị huỷ. Nếu không, kết nối trực tiếp sẽ được sử dụng.