วีเซิร์ต

โครงการโอเพ่นซอร์สนี้ได้รับการสนับสนุนจากชุมชน หากต้องการรายงานปัญหาหรือแบ่งปันแนวคิด ให้ใช้ Issues และหากคุณมีข้อเสนอแนะในการแก้ไขปัญหา โปรดระบุรายละเอียดเหล่านั้นด้วย นอกจากนี้ ให้ใช้ Pull Requests เพื่อสนับสนุนการแก้ไขข้อบกพร่องจริงหรือการปรับปรุงที่เสนอ เรายินดีต้อนรับและขอขอบคุณทุกการมีส่วนร่วม มีคำถามหรือต้องการหารือบางอย่างกับทีมของเรา? เข้าร่วมกับเราบน Slack !

วีเซิร์ต

VCert คือไลบรารี Go, SDK และยูทิลิตีบรรทัดคำสั่งที่ออกแบบมาเพื่อลดความซับซ้อนในการสร้างคีย์และการลงทะเบียนข้อมูลระบุตัวตนของเครื่อง (หรือที่เรียกว่าใบรับรองและคีย์ SSL/TLS) ที่สอดคล้องกับนโยบายความปลอดภัยขององค์กรโดยใช้ Venafi Trust Protection Platform หรือ Venafi Control Plane หรือหิ่งห้อยเวนาฟี

ดู VCert CLI สำหรับ Venafi Trust Protection Platform หรือ VCert CLI สำหรับ Venafi Control Plane หรือ VCert CLI สำหรับ Venafi Firefly เพื่อเริ่มต้นใช้งานยูทิลิตีบรรทัดคำสั่ง

ความเข้ากันได้

รุ่น VCert ได้รับการทดสอบโดยใช้ Trust Protection Platform เวอร์ชันล่าสุด ฟังก์ชันการทำงานทั่วไปของ VCert รุ่นล่าสุดควรเข้ากันได้กับ Trust Protection Platform 17.3 หรือสูงกว่า ช่องแบบกำหนดเองและการติดตามอินสแตนซ์ต้องใช้ TPP 18.2 หรือสูงกว่า และ Token Authentication ต้องใช้ TPP 20.1 หรือสูงกว่า

การตั้งค่านักพัฒนาซอฟต์แวร์

1. กำหนดค่าสภาพแวดล้อม Go ของคุณตาม https://golang.org/doc/install

2. ตรวจสอบว่าตัวแปรสภาพแวดล้อม GOPATH ได้รับการตั้งค่าอย่างถูกต้อง

3. ดาวน์โหลดซอร์สโค้ด:

   go get github.com/Venafi/vcert/v5

   หรือก่อนไป 1.13

   git clone https://github.com/Venafi/vcert.git $GOPATH /src/github.com/Venafi/vcert/v5

   ไป 1.11 โดยเปิดใช้งานโมดูล go หรือไป 1.13 ขึ้นไป ตรวจสอบให้แน่ใจว่าได้โคลนนอก $GOPATH/src

   git clone https://github.com/Venafi/vcert.git

4. สร้างยูทิลิตี้บรรทัดคำสั่งสำหรับ Linux, macOS และ Windows:

   make build

การใช้ VCert เพื่อรวม Venafi เข้ากับแอปพลิเคชันของคุณ

สำหรับตัวอย่างโค้ดการใช้งานทางโปรแกรม โปรดตรวจสอบไฟล์ในโฟลเดอร์ตัวอย่าง

ส่วนทั่วไป

1. ในไฟล์ main.go ของคุณ ให้ดำเนินการประกาศการนำเข้าต่อไปนี้:

    import (
       "github.com/Venafi/vcert/v5"
       "github.com/Venafi/vcert/v5/pkg/certificate"
       "github.com/Venafi/vcert/v5/pkg/endpoint"
   )

2. สร้างอ็อบเจ็กต์การกำหนดค่าประเภท &vcert.Config ที่ระบุรายละเอียดการเชื่อมต่อ Venafi โดยทั่วไปโซลูชันได้รับการออกแบบเพื่อรับรายละเอียดเหล่านั้นจากห้องเก็บความลับ ไฟล์ .ini ตัวแปรสภาพแวดล้อม หรือพารามิเตอร์บรรทัดคำสั่ง

ลงทะเบียนใบรับรอง

1. สร้างอินสแตนซ์ไคลเอ็นต์โดยการเรียกเมธอด NewClient ของคลาส vcert ด้วยอ็อบเจ็กต์การกำหนดค่า
2. เขียนออบเจ็กต์คำขอใบรับรองประเภท &certificate.Request
3. สร้างคู่คีย์และ CSR สำหรับการร้องขอใบรับรองโดยการเรียกเมธอด GenerateRequest ของไคลเอ็นต์
4. ส่งคำขอโดยส่งออบเจ็กต์คำขอใบรับรองไปยังวิธี RequestCertificate ของไคลเอ็นต์
5. ใช้รหัสคำขอเพื่อรับใบรับรองโดยใช้วิธี RetrieveCertificate ของไคลเอ็นต์

ผู้ฟัง TLS ใหม่สำหรับโดเมน

1. เรียกเมธอด vcert.Config NewListener พร้อมรายการโดเมนเป็นอาร์กิวเมนต์ ตัวอย่างเช่น ("test.example.com:8443", "example.com")
2. ใช้ gets net.Listener เป็นอาร์กิวเมนต์ของ http.Serve ในตัวหรือเซิร์ฟเวอร์ https อื่นๆ

ตัวอย่างอยู่ในสถานะที่คุณสามารถสร้าง/ดำเนินการได้โดยใช้คำสั่งต่อไปนี้ (หลังจากตั้งค่าตัวแปรสภาพแวดล้อมที่จะกล่าวถึงในภายหลัง):

go build -o cli ./example
go test -v ./example -run TestRequestCertificate

ข้อกำหนดเบื้องต้นสำหรับการใช้งานกับ Trust Protection Platform

1. บัญชีผู้ใช้ที่ได้รับสิทธิ์การเข้าถึง WebSDK
2. โฟลเดอร์ (โซน) ที่ผู้ใช้ได้รับสิทธิ์ต่อไปนี้: View , Read , Write , Create , Revoke (สำหรับการดำเนินการเพิกถอน) และ Private Key Read (สำหรับการดำเนินการรับเมื่อมีการสร้างบริการ CSR)
3. นโยบายนำไปใช้กับโฟลเดอร์ที่ระบุ:
   1. เทมเพลต CA ที่ Trust Protection Platform จะใช้เพื่อลงทะเบียนคำขอใบรับรองที่ส่งโดย VCert
   2. ค่า DN หัวเรื่องสำหรับหน่วยองค์กร (OU), องค์กร (O), เมือง (L), รัฐ (ST) และประเทศ (C)
   3. ประเภทการจัดการไม่ได้ล็อคหรือล็อคเป็น 'การลงทะเบียน'
   4. การสร้างคำขอลงนามใบรับรอง (CSR) ถูกปลดล็อคหรือไม่ได้ล็อคไว้ที่ 'CSR ที่สร้างโดยบริการ'
   5. สร้างคีย์/CSR บนแอปพลิเคชันที่ไม่ได้ล็อคหรือล็อคเป็น 'ไม่'
   6. (แนะนำ) ปิดใช้งานการต่ออายุอัตโนมัติโดยตั้งเป็น 'ใช่'
   7. (แนะนำ) ความแรงของบิตของคีย์ ตั้งค่าเป็น 2048 หรือสูงกว่า
   8. (แนะนำ) กำหนดนโยบายการอนุญาตพิเศษของโดเมนอย่างเหมาะสม

ข้อกำหนดสำหรับเทมเพลต CA ที่จะได้รับการกำหนดตามนโยบายเป็นไปตามแนวทางปฏิบัติที่ดีที่สุดของ Venafi ที่มีมายาวนาน ซึ่งตรงตามวัตถุประสงค์การออกแบบของเราเพื่อให้กระบวนการขอใบรับรองง่ายสำหรับผู้ใช้ VCert หากคุณต้องการความสามารถในการระบุเทมเพลต CA พร้อมกับคำขอ คุณสามารถใช้ TPP REST API ได้ แต่โปรดทราบว่าการดำเนินการนี้ขัดแย้งกับคำแนะนำของ Venafi

การทดสอบด้วย Trust Protection Platform และ Venafi Control Plane

การทดสอบหน่วย:

make test

การทดสอบบูรณาการสำหรับ Trust Protection Platform และ Venafi Control Plane จำเป็นต้องมีการเข้าถึงผลิตภัณฑ์เหล่านั้น ตัวแปรสภาพแวดล้อมใช้เพื่อระบุการตั้งค่าที่จำเป็นรวมถึงข้อมูลรับรอง คีย์ Venafi Control Plane API และส่วนของค่าโซน (เช่น Application Name Issuing Template API Alias ​​) พร้อมใช้งานแล้วบนเว็บอินเทอร์เฟซ

 export TPP_URL=https://tpp.venafi.example/vedsdk
export TPP_USER=tpp-user
export TPP_PASSWORD=tpp-password
export TPP_ZONE= ' somesuggested_policy '
export TPP_ZONE_RESTRICTED= ' somelocked_policy '
export TPP_ZONE_ECDSA= ' someecdsa_policy '

make tpp_test

 export CLOUD_URL=https://api.venafi.cloud/v1
export CLOUD_APIKEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLOUD_ZONE= ' My ApplicationPermissive CIT '
export CLOUD_ZONE_RESTRICTED= ' Your ApplicationRestrictive CIT '

make cloud_test

การทดสอบยูทิลิตี้บรรทัดคำสั่งใช้ไฟล์ฟีเจอร์ Cucumber & Aruba

• หากต้องการรันการทดสอบคุณสมบัติทั้งหมดพร้อมกัน:

  make cucumber

• หากต้องการรันการทดสอบเฉพาะคุณสมบัติเฉพาะ:

  make cucumber FEATURE=./features/basic/version.feature

  คุณสมบัติที่มีคือ:

  • basic
  • config
  • enroll
  • format
  • gencsr
  • renew
  • revoke

เมื่อรัน การทดสอบเหล่านี้จะดำเนินการในคอนเทนเนอร์ Docker ของตนเองโดยใช้ Cucumber เวอร์ชัน Ruby
การทดสอบที่เสร็จสมบูรณ์จะรายงานจำนวนสถานการณ์การทดสอบและขั้นตอนที่ผ่าน ล้มเหลว หรือถูกข้าม

ฟังก์ชั่นเพลย์บุ๊ก

สำหรับคำอธิบายโดยละเอียดเกี่ยวกับ Playbook และวิธีการสร้าง Playbook โปรดตรวจสอบที่นี่: Readme Playbook

การมีส่วนร่วมใน VCert

Venafi ยินดีรับการสนับสนุนจากชุมชนนักพัฒนา

1. แยกไปยังบัญชีของคุณ (https://github.com/Venafi/vcert/fork)
2. โคลนส้อมของคุณ:

   git clone [email protected]:youracct/vcert.git

3. สร้างสาขาคุณลักษณะ:

   git checkout -b your-branch-name

4. ใช้งานและทดสอบการเปลี่ยนแปลงของคุณ
5. ยอมรับการเปลี่ยนแปลงของคุณ:

   git commit -am ' Added some cool functionality '

6. ดันไปที่สาขา

   git push origin your-branch-name

7. สร้าง Pull Request ใหม่ที่ https://github.com/youracct/vcert/pull/new/your-branch-name

ใบอนุญาต

ลิขสิทธิ์ © Venafi, Inc. สงวนลิขสิทธิ์

VCert ได้รับอนุญาตภายใต้ Apache License เวอร์ชัน 2.0 ดูใบอนุญาตสำหรับข้อความใบอนุญาตฉบับเต็ม

กรุณาส่งคำถาม/ความคิดเห็นไปที่ [email protected]