FOSSLight Binary Scanner

FOSSLight Binary is released under the Apache-2.0. Current python package version. REUSE status

FOSSLight Binary Scanner는 Binary를 찾아 출력하고 Binary DB에 동일하거나 비슷한 Binary가 있으면 해당 OSS 정보를 출력합니다.
jar 파일에 대한 오픈 소스 분석 시, 오픈 소스인 Dependency-check-py를 이용합니다.

Github Repository : https://github.com/fosslight/fosslight_binary_scanner
License : Apache-2.0

목차

📋 필요 조건

FOSSLight Binary Scanner는 Python 3.6+ 기반에서 동작합니다.
OSS 정보(OSS Name, OSS Version, License)를 Binary DB로부터 추출하는 기능을 사용하려면 DB 세팅 가이드를 참고하세요.

Jar 파일에 대한 분석을 위해서는 Java를 설치해야 합니다.(Open Source JDK를 설치)

🎉 설치 방법

방법 1. 실행 파일 다운로드

OS(Operating System)에 맞는 실행 파일을 다운로드 받습니다. : https://github.com/fosslight/fosslight_binary_scanner/releases
단, 지원하지 않는 OS인 경우 ‘방법 2'로 설치합니다.

방법 2. Python 환경 기반 fosslight_binary 설치

  1. python 3.6 + virtualenv 환경 세팅
  2. Python package인 fosslight_binary 설치 
    $ pip3 install fosslight_binary

🚀 실행 방법

방법 1. windows에서 실행 파일로 실행하는 경우

binary 분석할 path에 fosslight_bin_windows.exe 파일 위치시킨 후, 더블 클릭하여 실행합니다.

방법 2. 그 외, command로 실행하는 경우

$ fosslight_binary [option] <arg>

Options

    Mandatory:
        -p <binary_path>              Binary를 추출할 경로

    Options:
        -h                            Help Message 출력
        -o <output_path>              결과물 저장할 경로 (특정 결과 파일명을 원하는 경우에는 파일명까지 입력합니다.)
        -f <format>                   결과 파일 format (excel, csv, opossum) (default: excel and csv (window : excel only)
        -d <db_url>                   Binary DB 접속 정보(format :'postgresql://username:password@host:port/database_name')

📁 결과

$ tree
.
├── binary_20210601_201646.txt
├── fosslight_bin_log_20210601_201646.txt
├── FOSSLight-Report_20210601_201646_BIN.csv
├── FOSSLight-Report_20210601_201646.xlsx
└── Opossum_input_20210601_201646.json
  • binary_[datetime].txt : Binary별 checksum, tlsh 값이 출력된 결과
  • fosslight_bin_log_[datetime].txt : 실행 log
  • FOSSLight-Report_[datetime]_BIN.csv : FOSSLight binary의 결과 (csv 형태. windows는 생성 안 함)
  • FOSSLight-Report_[datetime].xlsx : FOSSLight binary의 결과 (FOSSLight Report 형태)
    • jar 파일 분석 시, Vulnerability Link Column이 FOSSLight-Report_[datetime].xlsx에 추가 됨.
  • Opossum_input_[datetime].json : OpossumUI에서 활용 가능한 Binary 분석 결과

🧐 동작 방식

  1. 하기 사항을 제외하고 Binary를 추출합니다.
    1-0. symbolic link, FIFO 파일
    1-1. 파일 extension : [‘png', ‘gif', ‘jpg', ‘bmp', ‘jpeg', ‘qm', ‘xlsx', ‘pdf', ‘ico', ‘pptx', ‘jfif', ‘docx', ‘doc', ‘whl', ‘xls', ‘xlsm', ‘ppt', ‘mp4', ‘pyc', ‘plist']
    1-2. 파일 Type : [‘data','timezone data', ‘apple binary property list']
    1-3. 경로 : [‘.git']
  2. 하기 사항에 대하여 FOSSLight Report에 "Exclude"를 체크합니다.
    • Binary가 [‘fosslight_bin', ‘fosslight_bin.exe']에 포함되는 경우
    • 경로가 ["test", "tests", "doc", "docs"]에 포함되는 경우
  3. Binary별 checksum과 tlsh를 출력합니다.
  4. OSS 정보를 Binary DB로 부터 불러옵니다.
  5. Output 파일을 생성합니다.