unlock_keyring: Unlock the keyring

In BenjaminWolfe/speakfriend: Very Easy Password Management

Description

Enter the master password for R to remember all other passwords.

Usage

unlock_keyring(master_password = NULL, key = NULL,
  ring = getOption("keyring_keyring", "friend"))

Arguments

master_password	Character, to specify master password in plain text, or NULL to type it in at runtime.
key	Character (optional): key name. Chiefly for use in error messages, as this function is also called by list_keys, which is called either directly or indirectly by has_key, set_key, get_key, and drop_key.
ring	Optional. Name of keyring.

Details

It is recommended to enter your master password interactively using unlock_keyring(). You can also use unlock_keyring("your_master_password") to enter your master password programmatically, but entering passwords in plain text is not recommended. You could forget and save it as a script, and either way it will show up in your .Rhistory file.

Function includes checks for has_keyring and keyring_locked. If the keyring is already unlocked, unlock_keyring will message the user.

Value

NULL (invisibly)

Examples

## Not run: 
unlock_keyring()

## End(Not run)

BenjaminWolfe/speakfriend documentation built on Nov. 18, 2019, 5:09 a.m.