Access the System Credential Store from R
Platform independent API to access the operating systems credential store. Currently supports:
- Keychain on macOS (
- Credential Store on Windows (
- the Secret Service API on Linux (
- encrypted files (
- environment variables (
backend_env). The last two are available on all platforms. Additional storage backends can be added easily.
libsecret library, at least version 0.16.
- Recent RedHat, Fedora and CentOS systems:
The file backend uses the sodium package:
- Fedora, EPEL:
OS X and Windows
No additional software needed
Install the package from CRAN:
Configuring an OS-specific backend:
- The default is operating system specific, and is described in
manual page of
default_backend(). In most cases you don't have to configure this.
backend_secret_service, if build with
- Or store the secrets in environment variables on other operating
Should you need to change the default backend, set the
R_KEYRING_BACKEND environment variable or the
option to the backend's name (e.g.
Query secret keys in a keyring:
Each keyring can contain one or many secrets (keys). A key is defined by a service name and a password. Once a key is defined, it persists in the keyring store of the operating system. This means the keys persist beyond the termination of and R session. Specifically, you can define a key once, and then read the key value in completely independent R sessions.
- Setting a secret interactively:
- Setting a secret from a script, i.e. non-interactively:
- Reading a secret:
- Listing secrets:
- Deleting a secret:
A keyring is a collection of keys that can be treated as a unit.
A keyring typically has a name and a password to unlock it.
Note that all platforms have a default keyring, and
will use that automatically. The default keyring is also convenient,
because the OS unlocks it automatically when you log in, so secrets
are available immediately.
You only need to explicitly deal with keyrings and the
functions if you want to use a different keyring.
Please see our writeup of some
and as always, use the source code.
MIT © RStudio