xref: /titanic_51/usr/src/man/man3sasl/sasl_checkapop.3sasl (revision c10c16dec587a0662068f6e2991c29ed3a9db943) 
 te
 Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
 Portions Copyright (C) 2003, Sun Microsystems,
 Inc. All Rights Reserved
 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.
 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.
 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]
 sasl_checkapop 3SASL "14 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_checkapop - check an APOP challenge or response

 SYNOPSIS


cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>

int sasl_checkapop(sasl_conn_t *conn, const char *challenge,
 unsigned challen, const char *response, unsigned resplen);




 DESCRIPTION

The sasl_checkapop() interface checks an APOP challenge or response. APOP
is an option POP3 authentication command that uses a shared secret password.
See RFC 1939.


If sasl_checkapop() is called with a NULL challenge,
sasl_checkapop() will check to see if the APOP mechanism is enabled.

 PARAMETERS

conn


The sasl_conn_t for which the request is being made





challenge


The challenge sent to the client





challen


The length of challenge





response


The client response





resplens


The length of response




 RETURN VALUES

sasl_checkapop() returns an integer that corresponds to a SASL error
code.

 ERRORS

SASL_OK


Indicates that the authentication is complete





All other error codes indicate an error situation that must be handled, or the
authentication session should be quit. See sasl_errors(3SASL) for
information on SASL error codes.

 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilitySUNWlibsasl
Interface StabilityObsolete
MT-LevelSafe



 SEE ALSO

sasl_errors(3SASL), attributes(5)


Meyers, J. and Rose, M. RFC 1939, Post Office Protocol - Version 3.
Network Working Group. May 1996.