The main files and their functions are as follows (listed in order):

joern: Software used for generating code property graphs, primarily using the bin/joern-parse and bin/joern commands.

get_rawpatch.py: Script for retrieving patch files.

get_ab_file.py: Script for obtaining pre- and post-patch versions of files.

gen_cpg.py + locate_align.py: Scripts for removing unrelated function modifications between pre- and post-patch versions.

my_gen_cpg.py: Script for generating code property graphs and processing node and edge relationships (complex, no need to fully understand, inspired by other research papers).

test.py: Calls two scripts in the preproc directory to parse node and edge information from CPG files:

preproc/extract_graph.py: Reads files, extracts properties, and converts code into token sequences.

preproc/construct_graph.py: Handles node and edge embeddings, generating vectors.

testdata2-5: Processed data used as input for the model (corresponding to FFmpeg, Linux, QEMU, Wireshark).

dataloader.py: Works with model.py to load data.

model.py: The main model file.

output-4edges: Directory for saving model outputs.

Installation

1. Install OS

Download Ubuntu 20.04.4 LTS (Focal Fossa) desktop version .iso file and install the OS.

Note: To avoid potential version conflicts of Python and Java on existing OS, we suggest installing a new Ubuntu virtual machine on VMM (e.g., VirtualBox 5.2.24, VMware, etc.).

Suggested system configurations:
(Our package can run on pure CPU environments)
RAM: >2GB
Disk: >30GB
CPU: >1 core

2. Clone Source Code

Install git tool if you have not intalled it.

sudo apt install git

Download the project folder into the user's HOME directory.

cd ~
git clone https://github.com/Qi247/SimSPI.git

3. Install Dependencies

cd ~/SimSPI/
chmod +x install_dep.sh
./install_dep.sh

How-to-Run

Note: All commands are executed under the main project folder: ~/SimSPI/.

1. Pre-processing

1.1 Use Test Patch Samples

We provide 10 patch as test examples in ~/SimSPI/raw_patch/.

To retrive their pre- and post-patch files, run the following commands under ~/SimSPI/:

python3 get_ab_file.py nginx nginx 02cca547
python3 get_ab_file.py nginx nginx 661e4086
python3 get_ab_file.py nginx nginx 9a3ec202
python3 get_ab_file.py nginx nginx dac90a4b
python3 get_ab_file.py nginx nginx fc785b12
python3 get_ab_file.py nginx nginx 60a8ed26
python3 get_ab_file.py nginx nginx bd7dad5b
python3 get_ab_file.py nginx nginx 4c5a49ce
python3 get_ab_file.py nginx nginx 71eb19da
python3 get_ab_file.py nginx nginx 56f53316

In the above, the third column refers to the owner (i.e., nginx), the fourth column refers to the repository (i.e., nginx), and the last column refers to the commit ID (e.g., 02cca547).

As the result, the pre-patch and post-patch files will be stored in ~/SimSPI/ab_file/.

1.2 Use Your Own Patches

You can pre-process your own patches by running:

python3 get_ab_file.py [owner] [repository] [commitID]

where [owner], [repository], and [commitID] are the owner name, repository name, and commit ID of the patch hosted on GitHub.

2. Generate PatchCPGs

To generate PatchCPGs for all the patches processed by the last step, please run the following commands under ~/SimSPI/:

chmod -R +x ./joern
sudo python3 gen_cpg.py
python3 merge_cpg.py

Here, gen_cpg.py will generate two CPGs for pre- and post-patch files, respectively.
merge_cpg.py will generate a merged PatchCPG from the two CPGs.
The output PatchCPGs will be saved in ~/SimSPI/testdata/.

3. Run PatchGNN

In ~/SimSPI/, run the command:

python3 test.py

The prediction results are saved in file ~/SimSPI/logs/test_results.txt.

See the results by running:

cat logs/test_results.txt

The prediction results contains the PatchCPG file path and the predictions, where 1 represents security patch and 0 represents non-security patch.

filename,prediction
./testdata/fc785b12/out_slim_ninf_noast_n1_w.log,0
./testdata/dac90a4b/out_slim_ninf_noast_n1_w.log,1
./testdata/60a8ed26/out_slim_ninf_noast_n1_w.log,1
./testdata/71eb19da/out_slim_ninf_noast_n1_w.log,0
./testdata/9a3ec202/out_slim_ninf_noast_n1_w.log,1
./testdata/bd7dad5b/out_slim_ninf_noast_n1_w.log,1
./testdata/661e4086/out_slim_ninf_noast_n1_w.log,1
./testdata/02cca547/out_slim_ninf_noast_n1_w.log,0
./testdata/4c5a49ce/out_slim_ninf_noast_n1_w.log,0
./testdata/56f53316/out_slim_ninf_noast_n1_w.log,0