From 11a2cec003089292df23ba768b68d741a51d6d8f Mon Sep 17 00:00:00 2001 From: Shivaram Lingamneni Date: Thu, 4 Jun 2020 10:11:10 -0400 Subject: [PATCH] review fix --- docs/MANUAL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/MANUAL.md b/docs/MANUAL.md index 7eb8f7a4..ea58261e 100644 --- a/docs/MANUAL.md +++ b/docs/MANUAL.md @@ -849,14 +849,14 @@ Oragono can emulate certain capabilities of the ZNC bouncer for the benefit of c ## External authentication systems -Oragono can be configured to call arbitrary scripts to authenticate users; see the `auth-script` section of the config. The API for these scripts is as follows: Oragono will invoke the script with a configurable set of arguments, then send it the authentication data as JSON on the first line (`\n`-terminated) of stdin. The input is a JSON-encoded dictionary with the following keys: +Oragono can be configured to call arbitrary scripts to authenticate users; see the `auth-script` section of the config. The API for these scripts is as follows: Oragono will invoke the script with a configurable set of arguments, then send it the authentication data as JSON on the first line (`\n`-terminated) of stdin. The input is a JSON dictionary with the following keys: * `accountName`: during passphrase-based authentication, this is a string, otherwise omitted * `passphrase`: during passphrase-based authentication, this is a string, otherwise omitted * `certfp`: during certfp-based authentication, this is a string, otherwise omitted * `ip`: a string representation of the client's IP address -The script must print a single line (`\n`-terminated) to its output and exit. This line must be a JSON-encoded dictionary with the following keys: +The script must print a single line (`\n`-terminated) to its output and exit. This line must be a JSON dictionary with the following keys: * `success`, a boolean indicating whether the authentication was successful * `accountName`, a string containing the normalized account name (in the case of passphrase-based authentication, it is permissible to return the empty string or omit the value)