프레임워크 인식 정적 코드 분석 도구로, 플랫폼별 규칙, 오염 분석, 노력 추정 및 억제 기준선을 통해 자동화된 소스 코드 리뷰를 수행합니다.
# Daksh SCRA (소스 코드 검토 지원) ``` Author: - Debasis Mohanty ([email protected]) - Twitter / X: @coffeensecurity - www.coffeeandsecurity.com ``` ## Daksh SCRA 소개 Daksh SCRA(Source Code Review Assist)는 소스 코드 검토 프로세스의 효율성을 높이기 위해 만들어졌으며, 코드 검토자에게 잘 구조화되고 체계적인 접근 방식을 제공합니다. 잠재적인 문제로 모든 것을 무분별하게 표시하는 대신, Daksh SCRA는 신중한 분석을 장려하며 잠재적 문제의 조사와 확인을 촉구합니다. 이러한 접근 방식은 모든 잠재적 우려 사항을 버그로 표시하려는 혼란을 완화하고, 오탐에 소비되는 혼란과 시간 낭비를 줄입니다. ### 데뷔 Daksh SCRA는 Black Hat USA 2022(8월 6-9일)의 소스 코드 검토 교육 세션에서 처음 소개되었으며, 특정 청중에게 조용히 선보였습니다. 공식적인 대중 데뷔는 라스베이거스에서 열린 Black Hat USA 2023에서 이루어졌습니다. ## 기능 및 기능성 DakshSCRA는 파일 경로 관심 영역과 노력 추정부터 소프트웨어 정찰, 상황별 규칙 및 교차 파일 분석에 이르기까지 수동 소스 코드 검토를 위한 독특한 기능들을 결합합니다. | 기능 | 태그 | 중요한 이유 | |---|---|---| | **파일 경로 관심 영역** | 세계 최초* | 코드와 함께 파일 및 디렉터리 이름 자체를 스캔하여 검토자가 흔히 놓치는 백업 파일, 디버그 엔드포인트, 구성 덤프 및 자격 증명 파일과 같은 의심스러운 경로를 표시합니다. | | **과학적 노력 추정** | 세계 최초* | 코드베이스 크기와 프로젝트 신호를 기반으로 수동 검토 노력에 대한 정량화된 추정치를 생성합니다. 구성 가능한 가정을 통해 참여 계획을 명시적이고 반복 가능하게 만듭니다. | | **소프트웨어 정찰** | 세계 두 번째* | 스캔 전에 파일 내용과 프로젝트 구조에서 언어, 프레임워크 및 인프라를 감지합니다. 기술 인벤토리를 자동 규칙 선택, 의미 분석 및 검토 계획과 연결합니다. | | **고급 의미 및 교차 파일 분석** | 출시 당시 가장 진보된 오픈 소스* | 목적에 맞게 구축된 분석을 사용하여 지원되는 파일 경계를 넘어 소스에서 싱크까지 사용자 제어 데이터를 추적합니다. 고급 분석은 2026년 3월 원래 RDL과 함께 출시되었으며, RDL v2는 파일 전반에 걸친 의미 규칙 평가를 확장합니다. | * 각 기능이 도입된 당시의 일반적인 검색을 기반으로 합니다. 오픈 소스 보안 코드 검토 도구에서 유사한 기능은 발견되지 않았습니다. 노력 추정의 경우 상용 도구에서도 유사한 접근 방식이 발견되지 않았습니다. 정찰은 Microsoft Application Inspector 다음으로 두 번째였습니다. 교차 파일 분석은 출시 당시 오픈 소스 코드 검토 도구 중 가장 진보된 것이었습니다. ### 기능 이력 및 증거 | 기능 / 마일스톤 | 날짜 | 릴리스 | 증거 / 범위 | |---|---|---|---| | 초기 베타 및 파일 경로 규칙 | 2022년 10월 22일 | v0.1-beta | [초기 릴리스; 보존된 소스에는 전용 파일 경로 규칙 인벤토리가 포함되어 있습니다.](https://github.com/coffeeandsecurity/DakshSCRA/releases/tag/v0.1-beta) | | 소프트웨어 정찰 (공개된 소개) | 2023년 7월 9일 | v0.3-beta | [릴리스 노트에서 정찰을 소개합니다; 이전 저장소 코드는 별도의 구현 증거입니다.](https://github.com/coffeeandsecurity/DakshSCRA/releases/tag/v0.3-beta) | | 수동 검토 노력 추정 (구현) | 2023년 7월 29일 | 구현 커밋 | [전용 추정 모듈 추가됨; 이후 수정 릴리스의 날짜가 아닙니다.](https://github.com/coffeeandsecurity/DakshSCRA/commit/65d5c6a) | | 원래 RDL 및 파일 간 고급 분석 | 2026년 3월 2일 | v0.31-beta | [조건부 규칙 로직과 독립적인 교차 파일 분석이 함께 출시되었습니다. 릴리스 표시 날짜는 3월 2일이며, 게시 타임스탬프는 2026년 3월 1일 18:39 UTC입니다.](https://github.com/coffeeandsecurity/DakshSCRA/commit/d90ba51) | ### 비교 증거 - **정찰 선행 도구:** [Microsoft Application Inspector](https://www.microsoft.com/en-us/security/blog/2020/01/16/introducing-microsoft-application-inspector/) (2020년 1월 16일)는 더 이른 소스 특성 도구를 문서화합니다. Daksh SCRA 정찰은 그 다음으로 두 번째에 위치합니다. 날짜는 저장소 또는 릴리스 마일스톤을 나타냅니다. DakshSCRA는 **Black Hat USA 2022** 교육에서 소개되었으며 **Black Hat USA 2023**에서 공개적으로 데뷔했습니다. 해당 날짜는 프로젝트의 소개를 설명하는 것이지, 현재의 모든 기능을 설명하는 것은 아닙니다. > 활발한 개선이 진행 중입니다. 다가오는 릴리스에서 여러 새로운 기능과 개선 사항이 계획되어 있습니다. 새로운 규칙 업데이트 또는 추가와 향후 개발에 자유롭게 기여해 주세요. 버그를 발견하면 [[email protected]](mailto:[email protected])으로 보고해 주세요. 자세한 문서: [https://dakshlabs.com/#docs](https://dakshlabs.com/#docs) --- ## 시작하기 Daksh SCRA를 실행하는 방법은 두 가지입니다. 워크플로에 맞는 방법을 선택하세요: | | 적합한 대상 | 바로가기 | |---|---|---| | 🌐 **웹 UI (Docker)** | 가장 쉬운 시작 방법 - 명령 하나, 브라우저 대시보드, 실시간 스캔 진행 상황, 보고서/아티팩트 브라우저. 대부분의 사용자에게 권장됩니다. | [웹 UI (Docker)](#web-ui-docker) | | 💻 **CLI (Python)** | 스크립팅, CI 파이프라인 또는 Docker 없이 스캔 실행. | [CLI 설정](#cli-setup) | 두 경로 모두 완전히 동일한 스캔 엔진을 실행합니다. 웹 UI는 동일한 CLI 위에 구축된 브라우저 프런트 엔드이므로, 어느 쪽이든 결과는 동일합니다. --- ## 웹 UI (Docker) Daksh SCRA를 실행하는 가장 빠른 방법은 호스트 인식 Docker 시작 도우미로 실행되는 브라우저 기반 웹 UI를 통하는 것입니다. 스캔 런처, 실시간 콘솔 피드, 과거 보고서의 탐색 가능한 기록을 제공합니다. 시작 도우미에는 Python 3(표준 라이브러리만)가 필요하며, 애플리케이션과 그 종속성은 Docker에서 실행됩니다. Docker 설정은 웹 UI와 CLI를 동일한 이미지로 빌드된 독립적인 서비스로 실행하므로, 동일한 컨테이너에서 둘 중 하나(또는 둘 다)를 사용할 수 있습니다. ### 웹 UI 실행 GitHub에서 Daksh SCRA를 다운로드한 후, **먼저 ZIP 아카이브의 압축을 해제하세요**. `docker-compose.yml`과 `dakshscra.py`가 포함된 압축 해제된 프로젝트 폴더 안에서 터미널(Windows에서는 PowerShell 또는 명령 프롬프트)을 엽니다. **아래의 모든 시작 및 Docker Compose 명령은 해당 폴더에서 실행하세요.** 터미널이 다른 위치에서 열리는 경우, 먼저 압축 해제된 폴더로 이동하세요: ```text cd "path/to/extracted/DakshSCRA-folder" ``` 예제 경로를 실제 다운로드 위치와 폴더 이름으로 바꾸세요. 저장소를 복제한 경우에는 상위 폴더에서 `cd DakshSCRA`를 실행하세요. 시작 도우미는 Windows, WSL, Linux 및 macOS를 인식한 다음, 컨테이너를 시작하기 전에 호스트 루트, 사용 가능한 Windows 드라이브 및 공통 폴더를 읽기 전용으로 마운트합니다. Docker가 실행 중인 컴퓨터에서 실행하세요. Linux, macOS 또는 WSL (포그라운드): ```bash python3 tools/start_webui.py ``` Windows PowerShell 또는 명령 프롬프트(포그라운드): ```powershell py tools/start_webui.py ``` 분리(백그라운드) 모드로 실행하려면 `--detach`를 추가하세요. 시작 명령이 반환된 후에도 컨테이너는 계속 실행되어 터미널을 사용할 수 있습니다. Linux, macOS 또는 WSL (분리 모드): ```bash python3 tools/start_webui.py --detach ``` Windows PowerShell 또는 명령 프롬프트(분리 실행): ```powershell py tools/start_webui.py --detach ``` `--dry-run`을 사용하면 컨테이너를 시작하지 않고 감지된 경로를 확인할 수 있습니다. 기존 `.env` 경로 재정의가 적용됩니다. 컨테이너를 다시 생성할 때 계정, 스캔 및 런타임 볼륨은 보존됩니다. Docker Desktop은 선택한 호스트 경로를 공유하기 위한 권한을 요구할 수 있습니다. 마운트를 거부하는 경우 Docker Desktop에서 해당 위치를 허용한 후 헬퍼를 다시 실행하세요. 원격 브라우저는 자신의 컴퓨터 드라이브가 아닌 **Docker 호스트의** 폴더를 봅니다. 자동 감지에는 로컬 Docker 엔진이 필요합니다. 원격 Docker 컨텍스트를 사용하는 경우 엔진 호스트에서 헬퍼를 실행하세요. 수동으로 구성한 마운트의 경우 `docker compose up --build -d api web`을 계속 사용할 수 있습니다. 기본 구성은 저장소를 `/scan-targets`에, `${DAKSH_HOST_MOUNT:-/}`를 `/host/root`에 마운트합니다. Windows 드라이브 검색 및 공통 폴더 바로가기에는 헬퍼를 사용하세요. 일반 Compose는 클라이언트 OS를 감지할 수 없습니다. 그런 다음 [http://localhost:3030](http://localhost:3030)을 여세요. 다른 포트를 사용하려면: ```bash DAKSH_PORT=9090 python3 tools/start_webui.py ``` 스택을 중지하려면 다음을 실행하세요: ```bash docker compose down ``` ### 반복적인 Docker 빌드 후 디스크 공간 확보 저장소 폴더에서 별도의 정리 도우미를 사용하세요. 기본적으로 미리 보기만 수행합니다: **이 작업은 Daksh 컨테이너, 서비스 이미지, 네트워크 및 볼륨을 삭제하며, 여기에는 저장된 계정, 스캔 기록 및 런타임 볼륨에 저장된 아티팩트가 포함됩니다. 보관하려는 항목은 먼저 백업하세요.** ```bash python3 tools/clean_project_docker.py python3 tools/purge_all_docker.py ``` `--execute`를 추가해 삭제한 다음, 요청된 확인을 입력하세요. 첫 번째 헬퍼는 이 프로젝트의 컨테이너, 네트워크, 서비스 이미지 및 볼륨을 제거하며, 공유 빌드 캐시는 보존합니다. 두 번째 헬퍼는 **선택한 Docker 엔진의 모든 프로젝트에 걸쳐** 컨테이너를 강제로 제거하고 이미지, 네트워크, 명명된/익명 볼륨 및 기본 빌더 캐시를 정리합니다. 원격 엔진에 영향을 줄 수 있습니다. 둘 다 바인드 마운트된 호스트 파일을 삭제하거나 Docker를 제거하지 않습니다. Windows 사용자는 `python3`를 `py`로 바꿀 수 있습니다. 사용자 지정 프로젝트 이름, 제외 항목 및 삭제 세부 정보는 [정리 범위 및 명령](https://github.com/coffeeandsecurity/dakshscra/blob/main/docs/usage-guide.md#docker-cleanup-and-full-purge)을 참조하세요. 다음 명령으로 남은 Docker 디스크 사용량을 확인하세요: ```bash docker system df ``` 저장된 Daksh 데이터는 유지하면서 사용하지 않는 빌드 캐시만 해제하려면 `docker builder prune --all --force`를 실행하세요. 저장소와 스캔 대상 등 바인드 마운트된 호스트 폴더의 파일은 디스크에 그대로 남습니다. 준비가 되면 `python3 tools/start_webui.py --detach`로 다시 시작하세요. ### 로그인 Web UI를 사용하려면 계정이 필요합니다. **최초 로그인** 1. 포털을 시작하고(`python3 tools/start_webui.py --detach`) [http://localhost:3030](http://localhost:3030)을 엽니다. 2. 로그인 페이지가 최초 설정을 감지합니다. 사용자 이름 `admin`과 초기 비밀번호를 미리 채우고 최초 설정 안내를 표시합니다. | 설정 | 값 | |---|---| | 사용자 이름 | `admin` (또는 `.env`의 `DAKSH_ADMIN_USERNAME`) | | 초기 비밀번호 | `Daksh@ChangeMe1` (또는 `.env`의 `DAKSH_ADMIN_PASSWORD`) | 3. **Sign in**을 클릭합니다. 전체 화면 **비밀번호 변경** 단계가 나타나며 건너뛸 수 없습니다. 초기 비밀번호를 현재 비밀번호로 입력하고, 새 비밀번호를 선택하며(최소 8자, 현재 비밀번호와 달라야 함), 원하면 사용자 이름도 변경할 수 있습니다. 4. 저장하면 대시보드로 이동합니다. 이후로는 로그인 페이지가 아무것도 미리 채우지 않으며, 자신의 자격 증명으로 로그인합니다. 초기 비밀번호는 데이터베이스에 계정이 없을 때만 사용되며, 변경되는 즉시 작동을 멈춥니다. 그 전까지는 포털에 접근할 수 있는 누구나 이 비밀번호로 로그인할 수 있으므로, 포털에 다른 사람이 접근할 수 있다면 최초 시작 전에 `.env`에 `DAKSH_ADMIN_PASSWORD`를 설정하세요. 관리자 계정은 `POST /api/v1/auth/users` API 엔드포인트를 통해 추가 계정을 만들 수 있습니다(아직 전용 UI는 없음). 새로 생성되거나 재설정된 계정도 최초 로그인 시 할당된 비밀번호를 변경해야 합니다. 인증 관련 설정(세션 수명, 쿠키 보안, CORS)의 전체 목록은 `.env.example`을 참조하세요. ### 제공 기능 - scan, recon, estimate, recon+estimate, list, PDF-from-JSON 모드를 위한 반응형 명령 빌더 - 실행 중 실시간 콘솔 피드 및 단계별 라이브 진행 상황 - HTML / PDF / JSON 출력에 대한 작업별 아티팩트 스냅샷 - 결과 및 보고서를 위한 Developer Mode, Code Review Mode 또는 Both 안내; 기본값은 Both - 실행 양식, 라이브 피드, 아티팩트, 최근 작업 간의 빠른 브라우저 내 탐색 - 대상 경로 선택을 위한 내장 디렉터리 브라우저(OS 인식: Windows, macOS, Linux / Docker) 내부적으로 CLI가 여전히 핵심입니다. 모든 스캔을 수행하고 모든 HTML / PDF / JSON 출력을 생성합니다. Web UI는 한 번에 하나의 활성 작업을 실행하며, 완료된 각 작업의 출력을 `runtime/webui/jobs/<job-id>/artifacts/`에 스냅샷으로 저장하여 과거 보고서에 계속 접근할 수 있게 합니다. ### Docker에서 CLI 실행 CLI를 사용하는 데 로컬 Python 환경도 필요하지 않습니다. 동일한 이미지로 빌드되는 자체 Compose 서비스로 제공됩니다: ```bash docker compose run --rm cli -h docker compose run --rm cli -r auto -t /scan-targets/path/to/source ``` ### 이미지에 포함된 내용 - FastAPI 백엔드 + 웹 UI 프론트엔드 - 별도의 서비스로 제공되는 전체 Daksh SCRA CLI - PDF 생성을 위한 Playwright Chromium - 영구 `reports/` 및 `runtime/` 볼륨 - 컨테이너 내부에서 소스 트리에 접근할 수 있도록 하는 호스트 경로 마운트 **주요 마운트 지점:** | 마운트 | 컨테이너 내부 경로 | |---|---| | 프로젝트 소스 | `/app` | | 기본 스캔 루트 (저장소 또는 `DAKSH_SCAN_ROOT`) | `/scan-targets` | | 호스트 파일 시스템 (Windows의 시스템 드라이브) | `/host/root` | | 추가 Windows/WSL 드라이브 | `/host/drives/<letter>` | | 현재 사용자의 홈 | `/host/user` | | 일반적인 호스트 폴더 | `/host/locations/<name>` | | 선택적 `DAKSH_HOST_SOURCE` | `/host/source` | 선택적 경로 및 인증 재정의를 위해 `.env.example`을 `.env`로 복사하세요. `DAKSH_BROWSE_ROOTS`는 **컨테이너** 경로의 쉼표로 구분된 허용 목록입니다. 마운트된 위치를 자동 검색하려면 설정하지 않은 채로 두세요. 헬퍼로 전환할 때 구식 `/host/c`, `/host/d` 또는 `/mnt` 허용 목록은 제거하거나 업데이트해야 합니다. 호스트 폴더는 읽기 전용이며, 보고서와 런타임 데이터는 기존 애플리케이션 위치에서 계속 쓰기 가능합니다. 다른 드라이브를 연결한 후에는 헬퍼를 사용하여 재시작하세요. Docker 소켓이나 권한 있는 컨테이너는 필요하지 않습니다. --- ## CLI 설정 Python으로 Daksh SCRA를 직접 실행하는 것을 선호하시나요? 로컬에서 설정하는 방법은 다음과 같습니다. ### 사전 요구 사항 - Python 3.8+ - `requirements.txt`에 나열된 모든 라이브러리 ### 1. Daksh SCRA 다운로드 ```bash git clone https://github.com/coffeeandsecurity/DakshSCRA.git ``` 또는 [https://github.com/coffeeandsecurity/DakshSCRA](https://github.com/coffeeandsecurity/DakshSCRA)에서 최신 zip 파일을 다운로드한 후 압축을 해제하세요. ### 2. 가상 환경 설정 > 💡 가상 환경은 어느 디렉터리에든 생성할 수 있으며, DakshSCRA 폴더 안에 있을 필요는 없습니다. **옵션 A: 한 단계 설정 (권장)** ```bash python setup_env.py ``` 이 스크립트는 가상 환경을 생성하고, 모든 종속성을 설치하며, Playwright의 Chromium 브라우저(PDF 내보내기에 필요)를 설치합니다. **옵션 B: 수동 설정** Windows: ```bash python -m venv daksh-env .\daksh-env\Scripts\activate ``` macOS / Linux: ```bash python3 -m venv daksh-env source daksh-env/bin/activate ``` 그런 다음 의존성을 설치합니다: ```bash cd path/to/DakshSCRA pip install -r requirements.txt playwright install chromium ``` ## CLI 사용법 가상 환경 내에서는 `python`을 사용하고, 가상 환경 외부에서는 `python3`을 사용하세요. ### 명령줄 옵션 ``` usage: dakshscra.py [-h] [-r RULES] [-f FILE_TYPES] [-v] [-t TARGET_DIR] [-l {R,RF}] [--recon] [--rs] [--estimate] [-rpt FORMATS] [--pdf-from-json] [--json-input-dir PATH] [--pdf-output PATH] [--pdf-multi-dir PATH] [--pdf-single-only] [--skip-analysis] [--loc] [--baseline-file PATH] [--baseline-generate] [--no-baseline] [--review-config PATH] [--resume-scan] [--state-file PATH] [--no-state] [--state] ``` | 옵션 | 설명 | |---|---| | `-r RULES` | 플랫폼 규칙 (예: `php`, `java`, `php,java`) 또는 자동 감지를 위한 `auto` | | `-f FILE_TYPES` | 스캔을 위한 기본 파일 유형 재정의 | | `-v` | 상세 수준 (`-v`, `-vv`, `-vvv`) | | `-t TARGET_DIR` | 대상 소스 코드 디렉터리 | | `-l {R,RF}` | 플랫폼 규칙 + 프레임워크 `[R]` 나열 또는 파일 유형 포함 `[RF]` | | `--recon` | 정찰 실행 (플랫폼 / 프레임워크 / 언어 감지) | | `--rs`, `--recon-strict` | 엄격한 정찰: 높은 신뢰도의 감지만 (`--recon`과 함께 사용) | | `--estimate` | 코드베이스 크기를 기반으로 코드 리뷰 노력 추정 | | `-rpt`, `--report FORMATS` | 보고서 형식: `html`, `pdf`, `docx`, `json` 또는 쉼표로 구분된 조합 (기본값: `html`) | | `--pdf-from-json` | 재스캔 없이 기존 JSON 출력에서 PDF 보고서 생성 | | `--json-input-dir PATH` | JSON 보고서 디렉터리 (기본값: `./reports/data`) | | `--pdf-output PATH` | 단일 PDF 출력 경로 (기본값: `./reports/scan/pdf/report.pdf`) | | `--pdf-multi-dir PATH` | 다중 파일 PDF 출력 디렉터리 (기본값: `./reports/scan/pdf/multi-file`) | | `--pdf-single-only` | 결합된 단일 파일 PDF만 생성하고 플랫폼별 다중 파일 세트는 건너뜀 | | `--skip-analysis` | 이번 실행에서 분석기 단계 비활성화 | | `--loc` | 유효 코드 줄 수 계산 | | `--baseline-file PATH` | 억제 기준선 파일 (JSON) | | `--baseline-generate` | 현재 발견 사항에서 억제 기준선 생성 | | `--no-baseline` | 이번 실행에서 기준선 억제 비활성화 | | `--review-config PATH` | 발견 사항 분류 파일 (JSON); 이전에 검토된 오탐을 보고서에서 억제 | | `--resume-scan` | 상태 파일에서 이전에 중단된 스캔 재개 | | `--state-file PATH` | 사용자 지정 스캔 상태 / 체크포인트 파일 경로 | | `--no-state` | 이번 실행에서 스캔 상태 체크포인팅 비활성화 | | `--state` | 이번 실행에서 스캔 상태 체크포인팅 강제 활성화 | ### 사용 예시 > `-f` (파일 유형)는 선택 사항입니다. 지정하지 않으면 DakshSCRA는 선택한 플랫폼의 기본 파일 유형을 사용합니다. ```bash # Single platform scan python dakshscra.py -r php -t /path/to/source # Multiple platforms python dakshscra.py -r php,java,cpp -t /path/to/source # Auto-detect platform and apply matching rules python dakshscra.py -r auto -t /path/to/source # Override filetypes python dakshscra.py -r php -f dotnet -t /path/to/source # Reconnaissance only (no scanning) python dakshscra.py --recon -t /path/to/source # Reconnaissance + scanning python dakshscra.py --recon -r php -t /path/to/source # Strict recon (high-confidence detections only) python dakshscra.py --recon --rs -t /path/to/source # Effort estimation python dakshscra.py --estimate -t /path/to/source # Scan with HTML + PDF report output python dakshscra.py -r auto -t /path/to/source -rpt html,pdf # Verbosity levels python dakshscra.py -r php -v -t /path/to/source # default python dakshscra.py -r php -vvv -t /path/to/source # show all pattern checks # Generate suppression baseline from current findings python dakshscra.py -r auto -t /path/to/source --baseline-generate # Apply suppression baseline (suppress known FPs) python dakshscra.py -r auto -t /path/to/source --baseline-file config/suppressions.json # Disable baseline for this run python dakshscra.py -r auto -t /path/to/source --no-baseline # Apply findings triage / review config python dakshscra.py -r auto -t /path/to/source --review-config config/review.json # Scan with checkpoint state enabled python dakshscra.py -r auto -t /path/to/source --state # Resume an interrupted scan python dakshscra.py -r auto -t /path/to/source --resume-scan # Resume with a custom state file python dakshscra.py -r auto -t /path/to/source --resume-scan --state-file runtime/scan_state.json # Generate PDF from existing JSON outputs (no re-scan) python dakshscra.py --pdf-from-json # Generate PDF from a custom JSON directory python dakshscra.py --pdf-from-json --json-input-dir ./custom/reports/data # Custom output paths for PDF python dakshscra.py --pdf-from-json --pdf-output ./reports/scan/pdf/custom.pdf --pdf-multi-dir ./reports/scan/pdf/multi-file # Single combined PDF only (skip per-platform set) python dakshscra.py --pdf-from-json --pdf-single-only ``` ### 지원 플랫폼 규칙 및 프레임워크 ```bash python dakshscra.py -l R # List platform rules and framework mappings python dakshscra.py -l RF # List platform rules, framework mappings, and filetypes ``` 현재 지원되는 플랫폼 및 프레임워크 매핑: <!-- supported-platforms:start --> | 플랫폼 | 프레임워크 | |---|---| | dotnet | aspnetcore, blazor, entityframework, identity | | php | codeigniter, drupal, laravel, symfony, wordpress, yii | | java | hibernate, mybatis, spring, springboot, struts | | javascript | angular, electron, express, nestjs, nextjs, react, vue | | kotlin | exposed, ktor, springkotlin | | python | django, fastapi, flask, sqlalchemy | | go | echo, fiber, gin, gorilla, gorm | | c | freertos | | cpp | boost, qt | | android | cordova-android, flutter-android, ionic-android, jetpack, nativescript-android, reactnative-android, retrofit, room, xamarin-android | | ios | alamofire, cordova-ios, coredata, flutter-ios, ionic-ios, nativescript-ios, reactnative-ios, swiftui, uikit, xamarin-ios | | reactnative | expo, reactnative | | flutter | flutter, flutter-dio, flutter-hive | | xamarin | xamarin | | maui | - | | kmp | - | | ionic | ionic | | nativescript | nativescript | | cordova | cordova | | bash | - | | powershell | - | | dockerfile | - | | terraform | terraform-aws, terraform-azure, terraform-gcp | | kubernetes | - | | ruby | rails, sinatra | | rust | actix, axum, rocket | | common | - | <!-- supported-platforms:end --> 이 표는 등록된 규칙 팩을 나열합니다. 대시(-)는 별도의 프레임워크 팩이 등록되지 않았음을 의미합니다. 분석 범위는 언어와 규칙에 따라 다릅니다. 플랫폼 또는 프레임워크 레지스트리를 변경한 후에는 이 표를 새로 고치고 변경 사항을 제출하기 전에 확인하십시오: ```bash python3 tools/supported_platforms.py python3 tools/supported_platforms.py --check ``` 최신 지원 플랫폼과 프레임워크를 확인하려면 항상 다음을 실행하세요: ```bash python dakshscra.py -l R ``` ## 구성 참조 ### `config/tool.yaml` Daksh SCRA 런타임 기본값은 `config/tool.yaml`을 통해 제어됩니다. ```yaml state_management: enabled: false resume_mode: manual persist_after_seconds: 300 persist_interval_seconds: 30 default_state_file: runtime/scan_state.json cleanup_on_success: false analysis: run_by_default: true include_frameworks: true report_theme: hacker_mode ``` **분석기 구성 옵션:** - `analysis.run_by_default` - `true`: 스캔 중 분석기가 자동으로 실행됨 - `false`: 구성에서 다시 활성화하거나 CLI를 통해 활성화하지 않는 한 분석기 비활성화됨 - `analysis.include_frameworks` - `true`: 프레임워크 탐지가 존재하는 경우 프레임워크 수준 분석기 항목 포함 - `false`: 플랫폼 수준 분석기 출력만 포함 - `analysis.report_theme` - `hacker_mode`: 어두운 고대비 현대적 분석기 테마 (기본값) - `professional_mode`: 밝은 현대적 분석기 테마 - `both`: 두 테마 변형을 나란히 생성 ### 패턴 규칙 및 시맨틱 규칙 **패턴 규칙은 패턴과 문맥적 조건을 사용하여 관심 영역을 식별합니다. 검토자는 해당 영역이 실제 보안 문제를 나타내는지 조사합니다.** **시맨틱 규칙은 코드 관계, 입력 전파 및 모델링된 보호 조치를 분석하여 더 강력한 증거를 제공합니다. 이는 발견 사항을 뒷받침하거나 억제할 수 있지만, 불완전한 모델링, 배포 설정 및 런타임 동작은 여전히 결론에 영향을 미칠 수 있습니다.** `--rule-mode pattern|semantic|both`를 선택하거나(기본값 `both`), 새 스캔에서 동일한 모드를 선택하십시오. 시맨틱 전용 모드는 네이티브 텍스트 기준선을 건너뛰면서 정제된 모바일 소스/구성 검사 및 지원되는 흐름 모델을 유지합니다. 지원되는 발견 사항은 여전히 검토자의 확인이 필요하며, 억제가 안전성을 입증하지는 않습니다. 내장 검사는 [`rules/scanning/platform/`](https://github.com/coffeeandsecurity/dakshscra/blob/main/rules/scanning/platform) 아래의 단일 파일 패턴 규칙으로 작성되며, 플랫폼 및 프레임워크 디렉터리를 유지합니다. 예를 들어 Java 검사는 `java/java.rules/*.yaml`에, Spring 검사는 `java/framework/spring.rules/*.yaml`에 위치합니다. 각 파일은 패턴, 문맥적 조건, 규칙 및 영향 설명, 개발자 및 검토자 지침, 권장 사항, 그리고 모든 코드 문맥 및 강조 표시 설정을 유지합니다. 실행 가능한 `review_steps` 및 `recommendations`는 원래 지침을 실행 가능한 지시 사항으로 확장합니다. 기존 팩에 YAML 파일을 추가하고, `python3 tools/rdl_lint.py rules/scanning/platform`으로 검증한 다음, 작은 양성/음성 픽스처를 스캔하십시오. 스캐너는 XML이나 별도의 RDL v1 파일을 편집하지 않고도 이를 발견합니다. 시맨틱 정의는 [`rules/scanning/logic/rdl/v2/`](https://github.com/coffeeandsecurity/dakshscra/blob/main/rules/scanning/logic/rdl/v2) 아래에 유지됩니다. 해당 엔진에서 평가되는 네이티브 텍스트 기준선은 패턴 규칙으로 유지됩니다. 레거시 `--rdl-engine` 선택은 저장된 스캔 및 기존 스크립트와 호환됩니다. YAML 형식, 조건, 검증, 증거 설정 및 외부 XML 가져오기에 대해서는 [규칙 작성 및 마이그레이션 가이드](https://github.com/coffeeandsecurity/dakshscra/blob/main/docs/usage-guide.md#pattern-rules-and-semantic-rules)를 참조하십시오. 해당되는 플랫폼 및 프레임워크 팩에는 보안 작업 검토 후보도 포함됩니다. 시맨틱 모델은 응답 출처 값, 대량 바인딩 소스 및 암호화 키 인수를 구별하며, 지원되는 구성 폴백을 키 작업으로 추적할 수 있습니다. 새로 생성된 발견 사항은 지원되는 메서드/클래스 제어 선언을 작업과 연결합니다. 형식화된 C# 모델 검토는 선언된 필드 정책을 유지할 수 있습니다. 테넌트 격리에는 애플리케이션별 불변 조건이 필요합니다. 이는 명시적인 모델링 한계를 가진 증거 기반 검토 기능이며, 모든 권한 부여 또는 비즈니스 로직 결함을 보장된 탐지하는 것은 아닙니다. [보안 작업 및 제어 문맥](https://github.com/coffeeandsecurity/dakshscra/blob/main/docs/usage-guide.md#security-operation-and-control-context)을 참조하십시오. --- ## 보고서 출력 구조 CLI 출력은 스캔별로 `reports/<project>/<scan>/` 아래에 보관됩니다. CLI 및 Web UI 내보내기는 HTML, PDF, Word 및 JSON에 대해 저장된 데이터 수집 및 렌더러를 공유합니다. 전체 HTML은 링크된 페이지 매김 상세 페이지가 포함된 경량 요약/색인을 엽니다. Web UI에서 **Reports**에서 내보내기를 생성하고, HTML ZIP을 추출한 후 `index.html`을 먼저 여십시오. ``` reports/<project>/<scan>/ ├── scan/ │ ├── html/ │ │ ├── report.html # Summary and report index (open first) │ │ ├── report-files/ # Linked detail pages and saved-results.json │ │ └── multi-file/ # Per-platform HTML report set │ ├── pdf/ │ │ ├── report.pdf # Single-file PDF scan report │ │ └── multi-file/ # Per-platform PDF report set │ ├── word/ │ │ └── report.docx # Editable Word report when requested │ ├── json/ │ │ └── report.json # Complete structured report document │ ├── recon/ │ │ └── reconnaissance.html # Reconnaissance HTML report │ └── estimate/ │ └── estimation.html # Effort estimation HTML report ├── analysis/ │ └── <platform>/ │ ├── analysis.html # Taint analysis report (default theme) │ ├── analysis_professional.html # Professional theme (if theme=both) │ ├── analysis_xref.html # Cross-reference report │ └── analysis.json # Structured analysis data └── data/ ├── areas_of_interest.json # AoI findings ├── filepaths_aoi.json # File path AoI findings ├── summary.json # Scan summary ├── recon.json # Recon summary └── analysis.json # Analyzer output ``` 런타임 파일(스캔 상태, 로그, 인벤토리)은 `runtime/` 아래에 기록됩니다. Web UI를 통해 실행하는 경우, 각 작업의 출력은 추가로 `runtime/webui/jobs/<job-id>/artifacts/` 아래에 스냅샷으로 저장됩니다([Web UI (Docker)](#web-ui-docker) 참조). --- ## 작성자 | | | |---|---| | 웹사이트 | [coffeeandsecurity.com](https://www.coffeeandsecurity.com) | | 이메일 | [email protected] | | Twitter / X | [@coffeensecurity](https://x.com/coffeensecurity) | | 소스 | [github.com/coffeeandsecurity/DakshSCRA](https://github.com/coffeeandsecurity/DakshSCRA) | | 라이선스 | GNU General Public License v3.0 (GPL-3.0) | DakshSCRA가 팀의 상당한 시간, 노력 또는 비용을 절약하고, 값비싼 상용 도구에 대한 의존도를 줄이며, 검토 범위를 개선하거나, 코드 검토를 더 체계적이고 효과적으로 만드는 데 도움이 되었다면, 언제든지 연락하여 경험을 공유해 주시기 바랍니다. 저는 항상 사려 깊은 피드백과 흥미로운 대화를 환영합니다. --- [Read more](https://github.com/coffeeandsecurity/dakshscra)