minder

- - - -

การติดตั้ง | เอกสารประกอบ | ข่าวประชาสัมพันธ์

มายด์เดอร์คืออะไร?

Minder เป็นแพลตฟอร์มโอเพ่นซอร์สที่ช่วยให้ทีมพัฒนาและชุมชนโอเพ่นซอร์สสร้างซอฟต์แวร์ที่ปลอดภัยยิ่งขึ้น และพิสูจน์ให้ผู้อื่นเห็นว่าสิ่งที่พวกเขาสร้างขึ้นนั้นปลอดภัย Minder ช่วยให้เจ้าของโปรเจ็กต์จัดการมาตรการรักษาความปลอดภัยในเชิงรุกโดยจัดเตรียมชุดการตรวจสอบและนโยบายเพื่อลดความเสี่ยงตลอดห่วงโซ่อุปทานของซอฟต์แวร์ และยืนยันแนวทางปฏิบัติด้านความปลอดภัยแก่ผู้บริโภคขั้นปลายน้ำ

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

Minder สามารถนำไปใช้เป็นแผนภูมิ Helm และจัดให้มีเครื่องมือ minder CLI Stacklok ซึ่งเป็นบริษัทที่สนับสนุน Minder ยังให้บริการ Minder เวอร์ชันโฮสต์ที่ใช้งานได้ฟรี (สำหรับพื้นที่เก็บข้อมูลสาธารณะเท่านั้น) Minder ได้รับการออกแบบมาให้ขยายได้ ทำให้ผู้ใช้สามารถผสานรวมกับเครื่องมือและกระบวนการที่มีอยู่ได้

คุณสมบัติ

• การกำหนดค่าและการรักษาความปลอดภัย Repo: ลดความซับซ้อนของการกำหนดค่าและการจัดการการตั้งค่าความปลอดภัยและนโยบายทั่วทั้ง Repos
• การบังคับใช้ความปลอดภัยเชิงรุก: บังคับใช้การกำหนดค่าความปลอดภัยแนวทางปฏิบัติที่ดีที่สุดอย่างต่อเนื่องโดยการตั้งค่านโยบายแบบละเอียดเพื่อแจ้งเตือนเท่านั้นหรือแก้ไขอัตโนมัติ
• การรับรองสิ่งประดิษฐ์: ตรวจสอบอย่างต่อเนื่องว่าแพ็กเกจได้รับการลงนามเพื่อให้แน่ใจว่าไม่มีการปลอมแปลงโดยใช้ Sigstore โปรเจ็กต์โอเพ่นซอร์ส
• การจัดการการพึ่งพา: จัดการมาตรการรักษาความปลอดภัยการพึ่งพาโดยช่วยให้นักพัฒนาตัดสินใจเลือกได้ดีขึ้นและบังคับใช้การควบคุม Minder ได้รับการผสานรวมกับ OSV และ Trusty เพื่อเปิดใช้งานการจัดการการพึ่งพาที่ขับเคลื่อนด้วยนโยบายตามระดับความเสี่ยงของการพึ่งพา

ตัวอย่างสาธารณะ

Stacklok ซึ่งเป็นบริษัทที่สนับสนุน Minder จัดทำอินสแตนซ์สาธารณะของ Minder ที่ใช้งานได้ฟรี นี่เป็นอินสแตนซ์เริ่มต้นที่ใช้เมื่อคุณใช้ minder CLI อินสแตนซ์นี้ใช้ได้กับพื้นที่เก็บข้อมูลสาธารณะเท่านั้น

---

การเริ่มต้นใช้งาน (< 1 นาที)

การเริ่มต้นใช้งาน Minder ใช้เวลาไม่ถึงนาทีและง่ายดายเพียง:

1. การติดตั้ง Minder
2. กำลังเข้าสู่ระบบ Minder
3. และเรียกใช้ minder quickstart เพื่อสร้างโปรไฟล์แรกของคุณ

ในเวลาเพียงไม่กี่วินาที คุณจะลงทะเบียนพื้นที่เก็บข้อมูลของคุณและเปิดใช้งานการป้องกันการสแกนความลับสำหรับพื้นที่เก็บข้อมูลทั้งหมด! -

การติดตั้ง

เลือกวิธีการที่คุณต้องการในการติดตั้ง minder :

MacOS (โฮมบรูว์)

ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง Homebrew แล้ว

brew install minder

วินโดวส์ (วิงเก็ต)

ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง Winget แล้ว

winget install stacklok.minder

ดาวน์โหลดรุ่น

ดาวน์โหลดรุ่นล่าสุดจาก minder/releases

สร้างมันขึ้นมาจากแหล่งที่มา

สร้าง minder และ minder-server จากซอร์สโดยทำตามคู่มือ build จากซอร์ส

กำลังเข้าสู่ระบบ Minder

หากต้องการใช้ minder กับอินสแตนซ์สาธารณะของ Minder ( api.stacklok.com ) ให้เข้าสู่ระบบโดยเรียกใช้:

minder auth login

เมื่อเสร็จสิ้น คุณจะเห็นว่า Minder Server ได้รับการตั้งค่าเป็น api.stacklok.com

เรียกใช้การเริ่มต้นอย่างรวดเร็วของ Minder

คำสั่ง quickstart จะแนะนำคุณตลอดขั้นตอนการสร้างโปรไฟล์แรกใน Minder ลงทะเบียนที่เก็บข้อมูลของคุณ และเปิดใช้งานการป้องกันการสแกนความลับสำหรับที่เก็บข้อมูลของคุณในไม่กี่วินาที

โดยเรียกใช้:

minder quickstart

สิ่งนี้จะแจ้งให้คุณลงทะเบียนผู้ให้บริการของคุณ เลือกที่เก็บที่คุณต้องการ สร้างประเภทกฎ secret_scanning และสร้างโปรไฟล์ที่เปิดใช้งานการสแกนความลับสำหรับที่เก็บที่เลือก

หากต้องการดูสถานะโปรไฟล์ของคุณ ให้เรียกใช้:

minder profile status list --profile quickstart-profile --detailed

คุณควรเห็นสถานะโปรไฟล์โดยรวมและมุมมองโดยละเอียดของสถานะการประเมินกฎสำหรับที่เก็บแต่ละแห่งที่ลงทะเบียนของคุณ

Minder จะยังคงติดตามที่เก็บข้อมูลของคุณต่อไป และจะตรวจสอบให้แน่ใจว่าจะแก้ไขการเบี่ยงเบนจากสถานะที่ต้องการโดยใช้คุณสมบัติ remediate หรือแจ้งเตือนคุณโดยใช้คุณสมบัติ alert หากจำเป็น

ยินดีด้วย! - ตอนนี้คุณสร้างโปรไฟล์แรกของคุณสำเร็จแล้ว!

อะไรต่อไป?

ตอนนี้คุณสามารถสำรวจฟีเจอร์ของ Minder ต่อไปได้โดยการเพิ่มหรือลบที่เก็บข้อมูล สร้างโปรไฟล์เพิ่มเติมด้วยกฎที่หลากหลาย และอื่นๆ อีกมากมาย Minder มีอะไรมากกว่าแค่การสแกนแบบเป็นความลับ

กฎ secret_scanning เป็นเพียงหนึ่งในกฎประเภทต่างๆ ที่ Minder รองรับ

คุณสามารถดูรายการกฎและโปรไฟล์ที่พร้อมใช้งานทั้งหมดที่ดูแลโดยทีมงานของ Minder ได้ที่นี่ - mindersec/minder-rules-and-profiles

ในกรณีที่คุณยังไม่พบสิ่งใดในนั้น Minder ได้รับการออกแบบมาให้ขยายได้ วิธีนี้ช่วยให้ผู้ใช้สามารถสร้างประเภทกฎและโปรไฟล์ที่กำหนดเองของตนเองได้ และรับประกันว่าจะมีการรับรองลักษณะเฉพาะของการรักษาความปลอดภัยของตน

เมื่อคุณได้ตั้งค่าทุกอย่างแล้ว คุณสามารถเรียกใช้คำสั่ง minder ต่อกับอินสแตนซ์สาธารณะของ Minder ได้ ซึ่งคุณสามารถจัดการพื้นที่เก็บข้อมูลที่ลงทะเบียนไว้ สร้างโปรไฟล์ กฎ และอื่นๆ อีกมากมาย เพื่อให้คุณมั่นใจได้ว่ามีการกำหนดค่าพื้นที่เก็บข้อมูลของคุณอย่างสม่ำเสมอและปลอดภัย

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ minder โปรดดูที่:

• คำสั่ง minder CLI - เอกสาร
• เอกสารประกอบ REST API minder - Docs.
• กฎและโปรไฟล์ minder ดูแลโดยทีมงานของ Minder - GitHub
• เอกสาร Minder - เอกสาร

แผนการทำงาน

ชุมชน Minder กำลังทำงานอย่างแข็งขันเพื่อพัฒนาคุณสมบัติใหม่และการปรับปรุงสำหรับ Minder

คุณสามารถดูแผนงานของเราได้ที่นี่

หากคุณต้องการร้องขอหรือสนับสนุนคุณลักษณะหรือการปรับปรุง โปรดใช้เทมเพลตปัญหาต่อไปนี้

การพัฒนา

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

สร้างจากแหล่งที่มา

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

คุณต้องมีเครื่องมือต่อไปนี้ - Go, Docker และ Docker Compose

ในการสร้างและรัน minder-server คุณจะต้องมี ko ด้วย

หากต้องการรันชุดทดสอบผ่าน make test คุณจะต้องมี gotestfmt และ helm

หากต้องการเรียกใช้เป้าหมาย make run-docker คุณจะต้องมี yq

โคลนพื้นที่เก็บข้อมูล

git clone [email protected]:mindersec/minder.git

สร้าง

รันสิ่งต่อไปนี้เพื่อสร้าง minder และ minder-server (ไบนารีจะมีอยู่ที่ ./bin/ / )

make build

หากต้องการใช้ minder กับอินสแตนซ์สาธารณะของ Minder ( api.stacklok.com ) ให้รัน:

minder auth login

เมื่อเสร็จสิ้น คุณจะเห็นว่า Minder Server ได้รับการตั้งค่าเป็น api.stacklok.com

หากคุณต้องการรัน minder กับอินสแตนซ์ minder-server ภายใน ให้ดำเนินการตามขั้นตอนด้านล่าง

การกำหนดค่าเริ่มต้น

สร้างไฟล์คอนฟิกูเรชันเริ่มต้นสำหรับ minder คุณสามารถทำได้โดยการทำ

cp config/config.yaml.example config.yaml

สร้างไฟล์คอนฟิกูเรชันเริ่มต้นสำหรับ minder-server คุณสามารถทำได้โดยการทำ

cp config/server-config.yaml.example server-config.yaml

คุณต้องตั้งค่าแอปพลิเคชัน OAuth2 เพื่อให้ minder-server ใช้งานได้ เมื่อเสร็จแล้ว ให้อัปเดตไฟล์การกำหนดค่าด้วยค่าที่เหมาะสม ดูเอกสารเกี่ยวกับวิธีการทำเช่นนั้น - เอกสาร

รัน minder-server

เริ่มต้น minder-server พร้อมกับบริการที่ต้องพึ่งพา ( keycloak และ postgres ) โดยเรียกใช้:

make run-docker

กำหนดค่าการเข้าสู่ระบบโซเชียล (GitHub)

minder-server ใช้ Keycloak เป็น IAM หากต้องการเข้าสู่ระบบ คุณจะต้องตั้งค่าแอปพลิเคชัน GitHub OAuth2 และกำหนดค่า Keycloak เพื่อใช้งาน

สร้างแอปพลิเคชัน OAuth2 สำหรับ GitHub ที่นี่ เลือก New OAuth App แล้วกรอกรายละเอียด URL การติดต่อกลับควรเป็น http://localhost:8081/realms/stacklok/broker/github/endpoint สร้างรหัสลับไคลเอ็นต์ใหม่สำหรับไคลเอ็นต์ OAuth2 ของคุณ

ใช้ client_id และ client_secret ที่คุณสร้างไว้ด้านบน เปิดใช้งานการเข้าสู่ระบบ GitHub บน Keycloak โดยเรียกใช้คำสั่งต่อไปนี้:

make KC_GITHUB_CLIENT_ID= < client_id > KC_GITHUB_CLIENT_SECRET= < client_secret > github-login

วิ่งใส่ใจ

ตรวจสอบให้แน่ใจว่าไฟล์ config.yaml มีอยู่ในไดเร็กทอรีปัจจุบันเพื่อให้ minder สามารถใช้งานได้

เรียกใช้ minder กับอินสแตนซ์ Minder ในเครื่องของคุณ ( localhost:8090 ):

minder auth login

เมื่อเสร็จสิ้น คุณจะเห็นว่า Minder Server ถูกตั้งค่าเป็น localhost:8090

ตามค่าเริ่มต้น ตัว minder CLI จะชี้ไปที่สภาพแวดล้อม Stacklok ที่ใช้งานจริงหากไม่มีไฟล์กำหนดค่า แต่การสร้าง config.yaml เพื่อเรียกใช้เซิร์ฟเวอร์จะชี้ CLI ไปที่สภาพแวดล้อมการพัฒนาในเครื่องของคุณ หากคุณต้องการใช้อินสแตนซ์อื่นอย่างชัดเจน คุณสามารถตั้งค่าตัวแปรสภาพแวดล้อม MINDER_CONFIG ให้ชี้ไปที่การกำหนดค่าเฉพาะได้ เรามีการกำหนดค่าสำหรับการพัฒนาในเครื่อง สภาพแวดล้อมการผลิต Stacklok และสภาพแวดล้อมการแสดงชั่วคราวของ Stacklok (อัปเดตบ่อยครั้ง) ที่เช็คอินในไดเร็กทอรี config

แนวทางการพัฒนา

คุณสามารถค้นหาข้อมูลโดยละเอียดเพิ่มเติมเกี่ยวกับกระบวนการพัฒนาได้ในคู่มือนักพัฒนา

Minder API

• เอกสาร REST API - ลิงก์

• เอกสาร Proto API - ลิงก์

• Protobuf - ลิงก์

• ข้อมูลจำเพาะ OpenAPI/ผยอง (JSON) - ลิงก์

มีส่วนร่วม

เรายินดีต้อนรับการมีส่วนร่วมของ Minder โปรดดูคู่มือการสนับสนุนของเราสำหรับข้อมูลเพิ่มเติม

ที่มา

โครงการ Minder ปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดด้านความปลอดภัยและความโปร่งใสในห่วงโซ่อุปทานของซอฟต์แวร์

สินทรัพย์ที่เผยแพร่ทั้งหมด:

• มีที่มา SLSA Build ระดับ 3 ที่สร้างขึ้นและตรวจสอบได้ สำหรับข้อมูลเพิ่มเติม โปรดดูที่เว็บไซต์ SLSA
• ได้รับการลงนามและตรวจสอบระหว่างการเปิดตัวโดยใช้โครงการ Sigstore เพื่อให้แน่ใจว่าไม่มีการงัดแงะและทุกคนสามารถตรวจสอบได้
• สร้างไฟล์เก็บถาวร SBOM และเผยแพร่พร้อมกับการเผยแพร่ สิ่งนี้ช่วยให้ผู้ใช้เข้าใจถึงการขึ้นต่อกันของโปรเจ็กต์และมาตรการรักษาความปลอดภัย

ใบอนุญาต

Minder ได้รับอนุญาตภายใต้ Apache 2.0 License