Access the System Credential Store from R
Platform independent API to access the operating systems credential store. Currently supports:
The last two are available on all platforms. Additional storage backends can be added easily.
For the Secret Service backend install the
libsecret library, at least version 0.16. This is typically the best keyring for a Linux desktop. Install these packages:
The file backend uses the sodium package, which needs the sodium library. This backend works best on Linux servers. Install these packages:
Install the package from CRAN:
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.
default_backend(). In most cases you don’t have to configure this.
backend_secret_service, if build with
Should you need to change the default backend, set the
R_KEYRING_BACKEND environment variable or the
keyring_backend R option to the backend’s name (e.g.
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. See
Note that all platforms have a default keyring, and
key_get(), etc. will use that automatically. The default keyring is also convenient, because usually the OS unlocks it automatically when you log in, so secrets are available immediately. But note that the file backend does not currently unlock its default keyring.
You only need to explicitly deal with keyrings and the
keyring_* functions if you want to use a different keyring.
Please see our writeup of some
keyring internals, and as always, use the source code.