Scroll to navigation

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 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 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
if 0, call to sasl_encode(3) <#std-saslman-sasl_encode-3>, sasl_decode(3) <#std-saslman-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
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 <#c.SASL_OK> indicates success.

Other return codes indicate errors and should be handled.

SEE ALSO

RFC 4422 <https://datatracker.ietf.org/doc/html/rfc4422.html>,:saslman:sasl(3), sasl_errors(3) <#std-saslman-sasl_errors-3> sasl_server_new(3) <#std-saslman-sasl_server_new-3>, sasl_client_new(3) <#std-saslman-sasl_client_new-3>

Author

The Cyrus Team

Copyright

1993-2016, The Cyrus Team

2026-04-04 2.1.28