{"id":18417968,"url":"https://github.com/quark-engine/quickstart-codeql","last_synced_at":"2025-06-15T10:38:38.354Z","repository":{"id":100116627,"uuid":"564194277","full_name":"quark-engine/quickstart-codeql","owner":"quark-engine","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-10T07:36:00.000Z","size":1,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-13T08:55:54.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quark-engine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-10T07:35:39.000Z","updated_at":"2022-11-10T07:35:39.000Z","dependencies_parsed_at":"2023-03-13T15:39:51.600Z","dependency_job_id":null,"html_url":"https://github.com/quark-engine/quickstart-codeql","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/quark-engine/quickstart-codeql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quark-engine%2Fquickstart-codeql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quark-engine%2Fquickstart-codeql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quark-engine%2Fquickstart-codeql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quark-engine%2Fquickstart-codeql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quark-engine","download_url":"https://codeload.github.com/quark-engine/quickstart-codeql/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quark-engine%2Fquickstart-codeql/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259960589,"owners_count":22938092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T04:12:24.638Z","updated_at":"2025-06-15T10:38:38.332Z","avatar_url":"https://github.com/quark-engine.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# QuickStart CodeQL\nIn this tutorial, we will learn how to install and run CodeQL with an easy example.\nWe show how to detect CWE-798 in an Android application [ovaa](https://github.com/oversecured/ovaa).\n\n### Step1: Install CodeQL\n\n1. Download the CodeQL CLI bundle\n\n```\n$ wget https://github.com/github/codeql-action/releases/latest/download/codeql-bundle.tar.gz\n$ tar -xvzf ./codeql-bundle.tar.gz\n```\n\n2. Adding `/\u003cextraction-root\u003e/codeql` to your PATH, so that you can run the executable as just CodeQL.\n\n\n### Step2: Download the detection script\n\nClone CodeQL script repository by running:\n```\n$ git clone https://github.com/github/codeql.git\n```\n### Step3: Download the ovaa source code\n\nClone the ovaa source code repository by running:\n```\n$ git clone https://github.com/oversecured/ovaa.git\n```\n\n### Step4: Create CodeQL database\n\nCreate CodeQL ovaa database by running:\n```\n$ codeql database create ovaa-db/ -l=java -c='./gradlew --no-daemon clean assembleRelease' --overwrite\n```\n\n### Step5: Analyze the sample with CWE-798 script\n\n- Analyzing ovaa with Codeql CWE-798 script.\n```\n$ codeql database analyze ovaa-db --format=csv --output=result.csv codeql/java/ql/src/Security/CWE/CWE-798/HardcodedCredentialsApiCall.ql\n```\n\n- You should now see the message in the terminal:\n```\nRunning queries.\nDid not find any ML models.\n[1/1] No need to rerun codeql/java/ql/src/Security/CWE/CWE-798/HardcodedCredentialsApiCall.ql.\nShutting down query evaluator.\nInterpreting results.\n```\n\n- The result will be saved in `result.csv`.\n\n\nHere is the excerpt from `result.csv`. It shows where the CWE-798 occured.\n![](https://i.imgur.com/2lWAXEN.png)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquark-engine%2Fquickstart-codeql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquark-engine%2Fquickstart-codeql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquark-engine%2Fquickstart-codeql/lists"}