MongoDB
This section covers the following topics:
Prerequisites
Component | Description |
---|---|
Proxy Agent |
|
Version | MongoDB 4.0 and above |
Add MongoDB Data Store
To configure MongoDB data store:
Log on to the CipherTrust Manager GUI.
Open the Data Discovery & Classification application.
Click Data Stores > Data Stores > Add Data Store. The Add Data Store wizard is displayed.
Complete the following steps:
Select Store Type
Under Select Data Store Category, select Database.
From Select Database Type, select MongoDB.
Click Next.
Configure Connection
Specify the credentials for the MongoDB data store:
Field Description Hostname/IP Specify a valid hostname or IP address of database server. Hostname must be more than 2 characters long. Port Specify a valid port for connecting to database server. It must be a valid integer between 1 and 65535.
Default port: 27017User Specify the username. Password Specify the password. (Optional) In the Select Number of Agents field, set the minimum and maximum number of agents for the data store. Refer to Agents for more information.
Warning
- As there is no limit on the number of minimum and maximum agents that you can set, you should exercise caution so that you do not impact the system performance by using too many resources for a single scan.
- You will not be able to add a datastore if the minimum number of agents cannot be assigned.
- A scan will fail if the assigned agent is unavailable after adding the datastore.
- The minimum number of agents must be less than or equal to the maximum number of agents.
(Optional) In the Add Label field, enter a label. You can also remove an existing label.
Click Next.
General Info
Specify the following details:
Name: Name for the data store.
Description (Optional): Description for the data store.
Location: Location of the data store. Refer to Managing Branch Locations for details.
Sensitivity Level (Optional): Sensitivity level for the data store. Refer to Sensitivity Levels for details.
Enable Data Store: Whether to enable the newly added data store. Select the check box to enable the data store.
Click Next.
Add Tags & Access Control
(Optional) Grant the
All groups (default)
access for reports. Alternatively, select a group.Click Save.
The data store is added to the Data stores page. If the Ready to Scan column shows Ready, then data store is properly configured.
For more information on tags and access control, expand the section below.
Tags and Access Control
The Add Tags & Access Control screen in the Add Data Store wizard allows you to grant access rights to your data store and add tags. More details below:
ACCESS - select user groups that can access the data store. Access to a data store provides ability to see reports that include scans of that data store. The available options are:
All groups: All groups of users can access the data store through reports. This is the default setting.
Selected group/s: Specified user defined groups can access the data store through reports. When this option is selected, select a group from the drop-down list. This list shows existing user defined groups. The user defined groups must already exist on CipherTrust Manager. If no user defined groups exist, ask the administrator to create a group. If needed, you can select multiple groups. Start typing the name of the desired group and select from the suggested groups.
TAGS - select a tag from the Add Tag drop-down list. Please check the list of prebuilt tags in Predefined Tags.
Tip
New tags can also be added. Start typing a new tag, and click the New: <new_tag> link that appears below the drop-down list.
Add as many tags as needed.
To remove a tag, click the close icon in the tag name.
In the General Info screen of the wizard, specify the name, description, branch location, and sensitivity level for your data store. See "Configuring a Data Store - General Information" for details.
In the Add Tags & Access Control screen of the wizard, grant access rights to your data store and add metadata. See "Configuring a Data Store – Tags and Access Control" for details.
Click Save to create the data store. At any time during the configuration you can click Back to go to any of the previous wizard screens to update the configuration. The newly created data store appears on the Data Stores page. By default, data stores are displayed in alphabetic order by name. Depending on the number of entries per page, you might need to navigate to other pages to view the newly created data store.
Add MongoDB Scan
To add a scan for MongoDB:
Open the Data Discovery & Classification application.
Click Scans > Add Scan. The Add Scan wizard is displayed.
Complete the following steps:
Refer to Scans for the description of screens of the Add Scan wizard.
General Info
Specify a Name for the scan.
(optional) Add a Description for the scan.
Expand Advanced Configuration and specify advanced configurations such as Scan Priority, Memory Usage Limit, and Amount of Data Object Volume. Refer to Advanced Configuration for details.
Click Next.
Select Data Stores
Under Data Store Name, select the desired data store that is Ready for scanning. You can select multiple data stores, if required.
Click Next.
Add Targets
To add a scan target, do one of the following:
Under Add Target Path field, specify the complete target path and click Apply.
If no specific target is added, the entire data store will be scanned. Target paths are case-sensitive.
The following table lists target paths and syntax to specify them with examples.
Target Path to Scan Syntax Example Full Data Store <EmptyPath> Database <DatabaseName> admin Collection <DatabaseName>/<CollectionName> admin/test Navigate and add target paths.
- Click Browse to navigate target paths from the root level. Alternatively, provide an initial path in the Add Target Path field and click Browse to navigate targets from that point onward.
- In the left pane, navigate and select the desired target path.
- Click Add Path to add the target path to the right pane. Similarly, add other target paths.
- Click Add.
Tip
Either navigate the target paths from the root level (without specifying any path in the Add Target Path field) or make sure you provide the correct path to navigate further locations within it.
Click Next.
Select Profiles
Under Classification Profile Name, select the desired classification profiles to search for in the data store. You can select multiple profiles, if required. Refer to Classification Profiles for details on classification profiles.
Click Next.
Add Filters
This step is optional.
Select the desired filter from the Select Filter drop-down list.
To filter the locations to scan a MongoDB data store, consider the following syntax.
Note
Exclude locations by prefix, suffix, and expression filters support wildcard characters. See Using Wildcard Characters to learn how wildcards work.
Exclude locations by prefix
Exclude search locations and nested locations with paths beginning with a given string. It can be used to exclude entire directory trees.
Filter Item Syntax Example Database <DatabaseName> admin Collection <DatabaseName>/<CollectionName>* - admin/test* — applies all locations that start with 'admin\test' as prefix *test* —applies all locations that contains "test" as prefix
Exclude locations by suffix
Exclude search locations and nested locations with paths ending with a given string, specify
<string>
.Filter Item Syntax Example Database <DatabaseName>* admin* — applies all locations that start with 'admin' as prefix. Collection <DatabaseName>/<CollectionName>* admin/test* — applies all locations that start with 'admin/test' as suffix.
*test* — applies all locations that contain 'test' as suffix.Exclude locations by expression
This filter is majorly used with wildcard characters.
Exclude search locations and nested locations that matches a given expression.
Filter Item Syntax Example Database <DatabaseName>* admin* — excludes all locations that start with 'admin'. Collection <DatabaseName>/<CollectionName>* admin/test* — excludes all locations that start with 'admin\test'.
*test* — excludes all locations that contain 'test'.
Click Apply.
Repeat above steps to apply multiple filters. Click Remove to remove any applied filter.
Click Next.
Note
Unsupported filters in MongoDB data stores:
- Include locations modified recently
- Exclude locations greater than file size
- Include locations within modification date
Schedule Run
Specify the scan run frequency. The two options are:
Manual: This is the default option. Select this option to run the scan manually. Select the Run Now check box to start the scan run after you save the changes.
Scheduled: Select this option to configure the scan to run automatically at the specified time.
Refer to Schedule Scan for more details on scheduling scan runs.
Click Save.