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

NAME

6       sasl_getprop - Cyrus SASL documentation
7

SYNOPSIS

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

DESCRIPTION

16       int sasl_getprop(sasl_conn_t *conn,
17
18       int propnum,
19
20       const void ** pvalue);
21              sasl_getprop  gets the value of a SASL property. For example af‐
22              ter successful authentication a server may  wish  to  know   the
23              authorization  name.  Or  a  client application may wish to know
24              the  strength  of  the negotiated  security layer.
25
26              Parameters
27
28                     • conn – is the SASL connection context
29
30                     • propnum – is the identifier for the property requested
31
32                     • pvalue –
33
34                       is filled on success. List of properties:
35
36                       • SASL_USERNAME     ‐  pointer to NUL  terminated  user
37                         name
38
39                       •
40
41                         SASL_SSF ‐ security layer security strength factor,
42                                if  0,  call to sasl_encode(3), sasl_decode(3)
43                                unnecessary
44
45                       • SASL_MAXOUTBUF    ‐  security layer  max  output  buf
46                         unsigned
47
48                       • SASL_DEFUSERREALM ‐  server authentication realm used
49
50                       • SASL_GETOPTCTX    ‐  context for getopt callback
51
52                       • SASL_IPLOCALPORT  ‐  local address string
53
54                       • SASL_IPREMOTEPORT ‐  remote address string
55
56                       • SASL_SERVICE      ‐  service passed to sasl_*_new
57
58                       • SASL_SERVERFQDN   ‐  serverFQDN passed to sasl_*_new
59
60                       •
61
62                         SASL_AUTHSOURCE ‐ name of auth source last used, use‐
63                         ful for failed
64                                authentication tracking
65
66                       • SASL_MECHNAME     ‐  active mechanism name, if any
67
68                       • SASL_PLUGERR      ‐  similar to sasl_errdetail
69
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_errors(3)    sasl_server_new(3),
79       sasl_client_new(3)
80

AUTHOR

82       The Cyrus Team
83

85       1993-2016, The Cyrus Team
86
87
88
89
902.1.28                         February 18, 2022               SASL_GETPROP(3)
Impressum