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

FreeBSD Manual Pages

  
 
  

home | help
SASL_GETPROP(3) 		   Cyrus SASL			 SASL_GETPROP(3)

NAME
     sasl_getprop - Cyrus SASL documentation

SYNOPSIS
     #include <sasl/sasl.h>

     int sasl_getprop(sasl_conn_t *conn,
		     int propnum,
		     const void ** pvalue);

DESCRIPTION
     int sasl_getprop(sasl_conn_t *conn,

     int propnum,

     const void ** pvalue);
	    sasl_getprop   gets  the value of a SASL property. For example after
	    successful authentication a server may  wish  to know   the   autho-
	    rization  name.  Or  a  client  application  may  wish  to know  the
	    strength  of  the negotiated  security layer.

	    Parameters

		   * conn a is the SASL connection context

		   * propnum a is the identifier for the property requested

		   * pvalue a

		     is filled on success. List of properties:

		     * SASL_USERNAME	 a  pointer to NUL terminated user name

		     *

		       SASL_SSF ^a security layer security strength factor,
			      if 0, call to sasl_encode(3),  sasl_decode(3)  un-
			      necessary

		     * SASL_MAXOUTBUF	  a   security	layer max output buf un-
		       signed

		     * SASL_DEFUSERREALM a  server authentication realm used

		     * SASL_GETOPTCTX	 a  context for getopt callback

		     * SASL_IPLOCALPORT  a  local address string

		     * SASL_IPREMOTEPORT a  remote address string

		     * SASL_SERVICE	 a  service passed to sasl_*_new

		     * SASL_SERVERFQDN	 a  serverFQDN passed to sasl_*_new

		     *

		       SASL_AUTHSOURCE ^a name of auth source last used, useful
		       for failed
			      authentication tracking

		     * SASL_MECHNAME	 a  active mechanism name, if any

		     * SASL_PLUGERR	 a  similar to sasl_errdetail

RETURN VALUE
     SASL  callback  functions should return SASL return codes.  See sasl.h  for
     a complete list. SASL_OK indicates success.

     Other return codes indicate errors and should be handled.

SEE ALSO
     RFC      4422,:saslman:sasl(3),	  sasl_errors(3)     sasl_server_new(3),
     sasl_client_new(3)

AUTHOR
     The Cyrus Team

COPYRIGHT
     1993-2016, The Cyrus Team

2.1.28				February 18, 2022		 SASL_GETPROP(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sasl_getprop&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help