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++)

Требования к разработке

• МВН 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. Для виртуальной машины kvm64 вместо этого используйте версию Almalinux 8.

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

Релизы

Новый выпуск создается автоматически один раз в день. Участники также могут вручную запустить рабочий процесс выпуска, если выпуск нужен им раньше.

Разработчики

Рекомендации по внесению взносов

Спасибо, что нашли время внести свой вклад в жизнь Йорна! Вот несколько рекомендаций, которые помогут гарантировать, что ваш запрос на включение будет объединен как можно скорее:

• Постарайтесь максимально использовать шаблоны, однако они могут не удовлетворять всем потребностям. Минимум, который мы хотели бы видеть, это:
  • Заголовок, который кратко описывает изменение и цель PR, желательно с соответствующим модулем в квадратных скобках, например, [javasrc2cpg] Addition Operator Fix .
  • Краткое описание изменений в корпусе ПР. Это могут быть пункты или абзацы.
  • Ссылка или ссылка на соответствующую проблему, если таковая имеется.
• Не:
  • Немедленно отправив CC/@/email спам другим участникам, команда рассмотрит PR и назначит наиболее подходящего участника для рассмотрения PR. Joern поддерживают как отраслевые партнеры, так и исследователи, по большей части преследующие их собственные цели и приоритеты, а дополнительная помощь в основном представляет собой волонтерскую работу. Если ваш PR устарел, напишите нам в последующих комментариях, попросив @ объяснить приоритет или спланировать, когда его можно будет рассмотреть (если вообще когда-нибудь, в зависимости от качества).
  • Оставьте тело описания пустым, это затруднит проверку цели PR.
• Не забудьте:
  • Не забудьте отформатировать код, т.е. запустите sbt scalafmt Test/scalafmt
  • Добавьте модульный тест, чтобы проверить изменения.

настройка IDE

Интеллидж ИДЕЯ

• Скачать сообщество Intellij
• Установите и запустите его
• Установите плагин Scala — просто найдите и установите его из Intellij.
• Важно: откройте sbt в своем локальном репозитории joern, запустите compile и оставьте его открытым — это позволит нам использовать сборку BSP на следующем этапе.
• Вернитесь к Intellij: откройте проект: выберите локальный клон joern: выберите, чтобы открыть его как BSP project (т.е. не sbt project !)
• Дождитесь завершения импорта и индексации, затем вы можете начать, например, Build -> build project или запустить тест.

VSCode

• Установите VSCode и Docker.
• Установите плагин ms-vscode-remote.remote-containers
• Откройте папку проекта Joern в VSCode. Visual Studio Code обнаруживает новые файлы и открывает окно сообщения: Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• Нажмите кнопку Reopen in Container чтобы повторно открыть папку в контейнере, созданную файлом .devcontainer/Dockerfile
• Переключитесь на боковую панель scalameta.metals в VSCode и выберите import build в BUILD COMMANDS
• После успешного import build вы готовы приступить к написанию кода для Joern.

QueryDB (плагин запросов)

Быстрый способ разработки и тестирования QueryDB:

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

Последняя команда печатает все доступные запросы — добавьте свои собственные в querydb, снова запустите приведенные выше команды, чтобы убедиться, что ваш запрос развернут. Более подробную информацию можно найти в отдельном файле readme querydb.