Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_getrealm_t (3sasl)

Name

sasl_getrealm_t - Realm Acquisition Callback

Synopsis

#include <sasl/sasl.h>


int sasl_getrealm_t(void *context, int id,
const char **availrealms,
const char **result)

Description

sasl_getrealm_t(3sasl)          SASL man pages          sasl_getrealm_t(3sasl)



NAME
       sasl_getrealm_t - Realm Acquisition Callback


SYNOPSIS
       #include <sasl/sasl.h>


       int sasl_getrealm_t(void *context, int id,
                       const char **availrealms,
                           const char **result)


DESCRIPTION
       sasl_getrealm_t   is   used   when   there   is   an  interaction  with
       SASL_CB_GETREALM as the type.

       If a mechanism would use this callback, but it is not present, then the
       first  realm  listed is automatically selected.  (Note that a mechanism
       may  still  force   the   existence   of   a   getrealm   callback   by
       SASL_CB_GETREALM to its required_prompts list).

       context context from the callback record

       id callback ID (SASL_CB_GETREALM)

       availrealms  A  string  list of the available realms.  NULL terminated,
       may be empty.

       result The chosen realm. (a NUL terminated string)


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



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)



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_getrealm_t(3sasl)