update_secret

name

Value of the secret, an arbitrary R object that
will be serialized using <code><a rd-options="base:serialize" href="/link/base%3A%3Aserialize()?package=secret&version=1.0.0&to=base%3Aserialize" data-mini-rdoc="base:serialize::base::serialize()">base::serialize()</a></code>.

value

The private RSA key to use. It defaults to the current
user's default key.

Vault location (starting point to find the vault).
To create a vault, use <code><a rd-options="=create_vault" href="/link/create_vault()?package=secret&version=1.0.0&to=%3Dcreate_vault" data-mini-rdoc="=create_vault::create_vault()">create_vault()</a></code> or <code><a rd-options="=create_package_vault" href="/link/create_package_vault()?package=secret&version=1.0.0&to=%3Dcreate_package_vault" data-mini-rdoc="=create_package_vault::create_package_vault()">create_package_vault()</a></code>.
If this is <code>NULL</code>, then <code>secret</code> tries to find the vault automatically:<ul>
<li>If the <code>secret.vault</code> option is set to path, that is used as the
starting point.</li>
<li>Otherwise, if the <code>R_SECRET_VAULT</code> environment variable is set to a
path, that is used as a starting point.</li>
<li>Otherwise the current working directory is used as the starting
point.</li>
</ul>If the starting point is a vault, that is used. Otherwise, if the
starting point is in a package tree, the <code>inst/vault</code> folder is used
within the package. If no vault can be found, an error is thrown.

vault

Allow sharing sensitive information, for example passwords,
'API' keys, etc., in R packages, using public key cryptography.

Gabor Csardi

secret

Share Sensitive Information in R Packages

G<c3><a1>bor Cs<c3><a1>rdi

Andrie de Vries

update_secret function

Value of the secret, an arbitrary R object that
will be serialized using <code><a rd-options='base:serialize' href='base::serialize()'>base::serialize()</a></code>.

Vault location (starting point to find the vault).
To create a vault, use <code><a rd-options='=create_vault' href='create_vault()'>create_vault()</a></code> or <code><a rd-options='=create_package_vault' href='create_package_vault()'>create_package_vault()</a></code>.
If this is <code>NULL</code>, then <code>secret</code> tries to find the vault automatically:<ul>
<li>If the <code>secret.vault</code> option is set to path, that is used as the
starting point.</li>
<li>Otherwise, if the <code>R_SECRET_VAULT</code> environment variable is set to a
path, that is used as a starting point.</li>
<li>Otherwise the current working directory is used as the starting
point.</li>
</ul>

If the starting point is a vault, that is used. Otherwise, if the
starting point is in a package tree, the <code>inst/vault</code> folder is used
within the package. If no vault can be found, an error is thrown.

update_secret: Update a secret in the vault.

Description

Usage

Arguments

See Also