home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _e4d3d84101cdae1a90283e3e52d30cca < prev    next >
Text File  |  2000-03-23  |  7KB  |  162 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>User::pwent - by-name interface to Perl's built-in getpw* functions</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> User::pwent - by-name interface to Perl's built-in getpw* functions</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#system specifics">System Specifics</A></LI>
  28.     </UL>
  29.  
  30.     <LI><A HREF="#note">NOTE</A></LI>
  31.     <LI><A HREF="#author">AUTHOR</A></LI>
  32.     <LI><A HREF="#history">HISTORY</A></LI>
  33. </UL>
  34. <!-- INDEX END -->
  35.  
  36. <HR>
  37. <P>
  38. <H1><A NAME="name">NAME</A></H1>
  39. <P>User::pwent - by-name interface to Perl's built-in getpw*() functions</P>
  40. <P>
  41. <HR>
  42. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  43. <UL>
  44. <LI>Linux</LI>
  45. <LI>Solaris</LI>
  46. <LI>Windows</LI>
  47. </UL>
  48. <HR>
  49. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  50. <PRE>
  51.  use User::pwent;
  52.  $pw = getpwnam('daemon')       || die "No daemon user";
  53.  if ( $pw->uid == 1 && $pw->dir =~ m#^/(bin|tmp)?\z#s ) {
  54.      print "gid 1 on root dir";
  55.  }</PRE>
  56. <PRE>
  57.  $real_shell = $pw->shell || '/bin/sh';</PRE>
  58. <PRE>
  59.  for (($fullname, $office, $workphone, $homephone) =
  60.         split /\s*,\s*/, $pw->gecos)
  61.  {
  62.     s/&/ucfirst(lc($pw->name))/ge;
  63.  }</PRE>
  64. <PRE>
  65.  use User::pwent qw(:FIELDS);
  66.  getpwnam('daemon')             || die "No daemon user";
  67.  if ( $pw_uid == 1 && $pw_dir =~ m#^/(bin|tmp)?\z#s ) {
  68.      print "gid 1 on root dir";
  69.  }</PRE>
  70. <PRE>
  71.  $pw = getpw($whoever);</PRE>
  72. <PRE>
  73.  use User::pwent qw/:DEFAULT pw_has/;
  74.  if (pw_has(qw[gecos expire quota])) { .... }
  75.  if (pw_has("name uid gid passwd"))  { .... }
  76.  print "Your struct pwd has: ", scalar pw_has(), "\n";</PRE>
  77. <P>
  78. <HR>
  79. <H1><A NAME="description">DESCRIPTION</A></H1>
  80. <P>This module's default exports override the core getpwent(), getpwuid(),
  81. and <A HREF="../../lib/Pod/perlfunc.html#item_getpwnam"><CODE>getpwnam()</CODE></A> functions, replacing them with versions that return
  82. <CODE>User::pwent</CODE> objects.  This object has methods that return the
  83. similarly named structure field name from the C's passwd structure
  84. from <EM>pwd.h</EM>, stripped of their leading ``pw_'' parts, namely <CODE>name</CODE>,
  85. <CODE>passwd</CODE>, <CODE>uid</CODE>, <CODE>gid</CODE>, <CODE>change</CODE>, <CODE>age</CODE>, <CODE>quota</CODE>, <CODE>comment</CODE>,
  86. <CODE>class</CODE>, <CODE>gecos</CODE>, <CODE>dir</CODE>, <CODE>shell</CODE>, and <CODE>expire</CODE>.  The <CODE>passwd</CODE>,
  87. <CODE>gecos</CODE>, and <CODE>shell</CODE> fields are tainted when running in taint mode.</P>
  88. <P>You may also import all the structure fields directly into your
  89. namespace as regular variables using the :FIELDS import tag.  (Note
  90. that this still overrides your core functions.)  Access these fields
  91. as variables named with a preceding <CODE>pw_</CODE> in front their method
  92. names.  Thus, <CODE>$passwd_obj->shell</CODE> corresponds to $pw_shell
  93. if you import the fields.</P>
  94. <P>The <CODE>getpw()</CODE> function is a simple front-end that forwards
  95. a numeric argument to <A HREF="../../lib/Pod/perlfunc.html#item_getpwuid"><CODE>getpwuid()</CODE></A> and the rest to getpwnam().</P>
  96. <P>To access this functionality without the core overrides, pass the
  97. <A HREF="../../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A> an empty import list, and then access function functions
  98. with their full qualified names.  The built-ins are always still
  99. available via the <CODE>CORE::</CODE> pseudo-package.</P>
  100. <P>
  101. <H2><A NAME="system specifics">System Specifics</A></H2>
  102. <P>Perl believes that no machine ever has more than one of <CODE>change</CODE>,
  103. <CODE>age</CODE>, or <CODE>quota</CODE> implemented, nor more than one of either
  104. <CODE>comment</CODE> or <CODE>class</CODE>.  Some machines do not support <CODE>expire</CODE>,
  105. <CODE>gecos</CODE>, or allegedly, <CODE>passwd</CODE>.  You may call these methods
  106. no matter what machine you're on, but they return <A HREF="../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if
  107. unimplemented.</P>
  108. <P>You may ask whether one of these was implemented on the system Perl
  109. was built on by asking the importable <CODE>pw_has</CODE> function about them.
  110. This function returns true if all parameters are supported fields
  111. on the build platform, false if one or more were not, and raises
  112. an exception if you asked about a field that Perl never knows how
  113. to provide.  Parameters may be in a space-separated string, or as
  114. separate arguments.  If you pass no parameters, the function returns
  115. the list of <CODE>struct pwd</CODE> fields supported by your build platform's
  116. C library, as a list in list context, or a space-separated string
  117. in scalar context.  Note that just because your C library had
  118. a field doesn't necessarily mean that it's fully implemented on
  119. that system.</P>
  120. <P>Interpretation of the <CODE>gecos</CODE> field varies between systems, but
  121. traditionally holds 4 comma-separated fields containing the user's
  122. full name, office location, work phone number, and home phone number.
  123. An <CODE>&</CODE> in the gecos field should be replaced by the user's properly
  124. capitalized login <CODE>name</CODE>.  The <CODE>shell</CODE> field, if blank, must be
  125. assumed to be <EM>/bin/sh</EM>.  Perl does not do this for you.  The
  126. <CODE>passwd</CODE> is one-way hashed garble, not clear text, and may not be
  127. unhashed save by brute-force guessing.  Secure systems use more a
  128. more secure hashing than DES.  On systems supporting shadow password
  129. systems, Perl automatically returns the shadow password entry when
  130. called by a suitably empowered user, even if your underlying
  131. vendor-provided C library was too short-sighted to realize it should
  132. do this.</P>
  133. <P>See <CODE>passwd(5)</CODE> and <A HREF="../../lib/Pod/perlfunc.html#item_getpwent"><CODE>getpwent(3)</CODE></A> for details.</P>
  134. <P>
  135. <HR>
  136. <H1><A NAME="note">NOTE</A></H1>
  137. <P>While this class is currently implemented using the Class::Struct
  138. module to build a struct-like class, you shouldn't rely upon this.</P>
  139. <P>
  140. <HR>
  141. <H1><A NAME="author">AUTHOR</A></H1>
  142. <P>Tom Christiansen</P>
  143. <P>
  144. <HR>
  145. <H1><A NAME="history">HISTORY</A></H1>
  146. <DL>
  147. <DT><STRONG><A NAME="item_March_18th%2C_2000">March 18th, 2000</A></STRONG><BR>
  148. <DD>
  149. Reworked internals to support better interface to dodgey fields
  150. than normal Perl function provides.  Added <CODE>pw_has()</CODE> field.  Improved
  151. documentation.
  152. <P></P></DL>
  153. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  154. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  155. <STRONG><P CLASS=block> User::pwent - by-name interface to Perl's built-in getpw* functions</P></STRONG>
  156. </TD></TR>
  157. </TABLE>
  158.  
  159. </BODY>
  160.  
  161. </HTML>
  162.