man/sasl_setpass.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_setpass "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_setpass \- Check a plaintext password
  44 .SH SYNOPSIS
  45 .nf
  46 .B #include <sasl/sasl.h>
  47
  48 .BI "int sasl_setpass(sasl_conn_t *" conn ", "
  49 .BI "                  const char *" user ", "
  50 .BI "                  const char *" pass ", unsigned " passlen ","
  51 .BI "                  const char *" oldpass ", unsigned " oldpasslen ","
  52 .BI "                  unsigned " flags ")"
  53
  54 .SH DESCRIPTION
  55
  56 .B sasl_setpass
  57 will set passwords in the sasldb, and trigger the setpass callbacks for all
  58 available mechanisms.
  59
  60 .I user
  61 is the username to set the password for.
  62
  63 .I pass
  64 and
  65 .I passlen
  66 are the password to set and its length
  67
  68 .I oldpass
  69 and
  70 .I oldpasslen
  71 are the old password & its length (and are optional)
  72
  73 .I flags
  74 Are flags including SASL_SET_CREATE and SASL_SET_DISABLE (to cause the
  75 creating of nonexistent accounts and the disabling of an account,
  76 respectively)
  77
  78 .SH NOTES
  79 .I oldpass
  80 and
  81 .I oldpasslen
  82 are unused in the Cyrus SASL implementation, though are passed on to
  83 any mechanisms that may require them.
  84
  85 .SH "RETURN VALUE"
  86 Returns SASL_OK on success. SASL error code on failure.
  87
  88 .SH "CONFORMING TO"
  89 RFC 2222
  90 .SH "SEE ALSO"
  91 sasl(3), sasl_errors(3), sasl_checkpass(3)