User Guide Functional Overview Requirements Architecture System Installation NetEye Additional Components Installation Setup The neteye Command Director NetEye Self Monitoring Tornado Business Service Monitoring IT Operation Analytics - Telemetry Geo Maps NagVis Audit Log Shutdown Manager Reporting ntopng Visual Monitoring with Alyvix Elastic Stack IT Operations (Command Orchestrator) Asset Management Service Level Management Cyber Threat Intelligence - SATAYO NetEye Update & Upgrade How To NetEye Extension Packs Troubleshooting Security Policy Glossary
module icon Setup
Cluster Satellite Security Identity and Access Management External Identity Providers Configure federated LDAP/AD Emergency Reset of Keycloak Configuration Advanced Configuration Authorization Resources Tuning Advanced Topics
Functional Overview Requirements Architecture System Installation NetEye Additional Components Installation Setup The neteye Command Introduction to NetEye Monitoring Business Service Monitoring IT Operation Analytics Visualization Network Visibility Log Management & Security Orchestrated Datacenter Shutdown Application Performance Monitoring User Experience Service Management Service Level Management & Reporting Requirements for a Node Cluster Requirements and Best Practices NetEye Satellite Requirements TCP and UDP Ports Requirements Additional Software Installation Introduction Single Node Cluster NetEye Master Master-Satellite Architecture Underlying Operating System Acquiring NetEye ISO Image Installing ISO Image Single Nodes and Satellites Cluster Nodes Configuration of Tenants Satellite Nodes Only Nodes behind a Proxy Additional NetEye Components Single Node Cluster Node Satellites Nodes only Verify if a module is running correctly Accessing the New Module Cluster Satellite Security Identity and Access Management External Identity Providers Configure federated LDAP/AD Emergency Reset of Keycloak Configuration Advanced Configuration Authorization Resources Tuning Advanced Topics Basic Concepts & Usage Advanced Topics Monitoring Environment Templates Monitored Objects Import Monitored Objects Data Fields Deployment Icinga 2 Agents Configuration Baskets Dashboard Monitoring Status VMD Permissions Notifications Jobs API Configuring Icinga Monitoring Retention Policy NetEye Self Monitoring 3b Concepts Collecting Events Add a Filter Node WHERE Conditions Iterating over Event fields Retrieving Payload of an Event Extract Variables Create a Rule Tornado Actions Test your Configuration Export and Import Configuration Example Under the hood Development Retry Strategy Configuration Thread Pool Configuration API Reference Configure a new Business Process Create your first Business Process Node Importing Processes Operators The ITOA Module Configuring User Permissions Telegraf Metrics in NetEye Telegraf Configuration Telegraf on Monitored Hosts Visualizing Dashboards Customizing Performance Graph The NetEye Geo Map Visualizer Map Viewer Configuring Geo Maps NagVis 3b Audit Log 3b Overview Shutdown Manager user Shutdown Manager GUI Shutdown Commands Advanced Topics Overview User Role Management Cube Use Cases ntopng and NetEye Integration Permissions Retention Advanced Topics Overview User Roles Nodes Test Cases Dashboard Use Cases Overview Architecture Authorization Elasticsearch Overview Enabling El Proxy Sending custom logs to El Proxy Configuration files Commands Elasticsearch Templates and Retentions El Proxy DLQ Blockchain Verification Handling Blockchain Corruptions El Proxy Metrics El Proxy Security El Proxy REST Endpoints Agents Logstash Elastic APM Elastic RUM Log Manager - Deprecated Overview Authorization in the Command Orchestrator Module Configuring CLI Commands Executing Commands Overview Permissions Installation Single Tenancy Multitenancy Communication through a Satellite Asset collection methods Display asset information in monitoring host page Overview Customers Availability Event Adjustment Outages Resource Advanced Topics Introduction Getting Started SATAYO Items Settings Managed Service Mitre Attack Coverage Changelog Before you start Update Procedure Single Node Upgrade from 4.41 to 4.42 Cluster Upgrade from 4.41 to 4.42 Satellite Upgrade from 4.41 to 4.42 DPO machine Upgrade from 4.41 to 4.42 Create a mirror of the RPM repository Sprint Releases Feature Troubleshooting Tornado Networking Service Management - Incident Response IT Operation Analytics - Telemetry Identity Provider (IdP) Configuration Introduction to NEP Getting Started with NEPs Online Resources Obtaining NEP Insights Available Packages Advanced Topics Upgrade to NetEye 4.31 Setup Configure swappiness Restarting Stopped Services Enable stack traces in web UI How to access standard logs Director does not deploy when services assigned to a host have the same name How to enable/disable debug logging Activate Debug Logging for Tornado Modules/Services do not start Sync Rule fails when trying to recreate Icinga object How to disable InfluxDB query logging Managing an Elasticsearch Cluster with a Full Disk Some logs are not indexed in Elasticsearch Elasticsearch is not functioning properly Reporting: Error when opening a report Debugging Logstash file input filter Bugfix Policy Reporting Vulnerabilities Glossary 3b

External Identity Providers

This section describes how to configure an external identity provider (IdP) in Neteye.

Identity Providers are services that create, maintain, and manage identity information for users while providing authentication services to relying applications within a federation or distributed network. If you have an existing IdP, you can configure it in NetEye to authenticate users with it (via SAML), defined in RFC 7522 or OIDC defined in the OpenID Connect Core 1.0 specification. Some popular options for that are: Ping Identity, Fortinet or MS ADFS. This page also shows examples of how to configure some of the most common IdPs.

When an IdP is enabled, Keycloak redirects the user to the IdP login page based on the email address’ domain.

Note

If LDAP is enabled and provides the user’s email address, the user can insert only the username at the login.

Add an IdP in NetEye

To add an IdP in NetEye, access the Authentication Admin Console and click on the Identity Providers > Add provider menu item. Many already configured IdPs can be easily set up by clicking a button under the Social section, or a custom IdP can be configured by selecting a protocol under the User defined tab.

Note

Keycloak supports SAML v2.0, OIDC v1.0, and OAuth 2.0.

After clicking a button, a wizard will guide you through the configuration of the IdP. You will also need access to the IdP admin console to obtain the necessary information to configure the IdP in NetEye, and accept NetEye as a client.

Specific IdP how-to guides

OpenID Connect (OIDC)

Keycloak supports the auto-discovery of OIDC configuration from the IdP. The URL: https://{YOUR-IDP-HOST}/.well-known/openid-configuration can be used to configure the IdPs discovery endpoint inside the Keycloak configuration form. If you want to configure the IdP manually, you can follow the official OIDC Configuration documentation.

We generally recommend using OIDC over SAML when possible, as it is easier to integrate with Keycloak and has a

Security Assertion Markup Language (SAML)

Keycloak supports the SAML identity descriptor file (metadata) from the IdP. If you want to configure the IdP manually, you can follow the official SAML Configuration documentation.

Common IdP configuration

Table 11 Configuration fields

Alias

The alias is a unique identifier for an identity provider and references an internal identity provider. Keycloak uses the alias to build redirect URIs for OpenID Connect protocols that require a redirect URI or callback URL to communicate with an identity provider. All identity providers must have an alias. Examples of aliases include Facebook, Google, and idp.acme.com.

Hide on Login Page

MUST be set to true because we have the IdP auto-selection based on email address

Account Linking Only

SHOULD be set to true

Store tokens

MUST be set to false

Store Token Readable

MUST be set to false

Trust Email

MUST be set to true

Sync Mode

SHOULD be set to force because you have to trust the IdP.

Case-sensitive username

SHOULD be set to true

See the official guide of Keycloak if you need particular configurations.

Configuring idp domains

For the Home IdP Discovery to correctly map the email domain to the proper login endpoint, the IdP domains need to be configured. This step ensures that Keycloak properly redirects to the IdP for authentication, requiring only the username as the initial step of the login process. Additionally, if multiple IdPs are configured in Keycloak, setting this parameter allows Keycloak to determine the correct IdP to redirect to based on the email domain associated with the entered username.

Since that configuration option is currently only available over a REST-API, we provide a neteye subcommand to make these configuration as easy as possible. With the neteye config auth idp command, you can view and edit the domain configuration with the subcommands list and set respectively.

To activate the flow, you then also need to follow the configuration steps below.

Enabling the Home IdP Discovery Flow

After setting up the IdP, you must change the default Authentication Flow on Keycloak. To do this, you need to access the Authentication section in the Authentication Admin Console and:

  • Click on the neteye-idp-discovery-flow flow
    • Click on the Dots menu button and select Bind flow

    • Select Browser and click on Save

  • Click on the neteye-first-broker-login-flow flow
    • Click on the Dots menu button and select Bind flow

    • Select First Login Flow and click on Save

Configuring Identity Provider Redirector step

If you have only one Identity Provider (IdP), you can configure an automatic redirect to it, bypassing the login screen for users. This will allow users to be redirected directly to your custom IdP.

To enable this:

  • Go to the Authentication` section in the Authentication Admin Console.

  • Select neteye-idp-discovery-flow.

  • Enable the “Identity Provider Redirector” step by setting its requirement to Alternative.

  • Click the gear icon next to the step, choose an alias, and enter the alias of your IdP in the Default identity provider field.

Once this is configured, users will no longer see the login screen and will be automatically redirected to the specified IdP.

If you need to log in with a local user, visit: https://{YOUR-HOST}/local_auth

Note

This step is optional and not required for all configurations.