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 2020-05-24 01:44:26 -04:00 committed by GitHub
parent 2528f3d928
commit 3b610982ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -134,32 +134,32 @@ the request using environment variables:
| Variable Name | Description | Example | | Variable Name | Description | Example |
| --- | --- | --- | | --- | --- | --- |
| GATEWAY_INTERFACE | The CGI version (for compatability). | ``GCI/1.1`` | | GATEWAY_INTERFACE | CGI version (for compatability). | ``GCI/1.1`` |
| SERVER_PROTOCOL | The server protocol. | ``GEMINI`` | | SERVER_PROTOCOL | The server protocol. | ``GEMINI`` |
| SERVER_SOFTWARE | The server version string. | ``jetforce/0.0.7`` | | SERVER_SOFTWARE | The server version string. | ``jetforce/0.0.7`` |
| GEMINI_URL | The raw URL string from the request. | ``gemini://mozz.us/cgi-bin/example.cgi/hello?world`` | GEMINI_URL | Raw URL string from the request. | ``gemini://mozz.us/cgi-bin/example.cgi/hello?world``
| SCRIPT_NAME | The part of the URL's path that corresponds to the CGI script location. | ``/cgi-bin/example.cgi`` | | SCRIPT_NAME | The part of the URL's path that corresponds to the CGI script location. | ``/cgi-bin/example.cgi`` |
| PATH_INFO | The remainder of the URL's path after the CGI script location. | ``/hello`` | | PATH_INFO | The remainder of the URL's path after the CGI script location. | ``/hello`` |
| QUERY_STRING | The query string portion of the request URL. | ``world`` | | QUERY_STRING | The query string portion of the request URL. | ``world`` |
| HOSTNAME | The server hostname. | ``mozz.us`` | | HOSTNAME | Server hostname. | ``mozz.us`` |
| SERVER_NAME | The server hostname (alias for HOSTNAME). | ``mozz.us`` | | SERVER_NAME | Server hostname (alias for HOSTNAME). | ``mozz.us`` |
| REMOTE_ADDR | The client IP address. | ``10.10.0.2`` | | REMOTE_ADDR | Client IP address. | ``10.10.0.2`` |
| REMOTE_HOST | The client IP address (alias for REMOTE_ADDR). | ``10.10.0.2`` | | REMOTE_HOST | Client IP address (alias for REMOTE_ADDR). | ``10.10.0.2`` |
| SERVER_PORT | The server port number. | ``1965`` | | SERVER_PORT | Server port number. | ``1965`` |
Additional CGI variables will also be included when the connection uses a TLS client certificate: Additional CGI variables will also be included when the connection uses a TLS client certificate:
| Variable Name | Description | Example | | Variable Name | Description | Example |
| --- | --- | --- | | --- | --- | --- |
| AUTH_TYPE | The authentication type (for compatability). | ``CERTIFICATE`` | | AUTH_TYPE | Authentication type (for compatability). | ``CERTIFICATE`` |
| REMOTE_USER | The subject CommonName attribute, if provided. | ``michael123`` | | REMOTE_USER | The subject CommonName attribute, if provided. | ``michael123`` |
| TLS_CLIENT_HASH | A base64-encoded certificate fingerprint | ``hjQftIC/4zPDQ1MNdav5nRQ39pM482xoTIgxtjyZOpY=`` | | TLS_CLIENT_HASH | A base64-encoded certificate fingerprint. | ``hjQftIC/4zPDQ1MNdav5nRQ39pM482xoTIgxtjyZOpY=`` |
| TLS_CLIENT_NOT_BEFORE | The certificate activation date | ``2020-04-05T04:18:22Z`` | | TLS_CLIENT_NOT_BEFORE | Certificate activation date. | ``2020-04-05T04:18:22Z`` |
| TLS_CLIENT_NOT_AFTER | The certificate expiration date | ``2021-04-05T04:18:22Z`` | | TLS_CLIENT_NOT_AFTER | Certificate expiration date. | ``2021-04-05T04:18:22Z`` |
| TLS_CLIENT_SERIAL_NUMBER | The certificate serial number | ``73629018972631`` | | TLS_CLIENT_SERIAL_NUMBER | Certificate serial number. | ``73629018972631`` |
| TLS_CLIENT_VERIFIED | Whether the certificate verified by local CA | ``0``/``1`` | | TLS_CLIENT_VERIFIED | Was the certificate verified by OpenSSL? | ``0``/``1`` |
| TLS_CIPHER | The TLS cipher that was used. | ``TLS_AES_256_GCM_SHA384``| | TLS_CIPHER | TLS cipher that was negotiated. | ``TLS_AES_256_GCM_SHA384``|
| TLS_VERSION | The TLS version that was used. | ``TLSv1.3`` | | TLS_VERSION | TLS version that was negotiated. | ``TLSv1.3`` |
The CGI script must then write the gemini response to the *stdout* stream. The CGI script must then write the gemini response to the *stdout* stream.
This includes the status code and meta string on the first line, and the This includes the status code and meta string on the first line, and the