sasl_getprop(3) [suse man page]

sasl_getprop(10 July 2001)												sasl_getprop(10 July 2001)

NAME

       sasl_getprop - Get a SASL property

SYNOPSIS

       #include <sasl/sasl.h>

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

DESCRIPTION

       sasl_getprop  gets  the	value  of a SASL property. For example after successful authentication a server may wish to know the authorization
       name. Or a client application may wish to know the strength of the negotiated security layer.

       conn is the SASL connection object.  propnum is the identifier for the property requested and pvalue is filled in on success. List of prop-
       erties follows:

       SASL_USERNAME	 -  pointer to NUL terminated user name
       SASL_SSF 	 -  security layer security strength factor,
			    if 0, call to sasl_encode, sasl_decode unnecessary
       SASL_MAXOUTBUF	 -  security layer max output buf unsigned
       SASL_DEFUSERREALM -  server authentication realm used
       SASL_GETOPTCTX	 -  context for getopt callback
       SASL_IPLOCALPORT  -  local address string
       SASL_IPREMOTEPORT -  remote address string
       SASL_SERVICE	 -  service passed to sasl_*_new
       SASL_SERVERFQDN	 -  serverFQDN passed to sasl_*_new
       SASL_AUTHSOURCE	 -  name of auth source last used, useful for failed
			    authentication tracking
       SASL_MECHNAME	 -  active mechanism name, if any
       SASL_PLUGERR	 -  similar to sasl_errdetail

RETURN VALUE

       Returns SASL_OK on success. SASL error code on failure.

CONFORMING TO

       RFC 2222

SEE ALSO

       sasl(3), sasl_errors(3), sasl_server_new(3), sasl_client_new(3)

SASL man pages							       SASL						sasl_getprop(10 July 2001)

sasl_getprop(3SASL)			      Simple Authentication Security Layer Library Functions			       sasl_getprop(3SASL)

NAME

       sasl_getprop - get a SASL property

SYNOPSIS

       cc [ flag ... ] file ... -lsasl	 [ library ... ]
       #include <sasl/sasl.h>

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

DESCRIPTION

       Use  the  sasl_getprop()  interface to get the value of a SASL property. For example, after successful authentication, a server may want to
       know the authorization name. Similarly, a client application may want to know the strength of the security level that was negotiated.

PARAMETERS

       conn	       The SASL connection context.

       propnum	       The identifier for the property requested.

       pvalue	       The value of the SASL property. This value is filled in upon a successful call. Possible SASL values include:

		       SASL_USERNAME	       A pointer to a null-terminated user name.

		       SASL_SSF 	       The security layer security strength factor. If the value of SASL_SSF is 0, a call to sasl_encode()
					       or sasl_decode() is unnecessary.

		       SASL_MAXOUTBUF	       The maximum size of output buffer returned by the selected security mechanism

		       SASL_DEFUSERREALM       Server authentication realm used.

		       SASL_GETOPTCTX	       The context for getopt() callback.

		       SASL_IPLOCALPORT        Local address string.

		       SASL_IPREMOTEPORT       Remote address string.

		       SASL_SERVICE	       Service passed on to sasl_*_new().

		       SASL_SERVERFQDN	       Server FQDN passed on to sasl_*_new().

		       SASL_AUTHSOURCE	       Name of authentication source last used. Useful for failed authentication tracking.

		       SASL_MECHNAME	       Active mechanism name, if any.

		       SASL_PLUGERR	       Similar to sasl_errdetail().

ERRORS

       SASL_OK	       The call to sasl_getprop() was successful.

       See sasl_errors(3SASL) for information on SASL error codes.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWlibsasl		   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       sasl_errors(3SASL), attributes(5)

SunOS 5.10							    14 Oct 2003 					       sasl_getprop(3SASL)