GuardBasic: R6 class for the Basic authentication guard
In fireproof: Authentication and Authorization for 'fiery' Servers
GuardBasic R Documentation
R6 class for the Basic authentication guard
Description
This class encapsulates the logic of the
Basic authentication scheme.
See guard_basic() for more information.
Super class
fireproof::Guard -> GuardBasic
Active bindings
open_apiAn OpenID compliant security scheme description
Methods
Public methods
Inherited methods
Method new()
Constructor for the class
Usage
GuardBasic$new(validate, user_info = NULL, realm = "private", name = NULL)
Arguments
validateA 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_infoA 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.
realmThe 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.
nameThe 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
requestThe request to validate as a Request
object
responseThe corresponding response to the request as a
Response object
keysA named list of path parameters from the path matching
...Ignored
.datastoreThe 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
responseThe response object
scopeThe scope of the endpoint
...Ignored
.datastoreThe data storage from firesale
Method clone()
The objects of this class are cloneable with this method.
Usage
GuardBasic$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# 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"
)
}
)
fireproof documentation built on Dec. 17, 2025, 5:09 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| GuardBasic | R Documentation |
R6 class for the Basic authentication guard
Description
This class encapsulates the logic of the
Basic authentication scheme.
See guard_basic() for more information.
Super class
fireproof::Guard -> GuardBasic
Active bindings
open_apiAn OpenID compliant security scheme description
Methods
Public methods
Inherited methods
Method new()
Constructor for the class
Usage
GuardBasic$new(validate, user_info = NULL, realm = "private", name = NULL)
Arguments
validateA function that will be called with the arguments
username,password,realm,request, andresponseand returnsTRUEif the user is valid, andFALSEotherwise. 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_infoA function to extract user information from the username. It is called with a single argument:
userwhich is the username used for the successful authentication. The function should return a new user_info list.realmThe 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.
nameThe 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
requestThe request to validate as a Request object
responseThe corresponding response to the request as a Response object
keysA named list of path parameters from the path matching
...Ignored
.datastoreThe 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
responseThe response object
scopeThe scope of the endpoint
...Ignored
.datastoreThe data storage from firesale
Method clone()
The objects of this class are cloneable with this method.
Usage
GuardBasic$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# 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"
)
}
)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.