Navigation :

Single

This module is a convenient “single-access” controller. It is very limited in that it allows for a single username only, but it does provide strong security checking:

Remote (client) IP address match, and/or
Client must supply username and password, and/or
HTTPS protocol is required.

An example configuration is:

<jarvis>
    <app>
        <login module="Jarvis::Login::Single">
            <parameter name="require_https" value="no"/>
            <parameter name="remote_ip"     value="127.0.0.1"/>
            <parameter name="username"      value="bob"/>
            <parameter name="password"      value="test"/>
            <parameter name="group_list"    value="default"/>
        </login>
        ...

The parameters are:

Attribute	Default	Notes
`username`	(none)	User name to assign to anybody who successfully logs in using this module.
`group_list`	(none)	Comma-separated group list to assign to all logins using this module. If not specified, a single group identical to the username will be assigned.
`password`	(none)	If configured then the client must supply both `username` and `password` as CGI parameters when logging in to obtain a session cookie, and both supplied values must match the configured values. If not-configured (or configured empty) then any `username` and `password` supplied by the client will be ignored. The configured `username` parameter will be used as the username.
`remote_ip`	(none)	If configured then the client’s remote IP address must exactly match one of the addresses. This may be a single address or a comma-separated list.
`require_https`	`no`	If configured `yes`, then the client connection must be HTTPS.
`oauth_permissions`	(none)	A comma-separated list of OAuth2 permissions to give the user.

Note: At least one of remote_ip or password must be configured.