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

NAME

6       sasl_setprop - Cyrus SASL documentation
7

SYNOPSIS

9       #include <sasl/sasl.h>
10
11       int sasl_setprop(sasl_conn_t *conn,
12                       int propnum,
13                       const void * pvalue)
14

DESCRIPTION

16       int sasl_setprop(sasl_conn_t *conn,
17
18       int propnum,
19
20       const void * pvalue)
21              sasl_setprop   sets the value of a SASL property. For example an
22              application should tell the SASL library about  any external ne‐
23              gotiated security layer (i.e. TLS).
24
25              Parameters
26
27                     • conn – is the SASL connection context
28
29                     • propnum – is the identifier for the property requested
30
31                     • pvalue –
32
33                       contains   a pointer  to  the  data. It is the applica‐
34                       tions job to make sure this type is correct. This is an
35                       easy way to crash  a program.
36
37                       • SASL_AUTH_EXTERNAL   ‐   external  authentication  ID
38                         (const char *)
39
40                       • SASL_SSF_EXTERNAL   ‐    external   SSF   active   ‐‐
41                         (sasl_ssf_t)
42
43                       • SASL_DEFUSERREALM ‐ user realm (const char *)
44
45                       • SASL_SEC_PROPS   ‐    sasl_security_properties_t (may
46                         be freed after call)
47
48                       •
49
50                         SASL_IPLOCALPORT ‐ string describing the local ip and
51                         port in the form
52                                ”a.b.c.d;p”, or “e:f:g:h:i:j:k:l;port”
53
54                       •
55
56                         SASL_IPREMOTEPORT  ‐  string describing the remote ip
57                         and port in the form
58                                ”a.b.c.d;p”, or “e:f:g:h:i:j:k:l;port”
59
60

RETURN VALUE

62       SASL  callback  functions should return SASL return codes.  See  sasl.h
63       for a complete list. SASL_OK indicates success.
64
65       Other return codes indicate errors and should be handled.
66

SEE ALSO

68       RFC 4422,:saslman:sasl(3), sasl_errors(3)
69

AUTHOR

71       The Cyrus Team
72

74       1993-2016, The Cyrus Team
75
76
77
78
792.1.28                         February 18, 2022               SASL_SETPROP(3)
Impressum