1SASL_ENCODE(3)                    Cyrus SASL                    SASL_ENCODE(3)
2
3
4

NAME

6       sasl_encode - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_encode(sasl_conn_t *conn,
12                       const char * input,
13                       unsigned inputlen,
14                       const char ** output,
15                       unsigned * outputlen);
16
17       int sasl_encodev(sasl_conn_t *conn,
18                       const struct iovec * invec,
19                       unsigned numiov,
20                       const char ** output,
21                       unsigned * outputlen);
22

DESCRIPTION

24       sasl_encode  encodes  data  to be sent to be sent to a remote host  who
25       we’ve had  a successful authentication session with. If  there   is   a
26       negotiated  security   the  data  in signed/encrypted  and  the  output
27       should be sent without modification to the remote host. If there is  no
28       security layer the output is identical to the input.
29
30       sasl_encodev does the same, but for a struct iovec instead of a charac‐
31       ter buffer.
32
33       int sasl_encode(sasl_conn_t *conn,
34
35       const char * input,
36
37       unsigned inputlen,
38
39       const char ** output,
40
41       unsigned * outputlen);
42
43              Parameters
44
45                     • conn – is the SASL connection context
46
47                     • output  –  contains  the  decoded  data  and  is  allo‐
48                       cated/freed by the library.
49
50                     • outputlen – length of output.
51
52              int sasl_encodev(sasl_conn_t *conn,
53
54              const struct iovec * invec,
55
56              unsigned numiov,
57
58              const char ** output,
59
60              unsigned * outputlen);
61
62              Parameters
63
64                     • conn – is the SASL connection context
65
66                     • output  –  contains  the  decoded  data  and  is  allo‐
67                       cated/freed by the library.
68
69                     • outputlen – length of output.
70

RETURN VALUE

72       SASL  callback  functions should return SASL return codes.  See  sasl.h
73       for a complete list. SASL_OK indicates success.
74
75       Other return codes indicate errors and should be handled.
76

SEE ALSO

78       RFC 4422,:saslman:sasl(3), sasl_decode(3), sasl_errors(3)
79

AUTHOR

81       The Cyrus Team
82

84       1993-2016, The Cyrus Team
85
86
87
88
892.1.28                         February 18, 2022                SASL_ENCODE(3)
Impressum