Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Authen::CyrusSASL(3)  User Contributed Perl Documentation Authen::CyrusSASL(3)

NAME
       Authen::CyrusSASL - simple Sasl Authen Daemon client facilities

SYNOPSIS
	 use Authen::CyrusSASL;

	 $p = new Authen::CyrusSASL(Type => SASL_AUTHD,	Dir => '/var/run/saslauthd');
	 print "check=", $r->check_pwd('username', 'userpass', 'service', 'realm'), "\n";

	 $p = new Authen::CyrusSASL(Type => SASL_PWCHECK, Dir => '/var/run/pwcheck');
	 print "check=", $r->check_pwd('username', 'userpass', 'service', 'realm'), "\n";

DESCRIPTION
       The "Authen::CyrusSASL" module provides a simple	class that allows you
       to send request to the cyrus-sasl's 2.0 authen daemon.  This module is
       based on	the Authen::Radius module with the similar interface.

CONSTRUCTOR
       new ( Type => < SASL_AUTHD | SASL_PWCHECK >, < Dir => dirpath | Path =>
       sockpath	> [, TimeOut =>	TIMEOUT] )
	   Creates & returns a blessed reference to a Authen::CyrusSASL
	   object, or undef on failure.	 Error is saved	into $!.  Use undef on
	   the return value if you want	to undef the underlying	unix socket.

	   There are two types for Type	attribute - one	for saslauth daemon
	   and one for old pwcheck daemon (SASL_PWCHECK). The Type attribute
	   is obligatory.

	   The default value for Dir is	'/var/run/pwcheck' (it then looks for
	   the path '/var/run/pwcheck/pwcheck')	for pwcheck method, and
	   '/var/run/saslauthd'	(path '/var/run/saslauthd/mux')	for saslauthd
	   method.  You	can specify the	full path for pwcheck or mux special
	   files with the Path attribute.

	   The TimeOut value is	self explonatory.

METHODS
       check_pwd ( USERNAME, PASSWORD, SERVICE,	REALM )
	   Checks with the SASL	server if the specified	"PASSWORD" is valid
	   for user "USERNAME".	It returns SASL_OK if the "PASSWORD" is
	   correct, SASL_FAIL if the connection	fails, or SASL_BADAUTH if the
	   password or the username is incorrect (possible error is in the $!
	   variable).

SEE ALSO
       Cyrus-sasl archive located at ftp://ftp.andrew.cmu.edu/pub/cyrus-mail/

AUTHOR
       Piotr Klaban <poczta@klaban.torun.pl>

perl v5.24.1			  2017-07-03		  Authen::CyrusSASL(3)

NAME | SYNOPSIS | DESCRIPTION | CONSTRUCTOR | METHODS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Authen::CyrusSASL&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help