man/sasl_checkapop.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_checkapop "29 June 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_checkapop \- Check an APOP challenge/response
  44 .SH SYNOPSIS
  45 .nf
  46 .B #include <sasl/sasl.h>
  47
  48 .BI "int sasl_checkapop(sasl_conn_t *" conn ", "
  49 .BI "                  const char *" challenge ", "
  50 .BI "                  unsigned " challen ", "
  51 .BI "                  const char *" response ", "
  52 .BI "                  unsigned " resplen "); "
  53
  54 .SH DESCRIPTION
  55
  56 .B sasl_checkapop()
  57 will check an APOP challenge/response.  APOP is an optional POP3 (RFC 1939)
  58 authentication command which uses a shared secret (password). The password is
  59 stored in the SASL secrets database.  For information on the SASL shared
  60 secrets database see the
  61 .I System Administrators Guide
  62 in the doc/ directory of the SASL distribution.
  63 .sp
  64 If called with a
  65 .BI "NULL" " challenge" ","
  66 .B sasl_checkapop()
  67 will check to see if the APOP mechanism is enabled.
  68
  69 .SH "RETURN VALUE"
  70 sasl_checkapop returns an integer which corresponds to one of the
  71 following codes. SASL_OK indicates that the authentication is
  72 complete. All other return codes indicate errors and should either be
  73 handled or the authentication session should be quit.  See sasl_errors(3)
  74 for meanings of return codes.
  75
  76 .SH "CONFORMING TO"
  77 RFC 2222, RFC 1939
  78 .SH "SEE ALSO"
  79 sasl(3), sasl_errors(3)