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
sasl_getprop(3) *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
authorization name. Or a client application may wish to know the
strength of the negotiated security layer.
Parameters
o conn - is the SASL connection context
o propnum - is the identifier for the property requested
o pvalue -
is filled on success. List of properties:
o SASL_USERNAME - pointer to NUL terminated user
name
o
SASL_SSF - security layer security strength factor,
if 0, call to sasl_encode(3), sasl_decode(3)
unnecessary
o SASL_MAXOUTBUF - security layer max output buf
unsigned
o SASL_DEFUSERREALM - server authentication realm used
o SASL_GETOPTCTX - context for getopt callback
o SASL_IPLOCALPORT - local address string
o SASL_IPREMOTEPORT - remote address string
o SASL_SERVICE - service passed to sasl_*_new
o SASL_SERVERFQDN - serverFQDN passed to sasl_*_new
o
SASL_AUTHSOURCE - name of auth source last used, useful
for failed
authentication tracking
o SASL_MECHNAME - active mechanism name, if any
o SASL_PLUGERR - 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, 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)
cyrus-sasl2 2.1.28 - Generated Sun Sep 25 10:05:53 CDT 2022