Skip to content

[AI-5112] DDS: Delinea Secret Server v1.0.0 #19857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,8 @@ integration/dcgm:
- dcgm/**/*
integration/delinea_privilege_manager:
- delinea_privilege_manager/**/*
integration/delinea_secret_server:
- delinea_secret_server/**/*
integration/directory:
- directory/**/*
integration/disk:
Expand Down
3 changes: 3 additions & 0 deletions delinea_secret_server/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CHANGELOG - delinea_secret_server

<!-- towncrier release notes start -->
144 changes: 144 additions & 0 deletions delinea_secret_server/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
## Overview

[Delinea Secret Server][4] is an enterprise-grade password management solution designed to help organizations securely store, manage, and control access to privileged credentials. It aims to improve the security of sensitive data, reduce the risk of data breaches, and streamline the password management process.

This integration enriches and ingests the following logs:

- **Secret Server Logs**: Represents an event where a user performs an action (such as viewing, adding, or modifying) on a stored secret, folder, group, or user. It provides details including the user's identity, the source of the action, and the item the action was performed.

After it collects the logs, Delinea Secret Server channels them into Datadog for analysis. Using the built-in logs pipeline, these logs are parsed and enriched, allowing for effortless search and analysis. The integration provides insights into secret server logs through out-of-the-box dashboards and includes ready-to-use Cloud SIEM detection rules for improved monitoring and security.

## Setup

### Installation

To install the Delinea Secret Server integration, run the following Agent installation command and the following steps. For more information, see the [Integration Management][5] documentation.

**Note**: This step is not necessary for Agent version >= 7.65.0.

Linux command:

```shell
sudo -u dd-agent -- datadog-agent integration install datadog-delinea-secret-server==1.0.0
```

### Configuration

#### Log collection

1. Collecting logs is disabled by default in the Datadog Agent. Enable it in the `datadog.yaml` file:

```yaml
logs_enabled: true
```

2. Add this configuration block to your `delinea_secret_server.d/conf.yaml` file to start collecting your Delinea Secret Server logs.

```yaml
logs:
- type: tcp/udp
port: <PORT>
source: delinea-secret-server
service: delinea-secret-server
```

For available configuration options, see the [sample delinea_secret_server.d/conf.yaml][7]. Choose the appropriate protocol (either TCP or UDP) based on your Delinea Secret Server syslog forwarding configuration.

**Note**: Do not change the service and source values, as these parameters are integral to the pipeline's operation.

3. [Restart the Agent][1].

#### Configure syslog message forwarding from Delinea Secret Server

1. Log in to the **Delinea Secret Server** platform.
2. Navigate to **Settings** > **All Settings**.
3. Navigate to **Configuration** > **General** > **Application**.
4. Click **Edit**.
5. Check **Enable Syslog/CEF Log Output**.
6. Fill out the following information:

- **Syslog/CEF Server**: Enter Syslog/CEF Server Address.
- **Syslog/CEF Port**: Enter Syslog/CEF Server Port.
- **Syslog/CEF Protocol**: Select TCP or UDP.
- **Syslog/CEF Time Zone**: Select UTC Time.
- **Syslog/CEF DateTime Format**: Select ISO 8601.
- **Syslog/CEF Site**: Select the site that the CEF/Syslogs will run on.

7. Click **Save**.

### Validation

[Run the Agent's status subcommand][2] and look for `delinea_secret_server` under the Checks section.

## Data Collected

### Logs

The Delinea Secret Server integration collects Secret Server Logs.

### Metrics

The Delinea Secret Server integration does not include any metrics.

### Events

The Delinea Secret Server integration does not include any events.

### Service Checks

The Delinea Secret Server integration does not include any service checks.

## Troubleshooting

### Permission denied while port binding

If you see a **Permission denied** error while port binding in the Agent logs, see the following instructions:

1. Binding to a port number under 1024 requires elevated permissions. Grant access to the port using the `setcap` command:

- Grant access to the port using the `setcap` command:

```shell
sudo setcap CAP_NET_BIND_SERVICE=+ep /opt/datadog-agent/bin/agent/agent
```

- Verify the setup is correct by running the `getcap` command:

```shell
sudo getcap /opt/datadog-agent/bin/agent/agent
```

With the expected output:

```shell
/opt/datadog-agent/bin/agent/agent = cap_net_bind_service+ep
```

**Note**: Re-run this `setcap` command every time you upgrade the Agent.

2. [Restart the Agent][1].

### Data is not being collected

Make sure that traffic is bypassed from the configured port if the firewall is enabled.

### Port already in use

If you see the **Port <PORT-NO\> Already in Use** error, see the following instructions. The example below is for PORT-NO = 514:

On systems using Syslog, if the Agent listens for Delinea Secret Server logs on port 514, the following error can appear in the Agent logs: `Can't start UDP forwarder on port 514: listen udp :514: bind: address already in use`.

By default, Syslog listens on port 514. To resolve this error, take **one** of the following steps:

- Disable Syslog.
- Configure the Agent to listen on a different, available port.

Need help? Contact [Datadog support][3].

[1]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent
[2]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information
[3]: https://docs.datadoghq.com/help/
[4]: https://delinea.com/products/secret-server
[5]: https://docs.datadoghq.com/agent/guide/integration-management/?tab=linux#install
[6]: https://docs.delinea.com/online-help/secret-server/start.htm
[7]: https://github.com/DataDog/integrations-core/blob/master/delinea_secret_server/datadog_checks/delinea_secret_server/data/conf.yaml.example
10 changes: 10 additions & 0 deletions delinea_secret_server/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Delinea Secret Server
files:
- name: delinea_secret_server.yaml
options:
- template: logs
example:
- type: tcp/udp
port: <PORT>
source: delinea-secret-server
service: delinea-secret-server
Loading
Loading