share/man/man3sasl/sasl_chalprompt_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_CHALPROMPT_T 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_chalprompt_t \- prompt for input in response to a challenge
  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_chalprompt_t\fR(\fBvoid *\fR\fIcontext\fR, \fBint\fR \fIid\fR, \fBconst char *\fR\fIchallenge\fR,
  18      \fBconst char *\fR\fIprompt\fR, \fBconst char *\fR\fIdefresult\fR, \fBconst char **\fR\fIresult\fR,
  19      \fBunsigned *\fR\fIlen\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 Use the \fBsasl_chalprompt_t()\fR callback interface to prompt for input in
  26 response to a server challenge.
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIcontext\fR\fR
  32 .ad
  33 .RS 13n
  34 The context from the callback record.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIid\fR\fR
  41 .ad
  42 .RS 13n
  43 The callback id. \fIid\fR can have a value of \fBSASL_CB_ECHOPROMPT\fR or
  44 \fBSASL_CB_NOECHOPROMPT\fR
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIchallenge\fR\fR
  51 .ad
  52 .RS 13n
  53 The server's challenge.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIprompt\fR\fR
  60 .ad
  61 .RS 13n
  62 A prompt for the user.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIdefresult\fR\fR
  69 .ad
  70 .RS 13n
  71 The default result. The value of \fIdefresult\fR can be \fINULL\fR
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIresult\fR\fR
  78 .ad
  79 .RS 13n
  80 The user's response. \fIresult\fR is a null-terminated string.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fIlen\fR\fR
  87 .ad
  88 .RS 13n
  89 The length of the user's response.
  90 .RE
  91
  92 .SH RETURN VALUES
  93 .sp
  94 .LP
  95 Like other SASL callback functions, \fBsasl_chalprompt_t()\fR returns an
  96 integer that corresponds to a SASL error code. See <\fBsasl.h\fR> for a
  97 complete list of SASL error codes.
  98 .SH ERRORS
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBSASL_OK\fR\fR
 103 .ad
 104 .RS 11n
 105 The call to \fBsasl_chalprompt_t()\fR was successful.
 106 .RE
 107
 108 .sp
 109 .LP
 110 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 111 .SH ATTRIBUTES
 112 .sp
 113 .LP
 114 See \fBattributes\fR(5) for descriptions of the following attributes:
 115 .sp
 116
 117 .sp
 118 .TS
 119 box;
 120 c | c
 121 l | l .
 122 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 123 _
 124 Interface Stability     Evolving
 125 _
 126 MT-Level        MT-Safe
 127 .TE
 128
 129 .SH SEE ALSO
 130 .sp
 131 .LP
 132 \fBsasl_errors\fR(3SASL), \fBsasl_server_new\fR(3SASL), \fBattributes\fR(5)