System Documentation & Configurations
Overview
This document contains the configurations relating to the hosting and administration of the two REDCap versions offered by Arizona State University.
Guidance for Funded Projects Language
If not required by the funding agency, most funding proposals benefit by including information about the system being used for data collection. The following sections are recommended to be included in funding proposals.
| Enterprise REDCap | Enterprise Secure Research (ESR) REDCap |
---|---|---|
System Description | ||
Host |
|
|
Architecture | The system is running in Kubernetes and is scalable to meet potential demand. The frontend is managed via a github-backed Google Cloud Build pipeline, which makes sure all changes to the system are approved, version controlled, and pushed by the RTIC team. | The system is running in Kubernetes and is scalable to meet potential demand. The frontend is managed via a github-backed Google Cloud Build pipeline, which makes sure all changes to the system are approved, version controlled, and pushed by the ASU Research Computing team |
Regulatory Compliance |
| Complies with the guidance set forth by the Health Insurance Portability and Accountability Act (HIPAA) NOTE: Please contact a system administrator if your research must comply with 21 CFR Part 11 for the purposes of obtaining eConsents. Currently, this system is not set up to comply with the Code of Federal Regulations for obtaining electronic signatures. System and researcher processes must be confirmed and put in place for compliance, typically done on a project-by-project basis. |
Data Approved for Collection |
|
|
Data Exports |
|
|
Software Security | To help protect and secure the data stored in REDCap’s back end database, the software application employs various methods to protect against malicious users who may attempt to identify and exploit any security vulnerabilities in the system. Such methods will be described here in technical detail. In REDCap, all incoming data gets intentionally filtered, sanitized, and escaped. This includes all data submitted in an HTTP Post request and all query string data found in every URL when users access REDCap, among other modes through which user-defined data gets submitted in the application. Server environment variables that are vulnerable to forgery by end-users are also checked and sanitized. All user-submitted data is properly filtered for any possibly harmful markup tags (e.g. <script>) and is then escaped before ever being displayed on a web page within the application. SQL queries sent to the database server from REDCap are all properly escaped before being sent. If any values used in an SQL query originated from user-defined values, they would also have already been sanitized beforehand, as described above. User-defined data used within SQL queries have their data type checked to prevent any mismatching of data types (e.g. making sure a number is really a number). These processes of sanitization, filtering, data type checking, and escaping all help to protect against methods of attack, such as Cross-Site Scripting (XSS) and SQL Injection. To specifically protect against Cross-Site Request Forgery (CSRF), which is another method of attack, REDCap utilizes a “nonce” (a secret, user-specific token) on every web form used in the application. The nonce is generated as a unique value for each new HTTP request in every REDCap session. Additionally, REDCap employs “rate limiting” on its web pages, in which there is a set maximum number of web requests per minute that are allowed from a single IP address, and after that maximum is hit, the IP address of that user is permanently banned from REDCap. Rate limiting prevents denial of service attacks by bots as well as preventing other types of hacker attacks that require making many requests to the server in a short amount of time, such as with a BREACH attack. Regarding the prevention of BREACH attacks specifically, in addition to using rate limiting, REDCap always outputs an invisible string of random text of random length on every web page (to conceal the page’s true length) as an effective technique for mitigating such an attack. REDCap’s use of a unique nonce token on every web form also greatly diminishes the possibility of a BREACH attack. With regard to the security of cookies used by REDCap, all session cookies and other cookies related to authentication that are created by REDCap will automatically have the “HttpOnly” attribute set to TRUE. By default, the “Secure” cookie flag will be set to FALSE. while this is slightly more insecure, setting its value as TRUE can sometimes cause login issues with certain server configurations, such as reverse proxies. So for compatibility reasons, it is set as FALSE by default. However, any institution can enable the “Secure” flag of session cookies to improve security by setting session.cookie_secure=On in the REDCap web server’s PHP.INI configuration file. | |
Software Security Review | ASU’s Enterprise Technology conducted a Vendor IT Risk Assessment (VITRA), also known as a security review, on the REDCap software from Vanderbilt University Medical Center:
| |
System Access | ||
Availability |
|
|
Prerequisites for Access |
|
|
Logging In
|
|
|
Passwords |
|
|
Expirations and Suspensions |
|
|
Revocation | A user account may be revoked if:
Note: The content created by the user is not deleted and will be accessible after the account is extended or re-activated. | |
System Configuration | ||
Automatic Log Out |
|
|
Failed Log In Lockout |
|
|
|
|
|
System Services | ||
Backups |
|
|
Updates |
|
|
Unauthorized Access |
|
|
Validation |
|
|
Projects | ||
New Projects |
|
|
Project Access |
|
|
Project Audits | Both REDCap services may be audited for proper service and use. This is to ensure that projects are positioned in the correct version of the product. As a result of a project review, project owners may be advised to migrate a project from one version to another. ASU REDCap administrators perform these operational audits as resources permit. REDCap also provides audit trails for tracking data manipulation and user activity within a project. These audit trails are available to project owners and system administrators. REDCap has a built-in audit trail that automatically logs all user activity and logs all pages viewed by every user, including contextual information (e.g. the project or record being accessed). Whether the activity be entering data, exporting data, modifying a field, running a report, or add/modifying a user, among a plethora of other activities, REDCap logs all actions. The logging record can itself be viewed within a project by users that have been given privileges to view the Logging page. The Logging page allows such users to view or export the entire audit trail for that project, and also to filter the audit trail in various ways based upon the type of activity and/or user. The built-in audit trail in REDCap allows administrators to be able to determine all the activity and all the data viewed or modified by any given user | |
User Privileges | To ensure that REDCap users have access only to data and information that they are supposed to have access to within the application, user privileges are utilized within the software. Each user has their own account, and their user account will only have access to REDCap projects that they themselves have created or to projects to which other users have granted them access. Some of the general user privileges in the application are dictated by the customizable settings that each institution can adjust, such as whether or not users can create their own projects or if an administrator must create it for them, among other settings. User privileges are also granular on the project level and can be modified within any given project by someone with proper privileges accessing the project’s User Rights page. The creator of a project will automatically be given full rights to everything within the project, after which they may grant other users access to the project and limit those users’ privileges as desired. Within each project, there are user controls to limit access to various functionality and modules, such as being able to export data, to enter data, to add or modify database fields or survey questions, to build or run reports, to modify user privileges, to view the logging records, and so on. Another feature called Data Access Groups can be implemented to help segregate users and the data they enter by placing users into data access groups, after which they will only be able to access records created by someone in their group. This particular feature is entirely optional but is especially helpful in certain situations, such as for multi-institutional projects where the data entered by one institution should not be accessible or viewable by other institutions with access to that same project. | |
User Activity | Within each project, a comprehensive list of names of authorized personnel (including terminated users) and a description of their access privileges is available in the Logging module. Access to this module and its data is dependent on the user’s privileges within the project. |
- 1 System Description
- 1.1 Host
- 1.2 Architecture
- 1.3 Regulatory Compliance
- 1.4 Data Approved for Collection
- 1.5 Data Exports
- 1.6 Software Security
- 1.7 Software Security Review
- 2 System Access
- 2.1 Availability
- 2.2 Prerequisites for Access
- 2.3 Logging In
- 2.4 Passwords
- 2.5 Expirations and Suspensions
- 2.6 Revocation
- 3 System Configuration
- 4 System Services
- 4.1 Backups
- 4.2 Updates
- 4.3 Unauthorized Access
- 4.4 Validation
- 5 Projects
- 5.1 New Projects
- 5.2 Project Access
- 5.3 Project Audits
- 5.4 User Privileges
- 5.5 User Activity
- 6 System Timelines
System Timelines | |
---|---|
August 2024 |
|
March 2023 | redcap.rc.asu.edu moves to single sign-on using LDAP |
June-July 2021 |
|
May 2021 | Migrates VM environment in Fulton Schools of Engineering at redcap.chs.asu.edu to Reseasrch Computing VM environment at redcap.rc.asu.edu |
June 2021 | Research Computing brings esr.asu.edu system online in Google Cloud Platform |
August 2018 | VM environment in Fulton Schools of Engineering at redcap.chs.asu.edu (College of Health Solutions) system brought online |