Chainguard Container for auditbeat

Auditbeat is a lightweight shipper that you can install on your servers to audit the activities of users and processes on your systems.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/auditbeat:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image is comparable to the elastic/auditbeat image available from Docker Hub. Switching to the Chainguard image should not require any changes to your existing setup.

Getting Started

Docker

These Docker instructions assume you have a running instance of Elasticsearch and Kibana with which auditbeat can interact.

You can run the following command to test Chainguard's auditbeat image:

docker run \
    --cap-add="AUDIT_CONTROL" \
    --cap-add="AUDIT_READ" \
    --rm \
    cgr.dev/ORGANIZATION/auditbeat:latest setup -E "setup.kibana.host=<your_kibana_host>:5601" -E output.elasticsearch.hosts=["<your_elastic_host>:9200"]

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard registry.

Kubernetes

Applying the manifests from the following documentation assumes an existing Elasticsearch deployment on your cluster.

You can follow the official documentation for running Auditbeat on Kubernetes to run Auditbeat. Once you've downloaded the manifest from Elastic, you can modify it as needed.

Start by modifying the Daemonset resource in the downloaded manifest named auditbeat-kubernetes.yaml:

apiVersion: apps/v1
kind: DaemonSet
spec:
  template:
    spec:
      containers:
        - name: auditbeat
          image: cgr.dev/ORGANIZATION/auditbeat:latest

Then use the following command to deploy Auditbeat to Kubernetes:

kubectl create -f auditbeat-kubernetes.yaml

serviceaccount/auditbeat created
clusterrole.rbac.authorization.k8s.io/auditbeat created
role.rbac.authorization.k8s.io/auditbeat created
role.rbac.authorization.k8s.io/auditbeat-kubeadm-config created
clusterrolebinding.rbac.authorization.k8s.io/auditbeat created
rolebinding.rbac.authorization.k8s.io/auditbeat created
rolebinding.rbac.authorization.k8s.io/auditbeat-kubeadm-config created
configmap/auditbeat-config created
configmap/auditbeat-daemonset-modules created
daemonset.apps/auditbeat created

Helm

You can use the official Elastic Stack Helm chart in conjunction with an Elastic Operator and replace the image in values.yaml with the Chainguard image to install Auditbeat.

Use the following values.yaml file to configure the Helm chart:

eck-beats:
  config:
    # The below is a common example, full auditbeat config options can be found here:
    # https://www.elastic.co/guide/en/beats/auditbeat/current/configuring-howto-auditbeat.html
    auditbeat.modules:
    - module: file_integrity
      paths:
      - /hostfs/bin
      - /hostfs/usr/bin
      - /hostfs/sbin
      - /hostfs/usr/sbin
      - /hostfs/etc
      exclude_files:
      - '(?i)\.sw[nop]$'
      - '~$'
      - '/\.git($|/)'
      scan_at_start: true
      scan_rate_per_sec: 50 MiB
      max_file_size: 100 MiB
      hash_types: [sha1]
      recursive: true
    - module: auditd
      audit_rules: |
        # Executions
        -a always,exit -F arch=b64 -S execve,execveat -k exec

        # Unauthorized access attempts (amd64 only)
        -a always,exit -F arch=b64 -S open,creat,truncate,ftruncate,openat,open_by_handle_at -F exit=-EACCES -k access
        -a always,exit -F arch=b64 -S open,creat,truncate,ftruncate,openat,open_by_handle_at -F exit=-EPERM -k access

    processors:
    - add_cloud_metadata: {}
    - add_host_metadata: {}
    - add_process_metadata:
        match_pids: ['process.pid']
  daemonSet:
    podTemplate:
      spec:
        containers:
          - name: auditbeat
            image: cgr.dev/ORGANIZATION/auditbeat:latest
  enabled: true
  type: auditbeat

Install the Elastic Operator if it's not already running:

helm repo add elastic https://helm.elastic.co

"elastic" has been added to your repositories

Update the chart repositories:

helm repo update

...Successfully got an update from the "elastic" chart repository
Update Complete. ⎈Happy Helming!⎈

Install the elastic-operator Helm chart:

helm install elastic-operator elastic/eck-operator -n elastic-system --create-namespace

NAME: elastic-operator
LAST DEPLOYED: <DATE>
NAMESPACE: elastic-system
STATUS: deployed
REVISION: 1
TEST SUITE: None

Install the eck-stack chart with your custom values.yaml file:

helm install eck-stack elastic/eck-stack -n elastic-stack --create-namespace --values values.yaml

NAME: eck-stack
LAST DEPLOYED: <DATE>
NAMESPACE: elastic-stack
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Elasticsearch ECK-Stack <VERSION> has been deployed successfully!

Documentation and Resources

• Official auditbeat (Elastic beats subpackage) repository.
• Auditbeat installation and configuration quick start

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.