waldek
/
jetforce
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Michael Lazar 2021-02-18 23:57:36 -05:00 committed by GitHub
parent 2765eabd9b
commit 194f84a042
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -191,9 +191,9 @@ additional modification by the server.
#### CGI Environment Variables #### 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_PROTOCOL | ``GEMINI`` |
| SERVER_SOFTWARE | ``jetforce/0.0.7`` | | SERVER_SOFTWARE | ``jetforce/0.0.7`` |
| GEMINI_URL | ``gemini://mozz.us/cgi-bin/example.cgi/extra?hello%20world`` | | 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: Additional CGI variables will be included only when the client connection uses a TLS client certificate:
<dl> | Name | Example Value |
| --- | --- |
<dt>AUTH_TYPE</dt> | AUTH_TYPE | ``CERTIFICATE`` |
<dd> | REMOTE_USER | ``mozz123`` (the certificate's CommonName) |
Authentication type (for compatibility with RFC 3785).<br> | TLS_CLIENT_HASH | ``SHA256:86341FB480BFE333C343530D75ABF99D1437F69338F36C684C8831B63C993A96`` |
<em>Example: "CERTIFICATE"</em> | TLS_CLIENT_NOT_BEFORE | ``2020-04-05T04:18:22Z`` |
</dd> | TLS_CLIENT_NOT_AFTER | ``2021-04-05T04:18:22Z`` |
| TLS_CLIENT_SERIAL_NUMBER | ``73629018972631`` |
| TLS_CLIENT_AUTHORISED | ``0`` (not authorised) / ``1`` (authorised) † |
<dt>REMOTE_USER</dt> † Requires the server to be configured with a CA for validating client certificates.
<dd>
The certificate's subject CommonName attribute, if provided.<br>
<em>Example: "mozz123"</em>
</dd>
<dt>TLS_CLIENT_HASH</dt>
<dd>
A SHA fingerprint that can be used to uniquely identify the certificate.<br>
<em>Example: "SHA256:86341FB480BFE333C343530D75ABF99D1437F69338F36C684C8831B63C993A96"</em>
</dd>
<dt>TLS_CLIENT_NOT_BEFORE</dt>
<dd>
The certificate's activation date.<br>
<em>Example: "2020-04-05T04:18:22Z"</em>
</dd>
<dt>TLS_CLIENT_NOT_AFTER</dt>
<dd>
The certificate's activation date.<br>
<em>Example: "2021-04-05T04:18:22Z"</em>
</dd>
<dt>TLS_CLIENT_SERIAL_NUMBER</dt>
<dd>
The certificate's serial number.<br>
<em>Example: "73629018972631"</em>
</dd>
<dt>TLS_CLIENT_AUTHORISED</dt>
<dd>
Was the certificate deemed trusted by the server's CA certificate store.<br>
<em>0 (not authorised) / 1 (authorised)</em>
</dd>
</dl>
## Deployment ## Deployment