Guard: R6 base class for guards
In fireproof: Authentication and Authorization for 'fiery' Servers
Guard R Documentation
R6 base class for guards
Description
All guards inherit from this base class and adapts it for the particular
scheme it implements. Additional schemes can be implemented as subclasses of
this and will work transparently with fireproof.
Usage
is_guard(x)
Arguments
x
An object
Active bindings
nameThe name of the instance
open_apiAn OpenID compliant security scheme description
Methods
Public methods
-
-
-
-
-
-
Method new()
Constructor for the class
Usage
Guard$new(name = NULL)
Arguments
nameThe name of the scheme instance
Method check_request()
A function that validates an incoming request, returning
TRUE if it is valid and FALSE if not. The base class simply returns
TRUE for all requests
Usage
Guard$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()
Action to perform on the response in case the request fails
to get validated by any instance in the flow. All failing instances will
have this method called one by one so be mindful if you are overwriting
information set by another instance
Usage
Guard$reject_response(response, scope, ..., .datastore)
Arguments
responseThe response object
scopeThe scope of the endpoint
...Ignored
.datastoreThe data storage from firesale
Method forbid_user()
Action to perform on the response in case the request does
not have the necessary permissions for the endpoint. All succeeding
instances will have this method called one by one if permissions are
insufficient so be mindful if you are overwriting information set by
another instance
Usage
Guard$forbid_user(response, scope, ..., .datastore)
Arguments
responseThe response object
scopeThe scope of the endpoint
...Ignored
.datastoreThe data storage from firesale
Method register_handler()
Hook for registering endpoint handlers needed for this
auth method
Usage
Guard$register_handler(add_handler)
Arguments
add_handlerThe add_handler method from Fireproof to be called
for adding additional handlers
Method clone()
The objects of this class are cloneable with this method.
Usage
Guard$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# You'd never actually do this, rather you'd use the subclasses
guard <- Guard$new(name = "base_auth")
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.
| Guard | R Documentation |
R6 base class for guards
Description
All guards inherit from this base class and adapts it for the particular scheme it implements. Additional schemes can be implemented as subclasses of this and will work transparently with fireproof.
Usage
is_guard(x)
Arguments
x |
An object |
Active bindings
nameThe name of the instance
open_apiAn OpenID compliant security scheme description
Methods
Public methods
Method new()
Constructor for the class
Usage
Guard$new(name = NULL)
Arguments
nameThe name of the scheme instance
Method check_request()
A function that validates an incoming request, returning
TRUE if it is valid and FALSE if not. The base class simply returns
TRUE for all requests
Usage
Guard$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()
Action to perform on the response in case the request fails to get validated by any instance in the flow. All failing instances will have this method called one by one so be mindful if you are overwriting information set by another instance
Usage
Guard$reject_response(response, scope, ..., .datastore)
Arguments
responseThe response object
scopeThe scope of the endpoint
...Ignored
.datastoreThe data storage from firesale
Method forbid_user()
Action to perform on the response in case the request does not have the necessary permissions for the endpoint. All succeeding instances will have this method called one by one if permissions are insufficient so be mindful if you are overwriting information set by another instance
Usage
Guard$forbid_user(response, scope, ..., .datastore)
Arguments
responseThe response object
scopeThe scope of the endpoint
...Ignored
.datastoreThe data storage from firesale
Method register_handler()
Hook for registering endpoint handlers needed for this auth method
Usage
Guard$register_handler(add_handler)
Arguments
add_handlerThe
add_handlermethod from Fireproof to be called for adding additional handlers
Method clone()
The objects of this class are cloneable with this method.
Usage
Guard$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# You'd never actually do this, rather you'd use the subclasses
guard <- Guard$new(name = "base_auth")
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.