joern

요른 - 벌레 사냥꾼의 작업대

Joern은 소스 코드, 바이트코드, 바이너리 실행 파일을 분석하기 위한 플랫폼입니다. 언어 간 코드 분석을 위한 코드의 그래프 표현인 CPG(코드 속성 그래프)를 생성합니다. 코드 속성 그래프는 사용자 정의 그래프 데이터베이스에 저장됩니다. 이를 통해 Scala 기반 도메인별 쿼리 언어로 구성된 검색 쿼리를 사용하여 코드를 마이닝할 수 있습니다. Joern은 정적 프로그램 분석에서 취약점 발견 및 연구에 유용한 도구를 제공한다는 목표로 개발되었습니다.

홈페이지: https://joern.io

문서: https://docs.joern.io/

사양: https://cpg.joern.io

뉴스 / 변경 내역

• Joern v4.0.0은 Overflowdb에서 flatgraph로 마이그레이션됩니다.
• Joern v2.0.0이 Scala2에서 Scala3으로 업그레이드되었습니다.
• Joern v1.2.0은 overflowdb.traversal.Traversal 클래스를 제거합니다. 이 변경 사항은 이전 버전과 완전히 호환되지 않습니다. 자세한 글은 여기를 참조하세요.

요구사항

• JDK 21(다른 버전도 작동 할 수 있지만 제대로 테스트되지 않음)
• 선택 사항 : gcc 및 g++(C/C++ 코드에 포함/사용되는 경우 C/C++ 시스템 헤더 파일 자동 검색용)

개발 요구 사항

• mvn https://maven.apache.org/install.html

빠른 설치

 wget https://github.com/joernio/joern/releases/latest/download/joern-install.sh
chmod +x ./joern-install.sh
sudo ./joern-install.sh
joern

     ██╗ ██████╗ ███████╗██████╗ ███╗   ██╗
     ██║██╔═══██╗██╔════╝██╔══██╗████╗  ██║
     ██║██║   ██║█████╗  ██████╔╝██╔██╗ ██║
██   ██║██║   ██║██╔══╝  ██╔══██╗██║╚██╗██║
╚█████╔╝╚██████╔╝███████╗██║  ██║██║ ╚████║
 ╚════╝  ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝
Version: 2.0.1
Type `help` to begin

joern>

어떤 이유로든 설치 스크립트가 실패하면 다음을 시도하십시오.

 ./joern-install --interactive

Docker 기반 실행

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern

서버 모드에서 joern을 실행하려면:

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern --server

Almalinux 9에서는 SSE4.2를 지원하는 CPU가 필요합니다. kvm64 VM의 경우 Almalinux 8 버전을 대신 사용하세요.

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern-alma8 joern

릴리스

새 릴리스는 하루에 한 번 자동으로 생성됩니다. 더 빨리 릴리스가 필요한 경우 기여자는 릴리스 워크플로를 수동으로 실행할 수도 있습니다.

개발자

기여 지침

시간을 내어 Joern에 기여해 주셔서 감사합니다! 풀 요청이 가능한 한 빨리 병합되도록 하기 위한 몇 가지 지침은 다음과 같습니다.

• 가능한 한 템플릿을 활용해 보십시오. 그러나 모든 요구 사항에 맞지 않을 수도 있습니다. 우리가 보고 싶은 최소값은 다음과 같습니다:
  • PR의 변경 사항과 목적을 간략하게 설명하는 제목으로, 영향을 받는 모듈을 대괄호로 묶는 것이 좋습니다(예 [javasrc2cpg] Addition Operator Fix .
  • PR 본문의 변경 사항에 대한 간단한 설명입니다. 이는 글머리 기호나 단락에 포함될 수 있습니다.
  • 관련 문제에 대한 링크 또는 참조(있는 경우)
• 하지 말아야 할 것:
  • 즉시 CC/@/이메일을 다른 기여자에게 스팸으로 보내면 팀에서 PR을 검토하고 PR을 검토할 가장 적절한 기여자를 배정합니다. Joern은 대부분 각자의 목표와 우선순위에 따라 업계 파트너와 연구원에 의해 유지 관리되며 추가 지원은 주로 자원 봉사 활동입니다. 귀하의 PR이 오래되면 @을 포함한 후속 댓글을 통해 우선 순위에 대한 설명이나 문제 해결 시기(해당하는 경우 품질에 따라)에 대한 계획을 요청하세요.
  • 설명 본문을 비워두면 PR의 목적을 검토하기가 어렵습니다.
• 기억하세요:
  • 코드 형식을 지정해야 합니다. 즉, sbt scalafmt Test/scalafmt 실행하세요.
  • 변경 사항을 확인하려면 단위 테스트를 추가하세요.

IDE 설정

Intellij IDEA

• Intellij 커뮤니티 다운로드
• 설치하고 실행하세요
• Scala 플러그인을 설치하세요. Intellij 내에서 검색하고 설치하세요.
• 중요: 로컬 joern 저장소에서 sbt 열고 compile 실행한 후 열어 두십시오. 이렇게 하면 다음 단계에서 BSP 빌드를 사용할 수 있습니다.
• Intellij로 돌아가기: 프로젝트 열기: 로컬 joern 클론 선택: BSP project 로 열기 선택(즉, sbt project 아님 !)
• 가져오기 및 인덱싱이 완료될 때까지 기다린 다음 Build -> build project 또는 테스트 실행 등을 시작할 수 있습니다.

VSCode

• VSCode 및 Docker 설치
• ms-vscode-remote.remote-containers 플러그인을 설치합니다.
• VSCode에서 Joern 프로젝트 폴더 열기 Visual Studio Code는 새 파일을 감지하고 Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• .devcontainer/Dockerfile 파일로 생성된 컨테이너의 폴더를 다시 열려면 Reopen in Container 버튼을 선택하세요.
• VSCode에서 scalameta.metals 사이드바로 전환하고 BUILD COMMANDS 에서 import build 선택합니다.
• import build 성공하면 Joern용 코드 작성을 시작할 준비가 된 것입니다.

QueryDB(쿼리 플러그인)

QueryDB를 개발하고 테스트하는 빠른 방법:

 sbt stage
./querydb-install.sh
./joern-scan --list-query-names

마지막 명령은 사용 가능한 모든 쿼리를 인쇄합니다. querydb에 쿼리를 추가하고 위 명령을 다시 실행하여 쿼리가 배포되었는지 확인하세요. 자세한 내용은 별도의 querydb readme를 참조하세요.