---
name: "sasl_getsecret_t"
section: "3"
platform: "linux"
package: "libsasl2-dev"
version: "2.1.28+dfsg1-9"
release: "Debian 13 (Trixie)"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/sasl_getsecret_t"
---

# sasl\_getsecret\_t(3)

Cyrus SASL documentation

## NAME

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/3.md)*, *[sasl\_callbacks(3)](/sasl_callbacks/3.md)*

## AUTHOR

The Cyrus Team

## COPYRIGHT

1993-2016, The Cyrus Team