Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_checkapop (3sasl)

Name

sasl_checkapop - Check an APOP challenge/response

Synopsis

#include <sasl/sasl.h>

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

Description

sasl_checkapop(3sasl)           SASL man pages           sasl_checkapop(3sasl)



NAME
       sasl_checkapop - Check an APOP challenge/response

SYNOPSIS
       #include <sasl/sasl.h>

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


DESCRIPTION
       sasl_checkapop()  will  check  an  APOP challenge/response.  APOP is an
       optional POP3 (RFC 1939) authentication command  which  uses  a  shared
       secret (password). The password is stored in the SASL secrets database.
       For information on the SASL shared  secrets  database  see  the  System
       Administrators Guide in the doc/ directory of the SASL distribution.

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


RETURN VALUE
       sasl_checkapop returns an integer which corresponds to one of the  fol-
       lowing  codes.  SASL_OK  indicates that the authentication is complete.
       All other return codes indicate errors and should either be handled  or
       the  authentication session should be quit.  See sasl_errors(3SASL) for
       meanings of return codes.


CONFORMING TO
       RFC 4422, RFC 1939


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL), sasl_errors(3SASL)


NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded  from   ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             29 June 2001            sasl_checkapop(3sasl)