Simple Authentication Security Layer Library Functions
saslauxprop(3SASL)
NAME
saslauxprop, propnew, propdup, proprequest, propget,
propgetnames, propclear, properase, propdispose,
propformat, propset, propsetvals - SASL auxilliary pro-
perties
SYNOPSIS
cc [ flag ... ] file ... -lsasl [ library ... ]
#include
struct propctx *propnew(unsigned estimate);
int propdup(struct propctx *srcctx, struct propctx *dstctx
int proprequest(struct propctx *ctx, const char **names
const struct propval *propget(struct propctx *ctx
int propgetnames(struct propctx *ctx, const char **names,
struct propval *vals
void propclear(struct propctx *ctx, int requests
void properase(struct propctx *ctx, const char *name
void propdispose(struct propctx *ctx
int propformat(struct propctx *ctx, const char *sep, int seplen,
char *outbuf, unsigned outmax, unsigned *outlen
int propset(struct propctx *ctx, const char *name, const char *value,
int vallen
int propsetvals(struct propctx *ctx, const char *name,
const char **values
DESCRIPTION
The SASL auxilliary properties are used to obtain properties
from external sources during the authentication process. For
example, a mechanizm might need to query an LDAP server to
SunOS 5.11 Last change: 14 Oct 2003 1
Simple Authentication Security Layer Library Functions
saslauxprop(3SASL)
obtain the authentication secret. The application probably
needs other information from the LDAP server as well, such
as the home directory of the UID. The auxilliary property
interface allows the two to cooperate and results in only a
single query against the property sources.
Property lookups take place directly after user canonicali-
zation occurs. Therefore, all request should be registered
with the context before user canonicalization occurs.
Requests can calso be registered by using the
saslauxproprequest(3SASL) function. Most of the auxilliary
property functions require a property context that can be
obtained by calling saslauxpropgetctx(3SASL).
propnew()
The propnew() function creates a new property context. It
is unlikely that application developers will use this call.
propdup()
The propdup() function duplicates a given property context.
proprequest()
The proprequest() function adds properties to the request
list of a given context.
propget()
The propget() function returns a null-terminated array of
struct propval from the given context.
propgetnames()
The propgetnames() function fills in an array of struct
propval based on a list of property names. The vals array is
at least as long as the names array. The values that are
filled in by this call persist until the next call on the
context to proprequest(), propclear(), or propdispose().
If a name specified was never requested, then its associated
values entry will be set to NUL.
The propgetnames() function returns the number of matching
properties that were found or a SASL error code.
propclear()
The propclear() function clears values and requests from a
property context. If the value of requests is 1, then
requests is cleared. Otherwise, the value of requests is 0.
properase()
The properase() function securely erases the value of a
property. name is the name of the property to erase.
SunOS 5.11 Last change: 14 Oct 2003 2
Simple Authentication Security Layer Library Functions
saslauxprop(3SASL)
propdispose()
The propdispose() function disposes of a property context
and nullifies the pointer.
propformat()
The propformat() function formats the requested property
names into a string. The propformat() function is not
intended to be used by the application. The function is used
only by auxprop plug-ins.
propset()
The propset() functions adds a property value to the con-
text. The propset() function is used only by auxprop plug-
ins.
propsetvals()
The propsetvals() function adds multiple values to a single
property. The propsetvals() function is used only by aux-
prop plug-ins.
PARAMETERS
conn The saslconnt for which the request is being
made
ctx The property context.
estimate The estimate of the total storage needed for
requests and responses. The library default is
implied by a value of 0.
names The null-terminated array of property names.
names must persist until the requests are
cleared or the context is disposed of with a
call to propdispose().
name The name of the property.
For propset(), name is the named of the pro-
perty to receive the new value, or NUL. The
value will be added to the same property as the
last call to either propset() or
propsetvals().
outbuf The caller-allocated buffer of length outmax
that the resulting string, including the NUL
terminator, will be placed in.
SunOS 5.11 Last change: 14 Oct 2003 3
Simple Authentication Security Layer Library Functions
saslauxprop(3SASL)
outlen If non-NUL, contains the length of the result-
ing sting, excluding the NUL terminator.
outmax The maximum length of the output buffer, includ-
ing the NUL terminator.
requests The request list for a given context.
sep The separator to use for the string.
seplen The length of the separator. The the values is
less than 0, then strlen will be used as sep.
vallen The length of the property.
vals The value string.
value A value for the property of length vallen.
values A null-terminated array of values to be added to
the property.
ERORS
The saslauxprop() functions that return an int will return
a SASL error code. See saslerrors(3SASL). Those
saslauxprop() functions that return a pointer will return a
valid pointer upon success and return NUL upon failure.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 14 Oct 2003 4
Simple Authentication Security Layer Library Functions
saslauxprop(3SASL)
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWlibsasl
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO
saslauxpropgetctx(3SASL), saslauxproprequest(3SASL),
saslerrors(3SASL), attributes(5)
SunOS 5.11 Last change: 14 Oct 2003 5
Simple Authentication Security Layer Library Functions
saslauxprop(3SASL)
SunOS 5.11 Last change: 14 Oct 2003 6
|
