Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

sasl_setprop (3sasl)

Name

sasl_setprop - Set a SASL property

Synopsis

#include <sasl/sasl.h>


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

Description

sasl_setprop(3sasl)             SASL man pages             sasl_setprop(3sasl)



NAME
       sasl_setprop - Set a SASL property

SYNOPSIS
       #include <sasl/sasl.h>


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


DESCRIPTION
       sasl_setprop sets the value of a SASL property. For example an applica-
       tion should tell the SASL library about any external  negotiated  secu-
       rity layer (i.e. TLS).

       conn  is the SASL connection object.  propnum is the identifier for the
       property requested and pvalue 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.

       SASL_AUTH_EXTERNAL - external authentication ID (const char *)
       SASL_SSF_EXTERNAL -  external SSF active -- (sasl_ssf_t)
       SASL_DEFUSERREALM - user realm (const char *)
       SASL_SEC_PROPS  -    sasl_security_properties_t (may be freed after call)
       SASL_IPLOCALPORT -   string describing the local ip and port in the form
                            "a.b.c.d;p", or "e:f:g:h:i:j:k:l;port"
       SASL_IPREMOTEPORT -  string describing the remote ip and port in the form
                            "a.b.c.d;p", or "e:f:g:h:i:j:k:l;port"


RETURN VALUE
       Returns SASL_OK on success. SASL error code on failure.


CONFORMING TO
       RFC 4422


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+----------------------------------+
       |ATTRIBUTE TYPE |         ATTRIBUTE VALUE          |
       +---------------+----------------------------------+
       |Availability   | system/library/security/libsasl2 |
       +---------------+----------------------------------+
       |Stability      | Pass-through volatile            |
       +---------------+----------------------------------+

SEE ALSO
       sasl(3SASL), sasl_errors(3SASL)



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded  from   ftp://ftp.cyrusimap.org/cyrus-sasl/cyrus-
       sasl-2.1.26.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.cyrusimap.org/sasl/.



SASL                             10 July 2001              sasl_setprop(3sasl)