usr/src/man/man3sasl/sasl_checkapop.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_CHECKAPOP 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_checkapop \- check an APOP challenge or response
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_checkapop\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char *\fR\fIchallenge\fR,
  18      \fBunsigned\fR \fIchallen\fR, \fBconst char *\fR\fIresponse\fR, \fBunsigned\fR \fIresplen\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBsasl_checkapop()\fR interface checks an APOP challenge or response. APOP
  25 is an option POP3 authentication command that uses a shared secret password.
  26 See \fIRFC 1939\fR.
  27 .sp
  28 .LP
  29 If \fBsasl_checkapop()\fR is called with a \fINULL\fR challenge,
  30 \fBsasl_checkapop()\fR will check to see if the APOP mechanism is enabled.
  31 .SH PARAMETERS
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIconn\fR\fR
  36 .ad
  37 .RS 13n
  38 The \fBsasl_conn_t\fR for which the request is being made
  39 .RE
  40
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIchallenge\fR\fR
  45 .ad
  46 .RS 13n
  47 The challenge sent to the client
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIchallen\fR\fR
  54 .ad
  55 .RS 13n
  56 The length of \fIchallenge\fR
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIresponse\fR\fR
  63 .ad
  64 .RS 13n
  65 The client response
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIresplens\fR\fR
  72 .ad
  73 .RS 13n
  74 The length of \fIresponse\fR
  75 .RE
  76
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 \fBsasl_checkapop()\fR returns an integer that corresponds to a SASL error
  81 code.
  82 .SH ERRORS
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBSASL_OK\fR\fR
  87 .ad
  88 .RS 11n
  89 Indicates that the authentication is complete
  90 .RE
  91
  92 .sp
  93 .LP
  94 All other error codes indicate an error situation that must be handled, or the
  95 authentication session should be quit. See \fBsasl_errors\fR(3SASL) for
  96 information on SASL error codes.
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     SUNWlibsasl
 111 _
 112 Interface Stability     Obsolete
 113 _
 114 MT-Level        Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)
 121 .sp
 122 .LP
 123 Meyers, J. and Rose, M. \fIRFC 1939, Post Office Protocol - Version 3\fR.
 124 Network Working Group. May 1996.