/usr/share/doc/libauthen-sasl-perl/api.txt is in libauthen-sasl-perl 2.1600-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | Client API
----------
Basically the Authen::SASL module gathers some info. When ->client_new
is called the plugin is called to create a $conn object. At that point
it should query the Authen::SASL object for mechanisms and callbacks
Properties are then set on the $conn object by calling $conn->property
Then client_start is called
Then we call client_step with a challenge string to get a response
string. need_step can be called to check that this step is actually
necessary for the selected mechanism.
Quite simple really I think.
So the plugin just needs to support
client_new
client_start
client_step
need_step # returns true if client_step needs to be called
property # set/get for properties
mechanism # returns the name of the chosen mechanism
service # the service name passed to client_new
host # the hostname passed to client_new
is_success # returns true if authentication suceeded
Server API
----------
The server API is symetric to the client's one. server_new is called to
create a connection object. Then server_start is called, and if relevant
the first data from the client is passed to it as argument.
Then we call server_step with all the response from the clients, which
returns challenges. need_step also determines if the current mechanism
requires another step.
So the plugin just needs to support
server_new
server_start
server_step
need_step # returns true if client_step needs to be called
property # set/get for properties
mechanism # returns the name of the chosen mechanism
service # the service name passed to client_new
host # the hostname passed to client_new
is_success # returns true if authentication suceeded
Callbacks
---------
properties and callbacks are passed by name, so you will need to convert
them to numbers.
There are three types of call back
user => 'fred'
When the user callback is called, it will just return the string 'fred'
user => \&subname
When the user callback is called, &subname will be called and it will
be passed the $conn object as the first argument.
user => [ \&subname, 1, 2, 3]
When the user callback is called, &subname will be called. It will be passed
the $conn object, followed by all other values in the array
|