diff --git a/docs/srde/01_getting_started/01_intro.md b/docs/srde/01_getting_started/01_intro.md index 77ed192bf3..25193f1ffb 100644 --- a/docs/srde/01_getting_started/01_intro.md +++ b/docs/srde/01_getting_started/01_intro.md @@ -5,5 +5,5 @@ Welcome to the Secure Research Data Environment documentation! If you do not hav If you are an active user, you can proceed to one of the categories on the left. :::tip -If you are looking to use REDCap, proceed to [REDCap](../05_redcap/redcap.md) +If you are looking to use REDCap, proceed to [REDCap](../04_redcap/redcap.md) ::: diff --git a/docs/srde/01_getting_started/02_eligibility_accounts.md b/docs/srde/01_getting_started/02_eligibility_accounts.md index 9b9f2a04b1..92e604de35 100644 --- a/docs/srde/01_getting_started/02_eligibility_accounts.md +++ b/docs/srde/01_getting_started/02_eligibility_accounts.md @@ -3,7 +3,7 @@ The Secure Research Data Environment (SRDE) is a centralized secure computing platform designed to support research projects that require storage and computational resources. It provides a space for researchers to design and build secure, scalable, and resilient environments to store, share, and analyze moderate and high-risk data, as per the [NYU Electronic Data and System Risk Classification Policy](https://www.nyu.edu/about/policies-guidelines-compliance/policies-and-guidelines/electronic-data-and-system-risk-classification.html). -The Research Technology Services team leverages cloud computing resources to provide flexible, scalable, remotely accessible secure virtual environments. The team provides researchers with consultations and resources to comply with security requirements of research grants and Data Use Agreements (DUAs). SRDE resources intend to meet the security controls outlined in the NIST SP 800-171 to safeguard Controlled Unclassified Information (CUI). +The Research Technology Services team leverages cloud computing resources to provide flexible, scalable, remotely accessible secure virtual environments. The team provides researchers with consultations and resources to comply with security requirements of research grants and Data Use Agreements (DUAs). SRDE resources intend to meet the security controls outlined in NIST Special Publication 800-171. For more information, please see the [SRDE Infographic](https://drive.google.com/file/d/1hrkjX4hCi1YBz9_8F0HjuoVu6360Vw6r/view). diff --git a/docs/srde/02_dlp/_category_.json b/docs/srde/02_dlp/_category_.json deleted file mode 100644 index 07bb56b1f5..0000000000 --- a/docs/srde/02_dlp/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "label": "Data Loss Prevention" -} diff --git a/docs/srde/02_dlp/dlp.mdx b/docs/srde/02_dlp/dlp.mdx deleted file mode 100644 index e4e9b678e9..0000000000 --- a/docs/srde/02_dlp/dlp.mdx +++ /dev/null @@ -1,69 +0,0 @@ -# DLP Interpretation Guide - -Data Loss Prevention (DLP) is a tool provided by Google Cloud that automatically detects potentially sensitive information such as names, dates, social security numbers, credit card numbers, etc. As part of the SRDE egress process, we run a DLP scan to help the data steward more easily judge whether the data being exported is in compliance with the relevant data use agreement(s). The scan will flag any information it considers potentially sensitive, and it is up to the data steward to review the results and either approve the export or send it back to the researchers for further review. - -The DLP scan is triggered by the Egress_2 script as part of the data egress process. Once it is generated, you can explore the table of flagged items in BigQuery. First, open a query tab as shown in the screenshot below, and then use SQL queries like the examples in this guide to check specific items and view overall statistics on the table. - -![DLP scan in BigQuery](./static/dlp_scan_big_query.png) - - -:::note - DLP is just a tool, and it is not infallible. Use your best judgment, and if you see results that look confusing, get in touch with the PI for clarification. -::: - -## Viewing results from the DLP report - -This query, the most basic, fetches the first 100 flagged items in the report. -```sql -SELECT - quote, - info_type.name, - info_type.sensitivity_score.score, - likelihood -FROM `your_table_name` LIMIT 100 -``` - -Each row of the report contains a great deal of metadata on where the potentially sensitive metadata was found, as well as metadata on the DLP scan itself, but here we select only the following four columns: -- **quote**: the span of text that was flagged as sensitive info -- **info_type.name**: the type of sensitive info -- **Info_type.sensitivity_score.score**: the sensitivity level (LOW, MODERATE, or HIGH) -- **likelihood**: the confidence with which the DLP tool has flagged the item (POSSIBLE, LIKELY, or VERY_LIKELY) - -The results should look something like this. As you can see, the same piece of text may be flagged multiple times with different types, depending on the results of DLP’s auto-detection algorithms. -![DLP query results](./static/dlp_query_results.png) - -To see more results, you can adjust the value of the `LIMIT` clause or remove it entirely. Alternatively, use some of the sample queries below to view targeted subsets of the data. - -## Sample Queries: selecting a subset of flagged items - -Select only high-sensitivity items -```sql -SELECT quote, info_type.name, info_type.sensitivity_score.score, likelihood -FROM `your_table_name` -WHERE info_type.sensitivity_score.score = "SENSITIVITY_HIGH" -LIMIT 100 -``` - -Select only items that are high-sensitivity and have a likelihood higher than “possible” -```sql -SELECT quote, info_type.name, info_type.sensitivity_score.score, likelihood -FROM `your_table_name` -WHERE info_type.sensitivity_score.score = "SENSITIVITY_HIGH" -AND likelihood != "POSSIBLE" -LIMIT 100 -``` - -Select all items, sorted by type -```sql -SELECT quote, info_type.name, info_type.sensitivity_score.score, likelihood -FROM `your_table_name` -ORDER BY info_type.name -``` - -Select all items of type PERSON_NAME, ordered alphabetically -```sql -SELECT quote, info_type.name, info_type.sensitivity_score.score, likelihood -FROM `your_table_name` -WHERE info_type.name = "PERSON_NAME" -ORDER BY quote -``` diff --git a/docs/srde/02_dlp/static/dlp_query_results.png b/docs/srde/02_dlp/static/dlp_query_results.png deleted file mode 100644 index 53d071cf14..0000000000 Binary files a/docs/srde/02_dlp/static/dlp_query_results.png and /dev/null differ diff --git a/docs/srde/02_dlp/static/dlp_scan_big_query.png b/docs/srde/02_dlp/static/dlp_scan_big_query.png deleted file mode 100644 index f5a5883717..0000000000 Binary files a/docs/srde/02_dlp/static/dlp_scan_big_query.png and /dev/null differ diff --git a/docs/srde/03_faq/01_basics.mdx b/docs/srde/02_faq/01_basics.mdx similarity index 100% rename from docs/srde/03_faq/01_basics.mdx rename to docs/srde/02_faq/01_basics.mdx diff --git a/docs/srde/03_faq/02_env_roles.mdx b/docs/srde/02_faq/02_env_roles.mdx similarity index 100% rename from docs/srde/03_faq/02_env_roles.mdx rename to docs/srde/02_faq/02_env_roles.mdx diff --git a/docs/srde/03_faq/03_using_srde.md b/docs/srde/02_faq/03_using_srde.md similarity index 100% rename from docs/srde/03_faq/03_using_srde.md rename to docs/srde/02_faq/03_using_srde.md diff --git a/docs/srde/03_faq/_category_.json b/docs/srde/02_faq/_category_.json similarity index 100% rename from docs/srde/03_faq/_category_.json rename to docs/srde/02_faq/_category_.json diff --git a/docs/srde/04_support/01_support.md b/docs/srde/03_support/01_support.md similarity index 100% rename from docs/srde/04_support/01_support.md rename to docs/srde/03_support/01_support.md diff --git a/docs/srde/04_support/_category_.json b/docs/srde/03_support/_category_.json similarity index 100% rename from docs/srde/04_support/_category_.json rename to docs/srde/03_support/_category_.json diff --git a/docs/srde/05_redcap/_category_.json b/docs/srde/04_redcap/_category_.json similarity index 100% rename from docs/srde/05_redcap/_category_.json rename to docs/srde/04_redcap/_category_.json diff --git a/docs/srde/05_redcap/redcap.md b/docs/srde/04_redcap/redcap.md similarity index 100% rename from docs/srde/05_redcap/redcap.md rename to docs/srde/04_redcap/redcap.md