File

mod_auth_ccert/README.markdown @ 5691:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parent 4433:0e3f5f70a51d
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
- 'Type-Auth'
summary: Client Certificate authentication module
...

Introduction
============

This module implements PKI-style client certificate authentication. You
will therefore need your own Certificate Authority. How to set that up
is beyond the current scope of this document.

Configuration
=============


    authentication = "ccert"
    certificate_match = "xmppaddr" -- or "email"

    c2s_ssl = {
        cafile = "/path/to/your/ca.pem";
        capath = false; -- Disable capath inherited from built-in default
        verify = {"peer"; "client_once"}; -- Ask for client certificate
        verifyext = {
            -- Don't validate client certs as if they were server certs
            lsec_ignore_purpose = false
        }
    }


Compatibility
=============

  ----------------- --------------
  trunk             Works
  0.10 and later    Works
  0.9 and earlier   Doesn't work
  ----------------- --------------