Skip to content
Template for making a login screen for R Shiny web apps
Branch: master
Clone or download
Latest commit a991b18 Apr 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Add README html preview Mar 28, 2016
README.md add ShinyProxy Aug 2, 2018
admin.R extension file credentials for os case sensitive Mar 13, 2017
global.R Modify comments for clarity Mar 29, 2016
server.R Modify comments for clarity Mar 29, 2016
shiny_password.Rproj Initial commit - password module code Feb 22, 2016
ui.R Change main ui output name to "ui" Mar 1, 2016

README.md

Shiny Password: A simple (and not particularly secure) method for managing user access permissions in Shiny apps

RStudio's product Shiny allows users to easily build interactive web applications backed by an R session. Shiny applications can be served to end users via four mechanisms:

Both ShinyProxy, Shiny Server Pro and the highest two tiers of shinyapps.io allow administrators to set app-specific user access permissions. However, some users of shinyapps.io's lower tiers or Shiny server open-source may want to control app access as well.

The most secure method for accomplishing this with Shiny server open-source is to host the app behind a reverse proxy server that will manage web traffic to and from the Shiny server. The reverse proxy server can then use standard user access control tools such as Auth0 or PAM.

However, in some deployment environments using a reverse proxy may not be possible - this Shiny app template is designed for those scenarios. This app code conducts user authentication inside the Shiny app itself.

This approach does not resolve Shiny server open-source's use of an unencrypted web connection (it uses HTTP instead of HTTPS). A user password will be passed to the Shiny server in clear text, so anyone snooping on the web connection will be able to steal it.


Usage

This code is a template that can be used to add login functionality to any Shiny app. Users should place the code for their Shiny app in the appropriate locations in the template files.

The login interface operates by wrapping the Shiny app's entire UI specification in a renderUI() function. By default, an app user will only see the login screen. When he successfully authenticates, the conditional UI is triggered and the app content appears. This means that the entire UI specification code is written in the server.R file (as compared to it normally residing in the ui.R file). Your app's UI code should be written starting on line 16 of the server.R file.

The login template manages user credentials by saving them in a persistent data frame local to the Shiny app. The data frame contains 3 elements for each user: user name, password, and lock out status. Each time an app user attempts to log in, the app reads the data frame and compares the submitted credentials to the data frame's set of valid credentials. Note: the passwords are stored as md5 hashes so they are not legible to someone who managed to access the credentials data frame - this likely means the app owner will have to assign a new password to a user who forgets his since it can't simply be recovered from the credentials data.

The app owner may specify how many times a given user can attempt to log in before he is locked out by adjusting the "num_fails_to_lockout" parameter in the global.R file. Once a user fails to log in that number of times, his/her lockout status is set to TRUE in the persistent credentials data frame. Thus, if he reconnects to the app in a new session he will still be locked out. If a user fails to login too many times without specifying a valid user name, the session is locked out but the user could continue attempting to login by closing and reopening the web page because he never specified a valid user name that can be locked out permanently.

The admin.R file contains functions that the app owner can use to manage the user credentials data. When the app is first deployed, the credentials_init() function should be called. It creates the "credentials" directory in the app's local directory and saves an empty credentials data frame with the correct structure there.

The app owner may add one more users by using the add_users() function. The user names and passwords are submitted as two character strings or character vectors, where each user name is paired with the entry with the same index in the password vector.

The app owner may delete one or more users from the credentials data by using the delete_users() function with the user name(s) specified as a character string or a character vector.


WARNING AND DISCLAIMER:

I am not a security professional. This app template provides an extremely mild form of access control that can be easily circumvented by a knowledgable adversary.

You can’t perform that action at this time.