Check Point Identity Collector is a dedicated client agent installed on Windows Servers in your network. Identity Collector collects information about identities and their associated IP addresses, and sends it to the Check Point Security Gateways for identity enforcement. For mandatory requirements and more information, see sk108235.
This section explains the steps you must follow to operate Identity Collector as an identity source, including installation and configuration on the Windows Server.
To enable the Identity Collector solution, you must also configure it in the Identity Awareness Gateway object in SmartConsole:
You must select Identity Awareness Gateway interfaces that can accept connections from Identity Collector clients.
To select the Identity Awareness Gateway interfaces:
Important - The Through all interfaces and Through internal interfaces options have priority over Firewall Policy rules. If a Firewall rule is configured to block connections from Identity Collector clients, connections continue to be permitted when one of these options is selected.
An Identity Awareness Gateway accepts connections only from authorized Identity Collector client computers.
To configure authorized Identity Collector client computers:
Notes:
Or from the right upper corner, click the Objects tab > New > Host.
Notes:
The LDAP Account Units window opens.
By default, all User Directories options are selected. You can select only one or two options, if users are only from a specified directory, and you want to maximize Security Gateway performance, when users authenticate. Users with identical user names must log in with domain\username
.
To download the Identity Collector:
Make sure you open the link from a location defined in the Accessibility setting (Identity Collector > Settings > Edit).
https://<Gateway_IP_Address>/_IA_IDC/download/CPIdentityCollector.msi
Download should start automatically.
To install the Identity Collector, a user with administrator rights must run the Identity Collector installation.
For all requirements and more information, see sk108235.
The Windows server, on which you install the Identity Collector, must meet these requirements:
These are the elements of the Identity Collector client GUI that was downloaded from R80.20 Security Gateway:
Location in GUI |
Element in GUI |
Description |
---|---|---|
Upper left corner |
Icon with pink people silhouettes |
Opens a menu with these options:
|
Top toolbar
|
Query Pools |
Configuration of Query Pools |
Filters |
Configuration of Filters for login events |
|
Domains |
Configuration of Domains |
|
Syslog Parses |
Configuration of Syslog Parses |
|
Left navigation toolbar
|
Identity Sources |
Configuration of Identity Sources |
Gateways |
Configuration of Identity Awareness Gateways |
|
Logins Monitor |
View of login events |
|
Settings |
Configuration of advanced settings |
To add a new Query Pool in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
At the top, click Query Pools. |
3 |
From the top toolbar, click New Query Pool (). |
4 |
Enter the name for the Query Pool to show in the Identity Collector. |
5 |
(Optional) Enter the comment. |
6 |
Select the Identity Sources, from which to collect identities. |
7 |
Click OK. |
To edit an existing Query Pool in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
At the top, click Query Pools. |
3 |
Select the applicable Filter. |
4 |
From the top toolbar, click Edit Query Pool (). |
5 |
Select the Identity Sources, from which to collect identities. |
6 |
Click OK. |
To delete an existing Query Pool in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
At the top, click Query Pools. |
3 |
Select the applicable Filter. |
4 |
From the top toolbar, click Delete Query Pool (). |
5 |
Click Yes to confirm. |
6 |
Click OK. |
Note - The Identity Collector queries only the Identity Sources that are selected in the Query Pool.
You can configure the Identity Collector to filter the login events. The Identity Collector sends to the Identity Server (Identity Awareness Gateway) only events that match the filter criteria.
To add a new Filter for login events in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the top toolbar, click Filters. |
3 |
From the top toolbar, click New Filter (). |
4 |
Enter the name for the Filter to show in the Identity Collector. |
5 |
(Optional) Enter the comment. |
4 |
Configure the filter:
|
5 |
Click OK. |
To edit an existing Filter for login events in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the top toolbar, click Filters. |
3 |
Select the applicable Filter. |
4 |
From the top toolbar, click Edit Filter (). |
5 |
Configure the Filter:
|
6 |
Click OK. |
To delete an existing Filter for login events in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the top toolbar, click Filters. |
3 |
Select the applicable Filter. |
4 |
From the top toolbar, click Delete Filter (). |
5 |
Click Yes to confirm. |
6 |
Click OK. |
Cache:
The cache saves associations (user-to-IP address) that the Identity Collector creates for a certain time (the default is 5 minutes). If the event happens again during that time, the Identity Collector does not send it to the Identity Server again.
To add a new Active Directory Domain in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
At the top, click Domains. |
3 |
From the top toolbar, click New Domain (). |
4 |
Enter the Domain name to show in the Identity Collector. |
5 |
(Optional) Enter the comment. |
6 |
Enter the Domain account credentials - Username and Password. Note - The account must be a member of the Event Log Readers group. |
7 |
Enter the DC IP Address and click Test. |
8 |
Click OK. |
To edit an existing Active Directory Domain in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
At the top, click Domains. |
3 |
Select the applicable Domain. |
4 |
From the top toolbar, click Edit Domain (). |
5 |
Configure the Domain. |
6 |
Click OK. |
To delete an existing Active Directory Domain in the Identity Collector:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
At the top, click Domains. |
3 |
Select the applicable Domain. |
4 |
From the top toolbar, click Delete Domain (). |
5 |
Click Yes to confirm. |
6 |
Click OK. |
To connect the Identity Collector to the Check Point Identity Server (Identity Awareness Gateway):
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the left navigation toolbar, click Gateways. |
3 |
From the top toolbar, click Add (). |
4 |
Configure the Identity Awareness Gateway:
|
5 |
Click Test. |
6 |
Examine and approve the Certificate Info. |
7 |
Click OK. |
Workflow to configure the Identity Collector to work with Active Directory:
Notes:
To add a new Active Directory Domain:
See Working with Active Directory Domains in the Identity Collector.
To add a new Active Directory Domain Controller as an Identity Source:
Use one of these two options to add the required Domain Controllers.
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the left navigation toolbar, click Identity Sources. |
3 |
From the top toolbar, click New Source > Active Directory > Fetch Automatically. |
4 |
Enter the Domain Controller information:
|
5 |
Click Fetch. A list of the Domain Controllers show. |
6 |
Enable the Domain Controllers you want to add. |
7 |
Click OK. |
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the left navigation toolbar, click Identity Sources. |
3 |
From the top toolbar, click New Source > Active Directory > Add Manually. |
4 |
Enter the Domain Controller Name to show in the Identity Collector. |
5 |
(Optional) Enter your comment. |
6 |
Enter the Domain Controller information:
|
7 |
Click Test. |
8 |
Click OK |
To add a new Query Pool in the Identity Collector:
See Working with Query Pools in the Identity Collector.
To add a new Filter for login events in the Identity Collector:
See Working with Filters for Login Events in the Identity Collector.
To connect the Identity Collector to the Check Point Identity Server (Identity Awareness Gateway):
See Connecting the Identity Collector to the Identity Awareness Gateway.
Workflow to configure the Identity Collector to work with Cisco ISE:
To add a new Cisco ISE Server as an Identity Source:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the left navigation toolbar, click Identity Sources. |
3 |
From the top toolbar, click New Source > Cisco ISE. |
4 |
Enter the ISE Server Name to show in the Identity Collector. |
5 |
Enter the Server Settings:
|
6 |
Enter the Client Settings:
|
7 |
Click OK. |
To add or edit a Query Pool in the Identity Collector:
See Working with Query Pools in the Identity Collector.
To add or edit a Filter for login events in the Identity Collector:
See Working with Filters for Login Events in the Identity Collector.
To connect the Identity Collector to the Check Point Identity Server (Identity Awareness Gateway):
See Connecting the Identity Collector to the Identity Awareness Gateway.
Identity Collector can now receive and process syslog messages that contain identity information. Identity Collector can use these syslog messages as an additional identity source for the Identity Awareness Gateway.
Workflow to configure the Identity Collector to parse Syslog messages:
To create a Syslog Parser:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the top toolbar, click Syslog Parsers. |
3 |
Click New Parser. |
4 |
Enter the Syslog Parser information:
Important - Only the value of the attribute must be inside parentheses. |
5 |
Click OK. |
Additional information about how Syslog Parser works:
Syslog parser uses regular expressions with ECMAScript syntax.
To get an attribute, syslog parser uses this regular expression:
/<Message Subject>.*<Attribute Prefix><Attribute>[\\n|<Delimiter>].*$/.
Any unnecessary attributes should be empty. One of these pairs is mandatory:
Example syslog message:
LOCAL7.INFO: May 30 2017 11:15:45: %ASA-6-113004: AAA user accounting Successful : server = 192.168.1.1 : user = johndoe\n
The Syslog Parser for this message may look like this:
AAA user accounting Successful
Login
\s:
user\s=
\s(\w+)
server\s=
\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})
To add a Syslog Server as an Identity Source:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the left navigation toolbar, click Identity Sources. |
3 |
From the top toolbar, click New Source > Syslog. |
4 |
Enter the Syslog Server information:
|
To add or edit a Query Pool in the Identity Collector:
See Working with Query Pools in the Identity Collector.
To add or edit a Filter for login events in the Identity Collector:
See Working with Filters for Login Events in the Identity Collector.
To connect the Identity Collector to the Check Point Identity Server (Identity Awareness Gateway):
See Connecting the Identity Collector to the Identity Awareness Gateway.
Note - If you imported a previously exported configuration, the Identity Collector's GUI might not show the Syslog Parsers immediately. In this case, close and reopen the Identity Collector.
Workflow to configure the Identity Collector to work with NetIQ eDirectory LDAP servers:
Note - Check Point only supports user authentication for NetIQ eDirectory.
To configure the Identity Awareness Gateway to work with NetIQ eDirectory LDAP server:
Step |
Instructions |
---|---|
1 |
In SmartConsole, configure the Security Gateway that will act as Identity Awareness Identity Server:
|
2 |
In SmartConsole, create a new Host object to represent your NetIQ eDirectory LDAP server:
|
3 |
In SmartConsole, create a new LDAP Account Unit object to represent the NetIQ eDirectory LDAP server, which manages the identities:
|
4A |
Configure the new LDAP Account Unit object that represents the NetIQ eDirectory LDAP server:
|
4B |
Continue the configuration of the new LDAP Account Unit object that represents the NetIQ eDirectory LDAP server:
|
4C |
Continue the configuration of the new LDAP Account Unit object that represents the NetIQ eDirectory LDAP server:
|
4D |
Continue the configuration of the new LDAP Account Unit object that represents the NetIQ eDirectory LDAP server:
|
4E |
Complete the configuration of the new LDAP Account Unit object that represents the NetIQ eDirectory LDAP server: Click OK to close the LDAP Account Unit Properties window. |
5 |
In SmartConsole, install the Access Policy on the Identity Awareness Gateway that acts as Identity Server. |
To add a NetIQ eDirectory Server as an Identity Source:
Step |
Description |
---|---|
1 |
Open the Identity Collector application. |
2 |
From the left navigation toolbar, click Identity Sources. |
3 |
From the top toolbar, click New Source > eDirectory. |
4 |
Enter the eDirectory Server information:
|
5 |
Click OK to close the New eDirectory Server window. |
To add or edit a Query Pool in the Identity Collector:
See Working with Query Pools in the Identity Collector.
To add or edit a Filter for login events in the Identity Collector:
See Working with Filters for Login Events in the Identity Collector.
To connect the Identity Collector to the Check Point Identity Server (Identity Awareness Gateway):
See Connecting the Identity Collector to the Identity Awareness Gateway.
Sometimes, a Domain Controller sends events with domain names that are not the NetBIOS or the FQDN names. When this occurs, the Identity Awareness Gateway does not know the domain and drops the association. The Alias feature of the Identity Collector resolves this issue.
To enable Alias feature on the Identity Collector client computer:
C:\ProgramData\CheckPoint\IdentityCollector\
DomainDictionaryAliases.cfg
<name from which to convert>=<name to which to convert>
Notes:
Example:
If the nickname of "something.com
" is "someone
", add this line in the file: someone=something.com
This way, if an event contains the "someone
" domain, the domain name will change to "something.com
".
IDCService
Check Point Identity Collector
In the Identity Collector client, from the left navigation toolbar, click Settings.
Category |
Setting |
Description |
---|---|---|
Activity Log |
|
Logs the date and time of activities done in the Identity Collector. This log is cleared every time the Identity Collector GUI restarts. |
Settings > Identity Reporting |
Association time-to-live |
How long this association lives on the PDP Identity Awareness Gateway. The default is 720 minutes, or 12 hours. |
Cache time-to-live |
The cache saves associations (username-to-IP address) that the Identity Collector creates for a specified time. If the event occurs again during that time, the Identity Collector does not send the event to the Identity Awareness Gateway again. The default is 300 seconds, or 5 minutes. |
|
Ignore machine identities |
If you select this option, the Identity Collector does not send computer associations, only user associations. By default, this option is cleared. |
|
Ignore RDP events |
When Remote Desktop login occurs, 2 login events occur in the Domain Controller with the same username, but different IP addresses: the computer, from which login was made, and the computer, to which the login was made. If you select this option (this is the default), the Identity Collector ignores the IP address of the computer, from which login was made, because it is redundant. |
|
Clear Cache |
Clears all the entries saved in the cache. The Identity Collector will create new cache entries when it receives new associations. |
|
Settings > Debugging |
|
Lets you configure the debug topics and severity of collected internal messages in the Identity Collector. Location of the output files is configured in this file: The output files are:
|
Settings > ISE Servers |
Session Keep-alive |
The Identity Collector goes over its internal Cisco ISE sessions database every configured interval. If Identity Collector finds expired sessions, it queries the Cisco ISE Server to see if the session is still alive. Then Identity Collector updates the Identity Awareness Gateway accordingly. This value sets the interval, during which this occurs. The default is 1 minute. |
Settings > eDirectory |
LDAP Query Interval |
This value sets the frequency for Identity Collector to query eDirectory LDAP servers. The default is 20 seconds. |
Initial Fetch Time Frame |
This value sets how long Identity Collector waits for eDirectory LDAP servers during initial fetch. The default is 720 minutes, or 12 hours. |
|
Settings > Logins Monitor
|
Event expiration time |
The maximal time that the Logins Monitor Table stores each login record. |
Cache time-to-live |
The maximal time between two different login events by the same user or same computer that are treated as one Logins Monitor record. |
|
Auto refresh time |
The interval of time, during which the user interface of the Logins Monitor refreshes its view, when it requests an update of the users' logins records. |
|
Ignore revoked events |
When selected, the Logins Monitor tab only stores and shows the latest login event (both user and computer event) for each IP address. |
Direction |
Port |
Protocol |
---|---|---|
Identity Collector to Identity Awareness Gateway |
443 |
Proprietary Check Point protocol, over HTTPS. Used for ongoing communication between the agent and the Identity Awareness Gateway. |
Identity Collector to Microsoft Active Directory Domain Controller |
53 |
DNS |
Identity Collector to Microsoft Active Directory Domain Controller |
389 |
LDAP |
Identity Collector to Microsoft Active Directory Domain Controller |
636 |
LDAPS |
Identity Collector to Microsoft Active Directory Domain Controller |
135, |
* DCOM protocol, which makes extensive use of DCE/RPC. |
Identity Collector to Cisco ISE Server |
5222 |
Session subscribe. Gets notifications of new login or logout events from the Cisco ISE Server. |
Identity Collector to Cisco ISE Server |
8910 |
Bulk session download. Fetches all the active sessions from the Cisco ISE Server. |
* DCOM uses DCE/RPC. If the Active Directory Domain Controller uses Windows Firewall, you must configure it to allow Identity Collector traffic: enable Remote Event Log Management > Remote Event Log Management (RPC).
Exclude multi-user machines
After the Identity Collector works for a while, you can check how many multi-user computers there are, and add them to the Network Exclusion List. To do so, enter this command on the Identity Awareness Gateway CLI:
pdp idc muh show |
Exclude service accounts
After the Identity Collector works for a while, you can see how many service accounts there are, and add them to the Identity Exclusion List. To do so, enter this command on the Identity Awareness Gateway CLI:
pdp idc service_accounts |
Consolidate Groups
If the Identity Awareness Gateway receives the user groups from the Cisco Identity Collector (SGT), it does not try to fetch them from the user directory. If you enable group consolidation, the Identity Awareness Gateway fetches the group even if it receives groups from the Identity Collector:
pdp idc groups_consolidation show |