Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_getsecret_t (3sasl)

Name

sasl_getsecret_t - The SASL callback for secrets (passwords)

Synopsis

#include <sasl/sasl.h>


int sasl_getsecret_t(sasl_conn_t *conn,
void *context,
int id,
sasl_secret_t ** psecret);

Description

sasl_getsecret_t(3sasl)         SASL man pages         sasl_getsecret_t(3sasl)



NAME
       sasl_getsecret_t - The SASL callback for secrets (passwords)



SYNOPSIS
       #include <sasl/sasl.h>


       int sasl_getsecret_t(sasl_conn_t *conn,
                            void *context,
                           int id,
                           sasl_secret_t ** psecret);


DESCRIPTION
       sasl_getsecret_t is used to retrieve the secret from the application. A
       sasl_secret_t      should      be       allocated       to       length
       sizeof(sasl_secret_t)+<length  of  secret>. It has two fields len which
       is the length of the secret in bytes and data which contains the secret
       itself (does not need to be null terminated).

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