man/sasl_setprop.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\"
  17 .\" 3. The name "Carnegie Mellon University" must not be used to
  18 .\"    endorse or promote products derived from this software without
  19 .\"    prior written permission. For permission or any other legal
  20 .\"    details, please contact
  21 .\"      Office of Technology Transfer
  22 .\"      Carnegie Mellon University
  23 .\"      5000 Forbes Avenue
  24 .\"      Pittsburgh, PA  15213-3890
  25 .\"      (412) 268-4387, fax: (412) 268-7395
  26 .\"      tech-transfer@andrew.cmu.edu
  27 .\"
  28 .\" 4. Redistributions of any form whatsoever must retain the following
  29 .\"    acknowledgment:
  30 .\"    "This product includes software developed by Computing Services
  31 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  32 .\"
  33 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  34 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  35 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  36 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  37 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  38 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  39 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  40 .\"
  41 .TH sasl_setprop "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_setprop \- Set a SASL property
  44 .SH SYNOPSIS
  45 .nf
  46 .B #include <sasl/sasl.h>
  47
  48 .sp
  49 .BI "int sasl_setprop(sasl_conn_t " *conn ", "
  50 .BI "                    int " propnum ", "
  51 .BI "                    const void * " pvalue ")"
  52
  53 .fi
  54 .SH DESCRIPTION
  55
  56 .B sasl_setprop
  57 sets the value of a SASL property. For example an application should tell the SASL library about any external negotiated security layer (i.e. TLS).
  58
  59 .I conn
  60 is the SASL connection object.
  61 .I propnum
  62 is the identifier for the property requested and
  63 .I pvalue
  64 contains a pointer to the data. It is the applications job to make sure this type is correct. This is an easy way to crash a program.
  65
  66 .nf
  67 SASL_AUTH_EXTERNAL - external authentication ID (const char *)
  68 SASL_SSF_EXTERNAL -  external SSF active -- (sasl_ssf_t)
  69 SASL_DEFUSERREALM - user realm (const char *)
  70 SASL_SEC_PROPS  -    sasl_security_properties_t (may be freed after call)
  71 SASL_IPLOCALPORT -   string describing the local ip and port in the form
  72                      "a.b.c.d;p", or "e:f:g:h:i:j:k:l;port"
  73 SASL_IPREMOTEPORT -  string describing the remote ip and port in the form
  74                      "a.b.c.d;p", or "e:f:g:h:i:j:k:l;port"
  75 .fi
  76
  77 .SH "RETURN VALUE"
  78 Returns SASL_OK on success. SASL error code on failure.
  79
  80 .SH "CONFORMING TO"
  81 RFC 2222
  82 .SH "SEE ALSO"
  83 sasl(3), sasl_errors(3)