te
Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
getuserattr, getusernam, getuseruid, free_userattr, setuserattr, enduserattr, fgetuserattr - get user_attr entry

cc [ flag... ] file... -lsecdb -lsocket -lnsl [ library... ]
#include <user_attr.h> 

userattr_t *getuserattr(void);

userattr_t *getusernam(const char *name);

userattr_t *getuseruid(uid_t uid);

void free_userattr(userattr_t *userattr);

void setuserattr(void);

void enduserattr(void);

userattr_t *fgetuserattr(FILE *f);

The getuserattr(), getusernam(), and getuseruid() functions each return a user_attr(4) entry. Entries can come from any of the sources specified in the nsswitch.conf(4) file. The getuserattr() function enumerates user_attr entries. The getusernam() function searches for a user_attr entry with a given user name name. The getuseruid() function searches for a user_attr entry with a given user ID uid. Successive calls to these functions return either successive user_attr entries or NULL.

The fgetuserattr() function does not use nsswitch.conf but reads and parses the next line from the stream f. This stream is assumed to have the format of the user_attr files.

The free_userattr() function releases memory allocated by the getusernam(), getuserattr(), and fgetuserattr() functions.

The internal representation of a user_attr entry is a userattr_t structure defined in <user_attr.h> with the following members:

char *name; /* name of the user */
char *qualifier; /* reserved for future use */
char *res1; /* reserved for future use */
char *res2; /* reserved for future use */
kva_t *attr; /* list of attributes */

The setuserattr() function "rewinds" to the beginning of the enumeration of user_attr entries. Calls to getusernam() may leave the enumeration in an indeterminate state, so setuserattr() should be called before the first call to getuserattr().

The enduserattr() function may be called to indicate that user_attr processing is complete; the library may then close any open user_attr file, deallocate any internal storage, and so forth.

The getuserattr() function returns a pointer to a userattr_t if it successfully enumerates an entry; otherwise it returns NULL, indicating the end of the enumeration.

The getusernam() function returns a pointer to a userattr_t if it successfully locates the requested entry; otherwise it returns NULL.

The getuserattr() and getusernam() functions both allocate memory for the pointers they return. This memory should be deallocated with the free_userattr() function.

Individual attributes can be referenced in the attr structure by calling the kva_match(3SECDB) function.

Because the list of legal keys is likely to expand, code must be written to ignore unknown key-value pairs without error.

/etc/user_attr

/etc/nsswitch.conf

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
MT-Level	MT-Safe

getauthattr(3SECDB), getexecattr(3SECDB), getprofattr(3SECDB), user_attr(4), attributes(5)