Vault Client for Secrets and Sensitive Data

Provides an interface to a 'HashiCorp' vault server over its http API (typically these are self-hosted; see < https://www.vaultproject.io>). This allows for secure storage and retrieval of secrets over a network, such as tokens, passwords and certificates. Authentication with vault is supported through several backends including user name/password and authentication via 'GitHub'.


vaultr

Project Status: Active – The project has reached a stable, usable state and is being actively developed. R-CMD-check codecov.io CodeFactor

Interact with HashiCorp's vault, to securely use secrets from R. This package wraps the vault http API to allow secrets to be accessed from R. Secrets might be passwords, tokens, certificates or any other sensitive data.

  • Authenticate with several different providers (token, username and password, GitHub, LDAP, and "approle")
  • Read and write secrets into vault using its key-value stores (version 1 or 2), cubbyhole and in-transit "encryption-as-a-service"
  • Inspect and work with vault tokens
  • Read, write and update vault policies
  • Allows a degree of access to operator maintenance
  • Work with vault's audit devices

Usage

Create a vault client with the vault_client function:

vault <- vaultr::vault_client(login = TRUE)
## Verifying token

Interact with vault using this object:

vault$list("secret/database")
## [1] "admin"    "readonly"

and read secrets with

vault$read("secret/database/admin")
## $value
## [1] "s3cret"
vault$read("secret/database/readonly", field = "value")
## [1] "passw0rd"

or set secrets with

vault$write("secret/webserver", list(password = "horsestaple"))
vault$read("secret/webserver")

or delete secrets with

vault$delete("/secret/database/readonly")

Installation

Install vaultr from CRAN with

install.packages("vaultr")

To install our internally released version (which might be ahead of CRAN) via r-universe, use

install.packages(
  "vaultr",
  repos = c("https://vimc.r-universe.dev", "https://cloud.r-project.org"))

or install the bleeding edge with

remotes::install_gitub("vimc/vaultr", upgrade = FALSE)

License

MIT © Imperial College of Science, Technology and Medicine

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("vaultr")

1.2.0 by Rich FitzJohn, 3 years ago


https://github.com/vimc/vaultr, https://www.vaccineimpact.org/vaultr/


Report a bug at https://github.com/vimc/vaultr/issues


Browse source code at https://github.com/cran/vaultr


Authors: Rich FitzJohn [aut, cre] , Robert Ashton [aut] , Wes Hinsley [aut] , Imperial College of Science , Technology and Medicine [cph]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports R6, getPass, httr, jsonlite

Suggests knitr, mockery, processx, rmarkdown, testthat, withr

System requirements: vault


See at CRAN