Conventies voor tijdelijke aanduidingen van geheimen

Gebruik tijdelijke aanduidingen die leesbaar zijn voor mensen, maar niet op echte geheimen lijken.

Aanbevolen stijl

• Geef de voorkeur aan beschrijvende waarden zoals example-openai-key-not-real of example-discord-bot-token.
• Geef voor shell-fragmenten de voorkeur aan ${OPENAI_API_KEY} boven tekenreeksen in de tekst die op tokens lijken.
• Zorg dat voorbeelden duidelijk fictief zijn en beperkt blijven tot hun doel (provider, kanaal, authenticatietype).

Vermijd deze patronen in documentatie

• Letterlijke kop- of voettekst van een persoonlijke PEM-sleutel.
• Voorvoegsels die op actieve inloggegevens lijken, bijvoorbeeld sk-..., xoxb-..., AKIA....
• Realistisch ogende bearer-tokens die uit runtimelogboeken zijn gekopieerd.

Voorbeeld

# Goedexport OPENAI_API_KEY="example-openai-key-not-real" # Beter (wanneer het document over de koppeling van omgevingsvariabelen gaat)export OPENAI_API_KEY="${OPENAI_API_KEY}"