Diff

mod_auth_ccert/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 4433:0e3f5f70a51d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_ccert/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,40 @@
+---
+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
+  ----------------- --------------