sasl_auxprop_request (3)

Leading comments

Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in
   the docume...

(The comments found at the beginning of the groff file "man3/sasl_auxprop_request.3".)

NAME

sasl_auxprop_request - Request Auxiliary Properties from SASL

SYNOPSIS

#include <sasl/sasl.h>

int sasl_auxprop_request(sasl_conn_t *conn, 
                             const char ** propnames)

DESCRIPTION

sasl_auxprop_request will request that the SASL library obtain properties from any auxiliary property plugins that might be installed (such as the user's home directory from an LDAP server for example). Such lookup occurs just after username canonicalization is complete. Therefore, the request should be made before the call to sasl_server_start(3), but after the call to sasl_server_new(3).
conn the sasl_conn_t for which the request is being made.
propnames a NULL-terminated array of property names to request. Note that this array must persist until a call to sasl_dispose on the sasl_conn_t.

RETURN VALUE

Returns SASL_OK on success. See sasl_errors(3) for meanings of other return codes.

CONFORMING TO

RFC 4422

SEE ALSO

sasl(3), sasl_errors(3), sasl_auxprop(3), sasl_auxprop_getctx(3), sasl_server_new(3), sasl_server_start(3)