sasl_getsecret_t man page

sasl_getsecret_t — Cyrus SASL documentation

Synopsis

#include <sasl/sasl.h>

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

Description

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

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).

Parameters
  • conn – is the SASL connection context

Return Value

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

Other return codes indicate errors and should be handled.

See Also

RFC 4422,:saslman:sasl(3), sasl_callbacks(3)

Author

The Cyrus Team

Referenced By

sasl(3), sasl_callbacks(3).

January 29, 2018 2.1.27 Cyrus SASL