Appendix A - LDAP and LDAP Groups for Snare Central - User Information

This document is designed to assist a systems/security administrator with configuration of LDAP (Lightweight Directory Access Protocol) and LDAP Groups within the Snare Central starting from v8.6

Snare Central Server is capable of delegating user authentication and optionally group authorisation to an external LDAP or Active Directory server.

Configure LDAP

Authentication Mode

LDAP Web GUI authentication supports two operation modes:  user authentication only mode and user and group authentication mode. The mode is controlled by the  LDAP Groups  checkbox in the LDAP Setup section of the Configuration Wizard.

When LDAP Groups  is disabled, the GUI will redirect the authentication to the server and domain specified in the configuration. The user must still have an account on the Snare Server with the same name as the LDAP/AD user, in order to login, hence specifying DN is neither required nor allowed for users. The authentication will be carried out using the default username@DOMAIN (userPrincipalName) form.

When LDAP Groups is enabled, the GUI will not only authenticate the user, but will also confirm that the user belongs to one or more of the groups allowed to use the Snare Central Web GUI. This authentication is more flexible, and allows the DN to be specified. The Users DN  field, will be used to search for users under the specified OUs in order to bind and authenticate the user(s). At least two groups need to be available on the AD server, in order for this mode to work. This authentication mode is described in detail further in this document.

To configure LDAP authentication support, navigate to System | Administrative Tools | Configuration Wizard | LDAP Setup.


Trusted CA root Certificate Administration

Please note that when LDAP/SSL, LDAP/TLS or SASL/TLS will be used, the CA root certificate of the authority that issued the LDAP-server certificate is required.

The following provides a guide for exporting a CA root certificate from Windows Active Directory Certificate Service (AD CS) server:


 Creating a Certificate Snap-in in the Microsoft Management Console (MMC)

To extract CA root certificate, you can create a certificate snap-in in the Microsoft Management Console (MMC).

To create a certificate snap-in in MMC:

  • In your Active Directory Certificate Service (AD CS) server, you can go to Start > Run or simply press the WindowsKey+R.
  • In the Run window type mmc.exe to open the MMC.
  • In the MMC, go to File > Add/Remove Snap-in.
  • In the Add or Remove Snap-ins window, select Certificates then click Add.
  • In the Certificates snap-in window, select Computer account then click Next.
  • In the Select Computer window, choose Local computer then click Finish.
  • In the Add or Remove Snap-ins window, you can see Certificates (Local Computer) in the Selected snap-ins list box.
  • In the Add or Remove Snap-ins window, Click OK to save the snap-in settings.
  • You may save this and/or continue to extract CA root certificate by following Exporting a CA root certificate using Microsoft Management Console (MMC).
 Exporting a CA root certificate using Microsoft Management Console (MMC)

To export the CA root certificate from your Active Directory Certificate Service (AD CS) server, you may follow these steps:

If MMC is not yet open in your Active Directory Certificate Service (AD CS) server, you can go to Start > Run or simply press the WindowsKey+R then in the Run window, type mmc.exe to open Microsoft Management Console (MMC).

  • In the MMC window, go to Console Root > Certificates (Local Computer) and navigate to the CA root certificate location of the authority that issued the LDAP-server certificate.
  • Select the root certificate created for your AD domain. Make sure to select the correct base certificate (Not the certificate that included the certificate chain). in some cases you may need to export the intermediate certificate that is part of the root certificate chain.
  • Right-click the certificate, and then select All Tasks > Export from the drop-down menu.
  • In the Certificate Export Wizard, click Next.
  • In Export File Format, select Base-64 encoded X.509 (.CER), and then click Next.
  • In File to Export, browse to the location where you want to export the certificate and provide the name of the certificate file, and then click Next.
  • Click Finish.
  • The CA certificate is exported successfully to the specified location in your local system.
  • In the Snare Central LDAP Setup, go to Trusted CA root Certificate Administration and click Browse in the "Add or Update a CA Certificate".
  • Navigate to the location where the exported CA certificate and select the correct CA certificate and click Open.

NOTE: If certificate validation does not work when using TLS LDAP authentication after being uploaded to Snare Central you may need to validate that you have exported the correct root certificate chain and then include the additional certificate in the CA root Certificate Administration load as per the images below.

Alternatively for older Windows Server versions, follow the "Export and download the CA Root Certificate from your AD Server." procedure described in Snare Management Center#a)-Generating-Certificates-for-Snare-Management-Center


Trusted CA root Certificate subsection description:

This control allows you to install, update or remove trusted Root Certificates system wide. If you are required to authenticate users with LDAP/TLS or SASL/LDAP, you need to provide Snare Central with the CA root certificate of the authority that issued the LDAP server certificate.

If you are setting up a certificate authority for your organisation in order to build and use PEM certificates in-house, you need to make sure that Snare Central is configured to recognise and trust your CA.

The Snare Wizard only supports PEM certificates. Please make sure that the file you want to upload is a Base-64 encoded, X-509 certificate with one of the following file extensions: (.crt, .cer, .pem, .cert, .key).

It is also possible to load the certificate manually if required:

  • Copy their PEM base64 encoded cert to the server either via SCP or open a vi session to a file and use cut and paste the base 64 encoded file
  • mv testcert.pem /usr/local/share/ca-certificates/testcert.crt  - note the rename
  • ​/usr/sbin/update-ca-certificates -v
  • The refresh configuration wizard UI and it should show the new certificate loaded in the security tab in the configuration wizard.

LDAP Authentication subsection description:

  • Enable LDAP - To enable LDAP select the checkbox. When enabled, all local Snare accounts will be temporarily disabled with the exception of the ADMINISTRATOR account, and all access to Snare will be authenticated and authorised from the LDAP server whether the user name exists as a Snare account or not.
  • Protocol - Select from LDAP, LDAP/SSL, LDAP/TLS or SASL/TLS.  A CA root certificate is required for TLS, this will typically be from the Active Directory Domain internal certificate authority. 
  • Server - The IP address or FQDN (Full Qualified Domain Name) of your LDAP/AD server. Please note that when using TLS, the administrator needs to make sure that the FQDN exactly aligns with the server name in the certificate, or authentication will fail.
  • Domain - If specified, this Domain will be used for authentication. When the sAMAccountName option is enabled, the domain will be prepended to the to username using the DOMAIN\Username format. Otherwise, the Username@DOMAIN (User Principal Name) format will be used.

  • Port - The LDAP server port.  Port 389 is the standard unencrypted port, however is used for TLS connections.
  • Win Server 2012 R2 compatibility mode - Selecting this option will force a lower version of TLS. There is a known issue when trying to bind Snare Central to a MS Active Directory using LDAP/TLS on a Windows Server 2012 R2. OpenLDAP’s GnuTLS and Microsoft’s SChannel implementations are not compatible with TLS 1.2 negotiation during AD/LDAPS binding, therefore it’s necessary to disable TLS1.2 before attempting binding.
  • Use SAM Account Name - If checked, this option instructs the LDAP authentication process to use the provided username as sAMAccounName rather than using it as a userPrincipalName (the default) in the initial login window of Snare Central. This means that when this option is selected the LDAP bind process will try to login a username using the DOMAIN\username format instead of the default username@DOMAIN form.
  • LDAP Groups - Selecting this option, enables the authorisation of groups defined in the Active Directory server for Snare. Please note that when LDAP Groups option is enabled, all local accounts are temporarily disabled with the exception of the Administrator account. If enabled, any valid LDAP user that belongs to one or more of the Snare groups defined in the AD/LDAP server, will have access to Snare Central Web interface but will not be able to see any objectives until the correct access rights are granted to each objective.  This is set via the System | Administrative Tools | Manage Access Control configuration objective. 
  • Super Group Name-  When LDAP Groups is enabled, a special group in the AD/LDAP server that will be used as the base for authentication is required. The default group name is Snare_Central however the user can change this default if required.
  • Super Group DN- The complete distinguished name of the super group needs to be specified in this field.
  • Users DN - When the users that need have access to the Snare Central server are distributed in different branches across the LDAP/AD hierarchy, the complete distinguished names of all the OU (Organizational Units or Containers) where the users reside must be specified for LDAP queries to work properly. If users are spread across different Organisational Units in your LDAP/AD server, add all the required User Distinguished Names in this list, one per line. All LDAP user queries will be sequentially executed in the order that they appear in this list.
  • Test Authentication - This button is available to help verify that LDAP setup values are correct, verified by an overlay screen with a success or error message will be displayed to the user.
  • Retrieve Groups- When the LDAP Groups option is enabled, this button is also available and it must be used to grab the related group info in the LDAP/AD server as part of LDAP configuration. Simply enter a valid LDAP Username and LDAP Password to retrieve the valid groups that are set. Valid usernames formats are user, user@domain or domain\username.


    Local Groups

    When LDAP Groups option is disabled the user must still have an account on the Snare Central Server with the same name as the one in LDAP/AD server, in order to login.

LDAP/AD Server Configuration for LDAP Groups

LDAP Groups support delegates both authentication and group access control on the Snare Central user interface, to your selected LDAP/AD server and the "Manage Access Control" tool manages the permissions for those groups inside Snare server. Before LDAP Groups support can be enabled, the AD/LDAP server needs to meet the following conditions:

  • First, a super group needs to be created in the AD/LDAP server. By default the super group name is “Snare_Central” and by default  it shall be defined under the default Users OU or container. However this can be changed if required. This super group is a requirement as Snare Central server will search within this super group for all other Snare Server groups. For example, if the domain of the LDAP/AD server is domain.co, the Distinguished Name for the Snare_Central group has to be exactly "CN=Users,DC=domain,DC=co". However if another name or the location of this super group needs to be different, the administrator can change these values by updating the Super Group Name field and the Super Group DN fields.

  • Snare Central Server can retrieve any number of groups required as long as they are defined in the LDAP server and they are all members of the super group and the super group DN is provided. Starting from version 8.6, any sub group member of a group that is member of the super group will also have access to the Snare central UI effectively providing nested group capability under the super group.

  • Any user account belonging to (member of) any of the above groups will be granted access to Snare but will not have permission to access any Objective or Report until permissions have been given to a group via the “Manage Access Control” tool (see corresponding section further down).

  • Users belonging directly to (that are member of) the super group will not have access to the user interface as this group is for group membership only. So no user should be member of super group.

  • All password complexity and password expiry verification will need to be carried out in the LDAP server.

  • If users are distributed across the whole AD/LDAP hierarchy, it may be necessary to add the full DN (Distinguished Name) of the OUs (Organizational Units or Containers) where the users are located. Add each OU as a single line in the Users DN field of the LDAP Setup section.
  • Once the super group and all sub groups are specified in the AD/LDAP server and the Super Group Name and Super Group DN fields updated in the LDAP Setup section in the Snare Central server, the administrator need to retrieve the group information using the Retrieve Groups button and providing a valid user and password.
  • As a final step, once all the LDAP authentication has been successfully configured, it is required to grant access rights to the LDAP group(s) inside Snare Central with the "Manage Access Control" tool.


Active Directory requirements

Snare Central support for LDAP Groups relies on the existence of  the "memeberOf" attribute for each user that belongs to one or more of the groups that are members of the super group (the snare groups).

Retrieve Group Info

When LDAP Groups  option is enabled the first time, Snare Central needs to retrieve the group's information from the LDAP or AD server. This can be done specifying a valid user and password with enough access rights to retrieve this information. Please note that none user name or password will not be stored by Snare.

NOTE: As a requisite, before any group info can be retrieved, the super group needs to be created in the AD server and the super group name and DN specified in Snare configuration. Also, any Snare related subgroups need to be already created. These new groups must be members of the super group to be recognised by the Snare Central Server.


Nested Groups

Since version 8.6.0, Snare Central LDAP is able to recognise a group hierarchy under the super group. This is in contrast to previous versions where only the groups directly under the super group were recognised (groups direct members of the super group or top groups). However keep in mind that the "Manage Access Control" tool only uses these top groups for permission assignment. This means that when retrieving group information from the LDAP/AD server, only the groups that are directly members of the super group (top groups) will be retrieved.

Example

In this example, the Snare Central server is configured to forward user and group authentication to an Active Directory server. There are five Snare related groups with different privileges (not including the Snare_Central super group as it can not have users associated with it). There are nine different users that are members of one or more of these groups.


Please note how the users are spread across different Organisational Units (OU) in the AD server. In this scenario, we need to specify to the Snare Central server where in the LDAP hierarchy the users can be found. To achieve this, the Users DN field needs to include a list with all the Distinguished Names of the containers where the users are located. When a user tries to login, an LDAP background query is triggered to find the groups for which the user is member of. A query is made for each of the Distinguished Names defined in the above list (and in the same order) until a match is found.

Please note that the Users DN field is only useful when the LDAP Groups option is enabled. 

Once the groups of the user are found, and if at least on of those groups is member of the Snare_Central super group, then the access is granted.

In the following image, please note how the users and group are defined in the Active Directory hierarchy and how this defines their respective DNs:



The DNs and the membership of all involved users and groups are as follows:

Snare_Central super group

dn: CN=Snare_Central,CN=Users,DC=snaresub1,DC=snare,DC=ia
member: CN=Security Analists,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Snare Web Reports,OU=Marketing,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Snare Administrators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Snare Analists,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Snare Operators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

Groups:

Snare Administrators

dn: CN=Snare Administrators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Miles Davis,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Wolfgang A. Mozart,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Kevin Mitnick,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Generic Developer1,OU=Server Development,OU=Development Area,DC=snaresub1,DC=snare,DC=ia

Security Analists

dn: CN=Security Analists,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Kevin Mitnick,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

Snare Analists

dn: CN=Snare Analists,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Tonny Hawk,OU=Users,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Generic Visitor,OU=Guests,DC=snaresub1,DC=snare,DC=ia

Snare Operators

dn: CN=Snare Operators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Miles Davis,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Billie Holday,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=Generic Developer2,OU=Agent Development,OU=Development Area,DC=snaresub1,DC=snare,DC=ia

Snare Web Reports

dn: CN=Snare Web Reports,OU=Marketing,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
member: CN=David Gilmour,OU=Users,OU=Marketing,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia


Users:

developer one

dn: CN=Generic Developer1,OU=Server Development,OU=Development Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Administrators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

developer_two

dn: CN=Generic Developer2,OU=Agent Development,OU=Development Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Operators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

KMitnick

dn: CN=Kevin Mitnick,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Security Analists,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Administrators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

wmozart

dn: CN=Wolfgang A. Mozart,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Administrators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

bholiday

dn: CN=Billie Holday,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Operators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

miles

dn: CN=Miles Davis,OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Administrators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Operators,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

thawk

dn: CN=Tonny Hawk,OU=Users,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Analists,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

DGilmour

dn: CN=David Gilmour,OU=Users,OU=Marketing,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Web Reports,OU=Marketing,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia

visitor-one

dn: CN=Generic Visitor,OU=Guests,DC=snaresub1,DC=snare,DC=ia
memberOf: CN=Snare Analists,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia


To allow all of the nine users to have access to the Snare Central server UI, the value of the Users DN field shall be like this:

OU=Server Development,OU=Development Area,DC=snaresub1,DC=snare,DC=ia
OU=Agent Development,OU=Development Area,DC=snaresub1,DC=snare,DC=ia
OU=Users,OU=Security Assurance,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
OU=Users,OU=Provisioning Area,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
OU=Users,OU=Marketing,OU=Operations Area,DC=snaresub1,DC=snare,DC=ia
OU=Guests,DC=snaresub1,DC=snare,DC=ia

It is also valid to omit the domain part of the DNs as follows:

OU=Server Development,OU=Development Area
OU=Agent Development,OU=Development Area
OU=Users,OU=Security Assurance,OU=Operations Area
OU=Users,OU=Provisioning Area,OU=Operations Area
OU=Users,OU=Marketing,OU=Operations Area
OU=Guests

If last DN in the list is omitted, the visitor-one user will not be granted access to Snare as the server will not be able to find the user in the query.

The final setup for this example will look like this in the Snare Central UI:


Testing your setup.

The LDAP Setup provides the capability to test the authorisation and the group retrieval mechanisms. In order to be able to use this tool, first the values of the Server, Domain and Port fields need to be saved. If group retrieval is to be tested, the "LDAP Groups for Snare Central" need also to be enabled and saved. Once these fields are stored, a user and a password can be provided to verify that the authentication is working correctly. A panel with the result of the test query will pop-up.

In the following image the account attributes of the Generic Developer1 user are shown. Notice that the User Principal Name (UPN) is highlighted in green and it has the form username@domain. Also please notice that the sAMAccountName (developer one) along with the NetBios Name are shown and together they form a NetBIOS logon Name (DOMAIN\username) and is highlighted in blue.



The LDAP Username field in the Test section, accepts the user name in both UPN and SAM formats. Following the Generic Developer1 example, the value for this field could be:

developer one@snaresub1.snare.ia or SNARESUB1\developer one

The LDAP Username field also accepts just the username alone without any domain. When used like this, its behaviour depends on the value of the Use SAM Account Name checkbox. When enabled the authorisation test is performed using the DOMAIN\username otherwise the username@domain is used.


Valid username symbols

Pleas note that Snare Central sanitation mechanism will remove non-standard characters from the username field in the  login page. Active Directory User names can NOT contain any of the following:

Also these other symbols are not allowed  locally as a prevention for command injection:

  • At symbol (@),
  • Pound sign (#),
  • Dollar sign ($)

So is very likely that the Snare will remove all non-standard chars from the usernames prior to be send to the LDAP server for validation. Please try defining a simple user name in the AD server at first.


Login

Please note that the LDAP Username field behaviour is the exact same behaviour of the Snare Central login page.

Manage Access Control

The Manage Access Control interface provides an easy and flexible tool for changing Objectives Access Rights at the group level for both local groups or LDAP defined groups.

Every objective on the Snare Central can be individually secured so that only authorised staff have access to it. Access is granted at group level; therefore, an LDAP user must be attached to an LDAP group in order to view or change an objective. This also applies to local users and groups. Manage Access Control detects if Snare is in LDAP mode or not, and will change access rights for objectives accordingly.

Please note that most objectives under the "Administrative Tools" and "Data Management Tools" are restricted for Administrators group exclusively. This is because of the security risks and potential of harm to the Snare Central server involved. This means that most of such objectives cannot be accessed by LDAP users nor by local users that do not belong to the Administrators local group. This also means that the "Manage Access Control" interface cannot be used to assign permissions to these administrative objectives either. The complete list of the Administrators only objectives is the following.

Access restricted to users in Administrators group only

Administrative Tools

  • Antivirus Administration
  • Cloud Log Collection Configuration
  • IP Address Configuration
  • Configuration Wizard
  • Configure GeoLocation for Mapping
  • Display the Snare Central Log Files (from v8.6.1)
  • File Integrity Check Administration
  • Snare Central Update
  • Snare Threat Intelligence
  • User Administration
  • ShutDown / Reboot Snare Central
  • Manage Nightly Updates
  • Manage Access Control
  • Import Objectives
  • Manage Objective Schedules
  • Manage Plugins
  • Support Data Retrieval

Data Management Tools

  • Data Backup and Restore
  • Snare Data Import


One of two access rights levels can be granted:

  • Access permissions. This provides a user with read to view the output of this objective, and also regenerate the objective.
  • Change permissions. This provides a user with the ability to change the configuration settings for the objective as well as view and regenerate the function. 

A single, multiple or complete tree structures of existing objectives are able to be selected, to add or delete “Access” permissions (Read access) and/or “Control” permissions (Write access) to those objectives for a group or set of groups.

By selecting in the Objective name (or Objective directory) at the tree representation on the left (see image above) will select or deselect the objective(s). Once selected, one or more groups are required to be highlighted from the list provided and at least one access level to be checked in order to apply to selected objectives.

In addition, users who create, or clone an objective, are identified as the owner of the objective. Both the owner, and Snare Server ADMINISTRATOR have the ability to Delete the objective and Add new users to the objective.

Note

When LDAP Groups  is enabled, the Manage Access Control tool will affect only LDAP users and groups and will not have any effect on local Snare users or groups, hence all legacy options for access control like the Access Control (lock icon) in Snare’s top panel and setting Folder Permissions on directories in the Reports navigation tree will have no effect on LDAP permissions for the same objectives.


Info pre v7.2.0

Prior to Snare Central Server v7.2, only remote user authentication was available with the constraint that the remote user should correspondingly have a local Snare account. This still remains to be true when the option for remote LDAP Groups support is disabled (in Configuration Wizard).