En esta página

En esta página

Technical reference

Convenciones de marcadores de posición para secretos

Convenciones para marcadores de posición de secretos

Utilice marcadores de posición legibles para las personas, pero que no se parezcan a secretos reales.

Estilo recomendado

  • Prefiera valores descriptivos como example-openai-key-not-real o example-discord-bot-token.
  • Para fragmentos de shell, prefiera ${OPENAI_API_KEY} en lugar de cadenas insertadas que parezcan tokens.
  • Mantenga los ejemplos evidentemente ficticios y limitados a su propósito (proveedor, canal, tipo de autenticación).

Patrones que deben evitarse en la documentación

  • Texto literal del encabezado o pie de una clave privada PEM.
  • Prefijos que se parezcan a credenciales activas, p. ej., sk-..., xoxb-..., AKIA....
  • Tokens de portador de aspecto realista copiados de registros de ejecución.

Ejemplo

bash
# Correctoexport OPENAI_API_KEY="example-openai-key-not-real" # Mejor (cuando el documento trata sobre la conexión de variables de entorno)export OPENAI_API_KEY="${OPENAI_API_KEY}"
Was this useful?