แนวทางการใช้ตัวยึดตำแหน่งสำหรับข้อมูลลับ

ใช้ตัวยึดตำแหน่งที่มนุษย์อ่านเข้าใจได้ แต่ไม่มีลักษณะคล้ายข้อมูลลับจริง

รูปแบบที่แนะนำ

• ควรใช้ค่าที่สื่อความหมาย เช่น example-openai-key-not-real หรือ example-discord-bot-token
• สำหรับตัวอย่างคำสั่งเชลล์ ควรใช้ ${OPENAI_API_KEY} แทนสตริงที่เขียนในบรรทัดและมีลักษณะคล้ายโทเค็น
• ทำให้เห็นได้ชัดว่าตัวอย่างเป็นข้อมูลปลอม และระบุขอบเขตตามวัตถุประสงค์ (ผู้ให้บริการ ช่องทาง ประเภทการยืนยันตัวตน)

รูปแบบที่ควรหลีกเลี่ยงในเอกสาร

• ข้อความส่วนหัวหรือส่วนท้ายของคีย์ส่วนตัว PEM แบบตรงตัว
• คำนำหน้าที่มีลักษณะคล้ายข้อมูลประจำตัวที่ใช้งานจริง เช่น sk-..., xoxb-..., AKIA...
• โทเค็นสำหรับยืนยันตัวตนแบบ Bearer ที่ดูสมจริงและคัดลอกมาจากบันทึกการทำงาน

ตัวอย่าง

# ดีexport OPENAI_API_KEY="example-openai-key-not-real" # ดีกว่า (เมื่อเอกสารกล่าวถึงการเชื่อมโยงตัวแปรสภาพแวดล้อม)export OPENAI_API_KEY="${OPENAI_API_KEY}"