audit.sh: add a GDPR compliance check for repos that handle personal data

未关闭
#84 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
56/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
bash, shell
领域
security, tooling

调研方向

Start with scripts/audit.sh, the existing optional site-file check, and scripts/lib/detect-privacy.sh; inspect tests/run.sh for fixture conventions. Add checks for the listed privacy signals, notices and contacts, and the consent reminder for tracking signals, while skipping dependency, lock and build output. Done means the specified fixtures pass, ShellCheck passes, Bash 3.2 works, and output describes the heuristic without claiming compliance or giving legal advice.

由索引模型根据 Issue 内容生成。

描述

enhancement

Problem

scripts/audit.sh checks for the standard OSS files and has no privacy check at all. A repo can load Google Analytics or collect sign-ups from EU visitors, have no privacy notice, and still get a perfect audit score. GDPR Article 13 requires telling people what is collected at the point of collection, so this is a gap in a tool whose job is getting a repo ready to go public.

Proposed check

Add a GDPR check that runs only when the repo shows signs of handling personal data, the same way the Optional site-file block only prints when detect_site_framework finds a site. Put detection in scripts/lib/detect-privacy.sh.

Signals to look for in manifests and source:

Signal Examples
Analytics and tracking @vercel/analytics, posthog-js, mixpanel, @segment/*, @amplitude/*, react-ga*, gtag(, googletagmanager.com, connect.facebook.net, hotjar
Accounts and user data @supabase/*, firebase, next-auth, @auth/*, @clerk/*
Error tracking @sentry/*
Third-party assets fetched by the visitor's browser fonts.googleapis.com

When a signal is found, report:

  • Whether a privacy notice exists (PRIVACY.md, or a privacy page or route for a detected site).
  • Whether a privacy contact is named in it.
  • For analytics and tracking signals, a reminder to confirm consent is collected before non-essential cookies are set. A scan cannot prove this, so it stays a prompt.

Each finding names the signal and the file it was found in, so the result can be checked by hand.

Limits

This reports signals. It is not a legal review, and it can't tell whether a project is compliant. The output must say so and must never print "GDPR compliant".

Done when

  • A fixture with @vercel/analytics and no privacy notice gets a warning naming the package and the file.
  • The same fixture with a PRIVACY.md gets no missing-notice warning.
  • A fixture with no signals prints nothing new, and its score is unchanged.
  • node_modules, lockfiles, and build output are not scanned.
  • The output states that this is a heuristic and not legal advice.
  • tests/run.sh covers the cases above, shellcheck passes, and the script runs on bash 3.2.

A templates/PRIVACY.md that apply.sh can generate is a sensible follow-up, but it is out of scope here.

主要语言
Shell
星标
16
派生
9
平均合并
1 天 17 小时
30 天内合并 PR
1

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

CreativesLibrary/oss-launch 的其他 Issue

查看 CreativesLibrary/oss-launch 的全部 Issue

相似的 Issue

更多 Shell/Bash Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。