Vault
Cómo lee Volant los datos de Ansible Vault, de dónde obtiene las contraseñas y por qué nunca salen del proceso del controlador.
Volant lee y escribe los formatos de vault 1.1 y 1.2 de ansible-core 2.19.12. Los resultados, los mensajes de error y los códigos de salida coinciden con los de ansible-core.
De dónde vienen las contraseñas
Sección titulada «De dónde vienen las contraseñas»| Fuente | Notas |
|---|---|
-J, --ask-vault-pass |
Se pide en el terminal, sin eco. |
--vault-password-file, --vault-pass-file |
Un archivo, o un ejecutable que imprime la contraseña. Repetible. |
--vault-id LABEL@SOURCE |
La fuente es un archivo, un ejecutable o prompt. Repetible. |
[defaults] vault_password_file, vault_identity_list |
Lo mismo, desde ansible.cfg. |
ANSIBLE_VAULT_PASSWORD_FILE, ANSIBLE_VAULT_IDENTITY_LIST |
Lo mismo, desde el entorno. |
Cada contraseña se prueba con cada valor cifrado, sea cual sea su etiqueta.
Qué se descifra
Sección titulada «Qué se descifra»- Los valores
!vaulten línea de un playbook o de un archivo de variables. Se cargan como texto cifrado y se descifran cuando una plantilla los lee. Un valor descifrado conserva la confianza que le da ansible-core. - Archivos enteros cifrados:
vars_files,include_varsy los archivos degroup_varsyhost_vars. Un archivo cifrado que no se puede leer falla con el mensaje de ansible-core. - Los filtros
vaultyunvault, los testsvault_encryptedyvaulted_file, y el lookupunvault. - Un
srccifrado decopy,templateyscript, y un archivo comprimido cifrado deunarchive. La ejecución lo descifra en un directorio temporal privado antes de que el plugin lo lea.decrypt: falseencopyounarchiveconserva el texto cifrado.
Un valor !vault que ningún secreto abre hace fallar la tarea que lo lee, con los tres bloques que imprime ansible-core. debug: var=x termina con 2, con la causa en la línea donde está escrito el valor. is vault_encrypted responde para las variables del host actual.
Los secretos se quedan en el controlador
Sección titulada «Los secretos se quedan en el controlador»Una contraseña de vault vive en memoria en el proceso del controlador. Nunca se escribe en una línea de comandos, en el entorno de un proceso hijo, en un log, en un resultado ni en el enlace con el agente. Las contraseñas de conexión y de escalado de privilegios siguen la misma regla, y Conexiones explica cómo llega la contraseña SSH a ssh.
Los filtros, tests y lookups que se ejecutan en Python nunca ven la contraseña de vault. Por eso los de vault se ejecutan en el proceso del controlador. Consulta Filtros, tests y lookups que necesitan Python.
Un valor que volvió de un host administrado nunca se descifra con los secretos de la ejecución, y nunca se vuelve a renderizar como plantilla. Consulta Los valores de los hosts nunca se renderizan.
Cifrar y ver archivos
Sección titulada «Cifrar y ver archivos»volant vault encrypt, decrypt y view trabajan sobre los mismos archivos que ansible-vault: un archivo cifrado por uno lo lee el otro, con el id por defecto y con una etiqueta.
encryptsustituye cada archivo por su texto de vault ydecryptpor su texto en claro. Ambos dejan el resultado con modo0600y no imprimen nada; en un terminal escribenEncryption successfuloDecryption successfulen el error estándar. Un archivo sin salto de línea final vuelve sin él.- La cabecera es
$ANSIBLE_VAULT;1.1;AES256para el id por defecto y$ANSIBLE_VAULT;1.2;AES256;LABELpara otro.--vault-id LABEL@SOURCEfija la etiqueta. Con más de un--vault-id,--encrypt-vault-id(ovault_encrypt_identity,ANSIBLE_VAULT_ENCRYPT_IDENTITY) elige el que cifra; sin él, el comando sale con el código 5. --output FILEescribe ahí y deja intacto el origen,--output -escribe en la salida estándar, y sin nombre de archivo, o con-, lee la entrada estándar.viewimprime el texto en claro de cada archivo. En un terminal pasa por el paginador:PAGER, si noANSIBLE_PAGER, si no[defaults] pager, si noless.- Sin ninguna fuente de contraseña, el comando la pide.
encryptla pide dos veces, comoNew Vault password:yConfirm New Vault password:. -vimprime el archivo de configuración en uso y-vvla versión. Las líneas adicionales de-vvvvno se imprimen.
Crear, editar y recifrar archivos
Sección titulada «Crear, editar y recifrar archivos»volant vault create, edit y rekey trabajan sobre los mismos archivos que ansible-vault.
createtoma un solo nombre de archivo. Se niega con el código de salida 5 salvo que la salida estándar sea un terminal o se dé--skip-tty-check, y con el código de salida 1 cuando el archivo existe. Un directorio que falta se crea, con un aviso. El editor puede dejar el archivo vacío: el resultado es un archivo de vault válido con un texto vacío.editdescifra cada archivo, abre el editor y cifra el resultado con el secreto que abrió el archivo y la etiqueta que tenía. Si el texto no cambió, el archivo no se reescribe. Un archivo modificado conserva su modo.- El editor es
EDITOR, si noANSIBLE_EDITOR, si no[defaults] editor, si novi, dividido en palabras como lo haría un shell, con el nombre del archivo añadido. No se mira su estado de salida, como en ansible-vault. - El editor trabaja sobre una copia con modo
0600en un directorio privado bajoANSIBLE_LOCAL_TEMP([defaults] local_tmp, si no~/.ansible/tmp). La copia se sobrescribe y se elimina en cualquier salida, incluidos un editor que falla y SIGTERM o SIGHUP. Ctrl-C va al editor. rekeydescifra cada archivo con los secretos antiguos y lo escribe de nuevo con el nuevo, conservando su modo. El nuevo secreto viene de--new-vault-password-file, de--new-vault-id LABEL@SOURCEo de las preguntasNew Vault password:yConfirm New Vault password:. ImprimeRekey successfulen el error estándar, sea cual sea la salida estándar.
Cifrar cadenas
Sección titulada «Cifrar cadenas»volant vault encrypt_string convierte un valor en un bloque !vault | para un archivo de variables. Cada línea del texto cifrado lleva diez espacios de sangría, y cada bloque termina con un salto de línea:
mykey: !vault | $ANSIBLE_VAULT;1.1;AES256 66313561363937653234366564623639...-n NAMEda nombre a la cadena que ocupa el mismo lugar y--stdin-name NAMEda nombre a la entrada estándar. Sin nombre, el bloque empieza por!vault |.--vault-id LABEL@SOURCEda una cabecera1.2con la etiqueta.- Sin cadena, o con
-, el texto se lee de la entrada estándar hasta el final. Una entrada vacía sale con el código 5. - Con más de una cadena, el error estándar lleva una línea de comentario por cadena, y una nota cuando hay menos nombres que cadenas. La salida estándar contiene solo los bloques.
-ppide un nombre de variable y luego la cadena, que no se muestra al escribirla salvo que se dé--show-input. No se puede combinar con la lectura de la entrada estándar.- En un terminal,
Encryption successfulva al error estándar antes de los bloques. --output FILEescribe los bloques en el archivo, con modo0600.
Carencias conocidas
Sección titulada «Carencias conocidas»- El argumento
wrap_objectdel filtrovaultse rechaza como no admitido todavía. Su argumentosaltfunciona como en Ansible: la misma sal da siempre el mismo texto. - Con
-vvvvv,vault view,decryptyrekeyno imprimen la traza de ansible-core de cada secreto que prueban (Trying secret FileVaultSecret(...) for vault_id=...). Los secretos se prueban en el mismo orden.
La página de la línea de comandos tiene las opciones.