The username and password are passed to the program line by line via STDIN. An authentication module can therefore be tested as follows.

echo -e "${USERNAME}\n${PASSWORD}" | /usr/sbin/benno_auth.d

In the event of successful authentication, the module returns several lines containing the user's metadata from STDOUT.

ARCHIVE BennoContainer ROLE USER DISPLAYNAME Sabine Petersen MAIL info@hansen-und-meyer.de MAIL s.petersen@hansen-und-meyer.de MAIL sabine.petersen@hansen-und-meyer.de USERID s.petersen AUTH OK

If an error occurs, a line beginning with ERROR is returned (e.g., "ERROR ERR_AUTH")

After the ERROR, a symbolic error message is returned, separated by spaces. The associated error messages are stored in the file /etc/benno/benno-errors.txt and are displayed in the message box of the login screen.

Nach dem Schlüsselwort ARCHIVE wird die Bezeichnung des Containers (in der Regel der <simplecontainer />) zurückgegeben, auf den in dieser Session User zugegriffen werden soll. Dieser Wert bezieht sich auf den jeweiligen Inhalte des <identifier>…</identifier> Tags in der Konfigurationsdatei benno.xml.

This value indicates whether the user is a regular user (USER), administrator (ADMIN), or auditor (REVISOR). In practical operation, this value currently has no effect. The included authentication module sets the value of MAIL to for users who are set to ADMIN or REVISOR in the database *@*.

The user's name for display in the web UI.

This value sets the filter for emails to be displayed. It should contain all email addresses that the user is allowed to read.

Each MAIL line contains an email address whose emails the user can read. This value can be executed as a Lucene filter string, allowing for wildcards.

Optionaler Rückgabewert wie zum Beispiel <username>@<mandantenbezeichnung>. Falls dieser Wert gesetzt ist, werden die temporären Daten des Bentzers mit dieser ID in der internen Datenbank zwischengespeichert.

The value of USERID must system-wide .

This line indicates that authentication was successful.

Falls ein Authentisierungsmodul den String AUTH BREAK zurück gibt, wird der Authentisierungsvorgang sofort mit einem Authentisierungsfehler abgebrochen. Hiermit kann ein Modul z.B. einen Benutzer „aussperren“, wenn dieser z.B. nicht aus dem LDAP gelöscht werden kann.

This allows the authentication module to return arbitrary parameters to the web application.

Beispiel: AUTHPARAM AUTHBY db signalisiert, daß die Authentisierung gegen die interne Datenbank von Benno MailArchiv erfolgt ist.

Dem Schlüsselwort FILTER folgt durch ein Leerzeichen getrennt der Name mit dem dieser Filter im Web-Interface angezeigt wird. Der FilterName darf kein Leerzeichen enthalten. Ihm folgt durch ein Leerzeichen getrennt ein Lucene Filterstring.

Falls der Benutzername nach Ausscheiden eines Mitarbeiters neu vergeben wird, soll der neue Benutzer nicht auf die E-Mails des alten Benutzers zugreifen können. Dieses wird mit Hilfe eines Filtestrings realisiert. Das LDAP-Authentisierungsmodul gibt einen Filter zurück, wenn der Parameter filter_before_created = true konfiguriert wird.

FILTER StartDate:20190701 NOT SortableDate:[197001010000 TO 201907010000]

This FILTER parameter blocks access to emails prior to July 1, 2019. The filter is listed in the web interface as StartDate: 20190701 .

Der <Warnungstext> wird im Logfile des Webservers ausgegeben.

Infotext für das Debugging per Kommandozeile per benno-useradmin -t -u .

This is not required by the system and serves as an indication that, for example, a module has not been configured.

Diese Werte überschreiben die in der Konfigurationsdatei /etc/benno-web/rest.conf voreingestellten Werte.

The URL of the REST backend that the user should access in the session. For example, http://localhost:21080.

Username for authentication on the REST interface.

Password for authentication on the REST interface.