freedomofpress / freedomofpress/webcat-cli

Evaluate CSP

Open
#3 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

People who want to enroll their domain name and website in WEBCAT will benefit from a quick way to verify their Content Security Policy is compatible.

I propose a CLI tool like

npx webcat enrollment evaulate

which returns an exit code indicating if the CSP passes the test.

Or, perhaps

cspresso https://example.com  --evaluate

followed by a candidate policy argument that determines WEBCAT compatibility

Whatever the method, it should be documented in the WEBCAT CLI README as a single-line command giving a quick yes-or-no answer to a potential WEBCAT enrollee.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the WEBCAT CLI README section “Prepare the web application for compatibility” and compare the two proposed command forms: npx webcat enrollment evaulate and cspresso https://example.com --evaluate. Define the compatibility check and command interface before implementing a single-line command that returns a yes-or-no exit result and is documented in the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, documentation, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.