easy_sast

SAST ง่าย

Easy_sast เป็นคอนเทนเนอร์ Docker สำหรับใช้ในการรวมท่อเพื่อส่งสิ่งประดิษฐ์บิวด์ของแอปพลิเคชันไปยังเครื่องมือการวิเคราะห์แบบคงที่ สิ่งนี้ได้รับการพัฒนาในวิธีที่จะทำหน้าที่เป็นรูปแบบการสร้างสำหรับภาชนะอื่น ๆ ที่มีความหมายเพื่ออำนวยความสะดวกในการทำงานที่คล้ายกันและรวมเข้ากับผลิตภัณฑ์การวิเคราะห์แบบคงที่ของ Veracode

• คุณสมบัติ
• เร็ว
• การใช้งาน
• การบริจาค

Easy_sast มีให้บริการจาก Docker Hub โดยใช้ docker pull seiso/easy_sast

สำหรับการใช้งานขั้นสูงและข้อมูลเพิ่มเติมดูที่วิกิ

คุณสมบัติ

ฐานรหัสนี้ได้รับการพัฒนาตาม แถลงการณ์ที่ทนทาน เช่นนี้คือ:

• ใช้งานง่าย : ด้วยตัวเลือกเวิร์กโฟลว์และการกำหนดค่าที่เข้าใจ DevOps โดยสังหรณ์ใจ
• สามารถกำหนดค่าได้อย่างง่ายดาย : ค่าเริ่มต้นปฏิบัติและตัวเลือกการกำหนดค่าจำนวนมากเช่นไฟล์กำหนดค่าตัวแปรสภาพแวดล้อมและ/หรืออาร์กิวเมนต์ CLI
• รหัสที่ชัดเจนและเข้าใจได้ : การใช้คำแนะนำประเภทปกติอาร์กิวเมนต์คำหลักและรูปแบบรหัสปกติทำให้การทำความเข้าใจความตั้งใจของรหัสง่าย
• ออกแบบมาเพื่อให้แข็งแกร่ง : การจัดการข้อผิดพลาดการตรวจสอบความปลอดภัยอัตโนมัติและการตรวจสอบความถูกต้องที่แพร่หลาย
• ทดสอบ 100% : ครอบคลุมรหัส 100% สำหรับการทดสอบหน่วยในการกระทำทั้งหมด
• การจัดรูปแบบ 100% อย่างสม่ำเสมอ : ผ้าสำลีของ Docker, Make, Yaml และ Python ในการกระทำทั้งหมด

เร็ว

ข้อกำหนดเบื้องต้น

ในการสร้างและเรียกใช้โครงการนี้เราขอแนะนำให้คุณมี Docker 18.09 หรือใหม่กว่า, ค้นหา, Git, GNU Make และ Python 3

การตั้งค่า

ข้อกำหนดการรวม

ในการรวมเข้ากับ Veracode คุณจะต้อง:

• สามารถสร้างบิลด์ดีบั๊กของแอปพลิเคชันของคุณ

• มีบัญชีและใบอนุญาตที่ถูกต้องในการใช้ API ผลิตภัณฑ์ SAST ของ Veracode ที่ระบุไว้ด้านล่าง

• มีแอปพลิเคชันในศูนย์วิเคราะห์ของ Veracode ที่คุณตั้งใจจะใช้

• ส่งออกข้อมูลรับรอง Veracode ของคุณเป็นตัวแปรสภาพแวดล้อม:

   export VERACODE_API_KEY_ID=EXAMPLE
   export VERACODE_API_KEY_SECRET=EXAMPLE
  

เริ่มต้น

1. สร้างภาพนักเทียบท่า:

   make build

2. เรียกใช้คอนเทนเนอร์ Docker ส่งผ่านข้อมูลประจำตัว API ของคุณและติดตั้งไดเรกทอรีที่มีสิ่งประดิษฐ์ของคุณเป็น /สร้าง:

   docker run --env-file <( env | grep ^VERACODE_API_KEY_ ) -v " /path/to/build " :/build seiso/easy_sast:latest

รายละเอียดเพิ่มเติมและตัวเลือกการกำหนดค่ามีการระบุไว้ในการใช้งานและบนวิกิ

การใช้งาน

บรรทัดคำสั่ง

usage: main.py [-h] [--config-file CONFIG_FILE] [--version]
               [--debug | --verbose]

optional arguments:
  -h, --help                          show this help message and exit
  --config-file CONFIG_FILE           specify a config file
  --version                           show program ' s version number and exit
  --debug                             enable debug level logging
  --verbose                           enable info level logging

มีสองวิธีที่แนะนำในการส่งข้อมูลไปยัง easy_sast ที่รันไทม์:

1. ผ่านตัวแปรสภาพแวดล้อมไปยัง docker run โดยใช้ --env-file ตัวอย่างเช่น:

   docker run --env-file <( env | grep VERACODE_API_KEY_ ) -v " /path/to/build " :/build seiso/easy_sast:latest

2. คุณอาจต้องการส่งอาร์กิวเมนต์ไปยัง Python ในคอนเทนเนอร์โดยผนวกอาร์กิวเมนต์ของคุณเข้ากับ docker run ตัวอย่างเช่น:

   docker run -e VERACODE_API_KEY_ID=EXAMPLE -e VERACODE_API_KEY_SECRET=EXAMPLE seiso/easy_sast:latest --debug

ต้องการเรียนรู้เกี่ยวกับการใช้งานขั้นสูงมากขึ้นเช่นการเพิ่มประสิทธิภาพ SAST สำหรับคำขอดึงหรือไม่? ตรวจสอบวิกิ

รองรับ Veracode APIs

• อัปโหลด API
• ผลลัพธ์ API

โปรดทราบว่าอย่างน้อยที่สุดผู้ใช้ Veracode ของคุณจะต้องได้รับอนุญาตให้เข้าถึง API การอัปโหลดและจุดสิ้นสุดของ getAppList.do

หากคุณต้องการเห็นการสนับสนุนสำหรับ Veracode API หรือเวิร์กโฟลว์เพิ่มเติมเพื่อโต้ตอบกับ API เหล่านั้นโปรดเปิดปัญหาและแจ้งให้เราทราบ!

การบริจาค

1. แยกที่เก็บ
2. สร้างสาขาฟีเจอร์ผ่าน git checkout -b feature/description
3. ทำการเปลี่ยนแปลงของคุณ
4. กระทำการเปลี่ยนแปลงของคุณผ่าน git commit -am 'Summarize the changes here'
5. สร้างคำขอดึงใหม่ (วิธีการ)