Skip to content

Make browser extension setup reproducible #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jt55401 merged 2 commits into from
Aug 28, 2026
Merged

Make browser extension setup reproducible #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f30db89
docs: correct browser reference quick start
jt55401 Aug 27, 2026
fe89459
chore(deps): clear npm audit advisories
jt55401 Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ src/
├── platforms/ # 🔴 BROWSER-SPECIFIC — one adapter per browser
│ ├── common/ # PlatformAdapter interface (storage, messaging, tabs, scripting)
│ ├── chromium/ # Chrome / Edge implementation + Manifest V3
│ ├── firefox/ # Future — Manifest V2 (manifest only, no adapter yet)
│ └── safari/ # Future — Manifest V3 (manifest only, no adapter yet)
│ ├── firefox/ # Future, Manifest V2 (manifest only, no adapter yet)
│ └── safari/ # Future, Manifest V3 (manifest only, no adapter yet)
├── ui/ # ✅ SHARED — React components for popup, options, and in-page UI
│ ├── components/ # Reusable widgets (Button, MetadataInput, ProfileManager, etc.)
│ ├── popup/ # Extension popup (verification status, signing controls)
Expand Down Expand Up @@ -70,16 +70,27 @@ workspace/
└── htmltrust-browser-reference/
```

The canonicalization package is downloaded from its pinned v0.2.2 release archive, so only the browser-client sibling is required.
The canonicalization package is downloaded from its pinned v0.2.2 release archive. The browser-client sibling must be built before installing this package.

### Build
### Clean checkout

```sh
mkdir htmltrust-workspace
cd htmltrust-workspace
git clone https://github.com/HTMLTrust/htmltrust-browser-client.git
git clone https://github.com/HTMLTrust/htmltrust-browser-reference.git
cd htmltrust-browser-reference
npm ci
cd htmltrust-browser-client
git checkout 09e8c7552c8111a2cedd83fa45f4ffe3811bf5ca
npm ci --ignore-scripts
npm run build
cd ../htmltrust-browser-reference
npm ci --ignore-scripts
```

The browser-client commit above is the revision pinned by the reference repository's CI. Keep the checkout at that revision when reproducing CI locally.

### Build

Build for a specific browser:

```sh
Expand Down Expand Up @@ -114,6 +125,16 @@ npm run typecheck # TypeScript check without emitting files
npm run lint # Lint TypeScript sources
```

The CI validation sequence runs `npm run lint`, `npm test`, and each browser build:

```sh
npm run lint
npm test
npm run build:chromium
npm run build:firefox
npm run build:safari
```

## Project Structure

```
Expand All @@ -124,16 +145,16 @@ npm run lint # Lint TypeScript sources
├── tsconfig.json
├── webpack.config.js
├── jest.config.js
└── .eslintrc.js
└── eslint.config.js
```

## Current Status

- ✅ Chromium adapter fully implemented
- ✅ Core content verification pipeline
- ✅ React popup and options UI
- ⬜ Firefox adapter (manifest only — needs `browser.*` API adapter)
- ⬜ Safari adapter (manifest only — needs adapter)
- ⬜ Firefox adapter, manifest only, needs a `browser.*` API adapter
- ⬜ Safari adapter, manifest only, needs an adapter

## Companion Repositories

Expand Down
Loading
Loading