build: add Docker support for fuzzing scenarios

Adds Dockerfile and docker-compose.yml to facilitate running fuzzing targets in isolated environments.
Supports environment variables FUZZ, CXXFLAGS, FUZZ_RUNS, and FUZZ_INPUT.
Corpus data is persisted via volume mounts to the host.

Author: moisesPompilio

.dockerignore

@@ -0,0 +1,5 @@
+*.o
+*.a
+*.so
+*.out
+*.exe

.gitignore

@@ -11,4 +11,5 @@ obj/
 *.so
 __pycache__
 main.py
-corpus/
+corpus/
+docker/

Dockerfile

@@ -0,0 +1,91 @@
+# Uses Ubuntu as base
+FROM ubuntu:22.04
+
+# Sets environment variables for installation
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Installs basic tools
+RUN apt-get update && apt-get install -y \
+    wget curl git build-essential sudo \
+    libc6-dev libgcc-11-dev libasan6 \
+    cmake \
+    && rm -rf /var/lib/apt/lists/*
+
+# Installs Rust
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ENV PATH="/root/.cargo/bin:${PATH}"
+RUN rustup install stable && rustup install nightly
+
+# Installs Go
+RUN wget https://golang.org/dl/go1.22.2.linux-amd64.tar.gz && \
+    tar -C /usr/local -xzf go1.22.2.linux-amd64.tar.gz && \
+    rm go1.22.2.linux-amd64.tar.gz
+ENV PATH="/usr/local/go/bin:${PATH}"
+
+# Installs .NET SDK 8.0
+RUN wget https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb && \
+    dpkg -i packages-microsoft-prod.deb && \
+    rm packages-microsoft-prod.deb && \
+    apt-get update && apt-get install -y dotnet-sdk-8.0 && \
+    rm -rf /var/lib/apt/lists/*
+
+# Installs Python 3.11 and pip
+RUN apt-get update && apt-get install -y python3.11 python3-pip && \
+    rm -rf /var/lib/apt/lists/*
+RUN python3.11 -m pip install --upgrade pip
+
+# Installs LLVM and Clang 18
+RUN apt-get update && apt-get install -y \
+    lsb-release wget software-properties-common gnupg && \
+    wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add - && \
+    add-apt-repository "deb http://apt.llvm.org/jammy/ llvm-toolchain-jammy-18 main" && \
+    apt-get update && apt-get install -y \
+    clang-18 clang++-18 && \
+    ln -sfT /usr/bin/clang++-18 /usr/bin/clang++ && \
+    ln -sfT /usr/bin/clang-18 /usr/bin/clang && \
+    rm -rf /var/lib/apt/lists/*
+
+# Installs Boost
+RUN apt-get update && apt-get install -y libboost-all-dev && \
+    rm -rf /var/lib/apt/lists/*
+
+# Configures environment variables
+ENV CC=/usr/bin/clang
+ENV CXX=/usr/bin/clang++
+ENV BOOST_LIB_DIR=/usr/lib/x86_64-linux-gnu/
+
+# Working directory
+WORKDIR /app
+
+# Copies the repository
+COPY . .
+
+# Installs dependencies for embit
+RUN pip install -r modules/embit/embit_lib/requirements.txt
+
+# Clean cache bitcoin core
+RUN rm -rf /app/modules/bitcoin/univalue/build && \
+    mkdir -p /app/modules/bitcoin/univalue/build && \
+    cd /app/modules/bitcoin/univalue && \
+    CXXFLAGS="-fsanitize=address" cmake -B build && \
+    cmake --build build && \
+    cd build && \
+    make univalue
+
+# Copies and gives permission to auto_build.sh
+COPY auto_build.sh .
+RUN chmod +x auto_build.sh
+
+# CMD requires FUZZ, but FUZZ_RUNS and FUZZ_INPUT are optional
+CMD ["bash", "-c", "mkdir -p /app/data && \
+    ./auto_build.sh && \
+    if [ -z \"$FUZZ\" ]; then \
+    echo \"Error: FUZZ not defined\"; \
+    exit 1; \
+    elif [ -n \"$FUZZ_INPUT\" ]; then \
+    ./bitcoinfuzz \"$FUZZ_INPUT\"; \
+    elif [ -n \"$FUZZ_RUNS\" ]; then \
+    ./bitcoinfuzz -runs=$FUZZ_RUNS -artifact_prefix=/app/data/crash- /app/data; \
+    else \
+    ./bitcoinfuzz -artifact_prefix=/app/data/crash- /app/data; \
+    fi"]

docker-compose.yml

@@ -0,0 +1,108 @@
+x-common-env:
+  &common-env
+  FUZZ_RUNS: ${FUZZ_RUNS}
+  FUZZ_INPUT: ${FUZZ_INPUT}
+
+services:
+  script:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DRUST_BITCOIN"
+      FUZZ: script
+    volumes:
+      - ./docker/script:/app/data
+
+  deserialize_block:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DRUST_BITCOIN -DBTCD"
+      FUZZ: deserialize_block
+    volumes:
+      - ./docker/deserialize_block:/app/data
+
+  script_eval:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DBTCD"
+      FUZZ: script_eval
+    volumes:
+      - ./docker/script_eval:/app/data
+
+  descriptor_parse:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DRUST_MINISCRIPT -DEMBIT"
+      FUZZ: descriptor_parse
+      ASAN_OPTIONS: detect_leaks=0
+    volumes:
+      - ./docker/descriptor_parse:/app/data
+
+  miniscript_parse:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DRUST_MINISCRIPT -DEMBIT"
+      FUZZ: miniscript_parse
+      ASAN_OPTIONS: detect_leaks=0
+    volumes:
+      - ./docker/miniscript_parse:/app/data
+
+  script_asm:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DBTCD"
+      FUZZ: script_asm
+    volumes:
+      - ./docker/script_asm:/app/data
+
+  deserialize_invoice:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DLDK -DLND -DNLIGHTNING"
+      FUZZ: deserialize_invoice
+      ASAN_OPTIONS: detect_leaks=0
+    volumes:
+      - ./docker/deserialize_invoice:/app/data
+
+  address_parse:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DBITCOIN_CORE -DRUST_BITCOIN"
+      FUZZ: address_parse
+    volumes:
+      - ./docker/address_parse:/app/data
+
+  psbt_parse:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      <<: *common-env
+      CXXFLAGS: "-DEMBIT -DRUST_BITCOIN -DBTCD"
+      FUZZ: psbt_parse
+      ASAN_OPTIONS: detect_leaks=0
+    volumes:
+      - ./docker/psbt_parse:/app/data