home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / man / cat3 / getpwent.0 < prev    next >
Text File  |  1993-12-07  |  5KB  |  133 lines
  1.  
  2. GETPWENT(3)                UNIX Programmer's Manual                GETPWENT(3)
  3.  
  4. NNAAMMEE
  5.      ggeettppwweenntt, ggeettppwwnnaamm, ggeettppwwuuiidd, sseettppaasssseenntt, sseettppwweenntt, eennddppwweenntt - password
  6.      database operations
  7.  
  8. SSYYNNOOPPSSIISS
  9.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  10.      ##iinncclluuddee <<ppwwdd..hh>>
  11.  
  12.      _s_t_r_u_c_t _p_a_s_s_w_d _*
  13.      ggeettppwweenntt(_v_o_i_d)
  14.  
  15.      _s_t_r_u_c_t _p_a_s_s_w_d _*
  16.      ggeettppwwnnaamm(_c_o_n_s_t _c_h_a_r _*_l_o_g_i_n)
  17.  
  18.      _s_t_r_u_c_t _p_a_s_s_w_d _*
  19.      ggeettppwwuuiidd(_u_i_d___t _u_i_d)
  20.  
  21.      _i_n_t
  22.      sseettppaasssseenntt(_i_n_t _s_t_a_y_o_p_e_n)
  23.  
  24.      _i_n_t
  25.      sseettppwweenntt(_v_o_i_d)
  26.  
  27.      _v_o_i_d
  28.      eennddppwweenntt(_v_o_i_d)
  29.  
  30. DDEESSCCRRIIPPTTIIOONN
  31.      These functions operate on the password database file which is described
  32.      in passwd(5).  Each entry in the database is defined by the structure
  33.      _p_a_s_s_w_d found in the include file <_p_w_d_._h>:
  34.  
  35.            struct passwd {
  36.                    char    *pw_name;       /* user name */
  37.                    char    *pw_passwd;     /* encrypted password */
  38.                    uid_t   pw_uid;         /* user uid */
  39.                    gid_t   pw_gid;         /* user gid */
  40.                    time_t  pw_change;      /* password change time */
  41.                    char    *pw_class;      /* user access class */
  42.                    char    *pw_gecos;      /* Honeywell login info */
  43.                    char    *pw_dir;        /* home directory */
  44.                    char    *pw_shell;      /* default shell */
  45.                    time_t  pw_expire;      /* account expiration */
  46.            };
  47.  
  48.      The functions ggeettppwwnnaamm() and ggeettppwwuuiidd() search the password database for
  49.      the given login name or user uid, respectively, always returning the
  50.      first one encountered.
  51.  
  52.      The ggeettppwweenntt() function sequentially reads the password database and is
  53.      intended for programs that wish to process the complete list of users.
  54.  
  55.      The sseettppaasssseenntt() function accomplishes two purposes.  First, it causes
  56.      ggeettppwweenntt() to ``rewind'' to the beginning of the database.  Additionally,
  57.      if _s_t_a_y_o_p_e_n is non­zero, file descriptors are left open, significantly
  58.      speeding up subsequent accesses for all of the routines.  (This latter
  59.      functionality is unnecessary for ggeettppwweenntt() as it doesn't close its file
  60.      descriptors by default.)
  61.  
  62.      It is dangerous for long­running programs to keep the file descriptors
  63.      open the database will become out of date if it is updated while the pro­
  64.      gram is running.
  65.  
  66.  
  67.      The sseettppwweenntt() function is identical to sseettppaasssseenntt() with an argument of
  68.      zero.
  69.  
  70.      The eennddppwweenntt() function closes any open files.
  71.  
  72.      These routines have been written to ``shadow'' the password file, e.g.
  73.      allow only certain programs to have access to the encrypted password.  If
  74.      the process which calls them has an effective uid of 0, the encrypted
  75.      password will be returned, otherwise, the password field of the retuned
  76.      structure will point to the string `*'.
  77.  
  78. RREETTUURRNN VVAALLUUEESS
  79.      The functions ggeettppwweenntt(), ggeettppwwnnaamm(), and ggeettppwwuuiidd(), return a valid
  80.      pointer to a passwd structure on success and a null pointer if end­of­
  81.      file is reached or an error occurs.  The functions sseettppaasssseenntt() and
  82.      sseettppwweenntt() return 0 on failure and 1 on success.  The eennddppwweenntt() function
  83.      has no return value.
  84.  
  85. FFIILLEESS
  86.      /var/db/pwd.db      The insecure password database file
  87.      /var/db/spwd.db     The secure password database file
  88.      /etc/master.passwd  The current password file
  89.      /etc/passwd         A Version 7 format password file
  90.  
  91. SSEEEE AALLSSOO
  92.      getlogin(3),  getgrent(3),  passwd(5),  pwd_mkdb(8),  vipw(8)
  93.  
  94. HHIISSTTOORRYY
  95.      The ggeettppwweenntt, ggeettppwwnnaamm, ggeettppwwuuiidd, sseettppwweenntt,, and eennddppwweenntt functions ap­
  96.      peared in Version 7 AT&T UNIX.  The sseettppaasssseenntt function appeared in
  97.      4.3BSD-Reno.
  98.  
  99. BBUUGGSS
  100.      The functions ggeettppwweenntt(), ggeettppwwnnaamm(), and ggeettppwwuuiidd(), leave their results
  101.      in an internal static object and return a pointer to that object. Subse­
  102.      quent calls to the same function will modify the same object.
  103.  
  104.      The routines ggeettppwweenntt(), eennddppwweenntt(), sseettppaasssseenntt(), and sseettppwweenntt() are
  105.      fairly useless in a networked environment and should be avoided, if pos­
  106.      sible.
  107.  
  108. CCOOMMPPAATTIIBBIILLIITTYY
  109.      The historic function setpwfile(3),  which allowed the specification of
  110.      alternate password databases, has been deprecated and is no longer avail­
  111.      able.
  112.  
  113. BSD Experimental                April 19, 1991                               2
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.