Skip to content
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.

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

Talk about CodeQL from GitHub #564

Closed
3 of 7 tasks
binkley opened this issue Jul 4, 2024 · 0 comments
Closed
3 of 7 tasks

Talk about CodeQL from GitHub #564

binkley opened this issue Jul 4, 2024 · 0 comments
Labels
enhancement New feature or request security Shifting security left

Comments

@binkley
Copy link
Owner

binkley commented Jul 4, 2024

This is part of the epic #462 on quality.
This is part of the epic #586 on badges.. Badge card is here: #597

We have this turned on in GitHub actions. It is a checkbox to enable, but no one is sure what it does, or how to see reports.

  • If it is not helpful, consider removing from CI build -- KEEP.
  • Decide if we should discuss CodeQL, or merely reference it in the Use static analysis page ("Going further" at bottom of that page).
  • Go through the github codeql basics tutorial (https://github.com/skills/introduction-to-codeql)
  • Delete codeql action from mjp and re-add according to what you did in the tutorial. The next two items might not be an issue after doing this step.
  • Resolve the CodeQL warnings (see image below).
  • Add a custom GH action file to enable CodeQL -- the default is not helping us.
  • Add writing to discuss alongside other quality features like Spotless, etc. - mention licensing implications. Mention in security page, spillover into static analysis. Mention the tutorial, provide link(s)

Need a negative test

We should be able to force CodeQL to fail in CI as validation it is working.
See codeql-test branch.

Out of scope

  • Plugins for IDEs such as VSCode
  • Update configuration in github to generate sarif file - out of scope
  • Explore visualization of SARIF file - out of scope
  • Try to get the starter kit "working" in VSCode https://github.com/github/vscode-codeql-starter/
  • Configure VSCode agent to point to modern-java-practices

See https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning.

CodeQL is a feature from GitHub enabled in https://github.com/binkley/modern-java-practices/settings/security_analysis.

Example warning message:
Image

relevant link: https://medium.com/@joas.brito/codeql-finding-security-vulnerabilities-in-your-code-52f5bf28e7f

@binkley binkley moved this to Analysis in @binkley's Modern Build Jul 9, 2024
@binkley binkley added the security Shifting security left label Jul 9, 2024
@binkley binkley moved this from Analysis to Ready in @binkley's Modern Build Jul 9, 2024
@binkley binkley moved this from Ready to In progress in @binkley's Modern Build Jul 9, 2024
@binkley binkley assigned binkley and jwlibby and unassigned binkley Jul 9, 2024
@binkley binkley moved this from In progress to Ready in @binkley's Modern Build Jul 10, 2024
@binkley binkley added the enhancement New feature or request label Jul 10, 2024
@jwlibby jwlibby moved this from Ready to In progress in @binkley's Modern Build Jul 10, 2024
@jwlibby jwlibby self-assigned this Jul 10, 2024
@jwlibby jwlibby moved this to Analysis in @binkley's Modern Build Jul 16, 2024
@jwlibby jwlibby moved this from Analysis to In progress in @binkley's Modern Build Jul 16, 2024
@jwlibby jwlibby mentioned this issue Jul 25, 2024
2 tasks
@binkley binkley assigned binkley and unassigned binkley Aug 5, 2024
binkley added a commit that referenced this issue Aug 5, 2024
@jwlibby jwlibby moved this from In progress to In review in @binkley's Modern Build Aug 7, 2024
@binkley binkley closed this as completed Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request security Shifting security left
Projects
Status: Done
Development

No branches or pull requests

2 participants