File: sasl_getsimple_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 (55 lines) | stat: -rw-r--r-- 1,589 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
53
54
55
.. saslman:: sasl_getsimple_t(3)

.. _sasl-reference-manpages-library-sasl_getsimple_t:


====================================================================
**sasl_getsimple_t** - The SASL callback for username/authname/realm
====================================================================

Synopsis
========

.. code-block:: C

    #include <sasl/sasl.h>

    int sasl_getsimple_t(void *context,
                        int id,
                        const char ** result,
                        unsigned * len);

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

.. c:function::   int sasl_getsimple_t(void *context,
        int id,
        const char ** result,
        unsigned * len);

    **sasl_getsimple_t** is used to retrieve simple things from
    the application. In practice this is authentication name,
    authorization name, and realm.

    :param context: SASL connection context
    :param id: indicates which value is being requested.  Possible values
        include:

        * SASL_CB_USER     ‐ Client user identity to login as
        * SASL_CB_AUTHNAME ‐ Client authentication name
        * SASL_CB_LANGUAGE ‐ Comma‐separated list of :rfc:`1766` languages
        * SASL_CB_CNONCE   ‐ Client‐nonce (for testing mostly)
    :param result: value of the item requested
    :param len: lenth of the result

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

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

See Also
========

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