sasl_canon_user_t(3)

sasl_canon_user_t3

Cyrus sasl documentation

Usage

#include <sasl/sasl.h>
int sasl_canon_user_t(sasl_conn_t *conn, void *context, const char *user, unsigned ulen,
                      unsigned flags, const char *user_realm, char *out_user,
                      unsigned out_umax, unsigned *out_ulen)

Overview

int sasl_canon_user_t(sasl_conn_t *conn,
void *context,
const char *user,
unsigned ulen,
unsigned flags,
const char *user_realm,
char *out_user,
unsigned out_umax,
unsigned *out_ulen)

sasl_canon_user_t is the callback for an application-supplied user canonicalization function. This function is subject to the requirements that all user canonicalization functions are: It must copy the result into the output buffers, but the output buffers and the input buffers may be the same.

Parameters
•

context – context from the callback record

•

user – un-canonicalized username

•

ulen – length of user

•

flags – Either SASL_CU_AUTHID (indicating the authentication ID is being canonicalized) or SASL_CU_AUTHZID (indicating the authorization ID is to be canonicalized) or a bitwise OR of the the two.

•

user_realm – Realm of authentication.

•

out_user – The output buffer for the canonicalized username

•

out_umax – Maximum length for out_user

•

out_ulen – Actual length of out_user

Returns

SASL_OK indicates success. See sasl_errors(3) for a full list of SASL error codes.

Releases

11 releases since Debian 3.1 (Sarge); the text changed 5 times.

  1. 3.1
  2. 4.0–9
  3. 10
  4. 11
  5. 12
  6. 13

Conforming to

RFC 4422

Author

The Cyrus Team

From libsasl2-dev 2.1.28+dfsg1-9 in Debian 13 (Trixie). Parsed by carta from the page's man source.