share/man/man3sasl/sasl_getprop.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_GETPROP 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_getprop \- get a SASL property
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_getprop\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBint\fR \fIpropnum\fR, \fBconst void **\fR\fIpvalue\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_getprop()\fR interface to get the value of a SASL property. For
  24 example, after successful authentication, a server may want to know the
  25 authorization name. Similarly, a client application may want to know the
  26 strength of the security level that was negotiated.
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIconn\fR\fR
  32 .ad
  33 .RS 11n
  34 The SASL connection context.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIpropnum\fR\fR
  41 .ad
  42 .RS 11n
  43 The identifier for the property requested.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIpvalue\fR\fR
  50 .ad
  51 .RS 11n
  52 The value of the SASL property. This value is filled in upon a successful call.
  53 Possible SASL values include:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBSASL_USERNAME\fR\fR
  58 .ad
  59 .RS 21n
  60 A pointer to a null-terminated user name.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBSASL_SSF\fR\fR
  67 .ad
  68 .RS 21n
  69 The security layer security strength factor. If the value of \fBSASL_SSF\fR is
  70 0, a call to \fBsasl_encode()\fR or \fBsasl_decode()\fR is unnecessary.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBSASL_MAXOUTBUF\fR\fR
  77 .ad
  78 .RS 21n
  79 The maximum size of output buffer returned by the selected security mechanism
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBSASL_DEFUSERREALM\fR\fR
  86 .ad
  87 .RS 21n
  88 Server authentication realm used.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBSASL_GETOPTCTX\fR\fR
  95 .ad
  96 .RS 21n
  97 The context for \fBgetopt()\fR callback.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBSASL_IPLOCALPORT\fR\fR
 104 .ad
 105 .RS 21n
 106 Local address string.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBSASL_IPREMOTEPORT\fR\fR
 113 .ad
 114 .RS 21n
 115 Remote address string.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBSASL_SERVICE\fR\fR
 122 .ad
 123 .RS 21n
 124 Service passed on to \fBsasl_*_new()\fR.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBSASL_SERVERFQDN\fR\fR
 131 .ad
 132 .RS 21n
 133 Server FQDN passed on to \fBsasl_*_new()\fR.
 134 .RE
 135
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBSASL_AUTHSOURCE\fR\fR
 140 .ad
 141 .RS 21n
 142 Name of authentication source last used. Useful for failed authentication
 143 tracking.
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBSASL_MECHNAME\fR\fR
 150 .ad
 151 .RS 21n
 152 Active mechanism name, if any.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBSASL_PLUGERR\fR\fR
 159 .ad
 160 .RS 21n
 161 Similar to \fBsasl_errdetail()\fR.
 162 .RE
 163
 164 .RE
 165
 166 .SH ERRORS
 167 .sp
 168 .ne 2
 169 .na
 170 \fB\fBSASL_OK\fR\fR
 171 .ad
 172 .RS 11n
 173 The call to \fBsasl_getprop()\fR was successful.
 174 .RE
 175
 176 .sp
 177 .LP
 178 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 179 .SH ATTRIBUTES
 180 .sp
 181 .LP
 182 See \fBattributes\fR(5) for descriptions of the following attributes:
 183 .sp
 184
 185 .sp
 186 .TS
 187 box;
 188 c | c
 189 l | l .
 190 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 191 _
 192 Interface Stability     Evolving
 193 _
 194 MT-Level        MT-Safe
 195 .TE
 196
 197 .SH SEE ALSO
 198 .sp
 199 .LP
 200 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)