From 194f84a0426769cdb32a489490b0cb812a783b7f Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 18 Feb 2021 23:57:36 -0500 Subject: [PATCH] Update README.md --- README.md | 58 ++++++++++++------------------------------------------- 1 file changed, 12 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 6c15d4b..6ac98a8 100644 --- a/README.md +++ b/README.md @@ -191,9 +191,9 @@ additional modification by the server. #### CGI Environment Variables -| Name | Example | +| Name | Example Value | | --- | --- | -| GATEWAY_INTERFACE | ``CGI/1.1`` | +| GATEWAY_INTERFACE | ``CGI/1.1`` (for compatibility with RFC 3875) | | SERVER_PROTOCOL | ``GEMINI`` | | SERVER_SOFTWARE | ``jetforce/0.0.7`` | | GEMINI_URL | ``gemini://mozz.us/cgi-bin/example.cgi/extra?hello%20world`` | @@ -212,51 +212,17 @@ additional modification by the server. Additional CGI variables will be included only when the client connection uses a TLS client certificate: -
- -
AUTH_TYPE
-
- Authentication type (for compatibility with RFC 3785).
- Example: "CERTIFICATE" -
+| Name | Example Value | +| --- | --- | +| AUTH_TYPE | ``CERTIFICATE`` | +| REMOTE_USER | ``mozz123`` (the certificate's CommonName) | +| TLS_CLIENT_HASH | ``SHA256:86341FB480BFE333C343530D75ABF99D1437F69338F36C684C8831B63C993A96`` | +| TLS_CLIENT_NOT_BEFORE | ``2020-04-05T04:18:22Z`` | +| TLS_CLIENT_NOT_AFTER | ``2021-04-05T04:18:22Z`` | +| TLS_CLIENT_SERIAL_NUMBER | ``73629018972631`` | +| TLS_CLIENT_AUTHORISED | ``0`` (not authorised) / ``1`` (authorised) † | -
REMOTE_USER
-
- The certificate's subject CommonName attribute, if provided.
- Example: "mozz123" -
- -
TLS_CLIENT_HASH
-
- A SHA fingerprint that can be used to uniquely identify the certificate.
- Example: "SHA256:86341FB480BFE333C343530D75ABF99D1437F69338F36C684C8831B63C993A96" -
- -
TLS_CLIENT_NOT_BEFORE
-
- The certificate's activation date.
- Example: "2020-04-05T04:18:22Z" -
- -
TLS_CLIENT_NOT_AFTER
-
- The certificate's activation date.
- Example: "2021-04-05T04:18:22Z" -
- -
TLS_CLIENT_SERIAL_NUMBER
-
- The certificate's serial number.
- Example: "73629018972631" -
- -
TLS_CLIENT_AUTHORISED
-
- Was the certificate deemed trusted by the server's CA certificate store.
- 0 (not authorised) / 1 (authorised) -
- -
+† Requires the server to be configured with a CA for validating client certificates. ## Deployment