man/sasl_auxprop_request.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\"
  17 .\" 3. The name "Carnegie Mellon University" must not be used to
  18 .\"    endorse or promote products derived from this software without
  19 .\"    prior written permission. For permission or any other legal
  20 .\"    details, please contact
  21 .\"      Office of Technology Transfer
  22 .\"      Carnegie Mellon University
  23 .\"      5000 Forbes Avenue
  24 .\"      Pittsburgh, PA  15213-3890
  25 .\"      (412) 268-4387, fax: (412) 268-7395
  26 .\"      tech-transfer@andrew.cmu.edu
  27 .\"
  28 .\" 4. Redistributions of any form whatsoever must retain the following
  29 .\"    acknowledgment:
  30 .\"    "This product includes software developed by Computing Services
  31 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  32 .\"
  33 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  34 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  35 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  36 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  37 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  38 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  39 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  40 .\"
  41 .TH sasl_auxprop_request "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_auxprop_request \- Request Auxiliary Properties from SASL
  44
  45 .SH SYNOPSIS
  46 .nf
  47 .B #include <sasl/sasl.h>
  48
  49 .sp
  50 .BI "int sasl_auxprop_request(sasl_conn_t " *conn ", "
  51 .BI "                         const char ** " propnames ")"
  52
  53 .fi
  54 .SH DESCRIPTION
  55
  56 .B sasl_auxprop_request
  57 will request that the SASL library obtain properties from any auxiliary
  58 property plugins that might be installed (such as the user's home directory
  59 from an LDAP server for example).  Such lookup occurs just after username
  60 canonicalization is complete.  Therefore, the request should be made before
  61 the call to sasl_server_start(3), but after the call to sasl_server_new(3).
  62
  63 .I conn
  64 the sasl_conn_t for which the request is being made.
  65
  66 .I propnames
  67 a NULL-terminated array of property names to request.  Note that this
  68 array must persist until a call to sasl_dispose on the sasl_conn_t.
  69
  70 .SH "RETURN VALUE"
  71 Returns SASL_OK on success.  See sasl_errors(3) for meanings of other return
  72 codes.
  73
  74 .SH "CONFORMING TO"
  75 RFC 2222
  76 .SH "SEE ALSO"
  77 sasl(3), sasl_errors(3), sasl_auxprop(3), sasl_auxprop_getctx(3),
  78 sasl_server_new(3), sasl_server_start(3)