sasl_getsecret_t(3)

sasl_getsecret_t3

Cyrus sasl documentation

Usage

#include <sasl/sasl.h>
int sasl_getsecret_t(sasl_conn_t *conn,
                    void *context,
                    int id,
                    sasl_secret_t ** psecret);

Overview

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.

Releases

12 releases since Debian 3.0 (Woody); the text changed 7 times.

  1. 3.0
  2. 3.1
  3. 4.0–6.0
  4. 7–9
  5. 10
  6. 11
  7. 12
  8. 13

Author

The Cyrus Team

From libsasl2-dev 2.1.28+dfsg1-9 in Debian 13 (Trixie). Parsed by carta from the page's man source.