share/man/man3sasl/sasl_auxprop_request.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_AUXPROP_REQUEST 3SASL "Aug 22, 2003"
   9 .SH NAME
  10 sasl_auxprop_request \- request auxialliary properties from SASL
  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_auxprop_request\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char **\fR\fIpropnames\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBsasl_auxprop_request()\fR interface requests that the SASL library
  24 obtain properties form any auxialiary property plugins that might be installed,
  25 for example, the user's home directory from an LDAP server. The lookup occurs
  26 just after username canonicalization is complete. Therefore, the request should
  27 be made before the call to \fBsasl_server_start\fR(3SASL), but after the call
  28 to \fBsasl_server_new\fR(3SASL).
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIconn\fR\fR
  34 .ad
  35 .RS 13n
  36 The \fBsasl_conn_t\fR for which the request is being made
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIpropnames\fR\fR
  43 .ad
  44 .RS 13n
  45 A null-terminated array of property names to request. This array must persist
  46 until a call to \fBsasl_dispose\fR(3SASL) on the \fBsasl_conn_t\fR.
  47 .RE
  48
  49 .SH ERRORS
  50 .sp
  51 .LP
  52 \fBsasl_auxprop_request()\fR returns \fBSASL_OK\fR upon success. See
  53 \fBsasl_errors\fR(3SASL) for a discussion of other SASL error codes.
  54 .SH ATTRIBUTES
  55 .sp
  56 .LP
  57 See \fBattributes\fR(5) for descriptions of the following attributes:
  58 .sp
  59
  60 .sp
  61 .TS
  62 box;
  63 c | c
  64 l | l .
  65 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  66 _
  67 Interface Stability     Evolving
  68 _
  69 MT-Level        Safe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBsasl_dispose\fR(3SASL), \fBsasl_errors\fR(3SASL),
  76 \fBsasl_server_new\fR(3SASL), \fBsasl_server_start\fR(3SASL),
  77 \fBattributes\fR(5)