File: sasl_getsecret_t.rst.txt

package info (click to toggle)
cyrus-sasl2 2.1.27%2Bdfsg-2.1%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 19,940 kB
  • sloc: ansic: 58,942; javascript: 8,745; sh: 4,843; java: 1,614; xml: 1,498; makefile: 1,265; python: 342; perl: 199
file content (52 lines) | stat: -rw-r--r-- 1,370 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
.. saslman:: sasl_getsecret_t(3)

.. _sasl-reference-manpages-library-sasl_getsecret_t:


================================================================
**sasl_getsecret_t** - The SASL callback for secrets (passwords)
================================================================

Synopsis
========

.. code-block:: C

    #include <sasl/sasl.h>

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


Description
===========

.. c:function:: 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).

    :param conn: is the SASL connection context

Return Value
============

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

Other return codes indicate errors and should be handled.

See Also
========

:rfc:`4422`,:saslman:`sasl(3)`, :saslman:`sasl_callbacks(3)`