sasl_setprop - Set a SASL property — Cyrus SASL 2.1.28 documentation

- Home
- Cyrus IMAP
- Download
- Contribute

# Cyrus SASL

# sasl_setprop - Set a SASL property

## Synopsis

    #include <sasl/sasl.h>

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

## Description

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

  sasl_setprop 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).

  Parameters

    - conn – is the SASL connection context

    - propnum – is the identifier for the property requested

    - 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

SASL callback functions should return SASL return codes. See sasl.h for a complete list. `SASL_OK` indicates success.

Other return codes indicate errors and should be handled.

## See Also

RFC 4422,:saslman:sasl(3), sasl_errors(3)