usr/src/man/man3sasl/sasl_canon_user_t.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_CANON_USER_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_canon_user_t \- the canon user callback
  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_canon_user_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBvoid *\fR\fIcontext\fR, \fBconst char *\fR\fIuser\fR,
  18      \fBunsigned\fR \fIulen\fR, \fBunsigned\fR \fIflags\fR, \fBconst char *\fR\fIuser_realm\fR, \fBchar *\fR\fIout_user\fR,
  19      \fBunsigned *\fR\fIout_umax\fR, \fBunsigned *\fR\fIout_ulen\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBsasl_canon_user_t()\fR interface is the callback function for an
  26 application-supplied user canonical function. This function is subject to the
  27 requirements of all canonical functions. It must copy the result into the
  28 output buffers, but the output buffers and the input buffers can be the same.
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIconn\fR\fR
  34 .ad
  35 .RS 14n
  36 The SASL connection context.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIcontext\fR\fR
  43 .ad
  44 .RS 14n
  45 The context from the callback record.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIuser\fR\fR
  52 .ad
  53 .RS 14n
  54 User name. The form of \fIuser\fR is not canonical.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIulen\fR\fR
  61 .ad
  62 .RS 14n
  63 Length of \fIuser\fR. The form of \fIulen\fR is not canonical.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIflags\fR\fR
  70 .ad
  71 .RS 14n
  72 One of the following values, or a bitwise OR of both:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBSASL_CU_AUTHID\fR\fR
  77 .ad
  78 .RS 19n
  79 Indicates the authentication ID is canonical
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBSASL_CU_AUTHZID\fR\fR
  86 .ad
  87 .RS 19n
  88 Indicates the authorization ID is canonical
  89 .RE
  90
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fIuser_realm\fR\fR
  97 .ad
  98 .RS 14n
  99 Realm of authentication.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fIout_user\fR\fR
 106 .ad
 107 .RS 14n
 108 The output buffer for the user name.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fIout_max\fR\fR
 115 .ad
 116 .RS 14n
 117 The maximum length for the user name.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fIout_len\fR\fR
 124 .ad
 125 .RS 14n
 126 The actual length for the user name.
 127 .RE
 128
 129 .SH RETURN VALUES
 130 .sp
 131 .LP
 132 Like  other SASL callback functions, \fBsasl_canon_user_t()\fR returns an
 133 integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a
 134 complete list of SASL error codes.
 135 .SH ERRORS
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBSASL_OK\fR\fR
 140 .ad
 141 .RS 11n
 142 The call to \fBsasl_canon_user_t()\fR was successful.
 143 .RE
 144
 145 .sp
 146 .LP
 147 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 148 .SH ATTRIBUTES
 149 .sp
 150 .LP
 151 See \fBattributes\fR(5) for descriptions of the following attributes:
 152 .sp
 153
 154 .sp
 155 .TS
 156 box;
 157 c | c
 158 l | l .
 159 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 160 _
 161 Interface Stability     Evolving
 162 _
 163 MT-Level        MT-Safe
 164 .TE
 165
 166 .SH SEE ALSO
 167 .sp
 168 .LP
 169 \fBsasl_errors\fR(3SASL), \fBsasl_server_new\fR(3SASL), \fBattributes\fR(5)