doodlescheduling / saml-exporter

SAML Metadata exporter for prometheus

Prometheus SAML Metadata exporter

SAML Metadata exporter for Prometheus.

Features

• Tests if the SAML endpoint is reachable and exposes related http metrics
• Exposes metrics related to all encryption and signing x509 certificates
• Supports multiple SAML endpoints

Installation

Get the exporter either as a binaray from the latest release or packaged as a Docker image.

Helm Chart

For kubernetes users there is an official helm chart. Please read the installation instructions here.

helm template saml-exporter oci://ghcr.io/doodlescheduling/charts/saml-exporter --set samlMetadataURLSlice='{http://idp/metadata}'

Docker

You can run the exporter using docker:

docker run ghcr.io/doodlescheduling/saml-exporter:latest http://idp/metadata

Usage

saml-exporter

Use the -help flag to get help information.

Access metrics

The metrics are by default exposed at /metrics.

curl localhost:9412/metrics

Exporter configuration

The exporter can be configured by either command line flags (saml-exporter -h) or by defining env variables.

Env variable	Description	Default
URL	Comma separated list of http URL to SAML metadata	``
LOG_LEVEL	Log level	info
LOG_ENCODING	Log format	json
BIND	Bind address for the HTTP server	:9412
METRICS_PATH	Metrics endpoint	/metrics
HEALTH_PATH	Health probe endpoint	/health
USER_AGENT	HTTP request User agent	saml-exporter (go-http-client)

Exposed metrics

Name	Description	Type	Labels
saml_exporter_build_info	Build info SAML exporter	Gauge	"branch", "goversion", "revision", "revision"
http_client_requests_total	HTTP client request	Counter	"host", "code", "method"
saml_metadata_errors_total	Errors encountered while parsing SAML metadata	Counter	"url"
saml_x509_read_errors_total	Errors encountered while parsing SAML X509 certificates	Counter	"entityid", "use"
saml_x509_cert_not_valid_after	SAML X509 certificate expiration date	Gauge	"entityid", "use", "serial_number", "issuer_C", "issuer_CN", "issuer_L", "issuer_O", "issuer_ST", "subject_C", "subject_CN", "subject_L", "subject_O"
saml_x509_cert_not_valid_before	SAML X509 certificate not valid before	Gauge	"entityid", "use", "serial_number", "issuer_C", "issuer_CN", "issuer_L", "issuer_O", "issuer_ST", "subject_C", "subject_CN", "subject_L", "subject_O"

Grafana dashboard

This exporter comes with a read to use grafana dashboard, see ./grafana/dashboard.json Note: The helm chart as well as the kustomize base will deploy the grafana dashboard as a ConfigMap.

saml-exporter's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

• WARN: Unable to read vulnerability information
• WARN: Package lookup failures

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update gcr.io/distroless/static:nonroot docker digest to 112a87f
• chore(deps-dev): update actions/cache action to v3.3.3
• chore(deps): update module github.com/go-logr/logr to v1.4.1
• chore(deps): update module github.com/prometheus/client_golang to v1.18.0
• chore(deps): update module github.com/prometheus/common to v0.46.0
• chore(deps): update module github.com/testcontainers/testcontainers-go to v0.27.0
• chore(deps): update module github.com/sethvargo/go-envconfig to v1
• chore(deps-dev): update actions/cache action to v4
• chore(deps-dev): update actions/dependency-review-action action to v4
• chore(deps-dev): update actions/download-artifact action to v4
• chore(deps-dev): update actions/setup-go action to v5
• chore(deps-dev): update actions/setup-python action to v5
• chore(deps-dev): update actions/stale action to v9
• chore(deps-dev): update actions/upload-artifact action to v4
• chore(deps-dev): update github/codeql-action action to v3
• 🔐 Create all rate-limited PRs at once 🔐

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

• chore(deps-dev): update step-security/harden-runner action to v2.7.0

---

Warning

Renovate failed to look up the following dependencies: Failed to look up docker package doodlescheduling/saml-exporter.

Files affected: config/base/kustomization.yaml

---

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps-dev): update github/codeql-action digest to 2db0327
• chore(deps-dev): update actions/dependency-review-action action to v3.1.5
• chore(deps-dev): update anchore/sbom-action action to v0.15.6
• chore(deps): update module github.com/go-logr/zapr to v1.3.0
• chore(deps-dev): update actions/setup-python action to v4.8.0
• chore(deps-dev): update aquasecurity/trivy-action action to v0.16.1
• chore(deps-dev): update github/codeql-action action to v2.23.2
• chore(deps-dev): update sigstore/cosign-installer action to v3.3.0
• chore(deps-dev): update fossa-contrib/fossa-action action to v3
• chore(deps-dev): update zgosalvez/github-actions-ensure-sha-pinned-actions action to v3
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

dockerfile

Dockerfile

• gcr.io/distroless/static nonroot@sha256:91ca4720011393f4d4cab3a01fa5814ee2714b7d40e6c74f2505f74168398ca9

github-actions

.github/workflows/main.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v4.1.0@93397bea11091df50f3d7e59dc26a7711a8bcfbe
• actions/cache v3.3.2@704facf57e6136b1bc63b828d79edcd491f0ee84
• shogo82148/actions-goveralls v1.8.0@7b1bd2871942af030d707d6574e5f684f9891fb2

.github/workflows/pr-actions.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4.1.1@b4ffde65f46336ab88eb53be808477a3936bae11
• zgosalvez/github-actions-ensure-sha-pinned-actions v2.1.6@99589360fda82ecfac331cc6bfc9d7d74487359c

.github/workflows/pr-build.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• azure/setup-helm v3.5@5119fcb9089d432beecbf79bb2c7915207344b78
• actions/setup-python v4.7.1@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236
• helm/chart-testing-action v2.6.1@e6669bcd63d7cb57cb4380c33043eebe5d111992
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v4.1.0@93397bea11091df50f3d7e59dc26a7711a8bcfbe
• actions/cache v3.3.2@704facf57e6136b1bc63b828d79edcd491f0ee84
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v4.1.0@93397bea11091df50f3d7e59dc26a7711a8bcfbe
• actions/cache v3.3.2@704facf57e6136b1bc63b828d79edcd491f0ee84
• shogo82148/actions-goveralls v1.8.0@7b1bd2871942af030d707d6574e5f684f9891fb2
• actions/upload-artifact v3.1.3@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• azure/setup-helm v3.5@5119fcb9089d432beecbf79bb2c7915207344b78
• actions/setup-python v4.7.1@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236
• helm/chart-testing-action v2.6.1@e6669bcd63d7cb57cb4380c33043eebe5d111992
• helm/kind-action v1.8.0@dda0770415bac9fc20092cacbc54aa298604d140
• actions/download-artifact v3.0.2@9bc31d5ccc31df68ecc42ccf4149144866c47d8a
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/download-artifact v3.0.2@9bc31d5ccc31df68ecc42ccf4149144866c47d8a
• engineerd/setup-kind v0.5.0@aa272fe2a7309878ffc2a81c56cfe3ef108ae7d0
• imranismail/setup-kustomize v2.0.0@6691bdeb1b0a3286fb7f70fd1423c10e81e5375f

.github/workflows/pr-dependency-review.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4.1.1@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/dependency-review-action v3.1.3@7bbfa034e752445ea40215fff1c3bf9597993d3f

.github/workflows/pr-label.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• pascalgn/size-label-action b1f4946f381d38d3b5960f76b514afdfef39b609

.github/workflows/pr-nancy.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v4.1.0@93397bea11091df50f3d7e59dc26a7711a8bcfbe
• actions/cache v3.3.2@704facf57e6136b1bc63b828d79edcd491f0ee84
• sonatype-nexus-community/nancy-github-action v1.0.3@726e338312e68ecdd4b4195765f174d3b3ce1533

.github/workflows/pr-stale.yaml

• actions/stale v8.0.0@1160a2240286f5da8ec72b1c0816ce2481aabf84

.github/workflows/pr-trivy.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• aquasecurity/trivy-action 0.12.0@fbd16365eb88e12433951383f5e99bd901fc618f

.github/workflows/rebase.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• cirrus-actions/rebase 1.8@b87d48154a87a85666003575337e27b8cd65f691

.github/workflows/release.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/setup-go v4.1.0@93397bea11091df50f3d7e59dc26a7711a8bcfbe
• docker/login-action v3.0.0@343f7c4344506bcbf9b4de18042ae17996df046d
• sigstore/cosign-installer v3.1.2@11086d25041f77fe8fe7b9ea4e48e3b9192b8f19
• anchore/sbom-action v0.15.0@fd74a6fb98a204a1ad35bbfae0122c1a302ff88b
• goreleaser/goreleaser-action v5.0.0@7ec5c2b0c6cdda6e8bbb49444bc797dd33d74dd8
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• azure/setup-helm v3.5@5119fcb9089d432beecbf79bb2c7915207344b78
• sigstore/cosign-installer v3.1.2@11086d25041f77fe8fe7b9ea4e48e3b9192b8f19

.github/workflows/report-on-vulnerabilities.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• aquasecurity/trivy-action 0.12.0@fbd16365eb88e12433951383f5e99bd901fc618f
• actions/upload-artifact v3.1.3@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4.1.1@b4ffde65f46336ab88eb53be808477a3936bae11
• actions/download-artifact v3.0.2@9bc31d5ccc31df68ecc42ccf4149144866c47d8a
• JasonEtco/create-an-issue v2.9.1@e27dddc79c92bc6e4562f268fffa5ed752639abd

.github/workflows/scan.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• fossa-contrib/fossa-action v2.0.0@6728dc6fe9a068c648d080c33829ffbe56565023
• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• github/codeql-action 9f150ba795bcdde5bcd148bb808cc028dc662bd8
• github/codeql-action 9f150ba795bcdde5bcd148bb808cc028dc662bd8
• github/codeql-action 9f150ba795bcdde5bcd148bb808cc028dc662bd8

.github/workflows/scorecard.yaml

• step-security/harden-runner v2.6.1@eb238b55efaa70779f274895e782ed17c84f2895
• actions/checkout v4.1.1@b4ffde65f46336ab88eb53be808477a3936bae11
• ossf/scorecard-action v2.3.1@0864cf19026789058feabb7e87baa5f140aac736
• actions/upload-artifact v3.1.3@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
• github/codeql-action v2.22.7@66b90a5db151a8042fa97405c6cf843bbe433f7b

gomod

go.mod

• go 1.20
• github.com/crewjam/saml v0.4.14
• github.com/go-logr/logr v1.3.0
• github.com/go-logr/zapr v1.2.4
• github.com/prometheus/client_golang v1.17.0
• github.com/prometheus/client_model v0.5.0
• github.com/prometheus/common v0.45.0
• github.com/sethvargo/go-envconfig v0.9.0
• github.com/spf13/pflag v1.0.5
• github.com/testcontainers/testcontainers-go v0.26.0
• github.com/tj/assert v0.0.3
• go.uber.org/zap v1.26.0

helm-values

chart/saml-exporter/values.yaml

• quay.io/brancz/kube-rbac-proxy v0.15.0

kustomize

config/base/kustomization.yaml

• doodlescheduling/saml-exporter 0.0.1

---

• Check this box to trigger a request for Renovate to run again on this repository