R/http-credential.R

In credentials: Tools for Managing SSH and Git Credentials

#' Load and store git HTTPS credentials
#'
#' This requires you have the `git` command line program installed.The
#' [git_credential_ask] function looks up a suitable username/password
#' from the [`git-credential` store](https://git-scm.com/docs/gitcredentials).
#' If none are available it will prompt the user for credentials which
#' may be saved the store. On subsequent calls for the same URL, the
#' function will then return the stored credentials without prompting
#' the user.
#'
#' The appearance and security policy of the credential store depends
#' on your version of git, your operating system, your R frontend and
#' which [credential_helper] is used. On Windows and MacOS the credentials
#' are stored in the system password manager by default.
#'
#' It should be assumed that reading credentials always involves user
#' interaction. The user may be asked to unlock the system keychain or
#' enter new credentials. In reality, user interaction is usually only
#' required on the first authentication attempt, but the security policy
#' of most credential helpers prevent you from programmatically testing
#' if the credentials are already unlocked.
#'
#' @export
#' @family credentials
#' @rdname http_credentials
#' @name http_credentials
#' @aliases credentials
#' @param url target url, possibly including username or path
#' @param save in case the user is prompted for credentials, attempt to
#' remember them.
#' @param verbose print errors from `git credential` to stdout
git_credential_ask <- function(url = "https://github.com", save = TRUE, verbose = TRUE){
  cred <- parse_url(url)
  out <- credential_fill(cred = cred, verbose = verbose)
  if(isTRUE(save) && length(out) && length(out$password) && !is.na(out$password))
    credential_approve(out, verbose = verbose)
  out
}

#' @export
#' @rdname http_credentials
git_credential_update <- function(url = "https://github.com", verbose = TRUE){
  cred <- parse_url(url)
  credential_reject(cred)
  out <- credential_fill(cred = cred, verbose = verbose)
  credential_approve(out)
}

#' @export
#' @rdname http_credentials
git_credential_forget <- function(url = "https://github.com", verbose = TRUE){
  cred <- parse_url(url)
  credential_reject(cred)
}