xref: /titanic_52/usr/src/man/man3sasl/sasl_setprop.3sasl (revision 6a1af1a67532df169a657cce07140be64bdea084) 
 te
 Copyright (C) 1998-2003, Carnegie Mellon Univeristy. All Rights Reserved.
 Portions Copyright (C) 2003, Sun Microsystems,
 Inc. All Rights Reserved
 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.
 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.
 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]
 sasl_setprop 3SASL "14 Oct 2003" "SunOS 5.11" "Simple Authentication Security Layer Library Functions"
 NAME
sasl_setprop - set a SASL property

 SYNOPSIS


cc [ flag ... ] file ... -lsasl [ library ... ]
#include <sasl/sasl.h>

int sasl_setprop(sasl_conn_t *conn, int propnum, const void *pvalue);




 DESCRIPTION

Use the sasl_setprop() interface to set the value of a SASL property. For
example, an application can use sasl_setprop() to tell the SASL liabrary
about any external negotiated security layer like TLS.


sasl_setprop() uses the following flags.


SASL_AUTH_EXTERNAL


External authentication ID that is a pointer of type const char





SASL_SSF_EXTERNAL


External SSF active of type sasl_ssf_t





SASL_DEFUSERREALM


User realm that is a pointer of type const char





SASL_SEC_PROPS


sasl_security_properties_t, that can be freed after the call





SASL_IPLOCALPORT


A string that describes the local ip and port in the form a.b.c.d:p or
[e:f:g:h:i:j:k:l]:port or one of the older forms, a.b.c.d;p or
e:f:g:j:i:j:k:l;port





SASL_IPREMOTEPORT


A string that describes the remote ip and port in the form a.b.c.d:p or
[e:f:g:h:i:j:k:l]:port or one of the older forms, a.b.c.d;p or
e:f:g:j:i:j:k:l;port




 PARAMETERS

conn


The SASL connection context





propnum


The identifier for the property requested





pvalue


Contains a pointer to the data. The application must ensure that the data type
is correct, or the application can crash.




 RETURN VALUES

sasl_setprop() returns an integer that corresponds to a SASL error code.

 ERRORS

SASL_OK


The call to sasl_setprop() was successful.





See sasl_errors(3SASL) for information on SASL error codes.

 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

sasl_errors(3SASL), attributes(5)