https://github.com/r-lib/askpass

Password Entry for R, Git, and SSH
https://github.com/r-lib/askpass

Last synced: 7 days ago
JSON representation

Password Entry for R, Git, and SSH

• Host: GitHub
• URL: https://github.com/r-lib/askpass
• Owner: r-lib
• License: other
• Created: 2018-11-17T12:32:43.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-03T18:18:38.000Z (5 months ago)
• Last Synced: 2025-02-05T20:07:14.492Z (16 days ago)
• Language: R
• Homepage:
• Size: 1.84 MB
• Stars: 84
• Watchers: 6
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - r-lib/askpass - Password Entry for R, Git, and SSH (R)

README

        
# askpass

> Password Entry Utilities for R, Git, and SSH

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/askpass)](https://cran.r-project.org/package=askpass)

[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/askpass)](https://cran.r-project.org/package=askpass)

Cross-platform utilities for prompting the user for credentials or a 

passphrase, for example to authenticate with a server or read a protected key.

Includes native programs for MacOS and Windows, hence no 'tcltk' is required. 

Password entry can be invoked in two different ways: directly from R via the 

askpass() function, or indirectly as password-entry back-end for 'ssh-agent' 

or 'git-credential' via the SSH_ASKPASS and GIT_ASKPASS environment variables.

Thereby the user can be prompted for credentials or a passphrase if needed 

when R calls out to git or ssh.

## Called from R

To invoke the password prompt manually use:

```r

askpass::askpass()

```

This is used for example to read protected key files:

```r

library(openssl)

key <- rsa_keygen()

write_pem(key, 'testkey.pem', password = 'supersecret')

read_key('testkey.pem')

```

## Called from SSH / Git

The package also configures itself as the password entry back-end for ssh-agent and git-credential.

The easiest way to test this is using the credentials package:

```r

remotes::install_github("r-lib/credentials")

git_credential_ask('https://example.com')

```

## R for MacOS

![askpass-mac](img/askpass-mac.png)

## RStudio (server, desktop)

![askpass-rs](img/askpass-rs.png)

## RGUI / Windows

![askpass-rs](img/askpass-win.png)

## Terminal

![askpass-rs](img/askpass-term.png)