Quipu

YARA 규칙을 작성, 검증, 컴파일, 테스트하기 위한 데스크톱 워크벤치입니다.

Quipu("KEE-poo"로 발음)는 프로젝트 탐색기, YARA를 인식하는 편집기, YARA-X 컴파일러, 그리고 집중적인 스캔 결과를 하나의 로컬 애플리케이션으로 통합합니다. YARA-X와 그 언어 서버를 내장하고 있어 별도의 YARA 설치가 필요하지 않습니다.

[!IMPORTANT] Quipu는 MVP 단계입니다. 초기 지원 플랫폼은 64비트 Linux이며, Windows와 macOS 지원이 뒤따를 예정입니다.

컴파일된 YARA 프로젝트와 두 개의 일치하는 스캔 결과를 보여주는 Quipu

기능

.yar 및 .yara 파일이 있는 폴더를 워크스페이스로 열거나, 임시 규칙으로 시작합니다.
추론되거나 구성된 진입점, 중첩된 include, 외부 include, 프로젝트 문제를 탐색합니다.
Monaco 구문 강조, 자동 완성, 호버 문서, 실시간 YARA-X 진단과 함께 편집합니다.
전체 워크스페이스를 컴파일한 다음, 입력한 텍스트나 선택한 파일을 스캔합니다.
일치하는 규칙, 패턴, 오프셋, 바이트 길이, 그리고 강조된 바이트를 헥스 뷰어에서 검사합니다.
진단 및 일치 항목에서 해당 소스 정의로 바로 이동합니다.
변경되지 않은 컴파일된 규칙셋을 제한된 로컬 캐시에서 복원합니다.
애플리케이션에 포함된 작고 자족적인 예제 프로젝트 세트로 작업합니다.

규칙과 스캔 대상은 로컬에서 처리됩니다. Quipu는 그 내용을 원격 서비스로 전송하지 않습니다.

Linux에 설치

Linux x86-64 패키지는 GitHub Releases 페이지에 게시됩니다:

패키지	적합한 용도	설치 또는 실행
AppImage	지원되는 배포판에서의 휴대용 사용	`chmod +x Quipu_.AppImage && ./Quipu_.AppImage`
`.deb`	Ubuntu 22.04+ 및 Debian 12+	`sudo apt install ./Quipu_*.deb`
`.rpm`	최신 Fedora 릴리스	`sudo dnf install ./Quipu-*.rpm`

.deb 및 .rpm 패키지는 시스템 WebKitGTK 런타임을 사용합니다. 배포판이 해당 의존성을 충족할 수 없다면 AppImage를 사용하십시오.

Quipu 패키지는 현재 서명되지 않습니다. 각 릴리스에는 SHA256SUMS 파일이 포함되어 있으니, 패키지 옆에 다운로드하여 다운로드한 파일을 다음과 같이 검증하십시오:

sha256sum --ignore-missing --check SHA256SUMS

체크섬은 우발적인 손상을 감지하지만 인증된 서명은 아닙니다.

빠른 시작

Quipu를 시작하고 File → Open Example… → Basic text match를 선택합니다.
편집기에서 text_indicators.yar를 살펴봅니다.
Rules → Compile Workspace를 선택하거나 Ctrl+Shift+B를 누릅니다.
Rules → Scan Target으로 준비된 대상을 스캔하거나 Ctrl+Shift+Enter를 누릅니다.
일치 항목을 펼치고 선택하여 강조된 바이트를 검사합니다.

전체 가이드는 Quipu에 Help → Documentation 아래에 포함되어 있습니다. 해당 소스는 documentation/content에서도 확인할 수 있습니다.

워크스페이스와 `quipu.toml`

구성 없이 Quipu는 규칙 파일을 재귀적으로 탐색하고, 다른 파일에 의해 include되지 않은 각 파일에서 진입점을 추론합니다. 명시적인 진입점, include 디렉터리, 제외 항목이 필요할 때는 워크스페이스 루트에 quipu.toml을 추가하십시오:

schema = 1
entrypoints = ["main.yar"]
include_dirs = ["rules", "../shared-rules"]
exclude = ["fixtures/**", "vendor/legacy/**"]

전체 프로젝트 모델과 매니페스트 참조는 워크스페이스와 프로젝트를 참조하십시오.

소스에서 빌드

Quipu는 현재 Linux x86-64를 대상으로 합니다. 빌드에는 다음이 필요합니다:

Rust 1.93 이상
Node.js 22.6 이상
Zola 0.23
Git
Tauri와 WebKitGTK에 필요한 네이티브 라이브러리

Debian 또는 Ubuntu에서는 다음으로 네이티브 의존성을 설치하십시오:

sudo apt update
sudo apt install -y \
  build-essential \
  curl \
  file \
  libayatana-appindicator3-dev \
  libgtk-3-dev \
  librsvg2-dev \
  libssl-dev \
  libwebkit2gtk-4.1-dev \
  patchelf \
  rpm \
  wget

그런 다음 세 가지 Linux 패키지 형식을 모두 빌드하십시오:

git clone https://github.com/corelight/quipu.git
cd quipu/app
npm ci
npm run tauri -- build --bundles appimage,deb,rpm

산출물은 app/src-tauri/target/release/bundle/ 아래에 기록됩니다. Cargo가 YARA-X와 그 의존성을 소스에서 컴파일하기 때문에 첫 빌드는 시간이 걸릴 수 있습니다.

개발 및 테스트

의존성을 설치하고 개발 애플리케이션을 시작하십시오:

cd app
npm ci
npm run tauri -- dev

프런트엔드 단위 테스트, 프로덕션 프런트엔드 빌드, Rust 테스트를 다음과 같이 실행하십시오:

cd app
npm test
npm run build

cd src-tauri
cargo test --locked

네이티브 메뉴 인수 테스트 스위트는 추가적인 Linux 디스플레이 서버 요구 사항이 있습니다. 설정과 사용법은 test/README.md를 참조하십시오.

아키텍처

Quipu는 바닐라 TypeScript 프런트엔드와 Rust 백엔드를 갖춘 Tauri 애플리케이션입니다:

Vite는 프런트엔드와 Monaco 편집기를 애플리케이션 웹뷰로 번들링합니다.
Tauri IPC는 UI를 Rust의 워크스페이스, 파일시스템, 컴파일, 캐시, 스캔 서비스에 연결합니다.
YARA-X 컴파일러와 언어 서버는 프로세스 내에서 실행됩니다.
Zola는 앱에 내장된 오프라인 문서 사이트를 빌드합니다.

app/src/           TypeScript 프런트엔드
app/src-tauri/     Rust 백엔드 및 데스크톱 패키징
documentation/    번들된 오프라인 가이드의 소스
examples/          애플리케이션에 번들된 프로젝트
test/ui/           네이티브 메뉴 인수 테스트 하네스

애플리케이션 버전은 app/package.json에 정의되어 있으며, Tauri는 패키지 이름을 지정하고 실행 중인 버전을 보고할 때 해당 값을 읽습니다.

현재 제한 사항

초기에는 Linux x86-64 패키지만 지원됩니다.
Quipu는 디렉터리나 배치가 아닌, 한 번에 하나의 선택된 파일 또는 하나의 텍스트 버퍼만 스캔합니다.
새 규칙은 워크스페이스 루트에 생성됩니다. 이동 및 삭제 작업은 Quipu 외부에서 수행됩니다.
임시 규칙은 컴파일하고 스캔할 수 있지만 저장하거나 캐시할 수 없습니다.

기여 및 보안

기여를 환영합니다. 풀 리퀘스트를 열기 전에 CONTRIBUTING.md를 읽어 주십시오.

보안 취약점을 공개 이슈로 보고하지 마십시오. SECURITY.md의 비공개 보고 절차를 따르십시오.

감사의 글

Quipu는 Corelight가 만들었으며 YARA-X, Monaco Editor, Tauri로 구동됩니다.

라이선스

Quipu는 3-clause BSD 라이선스로 배포됩니다. LICENSE를 참조하십시오. 제3자로부터 통합된 소프트웨어에 대한 고지는 THIRD_PARTY_LICENSES에 있습니다.

quipu

인기