Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_getprop (3sasl)

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(3sasl)             SASL man pages             sasl_getprop(3sasl)



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 suc-
       cessful 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 proper-
       ties 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 4422


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL),        sasl_errors(3SASL),         sasl_server_new(3SASL),
       sasl_client_new(3SASL)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded from  ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             10 July 2001              sasl_getprop(3sasl)