SASL_GETPROP(3SASL) Simple Authentication Security Layer Library Functions
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(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
SEE ALSO
sasl_errors(3SASL),
attributes(7) October 14, 2003 SASL_GETPROP(3SASL)
