| Skip Navigation Links | |
| Exit Print View | |
 | man pages section 3: Basic Library Functions Oracle Solaris 11 Information Library |
| Skip Navigation Links | |
| Exit Print View | |
| man pages section 3: Basic Library Functions Oracle Solaris 11 Information Library |
enable_extended_FILE_stdio(3C)
posix_spawnattr_getschedparam(3C)
posix_spawnattr_getschedpolicy(3C)
posix_spawnattr_getsigdefault(3C)
posix_spawnattr_getsigignore_np(3C)
posix_spawnattr_getsigmask(3C)
posix_spawnattr_setschedparam(3C)
posix_spawnattr_setschedpolicy(3C)
posix_spawnattr_setsigdefault(3C)
posix_spawnattr_setsigignore_np(3C)
posix_spawnattr_setsigmask(3C)
posix_spawn_file_actions_addclose(3C)
posix_spawn_file_actions_addclosefrom_np(3C)
posix_spawn_file_actions_adddup2(3C)
posix_spawn_file_actions_addopen(3C)
posix_spawn_file_actions_destroy(3C)
posix_spawn_file_actions_init(3C)
pthread_attr_getdetachstate(3C)
pthread_attr_getinheritsched(3C)
pthread_attr_getschedparam(3C)
pthread_attr_getschedpolicy(3C)
pthread_attr_setdetachstate(3C)
pthread_attr_setinheritsched(3C)
pthread_attr_setschedparam(3C)
pthread_attr_setschedpolicy(3C)
pthread_barrierattr_destroy(3C)
pthread_barrierattr_getpshared(3C)
pthread_barrierattr_setpshared(3C)
pthread_condattr_getpshared(3C)
pthread_condattr_setpshared(3C)
pthread_cond_reltimedwait_np(3C)
pthread_key_create_once_np(3C)
pthread_mutexattr_getprioceiling(3C)
pthread_mutexattr_getprotocol(3C)
pthread_mutexattr_getpshared(3C)
pthread_mutexattr_getrobust(3C)
pthread_mutexattr_setprioceiling(3C)
pthread_mutexattr_setprotocol(3C)
pthread_mutexattr_setpshared(3C)
pthread_mutexattr_setrobust(3C)
pthread_mutex_getprioceiling(3C)
pthread_mutex_reltimedlock_np(3C)
pthread_mutex_setprioceiling(3C)
pthread_rwlockattr_destroy(3C)
pthread_rwlockattr_getpshared(3C)
pthread_rwlockattr_setpshared(3C)
pthread_rwlock_reltimedrdlock_np(3C)
pthread_rwlock_reltimedwrlock_np(3C)
pthread_rwlock_timedrdlock(3C)
pthread_rwlock_timedwrlock(3C)
rctlblk_get_enforced_value(3C)
- get password entry
#include <pwd.h>struct passwd *getpwnam(const char *name);
struct passwd *getpwnam_r(const char *name,struct passwd *pwd,char *buffer,intbuflen);
struct passwd *getpwent(void);
struct passwd *getpwent_r(struct passwd *pwd,char *buffer,intbuflen);
struct passwd *getpwuid(uid_tuid);
struct passwd *getpwuid_r(uid_tuid,struct passwd *pwd,char *buffer,intbuflen);
voidsetpwent(void);
voidendpwent(void);
struct passwd *fgetpwent(FILE *f);
struct passwd *fgetpwent_r(FILE *f,struct passwd *pwd,char *buffer,intbuflen);
cc [flag...]file...-D_POSIX_PTHREAD_SEMANTICS [library... ]intgetpwnam_r(const char *name,struct passwd *pwd,char *buffer,size_tbufsize,struct passwd **result);
intgetpwuid_r(uid_tuid,struct passwd *pwd,char *buffer,size_tbufsize,struct passwd **result);
These functions are used to obtain password entries. Entries can come fromany of the sources forpasswd specified in the/etc/nsswitch.conf file (seensswitch.conf(4)).
Thegetpwnam() function searches for a password entry with the login namespecified by the character string parametername.
Thegetpwuid() function searches for a password entry with the (numeric) userID specified by theuid parameter.
Thesetpwent(),getpwent(), andendpwent() functions are used to enumerate password entriesfrom the database. Thesetpwent() function sets (or resets) the enumeration tothe beginning of the set of password entries. This function should becalled before the first call togetpwent(). Calls togetpwnam() andgetpwuid()leave the enumeration position in an indeterminate state. Successive calls togetpwent()return either successive entries or a null pointer, indicating the end of theenumeration.
Theendpwent() function may be called to indicate that the caller expectsto do no further password retrieval operations; the system may then close the password file, deallocate resources it was using, and so forth. It is still allowed, but possibly less efficient, for the process tocall more password functions after callingendpwent().
Thefgetpwent() function, unlike the other functions above, does not usensswitch.confbut reads and parses the next line from the streamf, whichis assumed to have the format of thepasswd file. Seepasswd(4).
Thegetpwnam(),getpwuid(),getpwent(), andfgetpwent() functions use thread–specific data storage thatis reused in each call to one of these functions by thesame thread, making them safe to use but not recommended for multithreaded applications.
The parallel functionsgetpwnam_r(),getpwuid_r(),getpwent_r(), andfgetpwent_r() provide reentrant interfaces forthese operations.
Each reentrant interface performs the same operation as its non-reentrant counterpart, namedby removing the “ _r ” suffix. The reentrant interfaces, however, use buffers suppliedby the caller to store returned results instead of using thread-specific datathat can be overwritten by each call. They are safe for use inboth single-threaded and multithreaded applications.
Each reentrant interface takes the same parameters as its non-reentrant counterpart, aswell as the following additional parameters. Thepwd parameter must be apointer to astruct passwd structure allocated by the caller. On successful completion, thefunction returns the password entry in this structure. The parameterbuffer isa pointer to a buffer supplied by the caller, used as storagespace for the password data. All pointers within the returnedstruct passwdpwdpoint to data stored within this buffer; seepasswd Structure below. The buffer mustbe large enough to hold all the data associated with the passwordentry. The parameterbuflen (orbufsize for the standard-conforming versions; seestandards(5))should give the size in bytes ofbuffer. The maximum size neededfor this buffer can be determined with the {_SC_GETPW_R_SIZE_MAX}sysconf(3C) parameter. Thestandard-conforming versions place a pointer to the modifiedpwd structure in theresult parameter, instead of returning a pointer to this structure. A null pointeris returned at the location pointed to byresult on error orif the requested entry is not found.
For enumeration in multithreaded applications, the position within the enumeration is aprocess-wide property shared by all threads. Thesetpwent() function can be usedin a multithreaded application but resets the enumeration position for all threads. If multiple threads interleave calls togetpwent_r(), the threads will enumerate disjointsubsets of the password database.
Like their non-reentrant counterparts,getpwnam_r() andgetpwuid_r() leave the enumeration position inan indeterminate state.
Password entries are represented by thestruct passwd structure defined in <pwd.h>:
struct passwd { char *pw_name; /* user's login name */ char *pw_passwd; /* no longer used */ uid_t pw_uid; /* user's uid */ gid_t pw_gid; /* user's gid */ char *pw_age; /* not used */ char *pw_comment; /* not used */ char *pw_gecos; /* typically user's full name */ char *pw_dir; /* user's home dir */ char *pw_shell; /* user's login shell */};Thepw_passwd member should not be used as the encrypted password forthe user; usegetspnam() orgetspnam_r() instead. Seegetspnam(3C).
Thegetpwnam(),getpwnam_r(),getpwuid(), andgetpwuid_r() functions each return a pointer toastruct passwd if they successfully locate the requested entry. A null pointeris returned if the requested entry is not found, or an error occurs.On error,errno is set to indicate the error.
Applications wishing to check for error situations should seterrno to 0before callinggetpwnam(),getpwnam_r(),getpwuid(),getpwuid_r(),getpwent(),getpwent_r(),fgetpwent(), andfgetpwent_r(). Ifthese functions return a null pointer anderrno is non-zero, an erroroccurred.
The standard-conforming functionsgetpwnam_r() andgetpwuid_r() can return0 even on anerror, particularly in the case where the requested entry is not found.The application needs to check the return value and that thepwdpointer is non-null. Otherwise, an error value is returned to indicate the error.
Thegetpwent(),getpwent_r(),fgetpwent(), andfgetpwent_r() functions each return a pointer toastruct passwd if they successfully enumerate an entry; otherwise they return anull pointer on end-of-file or error. On error,errno is set to indicatethe error.
SeeIntro(2) for the proper usage and interpretation oferrno in multithreadedapplications.
Thegetpwnam(),getpwuid(),getpwent(), andfgetpwent() functions use thread–specific data storage, soreturned data must be copied before a subsequent call to any ofthese functions if the data is to be saved.
When the pointer returned by the reentrant functionsgetpwnam_r(),getpwuid_r(),getpwent_r(), andfgetpwent_r() is non-null, it is always equal to thepwd pointer thatwas supplied by the caller.
Thegetpwent_r(),fgetpwent(), andfgetpwent_r() functions will fail if:
An I/O error has occurred.
Insufficient storage was supplied bybuffer andbufsize to contain the data to be referenced by the resultingpasswd structure.
Thegetpwent_r() function will fail if:
There are {OPEN_MAX} file descriptors currently open in the calling process.
The maximum allowable number of files is currently open in the system.
Thegetpwnam(),getpwnam_r(),getpwuid(),getpwuid_r(),getpwent(),setpwent(), andendpwent() functions may failif:
An I/O error has occurred.
Thegetpwnam(),getpwnam_r(),getpwuid(),getpwuid_r(),getpwent(), andsetpwent() functions may fail if:
There are {OPEN_MAX} file descriptors currently open in the calling process.
The maximum allowable number of files is currently open in the system.
Thegetpwnam(),getpwnam_r(),getpwuid(), andgetpwuid_r() functions may fail if:
A signal was caught during the execution of the function call.
Thegetpwnam_r() andgetpwuid_r() functions may fail if:
Insufficient storage was supplied bybuffer andbufsize to contain the data to be referenced by the resultingpasswd structure.
Three names associated with the current process can be determined:getpwuid(geteuid()) returnsthe name associated with the effective user ID of the process;getlogin()returns the name associated with the current login activity; andgetpwuid(getuid()) returnsthe name associated with the real user ID of the process.
Seeattributes(5) for descriptions of the following attributes:
|
Forendpwent(),getpwent(),getpwnam(),getpwnam_r(),getpwuid(),getpwuid_r(), andsetpwent(),seestandards(5).
passwd(1),yppasswd(1),Intro(2),Intro(3),cuserid(3C),getgrnam(3C),getlogin(3C),getspnam(3C),nsswitch.conf(4),passwd(4),shadow(4),attributes(5),standards(5)
When compiling multithreaded programs, seeIntro(3).
Use of the enumeration interfacesgetpwent() andgetpwent_r() is discouraged; enumeration issupported for thepasswd file and NIS, but in general is notefficient and might not be supported for all database sources. The semanticsof enumeration are discussed further innsswitch.conf(4).
Previous releases allowed the use of `+' and `-' entries in/etc/passwdto selectively include and exclude NIS entries. The primary usage of these`+/-' entries is superseded by the name service switch, so the `+/-'form might not be supported in future releases.
If required, the `+/-' functionality can still be obtained for NIS byspecifyingcompat as the source forpasswd.
If the `+/-' is used, both/etc/shadow and/etc/passwd should have thesame `+' and `-' entries to ensure consistency between the password andshadow databases.
If a password entry from any of the sources contains an emptyuid orgid field, that entry will be ignored by the filesand NIS name service switch backends, causing the user to appear unknownto the system.
If a password entry contains an emptygecos,home directory, orshell field,getpwnam() andgetpwnam_r() return a pointer to a null string in therespective field of thepasswd structure.
If the shell field is empty,login(1) automatically assigns the default shell. Seelogin(1).
Solaris 2.4 and earlier releases provided definitions of thegetpwnam_r() andgetpwuid_r()functions as specified in POSIX.1c Draft 6. The final POSIX.1c standard changedthe interface for these functions. Support for the Draft 6 interface isprovided for compatibility only and might not be supported in future releases. Newapplications and libraries should use the standard-conforming interface.
For POSIX.1c-conforming applications, the_POSIX_PTHREAD_SEMANTICS and_REENTRANT flags are automatically turned onby defining the_POSIX_C_SOURCE flag with a value ≥199506L.
Copyright © 2011, Oracle and/or its affiliates. All rights reserved.Legal Notices |   |