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

Abierto
  • ¿Algo no está bien?
#84 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
56/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
bash, shell
Área
security, tooling

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Shell
Estrellas
16
Forks
9
Merge medio
1 d 17 h
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de CreativesLibrary/oss-launch

Todos los issues de CreativesLibrary/oss-launch

Issues similares

Más issues de Shell/Bash

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.