diff mod_auth_ccert/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_auth_ccert/README.wiki@29f3d6b7ad16
children 153f063c3d1a
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_ccert/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,36 @@
+---
+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 = {
+        capath = "/path/to/dir/with/your/ca"
+    }
+
+`capath` should be pointed to a directory with your own CA certificate.
+You will need to run `c_rehash` in it.
+
+Compatibility
+=============
+
+  ----------------- --------------
+  trunk             Works
+  0.9 and earlier   Doesn't work
+  0.10 and later    Works
+  ----------------- --------------