usr/src/man/man3sasl/sasl_setprop.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_SETPROP 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_setprop \- set a SASL property
  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_setprop\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBint\fR \fIpropnum\fR, \fBconst void *\fR\fIpvalue\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_setprop()\fR interface to set the value of a SASL property. For
  24 example, an application can use \fBsasl_setprop()\fR to tell the SASL liabrary
  25 about any external negotiated security layer like TLS.
  26 .sp
  27 .LP
  28 \fBsasl_setprop()\fR uses the following flags.
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBSASL_AUTH_EXTERNAL\fR\fR
  33 .ad
  34 .RS 22n
  35 External authentication ID that is a pointer of type \fBconst char\fR
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBSASL_SSF_EXTERNAL\fR\fR
  42 .ad
  43 .RS 22n
  44 External SSF active of type \fBsasl_ssf_t\fR
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBSASL_DEFUSERREALM\fR\fR
  51 .ad
  52 .RS 22n
  53 User realm that is a pointer of type \fBconst char\fR
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBSASL_SEC_PROPS\fR\fR
  60 .ad
  61 .RS 22n
  62 \fBsasl_security_properties_t\fR, that can be freed after the call
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBSASL_IPLOCALPORT\fR\fR
  69 .ad
  70 .RS 22n
  71 A string that describes the local ip and port in the form \fBa.b.c.d:p\fR or
  72 \fB[e:f:g:h:i:j:k:l]:port\fR or one of the older forms, \fBa.b.c.d;p\fR or
  73 \fBe:f:g:j:i:j:k:l;port\fR
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBSASL_IPREMOTEPORT\fR\fR
  80 .ad
  81 .RS 22n
  82 A string that describes the remote ip and port in the form \fBa.b.c.d:p\fR or
  83 \fB[e:f:g:h:i:j:k:l]:port\fR or one of the older forms, \fBa.b.c.d;p\fR or
  84 \fBe:f:g:j:i:j:k:l;port\fR
  85 .RE
  86
  87 .SH PARAMETERS
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fIconn\fR\fR
  92 .ad
  93 .RS 11n
  94 The SASL connection context
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fIpropnum\fR\fR
 101 .ad
 102 .RS 11n
 103 The identifier for the property requested
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fIpvalue\fR\fR
 110 .ad
 111 .RS 11n
 112 Contains a pointer to the data. The application must ensure that the data type
 113 is correct, or the application can crash.
 114 .RE
 115
 116 .SH RETURN VALUES
 117 .sp
 118 .LP
 119 \fBsasl_setprop()\fR returns an integer that corresponds to a SASL error code.
 120 .SH ERRORS
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBSASL_OK\fR\fR
 125 .ad
 126 .RS 11n
 127 The call to \fBsasl_setprop()\fR was successful.
 128 .RE
 129
 130 .sp
 131 .LP
 132 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 133 .SH ATTRIBUTES
 134 .sp
 135 .LP
 136 See \fBattributes\fR(5) for descriptions of the following attributes:
 137 .sp
 138
 139 .sp
 140 .TS
 141 box;
 142 c | c
 143 l | l .
 144 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 145 _
 146 Interface Stability     Evolving
 147 _
 148 MT-Level        MT-Safe
 149 .TE
 150
 151 .SH SEE ALSO
 152 .sp
 153 .LP
 154 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)