man/sasl_getopt_t.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_getopt_t "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_getopt_t \- The SASL get option callback
  44
  45
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <sasl/sasl.h>
  49
  50 .sp
  51 .BI "int sasl_getopt_t(void " *context ", "
  52 .BI "                const char " *plugin_name ", "
  53 .BI "                const char " *option ", "
  54 .BI "                const char ** " result ", "
  55 .BI "                unsigned * " len ")";
  56
  57 .fi
  58 .SH DESCRIPTION
  59
  60 .B sasl_getopt_t
  61 is used to retrieve an option, often mechanism specific, from the
  62 application. An example of this is requested what KERBEROS_V4 srvtab
  63 file to use.
  64 .I plugin_name
  65 is the plugin this value if for.
  66 .I option
  67 is a string representing the option. A common option that all server
  68 applications should handle is \"pwcheck_method\" which represents the
  69 method for checking plaintext passwords. See the administrators guide
  70 for a full description of this option.
  71 .PP
  72 Memory management of options supplied by the getopt callback should be
  73 done by the application, however, any requested option must remain available
  74 until the callback is no longer valid.  That is, when sasl_dispose is called for a
  75 the connection it is associated with, or sasl_done is called for global callbacks.
  76 .PP
  77 .SH "RETURN VALUE"
  78
  79 SASL callback functions should return SASL return codes. See sasl.h for a complete list. SASL_OK indicates success.
  80
  81 .SH "CONFORMING TO"
  82 RFC 2222
  83 .SH "SEE ALSO"
  84 sasl(3), sasl_callbacks(3), sasl_errors(3)