HTTPS Everywhere 项目使用教程

HTTPS Everywhere 项目使用教程

https-everywhere A browser extension that encrypts your communications with many websites that offer HTTPS but still allow unencrypted connections. 项目地址: https://gitcode.com/gh_mirrors/ht/https-everywhere

1. 项目目录结构及介绍

HTTPS Everywhere 项目目录结构如下：

.
├── .github
├── browser-dist
├── chromium
├── docs
├── hooks
├── lib-wasm
├── src
├── test
├── translations
├── utils
├── .build_exclusions
├── .dockerignore
├── .editorconfig
├── .gitignore
├── .gitmodules
├── .travis.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE.txt
├── README.md
├── SECURITY.md
├── dummy-chromium.pem
├── install-dev-dependencies.sh
├── make.sh
├── requirements.txt
├── rules
├── ruleset-testing.md
├── test.sh
└── ...

以下是主要目录和文件的介绍：

• .github: 存放 GitHub 相关的配置文件，例如 Pull Request 模板等。
• browser-dist: 存放编译后的浏览器扩展文件。
• chromium: 与 Chromium 浏览器相关的内容。
• docs: 项目文档。
• hooks: Git 钩子文件，用于自动化一些 Git 操作。
• lib-wasm: WebAssembly 相关的库文件。
• src: 源代码目录，包含项目的核心代码。
• test: 测试文件和测试代码。
• translations: 存放项目翻译的文件。
• utils: 实用工具脚本和库。
• .build_exclusions: 构建过程中的排除文件列表。
• .dockerignore: Docker 忽略文件列表。
• .editorconfig: 编辑器配置文件，用于统一不同开发者的编辑器设置。
• .gitignore: Git 忽略文件列表。
• .gitmodules: Git 子模块配置文件。
• .travis.yml: Travis CI 的配置文件，用于自动化测试和部署。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南，指导如何为项目贡献代码。
• Dockerfile: Docker 镜像构建文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和说明。
• SECURITY.md: 安全相关的指南和报告漏洞的方法。
• dummy-chromium.pem: 测试用的 Chromium 证书文件。
• install-dev-dependencies.sh: 安装开发依赖的脚本。
• make.sh: 构建项目的脚本。
• requirements.txt: 项目依赖的 Python 库列表。
• rules: 规则文件，定义了 HTTPS Everywhere 的规则集。
• ruleset-testing.md: 规则集测试文档。

2. 项目的启动文件介绍

项目的启动主要依赖于 src 目录下的源代码。具体来说，src 目录中的 background.js 文件是扩展的入口点。这个文件负责监听浏览器事件，并根据定义的规则自动将 HTTP 请求升级到 HTTPS。

// background.js 示例代码
chrome.webRequest.onBeforeRequest.addListener(
  function(details) {
    // 根据规则进行请求重定向
  },
  { urls: ["<all_urls>"] },
  ["blocking"]
);

3. 项目的配置文件介绍

HTTPS Everywhere 的配置主要通过 rules 目录下的规则文件进行。这些文件定义了哪些网站和路径应该被强制使用 HTTPS。例如：

# example.txt 示例规则
example.com
https://example.com

上述规则表示所有访问 example.com 的请求都将被重定向到 https://example.com。

此外，项目的配置也可能涉及 manifest.json 文件，这是浏览器扩展的配置文件，定义了扩展的基本信息和权限。

{
  "manifest_version": 2,
  "name": "HTTPS Everywhere",
  "version": "2023.1.0",
  "permissions": ["webRequest", "webRequestBlocking", "<all_urls>"],
  // 其他配置...
}

以上就是 HTTPS Everywhere 项目的基本介绍和使用方法。在使用前，请确保已经根据项目要求安装了必要的依赖，并根据实际情况调整配置文件。

https-everywhere A browser extension that encrypts your communications with many websites that offer HTTPS but still allow unencrypted connections. 项目地址: https://gitcode.com/gh_mirrors/ht/https-everywhere