Nothing
# This file contains the environment and option checks that relax specific
# safety protections during tests and debugging
# Used for branching when strict browser, redirect, signature, or UserInfo
# checks have been explicitly softened
# 1 Environment helpers --------------------------------------------------------
## 1.1 Test and interactive checks ---------------------------------------------
#' Detect a testthat session
#'
#' Used by warning and debug helpers.
#'
#' @return `TRUE` when code is running under testthat; otherwise `FALSE`.
#' @keywords internal
#' @noRd
.is_test <- function() {
if (requireNamespace("testthat", quietly = TRUE)) {
return(testthat::is_testing())
}
return(FALSE)
}
#' Detect an interactive session
#'
#' Used by logging and debugging helpers.
#'
#' @return `TRUE` when the current R session is interactive; otherwise `FALSE`.
#' @keywords internal
#' @noRd
.is_interactive <- function() {
interactive()
}
#' Detect tests or interactive execution
#'
#' Used by softening helpers that should stay quiet in non-interactive batch
#' execution.
#'
#' @return `TRUE` when code is running under testthat or in an interactive
#' session; otherwise `FALSE`.
#' @keywords internal
#' @noRd
.is_test_or_interactive <- function() {
.is_test() || .is_interactive()
}
# 2 Safety softeners -----------------------------------------------------------
## 2.1 Option-based softening checks -------------------------------------------
# Some helpers which determine if certain safety checks can be skipped
# based on package options. Most development-only options are hard-gated to
# testing or interactive sessions; a few explicit opt-ins (for example,
# allow_redirect) are honored in all sessions.
#' Throw an error if specific dev/debug softeners are enabled
#'
#' @description
#' `r lifecycle::badge("deprecated")`
#'
#' Deprecated helper that errors when a small subset of shinyOAuth's
#' development and debugging softeners are enabled. Use explicit startup checks
#' for the exact options your deployment permits or forbids instead.
#'
#' @details It only checks the following options:
#' \itemize{
#' \item `shinyOAuth.skip_browser_token`: Skips browser cookie presence check
#' \item `shinyOAuth.skip_id_sig`: Skips ID token signature verification
#' \item `shinyOAuth.expose_error_body`: Exposes HTTP response bodies
#' \item `shinyOAuth.allow_unsigned_userinfo_jwt`: Accepts unsigned (`alg=none`) UserInfo JWTs
#' \item `shinyOAuth.allow_redirect`: Allows sensitive HTTP flows to follow redirects
#' }
#'
#' @return Invisible `TRUE` if none of those options are enabled; otherwise an
#' error is thrown.
#'
#' @example inst/examples/error_on_softened.R
#' @keywords internal
#' @export
error_on_softened <- function() {
deprecate_warn_pkg(
when = "0.4.0.9000",
what = "error_on_softened()",
details = c(
x = paste(
"This helper only checks a small subset of shinyOAuth's",
"security-relaxing options"
),
i = paste(
"Use explicit startup checks for options like",
"`shinyOAuth.allow_non_atomic_state_store` and",
"`shinyOAuth.unblock_auth_params` when they matter to your deployment"
)
)
)
if (
any(
allow_skip_browser_token(),
allow_skip_signature(),
allow_expose_error_body(),
allow_unsigned_userinfo_jwt(),
allow_redirect()
)
) {
abort_pkg(
"One or more safety settings have been disabled",
c(
"x" = "These settings relax shinyOAuth's default safety protections",
"i" = "See `?error_on_softened` for more information"
)
)
}
return(invisible(TRUE))
}
#' Check whether browser token validation is softened
#'
#' Used by callback and session helpers.
#'
#' @return `TRUE` only when
#' `options(shinyOAuth.skip_browser_token = TRUE)` is set and the current
#' session is running under testthat or interactively; otherwise `FALSE`.
#' @keywords internal
#' @noRd
allow_skip_browser_token <- function() {
if (!getOption("shinyOAuth.skip_browser_token", FALSE)) {
return(FALSE)
}
if (.is_test_or_interactive()) {
if (!.is_test()) {
warn_pkg(
"Browser cookie presence check is disabled",
c(
"x" = "`options(shinyOAuth.skip_browser_token = TRUE)` is active",
"!" = "This bypasses a key security check and is intended only for local testing"
)
)
}
return(TRUE)
}
return(FALSE)
}
#' Check whether ID token signature verification is softened
#'
#' Used by ID token validation helpers.
#'
#' @return `TRUE` when signature verification is explicitly relaxed for tests or
#' interactive development; otherwise `FALSE`.
#' @keywords internal
#' @noRd
allow_skip_signature <- function() {
if (!getOption("shinyOAuth.skip_id_sig", FALSE)) {
return(FALSE)
}
if (.is_test_or_interactive()) {
if (!.is_test()) {
warn_pkg(
"ID token signature verification is disabled",
c(
"x" = "`options(shinyOAuth.skip_id_sig = TRUE)` is active",
"!" = "This bypasses cryptographic verification and is intended only for local testing"
)
)
}
return(TRUE)
}
return(FALSE)
}
#' Check whether HTTP error bodies may be exposed
#'
#' Used by HTTP error helpers.
#'
#' @return `TRUE` when error bodies may be included in thrown conditions for
#' development use; otherwise `FALSE`.
#' @keywords internal
#' @noRd
allow_expose_error_body <- function() {
if (!isTRUE(getOption("shinyOAuth.expose_error_body", FALSE))) {
return(FALSE)
}
if (.is_test_or_interactive()) {
if (!.is_test()) {
warn_pkg(
"Exposing HTTP response bodies in errors is enabled",
c(
"x" = "`options(shinyOAuth.expose_error_body = TRUE)` is active",
"!" = "This may leak sensitive information to the console"
)
)
}
return(TRUE)
}
FALSE
}
#' Check whether redirect following is allowed
#'
#' Used by HTTP request helpers.
#'
#' @return `TRUE` when redirect following is explicitly enabled for sensitive
#' OAuth flows; otherwise `FALSE`.
#' @keywords internal
#' @noRd
allow_redirect <- function() {
if (!isTRUE(getOption("shinyOAuth.allow_redirect", FALSE))) {
return(FALSE)
}
if (.is_test_or_interactive()) {
if (!.is_test()) {
warn_pkg(
"HTTP redirect following is enabled for sensitive OAuth flows",
c(
"x" = "`options(shinyOAuth.allow_redirect = TRUE)` is active",
"!" = paste(
"This disables anti-redirect protections;",
"only enable it when you deliberately accept that risk"
)
)
)
}
}
TRUE
}
#' Check whether unsigned UserInfo JWTs are allowed
#'
#' Used by signed UserInfo JWT validation.
#'
#' @return `TRUE` when unsigned UserInfo JWTs are allowed in tests or
#' interactive sessions; otherwise `FALSE`.
#' @keywords internal
#' @noRd
allow_unsigned_userinfo_jwt <- function() {
if (!isTRUE(getOption("shinyOAuth.allow_unsigned_userinfo_jwt", FALSE))) {
return(FALSE)
}
if (.is_test_or_interactive()) {
if (!.is_test()) {
warn_pkg(
"Unsigned UserInfo JWT acceptance is enabled",
c(
"x" = "`options(shinyOAuth.allow_unsigned_userinfo_jwt = TRUE)` is active",
"!" = "This bypasses JWT signature verification and is intended only for local testing"
)
)
}
return(TRUE)
}
# In production (non-test, non-interactive), refuse to honor the option
err_config(c(
"x" = "`options(shinyOAuth.allow_unsigned_userinfo_jwt = TRUE)` is set outside a test or interactive session",
"!" = "Accepting unsigned UserInfo JWTs in production would allow identity forgery",
"i" = "Remove this option or use `with_mocked_bindings()` in tests instead"
))
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.