Setting Up and Using Custom Regex in CYRISMA
Custom Regex in CYRISMA allows users to define and implement custom regular expressions to identify specific data patterns not covered by pre-built categories. This feature is particularly useful for organizations with unique data requirements or compliance needs. This article provides step-by-step guidance on setting up and using custom regex within the CYRISMA platform.
- User Manual
- Agents
- The Cyber Risk Assessment Process
- API Documents
- General Questions and Troubleshooting
- The Cyber Risk Assessment Process (Video Tutorials)
- Sales and Prospecting Articles
- CYRISMA Partner Portal Access
- Glossary
- CYRISMA Change Log
- Support Ticket SLA
- Onboarding Framework
- PSA Integrations
- Billing Questions
- Self Onboarding Guide
Table of Contents
1. What is Custom Regex?
Regular expressions (regex) are sequences of characters that define search patterns for text. CYRISMA's custom regex feature enables users to create personalized search patterns to identify unique sensitive data types, such as:
- Internal identifiers (e.g., employee IDs, project codes)
- Industry-specific information (e.g., SIN numbers in Canada, IBAN codes)
- Custom keywords relevant to organizational policies
2. When to Use Custom Regex
Consider using custom regex when:
- Pre-Built Categories Fall Short: Your organization needs to search for sensitive data types not included in CYRISMA’s predefined categories.
- Client-Specific Requirements: Clients request scans for data unique to their environment.
- Advanced Incident Response: Investigating specific terms or patterns to assess data exposure during breaches.
3. Setting Up Custom Regex
Follow these steps to create a custom regex in CYRISMA:
Step 1: Access the Custom Regex Feature
- Log in to your CYRISMA account.
- Navigate to the Admin area from the main dashboard.
- Select Sensitive Data Categories and then click on the Custom tab.
Step 2: Define Your Regex Pattern
- Click the Add New Regex button.
- Provide a Name for the regex to easily identify it later (e.g., “Canadian SIN Numbers”).
- Enter your regex pattern in the designated field. For example:
- A SIN number regex pattern:
^\d{3}-\d{3}-\d{3}$
- A custom identifier:
[A-Z]{3}\d{4}
- A SIN number regex pattern:
Step 3: Test the Regex
- Use the Test Pattern feature to verify your regex works as intended.
- Paste sample data into the test field to confirm it captures the correct information.
Step 4: Save the Regex
- Once satisfied, click Save to add the custom regex to your list of sensitive data categories.
4. Using Custom Regex in a Scan
After setting up your custom regex, you can use it in data scans.
Step 1: Initiate a Data Scan
- Navigate to the Sensitive Data Scan section in CYRISMA.
- Choose the type of scan you wish to perform (e.g., email, OneDrive, local drives).
Step 2: Select Custom Regex
- During the scan setup, go to the Custom category under data types.
- Select the regex patterns you wish to include in the scan.
Step 3: Execute the Scan
- Configure the rest of the scan settings, such as the target agent and date range.
- Run the scan and wait for results.
5. Interpreting Custom Regex Results
Once the scan completes:
- Go to the scan results and filter by Custom Data Categories to view matches for your custom regex.
- Review the specific locations (e.g., files, emails) where matches were found.
- Assess the context to determine whether the identified data poses a security risk.
6. Tips for Creating Effective Regex Patterns
-
Be Specific: Avoid overly broad patterns that may result in false positives.
- Example: Use
^\d{3}-\d{3}-\d{3}$
for SIN numbers instead of\d{9}
to prevent matching unrelated numbers.
- Example: Use
- Validate Often: Test your regex against real sample data to confirm accuracy.
-
Use Anchors: Use
^
and$
to specify the start and end of a pattern, respectively. -
Escape Special Characters: Characters like
.
or*
have special meanings in regex. Escape them using a backslash (\
) if you want to match them literally.
7. Practical Use Cases for Custom Regex
- Identifying Internal Data: Search for internal project names or department-specific identifiers.
- International Compliance: Match sensitive data formats used in other countries, such as IBAN for international banking.
- Keyword Searches for Incident Response: Search for specific terms like “Confidential” or “Top Secret” to locate sensitive documents quickly.
8. Managing and Updating Custom Regex
- Edit Existing Regex: Go to the Custom tab, select the regex you want to update, and modify the pattern.
- Delete Unused Regex: Remove obsolete regex patterns to maintain clarity and avoid confusion.
- Document Patterns: Keep a record of custom regex patterns and their purposes for future reference.
9. Conclusion
Custom regex in CYRISMA empowers organizations to tailor data scans to their unique needs, enhancing the platform’s flexibility and effectiveness. By following best practices and leveraging this feature strategically, you can improve data security, meet compliance requirements, and provide targeted solutions to your clients.