← Browse the extensions catalog

credcheck

Source README ↗

credcheck

PostgreSQL username/password checks. Upstream documentation.

Follow the quick start to set up extension-update email alerts first, then use the CronJob to install and refresh the catalog. These examples inherit image references and runtime settings from the catalog. The Cluster YAML is an excerpt: replace imageCatalogRef: ... with your catalog reference and keep your existing instance and storage settings.

Supported images

PostgreSQL 18; Debian Trixie and Bookworm; amd64 and arm64 build targets.

PostgreSQL compatibility

credcheck 6.0 images using PGDG package revision +2 require PostgreSQL 18.7 or later within major version 18. Upgrade PostgreSQL first: on 18.6, credcheck prevents startup with undefined symbol: heap_datum_check. CNPG does not enforce extension minimum minor versions.

Usage

1. Add the credcheck extension image to your Cluster

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: cluster-credcheck
spec:
  imageCatalogRef: ...
  postgresql:
    parameters:
      credcheck.encrypted_password_allowed: 'on'
    shared_preload_libraries:
    - credcheck
    extensions:
    - name: credcheck

2. Enable the extension in a database

Once the extension's files are available in the cluster, you can install it in a database in either of two ways:

Platform teams may make extension containers available across their clusters without installing every extension in every database. Install only the extensions a database uses; letting users enable them through SQL alongside the rest of their DDL schema management code can be a convenient approach.

For extensions that normally require superuser privileges, platform teams can use pgextwlist to allow non-superusers to install an administrator-approved selection of extensions.

3. Verify installation

Connect to the database with psql and run \dx to check the installed extensions.

Operation and privileges

CNPG reconciles role credentials using precomputed SCRAM verifiers. Set credcheck.encrypted_password_allowed: "on" so those updates succeed. Plaintext password policy cannot inspect precomputed verifiers; enforce equivalent policy where Kubernetes password Secrets are generated. SQL role changes using plaintext passwords remain checked.

Credential checks apply to role creation and password changes. Configure policy settings in postgresql.parameters; only administrators should change them.

Dependencies and updates

The image contains only the PGDG package server payload and license notices. The matching CNPG minimal image supplies PostgreSQL, libc and its base runtime. Project automation tracks package updates and rebuilds the extension images. Use the catalog maintenance schedule in the quick start to consume published PostgreSQL and extension image updates. Monitor pending SQL extension upgrades and review them separately; SQL versions need not match package versions.

Licenses and ownership

MIT. Redistribution notices are preserved under /licenses/.