sasl_canon_user_t(3sasl)

1sasl_canon_usSeirm_ptl(e3SAAuStLh)entication Security Layer LibrarsyasFlu_nccatnioonn_suser_t(3SASL)
2
3
4

NAME

6       sasl_canon_user_t - the canon user callback
7

SYNOPSIS

9       cc [ flag ... ] file ... -lsasl   [ library ... ]
10       #include <sasl/sasl.h>
11
12       int sasl_canon_user_t(sasl_conn_t *conn, void *context, const char *user,
13            unsigned ulen, unsigned flags, const char *user_realm, char *out_user,
14            unsigned *out_umax, unsigned *out_ulen);
15
16

DESCRIPTION

18       The  sasl_canon_user_t()  interface  is  the  callback  function for an
19       application-supplied user canonical function. This function is  subject
20       to the requirements of all canonical functions. It must copy the result
21       into the output buffers, but the output buffers and the  input  buffers
22       can be the same.
23

PARAMETERS

25       conn          The SASL connection context.
26
27
28       context       The context from the callback record.
29
30
31       user          User name. The form of user is not canonical.
32
33
34       ulen          Length of user. The form of ulen is not canonical.
35
36
37       flags         One of the following values, or a bitwise OR of both:
38
39                     SASL_CU_AUTHID     Indicates  the  authentication  ID  is
40                                        canonical
41
42
43                     SASL_CU_AUTHZID    Indicates  the  authorization  ID   is
44                                        canonical
45
46
47
48       user_realm    Realm of authentication.
49
50
51       out_user      The output buffer for the user name.
52
53
54       out_max       The maximum length for the user name.
55
56
57       out_len       The actual length for the user name.
58
59

RETURN VALUES

61       Like   other  SASL  callback  functions, sasl_canon_user_t() returns an
62       integer that corresponds to a SASL error code. See <sasl.h> for a  com‐
63       plete list of SASL error codes.
64

ERRORS

66       SASL_OK    The call to sasl_canon_user_t() was successful.
67
68
69
70       See sasl_errors(3SASL) for information on SASL error codes.
71

ATTRIBUTES

73       See attributes(5) for descriptions of the following attributes:
74
75
76
77
78       ┌─────────────────────────────┬─────────────────────────────┐
79       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
80       ├─────────────────────────────┼─────────────────────────────┤
81       │Availability                 │SUNWlibsasl                  │
82       ├─────────────────────────────┼─────────────────────────────┤
83       │Interface Stability          │Evolving                     │
84       ├─────────────────────────────┼─────────────────────────────┤
85       │MT-Level                     │MT-Safe                      │
86       └─────────────────────────────┴─────────────────────────────┘
87