sasl_getprop - Cyrus SASL documentation

NAME  SYNOPSIS  DESCRIPTION  RETURN VALUE  SEE ALSO  AUTHOR  COPYRIGHT 

---

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 authorization name. Or a client application may wish to know the strength of the negotiated security layer.
Parameters

	•		conn â is the SASL connection context
	•		propnum â is the identifier for the property requested
	•		pvalue â

is filled on success. List of properties:

	•		SASL_USERNAME â pointer to NUL terminated user name
	•

SASL_SSF â security layer security strength factor,

if 0, call to sasl_encode(3), sasl_decode(3) 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

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

---