Skip to content

Commit

Permalink
Merge pull request #4 from Ostorlab/switch_to_scanprofile
Browse files Browse the repository at this point in the history
Switch to scan profile
  • Loading branch information
3asm authored Mar 24, 2022
2 parents 47583ff + 8441804 commit de9e694
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
id: start_scan
uses: ./
with:
plan: rapid_static # Specify which plan to use for the scan (check plan section).
scan_profile: fast_scan # Specify which scan profile to use for the scan (check scan section).
asset_type: android-apk # type of asset to scan.
target: ostorlab.apk # path for target tto scan.
scan_title: title_scan_ci # type a title for your scan.
Expand Down
12 changes: 9 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
FROM python:3.8-alpine
RUN pip install ostorlab
CMD ostorlab --api-key="$INPUT_OSTORLAB_API_KEY" ci-scan run --log-flavor=github --title="$INPUT_SCAN_TITLE" --plan="$INPUT_PLAN" --break-on-risk-rating="$INPUT_BREAK_ON_RISK_RATING" --max-wait-minutes="$INPUT_MAX_WAIT_MINUTES" $INPUT_ASSET_TYPE $INPUT_TARGET
FROM python:3.8-slim-buster as base
FROM base as builder
RUN mkdir /install
WORKDIR /install
RUN pip install --prefix=/install ostorlab
FROM base
WORKDIR /root/
COPY --from=builder /install /usr/local
CMD ostorlab --api-key="$INPUT_OSTORLAB_API_KEY" ci-scan run --log-flavor=github --title="$INPUT_SCAN_TITLE" --scan-profile="$INPUT_SCAN_PROFILE" --break-on-risk-rating="$INPUT_BREAK_ON_RISK_RATING" --max-wait-minutes="$INPUT_MAX_WAIT_MINUTES" $INPUT_ASSET_TYPE $INPUT_TARGET
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
id: start_scan
uses: actions/ostorlab_actions@v1
with:
plan: rapid_static
scan_profile: fast_scan
asset_type: android-apk
target: andoird_apk.apk
can_title: title_scan_ci
Expand All @@ -55,7 +55,7 @@ jobs:
The Github actions the following options:
- **`plan`** *(['rapid_static', 'static_dynamic_backend'])*: [Required] - Specifies the scan plan ( `rapid_static` for fast static only analysis and `full analysis` for full static, dynamic and backend coverage).
- **`scan_profile`** *(['fast_scan', 'full_scan'])*: [Required] - Specifies the scan profile ( `fast_scan` for fast static only analysis and `full_scan` for full static, dynamic and backend coverage).
- **`asset_type`** *(['android-apk', 'android-aab', 'ios-ipa'])*: [Required] - Target asset, Ostorlab supports APK, AAB and IPA.
- **`target`**: [Required] - target file to scan.
- **`ostorlab_api_key`**: [Required] - API Key from Ostorlab portal.
Expand Down
6 changes: 3 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Ostorlab Security Scanner
description: Scan mobile apps for outdated dependencies, hardcoded secrets, privacy leakages, and insecure code (Signup at ostorlab.co).
inputs:
plan:
description: Specifies your scan plan ( free (rapid_static) for community scans and static_dynamic_backend for full analysis)
scan_profile:
description: Specifies your scan profile ( free "fast_scan" for community scans and "full_scan" for full analysis)
required: true
default: rapid_static
default: fast_scan
asset_type:
description: Type of asset to scan. (['android-apk', 'android-aab', 'ios-ipa'])
required: true
Expand Down

0 comments on commit de9e694

Please sign in to comment.