mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-23 23:51:08 +02:00
35 lines
1.4 KiB
Plaintext
35 lines
1.4 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Auto-auth with file sinks
|
|
description: >-
|
|
Use file sinks for auto-authentication with Vault Agent or Vault Proxy.
|
|
---
|
|
|
|
# Auto-auth sink: File
|
|
|
|
The `file` sink writes tokens, optionally response-wrapped and/or encrypted, to
|
|
a file. This may be a local file or a file mapped via some other process (NFS,
|
|
Gluster, CIFS, etc.).
|
|
|
|
Once the sink writes the file, it is up to the client to control lifecycle;
|
|
generally it is best for the client to remove the file as soon as it is seen.
|
|
|
|
It is also best practice to write the file to a ramdisk, ideally an encrypted
|
|
ramdisk, and use appropriate filesystem permissions. The file is currently
|
|
written with `0640` permissions as default, but can be overridden with the optional
|
|
'mode' setting.
|
|
|
|
## Configuration
|
|
|
|
- `path` `(string: required)` - The path to use to write the token file
|
|
- `mode` `(int: optional)` - Octal number string representing the bit pattern for the file mode, similar to `chmod`.
|
|
- `owner` `(int: optional)` - The UID to use for the token file. Defaults to the current user ID.
|
|
- `group` `(int: optional)` - The GID to use for token file. Defaults to the current group ID.
|
|
|
|
<Note>
|
|
|
|
Configuration options for response-wrapping and encryption for the sink
|
|
file are located within the [options common to all sinks](/vault/docs/agent-and-proxy/autoauth#configuration-sinks) documentation.
|
|
|
|
</Note>
|