Skip to content

Prometheus exporter to monitor SSL certificates public key fingerprint. Useful when your applications do SSL public key pinning.

License

Notifications You must be signed in to change notification settings

samuelb/ssl-pubkey-fingerprint-exporter

Repository files navigation

SSL public key fingerprint exporter

This Prometheus exporter allows you to monitor the public key fingerprints of your SSL certificates.

Table of Contents

Features

  • Monitor SSL certificate public key fingerprints
  • Support for both domain:port and full URL targets
  • Configurable timeout via environment variables
  • Docker support
  • Prometheus integration

Building

make

The created binaries will end up in the folder dist/.

Configuration

The exporter can be configured using environment variables:

Variable Description Default
LISTEN_ADDRESS Address to listen on :3000
DEFAULT_TIMEOUT Default timeout in seconds 10

Docker

docker pull basa/ssl-pubkey-fingerprint-exporter
docker run -p 3000:3000 basa/ssl-pubkey-fingerprint-exporter

Testing with curl

You can test the exporter using curl to make HTTP requests to the probe endpoint:

# Test with a domain and port
curl "http://localhost:3000/probe?target=example.com:443"

# Test with a custom listen address
LISTEN_ADDRESS=:8080 ./ssl-pubkey-fingerprint-exporter
curl "http://localhost:8080/probe?target=example.com:443"

Metrics

The response will be in Prometheus metrics format, showing the SSL certificate's public key fingerprint.

# HELP ssl_pubkey_fingerprint SSL certificate publickey SHA-256 fingerprint
# TYPE ssl_pubkey_fingerprint gauge
ssl_pubkey_fingerprint{fingerprint="base64encodedsha256sumofbinarypublickey=",target="example.com:443"} 1

Prometheus

Scrape configuration

scrape_configs:
  - job_name: "ssl-pubkey-fingerprint-exporter"
    metrics_path: /probe
    static_configs:
      - targets:
          - example.com:443
          - https://example.org
    relabel_configs:
      - source_labels: [__address__]
        target_label: __param_target
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: ssl-pubkey-fingerprint-exporter:3000

Example PromQL query

absent(ssl_pubkey_fingerprint{fingerprint="base64encodedsha256sumofbinarypublickey",target="example.com:443"})

Getting the SHA-256 fingerprint

Extract public key sha256 fingerprint from PEM-encoded certificate file

openssl x509 -pubkey -noout -in certificate.pem | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64

Extract public key sha256 fingerprint from keyfile

openssl rsa -in certificate.key -pubout | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64

Extract public key sha256 fingerprint from HTTP server

servername=example.com; echo Q | openssl s_client -connect $servername:443 -servername $servername | openssl x509 -pubkey -noout | openssl pkey -pubin -outform der | openssl dgst -sha256 -binary | openssl enc -base64

About

Prometheus exporter to monitor SSL certificates public key fingerprint. Useful when your applications do SSL public key pinning.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •