GitHub security workshop: Add a deterministic CodeQL scanning lab

Abierto
#271 1 comentario 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
50/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
github, github-actions, python

Línea de trabajo

Empieza revisando la aplicación pets y la guía de configuración existente del workshop; después, compara las opciones de configuración predeterminada y avanzada de CodeQL. Define un fixture exclusivo para formación o un cambio guiado, y documenta la consulta con nombre, la gravedad, el archivo, el flujo de datos, el desencadenador de branch o pull request, el paso de validación y el procedimiento de limpieza. Se considera terminado cuando la alerta aparece de forma fiable sin secretos, efectos secundarios ni una ruta de producción.

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

Descripción

priority: P2

Goal

Teach learners how to enable code scanning and observe a real, intentionally introduced CodeQL finding in the pets application.

Scope

Add one safe training change that is detected reliably by a documented Python CodeQL query. The vulnerable path should be realistic enough to teach source-to-sink reasoning, but isolated from normal workshop startup and clearly marked as training-only. Provide a maintainer verification procedure so dependency or query-suite updates cannot silently break the exercise.

Acceptance criteria

  • The exercise explains default setup versus advanced setup and selects one tested path.
  • Learners enable CodeQL using current, capability-based instructions.
  • A training fixture or guided code change triggers a named CodeQL query deterministically.
  • The fixture contains no real secret, external side effect, or production deployment path.
  • Learners trigger analysis on a branch or pull request and can identify the resulting check.
  • The expected query ID, severity, file, and vulnerable data flow are documented for maintainers.
  • A repeatable validation step proves the expected alert appears.
  • Cleanup/reset instructions return the repository to a safe state.
Lenguaje dominante
Python
Estrellas
80
Forks
161
Merge medio
31 min
PR fusionados (30 d)
1

Guía de contribución

Abrir la guía de contribución

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 github-samples/pets-workshop

Todos los issues de github-samples/pets-workshop

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.