leakage analysis

การวิเคราะห์การรั่วไหล

เครื่องมือวิเคราะห์แบบคงที่เพื่อตรวจจับการรั่วไหลของข้อมูลการทดสอบในโน้ตบุ๊ก Python

นี่คือเครื่องมือของกระดาษ ASE'22: การรั่วไหลของข้อมูลในสมุดบันทึก: การตรวจจับแบบคงที่และกระบวนการที่ดีกว่า การสาธิตออนไลน์ก็มีให้เช่นกัน สำหรับสคริปต์การประเมินผลและวัสดุของเราโปรดดู repo นี้

วิธีการสร้าง

1. ติดตั้ง Souffle เอ็นจิ้น Datalog ที่เราใช้สำหรับการวิเคราะห์หลักของเรา ตรวจสอบให้แน่ใจว่า Souffle สามารถเรียกใช้โดยตรงในบรรทัดคำสั่ง
2. ดึงและสร้าง [Pyright] รุ่นที่กำหนดเองของเราซึ่งเป็นเอ็นจิ้นการอนุมานประเภทที่เราใช้: git submodule update --init --recursive (โปรดดูที่ Submodule สำหรับการสร้างโครงการ)
3. ติดตั้งแพ็คเกจ Python ที่ต้องการในข้อกำหนด. txt เราใช้ Python 3.8 สำหรับเครื่องมือของเรา รุ่นงูหลามที่แตกต่างกันอาจส่งผลให้เกิดข้อผิดพลาดที่แตกต่างกันและข้อผิดพลาดที่ไม่คาดคิด

วิธีใช้

1. เรียกใช้การวิเคราะห์สำหรับไฟล์ Python เดียว: python3 -m src.main /path/to/file
2. เรียกใช้การวิเคราะห์สำหรับไฟล์ Python ทั้งหมดในไดเรกทอรี: python3 -m src.run /path/to/dir
3. ข้อมูลเพิ่มเติมสามารถพบได้โดยใช้ธง -h

วิธีการสร้างและเรียกใช้อิมเมจนักเทียบท่า

1. ดึง Pyright รุ่นที่เรากำหนดเองซึ่งเป็นเอ็นจิ้นการอนุมานประเภทที่เราใช้: git submodule update --init --recursive
2. เพิ่มไลบรารี Python ที่ใช้แล้วทั้งหมดลงใน requirements.txt TXT ซึ่งจะติดตั้งในคอนเทนเนอร์และใช้โดย Pyright
3. สร้างภาพนักเทียบท่า: docker build -t leakage-analysis .
4. เรียกใช้ภาพนักเทียบท่า: docker run -v /path/to/dir:/path/to/dir leakage-analysis /path/to/dir/$FILE -o โน้ตบุ๊กที่ต้องวิเคราะห์ทั้งหมดควรถูกแปลงเป็นไฟล์ Python และเก็บไว้ใน /path/to/dir

วิธีการอ่านเอาต์พุต

สำหรับ test.py ไฟล์อินพุตที่กำหนด py test.html ไฟล์ html เอาต์พุต html จะถูกสร้างขึ้นหากระบุสถานะ -o

ใน test.html เราแสดงผลการวิเคราะห์ควบคู่ไปกับรหัสอินพุต ตารางสรุปเกี่ยวกับปัญหาการรั่วไหลที่ตรวจพบจะแสดงอยู่ด้านบน ผู้ใช้ยังสามารถใช้ปุ่มโต้ตอบเพื่อเน้นรหัสที่เกี่ยวข้องและนำทางผ่านกลุ่มรหัสที่แตกต่างกัน

โครงสร้างภายใน

ได้รับไฟล์ Python, src/main.py แรกวิเคราะห์อินพุตลงใน AST จากนั้นจะป้อน AST ไปยังอินสแตนซ์ GlobalCollector (จาก global_collector.py ) ที่รวบรวมตัวแปรทั่วโลกที่เราไม่สามารถเปลี่ยนชื่อได้ในการแปลงในภายหลังซึ่งเราจะไม่สนใจในภายหลัง

ถัดไปมันจะป้อน AST ไปยังอินสแตนซ์ codetransformer (จาก irgen.py ) ที่แปลรหัส Python ดั้งเดิมเป็นเวอร์ชันที่ง่ายกว่าที่ 1) จะแบ่งคำสั่งที่ซับซ้อนให้เป็นหลาย ๆ ที่ง่ายกว่าและ 2) แปลรหัสเป็นแบบคงที่การกำหนดเดี่ยว (SSA) แบบคงที่

จากนั้นจะเรียกว่าเอ็นจิ้นการอนุมานประเภทบนไฟล์รหัสที่แปลงแล้ว ด้วยข้อมูลการอนุมานประเภทจะแปลงไฟล์รหัสเป็นข้อเท็จจริง datalog การวิเคราะห์ขั้นสุดท้ายสามารถอ่านได้โดยใช้ FactGenerator จาก factgen.py

ในที่สุดมันทำการวิเคราะห์ Datalog ( main.dl ) เกี่ยวกับข้อเท็จจริงที่สร้างขึ้นและผลลัพธ์ส่งผลในไดเรกทอรีเดียวกัน

โครงสร้างไดเรกทอรี

 src
├── factgen.py: convert transformed code to datalog facts
├── global_collector.py: collect global variables
├── __init__.py
├── irgen.py: transform code to simpler SSA form
├── main.dl: main datalog analysis that analyzes leakage
├── main.py: run analysis on a single file
├── render.py: output a html file based on analysis results and original code
├── run.py: run analysis on multiple files
└── scope.py: manage variable scopes for renaming purposes