Skip to content

Commit 47d5f05

Browse files
committed
fix : add codeql & apisec-scan
1 parent a62398e commit 47d5f05

File tree

2 files changed

+172
-0
lines changed

2 files changed

+172
-0
lines changed

.github/workflows/apisec-scan.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# APIsec addresses the critical need to secure APIs before they reach production.
7+
# APIsec provides the industry’s only automated and continuous API testing platform that uncovers security vulnerabilities and logic flaws in APIs.
8+
# Clients rely on APIsec to evaluate every update and release, ensuring that no APIs go to production with vulnerabilities.
9+
10+
# How to Get Started with APIsec.ai
11+
# 1. Schedule a demo at https://www.apisec.ai/request-a-demo .
12+
#
13+
# 2. Register your account at https://cloud.apisec.ai/#/signup .
14+
#
15+
# 3. Register your API . See the video (https://www.youtube.com/watch?v=MK3Xo9Dbvac) to get up and running with APIsec quickly.
16+
#
17+
# 4. Get GitHub Actions scan attributes from APIsec Project -> Configurations -> Integrations -> CI-CD -> GitHub Actions
18+
#
19+
# apisec-run-scan
20+
#
21+
# This action triggers the on-demand scans for projects registered in APIsec.
22+
# If your GitHub account allows code scanning alerts, you can then upload the sarif file generated by this action to show the scan findings.
23+
# Else you can view the scan results from the project home page in APIsec Platform.
24+
# The link to view the scan results is also displayed on the console on successful completion of action.
25+
26+
# This is a starter workflow to help you get started with APIsec-Scan Actions
27+
28+
name: APIsec
29+
30+
# Controls when the workflow will run
31+
on:
32+
# Triggers the workflow on push or pull request events but only for the "main" branch
33+
# Customize trigger events based on your DevSecOps processes.
34+
push:
35+
branches: [ "main" ]
36+
pull_request:
37+
branches: [ "main" ]
38+
schedule:
39+
- cron: '32 22 * * 4'
40+
41+
# Allows you to run this workflow manually from the Actions tab
42+
workflow_dispatch:
43+
44+
45+
permissions:
46+
contents: read
47+
48+
jobs:
49+
50+
Trigger_APIsec_scan:
51+
permissions:
52+
security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
53+
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
54+
runs-on: ubuntu-latest
55+
56+
steps:
57+
- name: APIsec scan
58+
uses: apisec-inc/apisec-run-scan@025432089674a28ba8fb55f8ab06c10215e772ea
59+
with:
60+
# The APIsec username with which the scans will be executed
61+
apisec-username: ${{ secrets.apisec_username }}
62+
# The Password of the APIsec user with which the scans will be executed
63+
apisec-password: ${{ secrets.apisec_password}}
64+
# The name of the project for security scan
65+
apisec-project: "VAmPI"
66+
# The name of the sarif format result file The file is written only if this property is provided.
67+
sarif-result-file: "apisec-results.sarif"
68+
- name: Import results
69+
uses: github/codeql-action/upload-sarif@v3
70+
with:
71+
sarif_file: ./apisec-results.sarif

.github/workflows/codeql.yml

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL Advanced"
13+
14+
on:
15+
push:
16+
branches: [ "main" ]
17+
pull_request:
18+
branches: [ "main" ]
19+
schedule:
20+
- cron: '37 11 * * 1'
21+
22+
jobs:
23+
analyze:
24+
name: Analyze (${{ matrix.language }})
25+
# Runner size impacts CodeQL analysis time. To learn more, please see:
26+
# - https://gh.io/recommended-hardware-resources-for-running-codeql
27+
# - https://gh.io/supported-runners-and-hardware-resources
28+
# - https://gh.io/using-larger-runners (GitHub.com only)
29+
# Consider using larger runners or machines with greater resources for possible analysis time improvements.
30+
runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
31+
permissions:
32+
# required for all workflows
33+
security-events: write
34+
35+
# required to fetch internal or private CodeQL packs
36+
packages: read
37+
38+
# only required for workflows in private repositories
39+
actions: read
40+
contents: read
41+
42+
strategy:
43+
fail-fast: false
44+
matrix:
45+
include:
46+
- language: actions
47+
build-mode: none
48+
- language: java-kotlin
49+
build-mode: none # This mode only analyzes Java. Set this to 'autobuild' or 'manual' to analyze Kotlin too.
50+
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
51+
# Use `c-cpp` to analyze code written in C, C++ or both
52+
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
53+
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
54+
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
55+
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
56+
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
57+
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
58+
steps:
59+
- name: Checkout repository
60+
uses: actions/checkout@v4
61+
62+
# Add any setup steps before running the `github/codeql-action/init` action.
63+
# This includes steps like installing compilers or runtimes (`actions/setup-node`
64+
# or others). This is typically only required for manual builds.
65+
# - name: Setup runtime (example)
66+
# uses: actions/setup-example@v1
67+
68+
# Initializes the CodeQL tools for scanning.
69+
- name: Initialize CodeQL
70+
uses: github/codeql-action/init@v4
71+
with:
72+
languages: ${{ matrix.language }}
73+
build-mode: ${{ matrix.build-mode }}
74+
# If you wish to specify custom queries, you can do so here or in a config file.
75+
# By default, queries listed here will override any specified in a config file.
76+
# Prefix the list here with "+" to use these queries and those in the config file.
77+
78+
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
79+
# queries: security-extended,security-and-quality
80+
81+
# If the analyze step fails for one of the languages you are analyzing with
82+
# "We were unable to automatically build your code", modify the matrix above
83+
# to set the build mode to "manual" for that language. Then modify this step
84+
# to build your code.
85+
# ℹ️ Command-line programs to run using the OS shell.
86+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
87+
- name: Run manual build steps
88+
if: matrix.build-mode == 'manual'
89+
shell: bash
90+
run: |
91+
echo 'If you are using a "manual" build mode for one or more of the' \
92+
'languages you are analyzing, replace this with the commands to build' \
93+
'your code, for example:'
94+
echo ' make bootstrap'
95+
echo ' make release'
96+
exit 1
97+
98+
- name: Perform CodeQL Analysis
99+
uses: github/codeql-action/analyze@v4
100+
with:
101+
category: "/language:${{matrix.language}}"

0 commit comments

Comments
 (0)