Current File : //usr/share/man/man3sasl/sasl_setprop.3sasl

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

\fBint\fR \fBsasl_setprop\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBint\fR \fIpropnum\fR, \fBconst void *\fR\fIpvalue\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Use the \fBsasl_setprop()\fR interface to set the value of a SASL property. For example, an application can use \fBsasl_setprop()\fR to tell the SASL liabrary about any external negotiated security layer like TLS.
.sp
.LP
\fBsasl_setprop()\fR uses the following flags.
.sp
.ne 2
.mk
.na
\fB\fBSASL_AUTH_EXTERNAL\fR\fR
.ad
.RS 22n
.rt  
External authentication ID that is a pointer of type \fBconst char\fR
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_SSF_EXTERNAL\fR\fR
.ad
.RS 22n
.rt  
External SSF active of type \fBsasl_ssf_t\fR
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_DEFUSERREALM\fR\fR
.ad
.RS 22n
.rt  
User realm that is a pointer of type \fBconst char\fR
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_SEC_PROPS\fR\fR
.ad
.RS 22n
.rt  
\fBsasl_security_properties_t\fR, that can be freed after the call
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_IPLOCALPORT\fR\fR
.ad
.RS 22n
.rt  
A string that describes the local ip and port in the form \fBa.b.c.d:p\fR or \fB[e:f:g:h:i:j:k:l]:port\fR or one of the older forms, \fBa.b.c.d;p\fR or \fBe:f:g:j:i:j:k:l;port\fR
.RE

.sp
.ne 2
.mk
.na
\fB\fBSASL_IPREMOTEPORT\fR\fR
.ad
.RS 22n
.rt  
A string that describes the remote ip and port in the form \fBa.b.c.d:p\fR or \fB[e:f:g:h:i:j:k:l]:port\fR or one of the older forms, \fBa.b.c.d;p\fR or \fBe:f:g:j:i:j:k:l;port\fR
.RE

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIconn\fR\fR
.ad
.RS 11n
.rt  
The SASL connection context
.RE

.sp
.ne 2
.mk
.na
\fB\fIpropnum\fR\fR
.ad
.RS 11n
.rt  
The identifier for the property requested
.RE

.sp
.ne 2
.mk
.na
\fB\fIpvalue\fR\fR
.ad
.RS 11n
.rt  
Contains a pointer to the data. The application must ensure that the data type is correct, or the application can crash.
.RE

.SH RETURN VALUES
.sp
.LP
\fBsasl_setprop()\fR returns an integer that corresponds to a SASL error code.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBSASL_OK\fR\fR
.ad
.RS 11n
.rt  
The call to \fBsasl_setprop()\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)