Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_getsimple_t (3sasl)

Name

sasl_getsimple_t - The SASL callback for username/authname/realm

Synopsis

#include <sasl/sasl.h>


int sasl_getsimple_t(void *context,
int id,
const char ** result,
unsigned * len);

Description

sasl_getsimple_t(3sasl)         SASL man pages         sasl_getsimple_t(3sasl)



NAME
       sasl_getsimple_t - The SASL callback for username/authname/realm



SYNOPSIS
       #include <sasl/sasl.h>


       int sasl_getsimple_t(void *context,
                           int id,
                           const char ** result,
                           unsigned * len);


DESCRIPTION
       sasl_getsimple_t  is  used  to retrieve simple things from the applica-
       tion. In practice this is authentication name, authorization name,  and
       realm. The id parameter indicates which value is being requested.  Pos-
       sible values include:

       SASL_CB_USER     - Client user identity to login as
       SASL_CB_AUTHNAME - Client authentication name
       SASL_CB_LANGUAGE - Comma-separated list of RFC 1766 languages
       SASL_CB_CNONCE   - Client-nonce (for testing mostly)


RETURN VALUE
       SASL callback functions should return SASL return codes. See sasl.h for
       a complete list. SASL_OK indicates success.


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_callbacks(3SASL), sasl_errors(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_getsimple_t(3sasl)