/ 
Auth-Kokolores-1.01
River stage zero No dependents
/ kokolores

NAME

kokolores - an alternative saslauthd

VERSION

version 1.01

DESCRIPTION

kokolores is an alternative saslauthd written in perl.

It is based on prefork server based on Net::Server and configurable thru a configuration file.

It features a plugin architecture and could be easily extended with custom plugins.

COMMANDLINE OPTIONS

Usage:

bin/kokolores [-h|--help] [-c|--config=<file>] [-f|--foreground] [-l|--loglevel=<level>]
-h --help

Show usage text.

-c --config=<file>

Specify an alternative configuration file path.

Default: /etc/kokolores/kokolores.conf

-f --foreground

Dont fork to background. Stay in foreground.

-l --loglevel=<level>

A value from 0-4:

0 errror
1 warning
2 notice
3 info
4 debug

CONFIGURATION FILE

Configuration options could be given in the format:

key = "value"

One per line.

GLOBAL CONFIGURATION OPTIONS

Global configuration options can just be listed in the global scope of the configuration file.

log_level (default: 2)
log_file (default: Sys::Syslog)
syslog_ident (default: kokolores)
syslog_facility (default: auth)
socket_path (default: /var/run/saslauthd/mux)
socket_mode (default: 0660)
pid_file (default: empty)
user (default: nobody)
group (default: mail)
min_servers (default: 4)
min_spare_servers (default: 4)
max_spare_servers (default: 12)
max_servers (default: 25)
max_requests (default: 1000)
satisfy (default: all)

All plugins are required to succeed.

Change to "any" to return a successfull authentication when the first plugin returns success.

PLUGIN CONFIGURATION

Plugins can be defined with a <Plugin> section:

<Plugin plugin-name>
  module = "ModuleName"
  option1 = "param"
  option2 = "param"
  # ...
</Plugin>

PLUGINS

kokolores comes with the following plugins:

SqlRetrieve

Search an retrieve an user from a SQL database.

All databases supported by perl-DBI should be supported.

CheckPassword

Check an password. Supports different hash methods to validate a password.

WRITING CUSTOM PLUGINS

If you know some perl it should be easy for your to write a custom plugin for kokolores.

Plugins have to be under the kokolores plugin namespace:

Auth::Kokolores::Plugin::<name>

For an example plugin read the source of:

Auth::Kokolores::Plugin::Example

AUTHOR

Markus Benning <ich@markusbenning.de>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Markus Benning <ich@markusbenning.de>.

This is free software, licensed under:

The GNU General Public License, Version 2, June 1991