You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: "Enable sensitive data detection, masking, and guardrail enforcement using Microsoft Presidio."
4
+
---
5
+
6
+
Hoop.dev’s Microsoft Presidio integration provides a powerful framework for detecting, classifying, and masking sensitive data within infrastructure sessions and workflows. It strengthens security and compliance by enforcing guardrails and protecting personally identifiable information (PII) across your organization’s resources.
7
+
8
+
## Key Features
9
+
10
+
### AI Data Masking
11
+
12
+
- Automatically identify and mask sensitive information such as PII and secrets within session logs or command inputs
13
+
- Ensure compliance with data protection policies while maintaining operational visibility
14
+
- Apply consistent masking across multiple environments and data flows
15
+
16
+
### Guardrails and Policy Enforcement
17
+
18
+
- Create and enforce custom guardrails that restrict sensitive actions or access patterns
19
+
- Prevent risky operations by applying rule-based controls to session activity
20
+
- Integrate seamlessly with approval workflows and policy evaluation mechanisms
21
+
22
+
### Extensible Detection
23
+
24
+
- Utilize Microsoft Presidio’s analyzers and recognizers to detect sensitive entities
25
+
- Extend detection logic with custom patterns to meet specific organizational requirements
26
+
- Benefit from Presidio’s open-source flexibility and ongoing improvements
27
+
28
+
## Benefits
29
+
30
+
-**Security:** Protect sensitive data in real time through automated masking and rule enforcement
31
+
-**Compliance:** Simplify adherence to privacy and governance standards by integrating PII protection directly into access flows
32
+
-**Control:** Define fine-grained policies for data handling and operational boundaries
33
+
-**Transparency:** Maintain a complete audit trail of masking and enforcement actions
34
+
35
+
## Integration with Other Features
36
+
37
+
Microsoft Presidio works seamlessly with other Hoop.dev capabilities:
38
+
39
+
-**Sessions:** Mask sensitive data in session recordings and live streams
40
+
-**Guardrails:** Apply Presidio-powered rules to restrict or log sensitive operations
41
+
-**Approvals:** Automatically trigger approvals or alerts when guardrail conditions are met
42
+
-**Logging & Monitoring:** Ensure all sensitive data is masked before being stored or transmitted
43
+
44
+
## Configuration
45
+
46
+
<Steps>
47
+
<Steptitle="Install">
48
+
Check the Microsoft Presidio documentation to install it.
<Steptitle="Run hoop.dev's Gateway with the new configs">
70
+
After setting up the environment variables, hoop.dev will use Microsoft Presidio to mask sensitive data in real-time in the data stream of any connection you configure.
Copy file name to clipboardExpand all lines: setup/configuration/ai-data-masking/get-started.mdx
+46-50Lines changed: 46 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,76 +4,73 @@ description: "Set up and know better about hoop.dev's AI Data Masking"
4
4
---
5
5
6
6
<Frame>
7
-
<img
8
-
src="/images/ai-data-masking.png"
9
-
/>
7
+
10
8
</Frame>
11
9
12
10
## Prerequisites
13
11
14
-
- Have properly installed hoop.dev through one of the options available in the [deployment overview](/setup/deployment/overview)
15
-
- Be on an enterprise plan
16
-
- Enough access to your infrastructure so you can load environment variables to your hoop.dev instance
17
-
- Have admin access to your hoop.dev instance
12
+
- Have properly installed hoop.dev through one of the options available in the [deployment overview](/setup/deployment/overview)
13
+
- Be on an enterprise plan
14
+
- Enough access to your infrastructure so you can load environment variables to your hoop.dev instance
15
+
- Have admin access to your hoop.dev instance
18
16
19
17
<Note>
20
18
This page is dedicated to the setup of AI Data Masking in self-hosted instances. If you are looking for the Learn Guides of AI Data Masking, [click here](/learn/ai-data-masking).
21
19
</Note>
22
20
23
-
## Set up
21
+
## Setup
24
22
25
-
You can either use Google Cloud Data Loss Prevention hosted by Google on GCP, or Microsoft Presidio, an open-source project that you can host yourself.
23
+
This service currently supports Microsoft Presidio for data classification and PII detection.
26
24
27
-
### Google Cloud Data Loss Prevention (DLP)
25
+
Google Cloud Data Loss Prevention (DLP) is still available for existing customers but is deprecated for new installations.
28
26
29
27
<Info>
30
28
You must be on an enterprise plan to have access to the AI Data Masking feature.
31
29
</Info>
32
30
33
-
Create an account at [Google Cloud Data Loss Prevention](https://cloud.google.com/security/products/dlp) and a service account with the permission `roles/dlp.user`.
34
-
35
-
When installing hoop.dev, you need to set the environment variable `GOOGLE_APPLICATION_CREDENTIALS_JSON` with your GCP DLP credentials in hoop's Gateway.
36
-
Hoop.dev uses Google Cloud's DLP at our protocol layer to mask sensitive data in real-time in the data stream of any connection you configure.
37
-
38
31
### Microsoft Presidio
39
32
40
33
<Steps>
41
-
<Steptitle="Install">
42
-
Check the Microsoft Presidio documentation to install it.
<Steptitle="Run hoop.dev's Gateway with the new configs">
68
-
After setting up the environment variables, hoop.dev will use Microsoft Presidio to mask sensitive data in real-time in the data stream of any connection you configure.
69
-
</Step>
34
+
<Steptitle="Install">
35
+
Check the Microsoft Presidio documentation to install it.
<Steptitle="Run hoop.dev's Gateway with the new configs">
57
+
After setting up the environment variables, hoop.dev will use Microsoft Presidio to mask sensitive data in real-time in the data stream of any connection you configure.
58
+
</Step>
70
59
</Steps>
71
60
61
+
### Google Cloud Data Loss Prevention (DLP)
62
+
63
+
Create an account at [Google Cloud Data Loss Prevention](https://cloud.google.com/security/products/dlp) and a service account with the permission `roles/dlp.user`.
64
+
65
+
When installing hoop.dev, you need to set the environment variable `GOOGLE_APPLICATION_CREDENTIALS_JSON` with your GCP DLP credentials in hoop's Gateway. Hoop.dev uses Google Cloud's DLP at our protocol layer to mask sensitive data in real-time in the data stream of any connection you configure.
66
+
67
+
<Note>
68
+
Google Cloud Data Loss Prevention (DLP) is still available for existing customers but is deprecated for new installations.
69
+
</Note>
72
70
73
71
## Redact Modes
74
72
75
-
The gateway now supports two operational modes that control how redaction failures are handled.
76
-
Configure your preferred mode by setting the environment variable **DLP_MODE** to either `strict` or `best-effort`.
73
+
The gateway now supports two operational modes that control how redaction failures are handled. Configure your preferred mode by setting the environment variable **DLP_MODE** to either `strict` or `best-effort`.
77
74
78
75
### best-effort
79
76
@@ -89,15 +86,14 @@ This mode will return an error in case it find any redaction issue
89
86
90
87
## Activate to your connections
91
88
92
-
Navigate to your Web App instance > Open the Manage toggle > click at AI Data Masking > Activate by connection and to configure which fields you want to set, hit the "Configure" button.
89
+
Navigate to your Web App instance \> Open the Manage toggle \> click at AI Data Masking \> Activate by connection and to configure which fields you want to set, hit the "Configure" button.
At the protocol layer when communicating with a database or server, hoop.dev will open the package and communicate with DLP provider to mask sensitive data in it. This happens in memory and in real-time, so the data is never stored in the database or server in its original form.
101
98
102
-
After the setup, we automatically give you a bunch of default and most used fields, so you don't need to worry much about that part either. You can remove or add fields as much as you like. To see all fields available, check our [documentation page for all fields supported](/setup/configuration/ai-data-masking/fields).
103
-
99
+
After the setup, we automatically give you a bunch of default and most used fields, so you don't need to worry much about that part either. You can remove or add fields as much as you like. To see all fields available, check our [documentation page for all fields supported](/setup/configuration/ai-data-masking/fields).
Guardrails allow you to create custom rules that protect and guide how your connections are used. These rules can be applied to specific connections or serve as default policies across your organization.
12
19
20
+
## Setup
21
+
22
+
This service currently supports Microsoft Presidio for configuring Guardrails rules.
23
+
24
+
<Steps>
25
+
<Steptitle="Install">
26
+
Check the Microsoft Presidio documentation to install it.
<Steptitle="Run hoop.dev's Gateway with the new configs">
48
+
After setting up the environment variables, hoop.dev will use Microsoft Presidio to create a secure layer with custom rules that protect and guide how your resources are used.
49
+
</Step>
50
+
</Steps>
51
+
13
52
## Creating a Guardrail
14
53
15
54
<Steps>
16
55
<Steptitle="Access Guardrails">
17
56
Navigate to the Guardrails section from the sidebar menu
18
57
</Step>
19
-
20
58
<Steptitle="Create New">
21
59
Click the "Create a new Guardrail" button in the top-right corner
22
60
</Step>
23
-
24
61
<Steptitle="Set Basic Information">
25
62
Provide:
63
+
26
64
- Name for the guardrail
27
65
- Description (Optional) explaining its purpose
28
66
</Step>
29
-
30
67
<Steptitle="Configure Rules">
31
68
Provide:
69
+
32
70
- Input Rules
33
71
- Output Rules
34
72
</Step>
@@ -37,12 +75,14 @@ Guardrails allow you to create custom rules that protect and guide how your conn
37
75
## Configuring Rules
38
76
39
77
### Input Rules
78
+
40
79
Rules that evaluate incoming commands or queries:
41
80
42
81
-**Pattern Matching**: Define patterns to match specific commands or queries
43
82
-**Conditions**: Set conditions that trigger the rule
44
83
45
84
### Output Rules
85
+
46
86
Rules that control or modify the output of commands:
47
87
48
88
-**Information Control**: Control what information can be returned
@@ -52,20 +92,21 @@ Rules that control or modify the output of commands:
52
92
<AccordionGroup>
53
93
<Accordiontitle="Pattern Rules">
54
94
Create rules based on command or query patterns:
95
+
55
96
- Regular expressions
56
97
- Exact matches
57
98
- Wildcard patterns
58
99
</Accordion>
59
-
60
100
<Accordiontitle="Security Rules">
61
101
Enforce security policies:
102
+
62
103
- Block dangerous commands
63
104
- Require additional approvals
64
105
- Limit access to sensitive data
65
106
</Accordion>
66
-
67
107
<Accordiontitle="Compliance Rules">
68
108
Ensure compliance requirements:
109
+
69
110
- Data access restrictions
70
111
- Audit logging requirements
71
112
- Regulatory compliance rules
@@ -75,17 +116,17 @@ Rules that control or modify the output of commands:
75
116
## Applying Guardrails
76
117
77
118
### Connection Assignment
119
+
78
120
<Steps>
79
121
<Steptitle="Select Connections">
80
122
Choose which connections will use the guardrail
81
123
</Step>
82
-
83
124
<Steptitle="Set Priority">
84
125
Define the order of rule evaluation when multiple guardrails apply
85
126
</Step>
86
-
87
127
<Steptitle="Configure Behavior">
88
128
Specify how rules should be enforced:
129
+
89
130
- Block non-compliant actions
90
131
- Warn users
91
132
- Require approval
@@ -98,15 +139,12 @@ Rules that control or modify the output of commands:
98
139
<Cardtitle="Start Simple"icon="list-check">
99
140
Begin with basic rules and expand as needed
100
141
</Card>
101
-
102
142
<Cardtitle="Test Rules"icon="vial">
103
143
Validate rules in a test environment first
104
144
</Card>
105
-
106
145
<Cardtitle="Document Purpose"icon="file-lines">
107
146
Clearly describe what each rule does
108
147
</Card>
109
-
110
148
<Cardtitle="Regular Review"icon="rotate">
111
149
Periodically review and update rules
112
150
</Card>
@@ -134,7 +172,6 @@ Keep your guardrails effective and current:
![mintlify[bot]](https://avatars.githubusercontent.com/in/222410?v=4&size=40){kind=avatar}
0 commit comments