Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SASL_CANON_USER_T(3)		   Cyrus SASL		    SASL_CANON_USER_T(3)

NAME
     sasl_canon_user_t - Cyrus SASL documentation

SYNOPSIS
     #include <sasl/sasl.h>

     int sasl_canon_user_t(sasl_conn_t *conn, void *context, const char *user, unsigned ulen,
			   unsigned flags, const char *user_realm, char *out_user,
			   unsigned out_umax, unsigned *out_ulen)

DESCRIPTION
     int sasl_canon_user_t(sasl_conn_t *conn,

     void *context,

     const char *user,

     unsigned ulen,

     unsigned flags,

     const char *user_realm,

     char *out_user,

     unsigned out_umax,

     unsigned *out_ulen)
	    sasl_canon_user_t is the callback for an  application-supplied  user
	    canonicalization   function.   This  function  is subject to the re-
	    quirements that all user canonicalization functions  are:  It   must
	    copy  the result into the output buffers, but the output buffers and
	    the input buffers  may be the same.

	    Parameters

		   * context a context from the callback record

		   * user a un-canonicalized username

		   * ulen a length of user

		   * flags a Either SASL_CU_AUTHID (indicating	the  authentica-
		     tion  ID is being canonicalized) or SASL_CU_AUTHZID  (indi-
		     cating the  authorization ID is to be canonicalized)  or  a
		     bitwise OR of the the two.

		   * user_realm a Realm of authentication.

		   * out_user a The output buffer for the canonicalized username

		   * out_umax a Maximum length for out_user

		   * out_ulen a Actual length of out_user

	    Returns
		   SASL_OK indicates success. See sasl_errors(3) for a full list
		   of SASL error codes.

CONFORMING TO
     RFC 4422

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

AUTHOR
     The Cyrus Team

COPYRIGHT
     1993-2016, The Cyrus Team

2.1.28				February 18, 2022	    SASL_CANON_USER_T(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sasl_canon_user_t&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help