man/sasl_canon_user_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_server_userdb_checkpass_t "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_server_userdb_checkpass_t \- Plaintext Password Verification Callback
  44
  45 .SH SYNOPSIS
  46 .nf
  47 .B #include <sasl/sasl.h>
  48
  49 .sp
  50 .BI "int sasl_canon_user_t(sasl_conn_t " *conn ","
  51 .BI "                      void " *context ","
  52 .BI "                      const char " *user ", unsigned " ulen ","
  53 .BI "                      unsigned " flags ","
  54 .BI "                      const char " *user_realm ","
  55 .BI "                      char " *out_user ", unsigned " out_umax ","
  56 .BI "                      unsigned " *out_ulen ")"
  57
  58 .fi
  59 .SH DESCRIPTION
  60
  61 .B sasl_canon_user_t
  62 Is the callback for an application-supplied user canonicalization function.
  63 This function is subject to the requirements that all user canonicalization
  64 functions are: It must copy the result into the output buffers, but the
  65 output buffers and the input buffers may be the same.
  66
  67 .I context
  68 context from the callback record
  69
  70 .I user
  71 and
  72 .I ulen
  73 Un-canonicalized username (and length)
  74
  75 .I flags
  76 Either SASL_CU_AUTHID (indicating the authentication ID is being canonicalized)
  77 or SASL_CU_AUTHZID (indicating the authorization ID is to be canonicalized)
  78 or a bitwise OR of the the two.
  79
  80 .I user_realm
  81 Realm of authentication.
  82
  83 .I out_user
  84 and
  85 .I out_umax
  86 and
  87 .I out_ulen
  88 The output buffer, max length, and actual length for the username.
  89
  90 .SH "RETURN VALUE"
  91 SASL callback functions should return SASL return codes. See sasl.h for a complete list. SASL_OK indicates success.
  92
  93 .SH "SEE ALSO"
  94 sasl(3), sasl_callbacks(3), sasl_errors(3)