Learn R Programming
fireproof (version 0.1.0)

GuardBasic: R6 class for the Basic authentication guard

Description

This class encapsulates the logic of the Basic authentication scheme. See guard_basic() for more information.

Arguments

Super class

fireproof::Guard -> GuardBasic

Active bindings

open_api

An OpenID compliant security scheme description

Methods

Inherited methods

Method new()

Constructor for the class

Usage

GuardBasic$new(validate, user_info = NULL, realm = "private", name = NULL)

Arguments

validate

A function that will be called with the arguments username, password, realm, request, and response and returns TRUE if the user is valid, and FALSE otherwise. If the function returns a character vector it is considered to be authenticated and the return value will be understood as scopes the user is granted.

user_info

A function to extract user information from the username. It is called with a single argument: user which is the username used for the successful authentication. The function should return a new user_info list.

realm

The realm this authentication corresponds to. Will be returned to the client on a failed authentication attempt to inform them of the credentials required, though most often these days it is kept from the user.

name

The name of the authentication

Method check_request()

A function that validates an incoming request, returning TRUE if it is valid and FALSE if not. It decodes the credentials in the Authorization header, splits it into username and password and then calls the validate function provided at construction.

Usage

GuardBasic$check_request(request, response, keys, ..., .datastore)

Arguments

request

The request to validate as a Request object

response

The corresponding response to the request as a Response object

keys

A named list of path parameters from the path matching

...

Ignored

.datastore

The data storage from firesale

Method reject_response()

Upon rejection this scheme sets the response status to 401 and sets the WWW-Authenticate header to Basic realm="<realm>", charset=UTF-8

Usage

GuardBasic$reject_response(response, scope, ..., .datastore)

Arguments

response

The response object

scope

The scope of the endpoint

...

Ignored

.datastore

The data storage from firesale

Method clone()

The objects of this class are cloneable with this method.

Usage

GuardBasic$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

Run this code
# Create a guard of dubious quality
basic <- GuardBasic$new(
  validate = function(user, password) {
    user == "thomas" && password == "pedersen"
  },
  user_info = function(user) {
    new_user_info(
      name_given = "Thomas",
      name_middle = "Lin",
      name_family = "Pedersen"
    )
  }
)

Run the code above in your browser using DataLab