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

NAME

6       sasl_canon_user_t - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_canon_user_t(sasl_conn_t *conn, void *context, const char *user, unsigned ulen,
12                             unsigned flags, const char *user_realm, char *out_user,
13                             unsigned out_umax, unsigned *out_ulen)
14

DESCRIPTION

16       int sasl_canon_user_t(sasl_conn_t *conn,
17
18       void *context,
19
20       const char *user,
21
22       unsigned ulen,
23
24       unsigned flags,
25
26       const char *user_realm,
27
28       char *out_user,
29
30       unsigned out_umax,
31
32       unsigned *out_ulen)
33              sasl_canon_user_t  is  the callback for an  application-supplied
34              user  canonicalization  function.  This function is  subject  to
35              the  requirements that all user canonicalization functions  are:
36              It  must  copy the result into the output buffers, but the  out‐
37              put buffers and the input buffers  may be the same.
38
39              Parameters
40
41                     · context – context from the callback record
42
43                     · user – un-canonicalized username
44
45                     · ulen – length of user
46
47                     · flags – Either SASL_CU_AUTHID (indicating the authenti‐
48                       cation ID is being  canonicalized)  or  SASL_CU_AUTHZID
49                       (indicating  the   authorization ID is to be canonical‐
50                       ized) or a bitwise OR of the the two.
51
52                     · user_realm – Realm of authentication.
53
54                     · out_user – The  output  buffer  for  the  canonicalized
55                       username
56
57                     · out_umax – Maximum length for out_user
58
59                     · out_ulen – Actual length of out_user
60
61              Returns
62                     SASL_OK  indicates success. See sasl_errors(3) for a full
63                     list of SASL error codes.
64

CONFORMING TO

66       RFC 4422
67

SEE ALSO

69       sasl(3), sasl_errors(3), sasl_callbacks(3)
70

AUTHOR

72       The Cyrus Team
73

75       1993-2016, The Cyrus Team
76
77
78
79
802.1.27                         January 29, 2018           SASL_CANON_USER_T(3)
Impressum