usr/src/man/man3sasl/sasl_getsecret_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_GETSECRET_T 3SASL "Oct 27, 2003"
   9 .SH NAME
  10 sasl_getsecret_t \- the SASL callback function for secrets (passwords)
  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_getsecret_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBvoid *\fR\fIcontext\fR,
  18      \fBint\fR \fIid\fR, \fBsasl_secret_t **\fR\fIpsecret\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 Use the \fBsasl_getsecret_t()\fR function to retrieve the secret from the
  25 application. Allocate a \fBsasl_secret_t\fR to length
  26 \fBsizeof(sasl_secret_t)+<length of secret>\fR. \fBsasl_secret_t\fR has two
  27 fields of \fIlen\fR which contain the length of \fIsecret\fR in bytes and the
  28 data contained in \fIsecret\fR. The \fIsecret\fR string does not need to be
  29 null-terminated.
  30 .SH PARAMETERS
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIconn\fR\fR
  35 .ad
  36 .RS 11n
  37 The connection context
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIcontext\fR\fR
  44 .ad
  45 .RS 11n
  46 The context from the callback structure
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fIid\fR\fR
  53 .ad
  54 .RS 11n
  55 The callback ID
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fIpsecret\fR\fR
  62 .ad
  63 .RS 11n
  64 To cancel, set the value of \fIpsecret\fR to \fINULL\fR. Otherwise, set the
  65 value to the password structure. The structure must persist until the next call
  66 to \fBsasl_getsecret_t()\fR in the same connection. Middleware erases password
  67 data when it is done with it.
  68 .RE
  69
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 Like other SASL callback functions, \fBsasl_getsecret_t()\fR returns an integer
  74 that corresponds to a SASL error code. See <\fBsasl.h\fR> for a complete list
  75 of SASL error codes.
  76 .SH ERRORS
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBSASL_OK\fR\fR
  81 .ad
  82 .RS 11n
  83 The call to \fBsasl_getsecret_t()\fR was successful.
  84 .RE
  85
  86 .sp
  87 .LP
  88 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Evolving
 103 _
 104 MT-Level        MT-Safe
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)