'\" te
.\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
.\" Portions Copyright (C) 2003, Sun Microsystems, Inc. All Rights Reserved
.TH sasl_canon_user_t 3SASL "27 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
.SH NAME
sasl_canon_user_t \- the canon user callback
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
#include <sasl/sasl.h>

\fBint\fR \fBsasl_canon_user_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBvoid *\fR\fIcontext\fR, \fBconst char *\fR\fIuser\fR,
     \fBunsigned\fR \fIulen\fR, \fBunsigned\fR \fIflags\fR, \fBconst char *\fR\fIuser_realm\fR, \fBchar *\fR\fIout_user\fR,
     \fBunsigned *\fR\fIout_umax\fR, \fBunsigned *\fR\fIout_ulen\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBsasl_canon_user_t()\fR interface is the callback function for an application-supplied user canonical function. This function is subject to the requirements of all canonical functions. It must copy the result into the output buffers, but the output buffers and the input buffers can be the same.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIconn\fR\fR
.ad
.RS 14n
.rt  
The SASL connection context.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcontext\fR\fR
.ad
.RS 14n
.rt  
The context from the callback record.
.RE

.sp
.ne 2
.mk
.na
\fB\fIuser\fR\fR
.ad
.RS 14n
.rt  
User name. The form of \fIuser\fR is not canonical.
.RE

.sp
.ne 2
.mk
.na
\fB\fIulen\fR\fR
.ad
.RS 14n
.rt  
Length of \fIuser\fR. The form of \fIulen\fR is not canonical.
.RE

.sp
.ne 2
.mk
.na
\fB\fIflags\fR\fR
.ad
.RS 14n
.rt  
One of the following values, or a bitwise OR of both:
.sp
.ne 2
.mk
.na
\fB\fBSASL_CU_AUTHID\fR\fR
.ad
.RS 19n
.rt  
Indicates the authentication ID is canonical
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_CU_AUTHZID\fR\fR
.ad
.RS 19n
.rt  
Indicates the authorization ID is canonical
.RE

.RE

.sp
.ne 2
.mk
.na
\fB\fIuser_realm\fR\fR
.ad
.RS 14n
.rt  
Realm of authentication.
.RE

.sp
.ne 2
.mk
.na
\fB\fIout_user\fR\fR
.ad
.RS 14n
.rt  
The output buffer for the user name.
.RE

.sp
.ne 2
.mk
.na
\fB\fIout_max\fR\fR
.ad
.RS 14n
.rt  
The maximum length for the user name.
.RE

.sp
.ne 2
.mk
.na
\fB\fIout_len\fR\fR
.ad
.RS 14n
.rt  
The actual length for the user name.
.RE

.SH RETURN VALUES
.sp
.LP
Like  other SASL callback functions, \fBsasl_canon_user_t()\fR returns an integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list of SASL error codes.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBSASL_OK\fR\fR
.ad
.RS 11n
.rt  
The call to \fBsasl_canon_user_t()\fR was successful.
.RE

.sp
.LP
See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Availabilitysystem/library/security/libsasl
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBsasl_errors\fR(3SASL), \fBsasl_server_new\fR(3SASL), \fBattributes\fR(5)