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

\fBint\fR \fBsasl_getsecret_t\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBvoid *\fR\fIcontext\fR,
     \fBint\fR \fIid\fR, \fBsasl_secret_t **\fR\fIpsecret\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_getsecret_t()\fR function to retrieve the secret from the application. Allocate a \fBsasl_secret_t\fR to length \fBsizeof(sasl_secret_t)+<length of secret>\fR. \fBsasl_secret_t\fR has two fields of \fIlen\fR which contain the length of \fIsecret\fR in bytes and the data contained in \fIsecret\fR. The \fIsecret\fR string does not need to be null-terminated.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIconn\fR\fR
.ad
.RS 11n
.rt  
The connection context
.RE

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

.sp
.ne 2
.mk
.na
\fB\fIid\fR\fR
.ad
.RS 11n
.rt  
The callback ID 
.RE

.sp
.ne 2
.mk
.na
\fB\fIpsecret\fR\fR
.ad
.RS 11n
.rt  
To cancel, set the value of \fIpsecret\fR to \fINULL\fR. Otherwise, set the value to the password structure. The structure must persist until the next call to \fBsasl_getsecret_t()\fR in the same connection. Middleware erases password data when it is done with it.
.RE

.SH RETURN VALUES
.sp
.LP
Like other SASL callback functions, \fBsasl_getsecret_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_getsecret_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), \fBattributes\fR(5)