home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _5a8fe8bf8d227dbadbc786d86a75ed3d < prev    next >
Text File  |  2000-03-23  |  21KB  |  365 lines

  1. <HTML>
  2. <HEAD>
  3. <TITLE>perlsec - Perl security</TITLE>
  4. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  5. <LINK REV="made" HREF="mailto:">
  6. </HEAD>
  7.  
  8. <BODY>
  9. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  10. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  11. <STRONG><P CLASS=block> perlsec - Perl security</P></STRONG>
  12. </TD></TR>
  13. </TABLE>
  14.  
  15. <A NAME="__index__"></A>
  16. <!-- INDEX BEGIN -->
  17.  
  18. <UL>
  19.  
  20.     <LI><A HREF="#name">NAME</A></LI>
  21.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  22.     <UL>
  23.  
  24.         <LI><A HREF="#laundering and detecting tainted data">Laundering and Detecting Tainted Data</A></LI>
  25.         <LI><A HREF="#switches on the #! line">Switches On the ``#!'' Line</A></LI>
  26.         <LI><A HREF="#cleaning up your path">Cleaning Up Your Path</A></LI>
  27.         <LI><A HREF="#security bugs">Security Bugs</A></LI>
  28.         <LI><A HREF="#protecting your programs">Protecting Your Programs</A></LI>
  29.     </UL>
  30.  
  31.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  32. </UL>
  33. <!-- INDEX END -->
  34.  
  35. <HR>
  36. <P>
  37. <H1><A NAME="name">NAME</A></H1>
  38. <P>perlsec - Perl security</P>
  39. <P>
  40. <HR>
  41. <H1><A NAME="description">DESCRIPTION</A></H1>
  42. <P>Perl is designed to make it easy to program securely even when running
  43. with extra privileges, like setuid or setgid programs.  Unlike most
  44. command line shells, which are based on multiple substitution passes on
  45. each line of the script, Perl uses a more conventional evaluation scheme
  46. with fewer hidden snags.  Additionally, because the language has more
  47. builtin functionality, it can rely less upon external (and possibly
  48. untrustworthy) programs to accomplish its purposes.</P>
  49. <P>Perl automatically enables a set of special security checks, called <EM>taint
  50. mode</EM>, when it detects its program running with differing real and effective
  51. user or group IDs.  The setuid bit in Unix permissions is mode 04000, the
  52. setgid bit mode 02000; either or both may be set.  You can also enable taint
  53. mode explicitly by using the <STRONG>-T</STRONG> command line flag. This flag is
  54. <EM>strongly</EM> suggested for server programs and any program run on behalf of
  55. someone else, such as a CGI script. Once taint mode is on, it's on for
  56. the remainder of your script.</P>
  57. <P>While in this mode, Perl takes special precautions called <EM>taint
  58. checks</EM> to prevent both obvious and subtle traps.  Some of these checks
  59. are reasonably simple, such as verifying that path directories aren't
  60. writable by others; careful programmers have always used checks like
  61. these.  Other checks, however, are best supported by the language itself,
  62. and it is these checks especially that contribute to making a set-id Perl
  63. program more secure than the corresponding C program.</P>
  64. <P>You may not use data derived from outside your program to affect
  65. something else outside your program--at least, not by accident.  All
  66. command line arguments, environment variables, locale information (see
  67. <A HREF="../../lib/Pod/perllocale.html">the perllocale manpage</A>), results of certain system calls (readdir(),
  68. readlink(), the variable of shmread(), the messages returned by
  69. msgrcv(), the password, gcos and shell fields returned by the
  70. <CODE>getpwxxx()</CODE> calls), and all file input are marked as ``tainted''.
  71. Tainted data may not be used directly or indirectly in any command
  72. that invokes a sub-shell, nor in any command that modifies files,
  73. directories, or processes. (<STRONG>Important exception</STRONG>: If you pass a list
  74. of arguments to either <A HREF="../../lib/Pod/perlfunc.html#item_system"><CODE>system</CODE></A> or <A HREF="../../lib/Pod/perlfunc.html#item_exec"><CODE>exec</CODE></A>, the elements of that list
  75. are <STRONG>NOT</STRONG> checked for taintedness.) Any variable set to a value
  76. derived from tainted data will itself be tainted, even if it is
  77. logically impossible for the tainted data to alter the variable.
  78. Because taintedness is associated with each scalar value, some
  79. elements of an array can be tainted and others not.</P>
  80. <P>For example:</P>
  81. <PRE>
  82.     $arg = shift;               # $arg is tainted
  83.     $hid = $arg, 'bar';         # $hid is also tainted
  84.     $line = <>;                 # Tainted
  85.     $line = <STDIN>;            # Also tainted
  86.     open FOO, "/home/me/bar" or die $!;
  87.     $line = <FOO>;              # Still tainted
  88.     $path = $ENV{'PATH'};       # Tainted, but see below
  89.     $data = 'abc';              # Not tainted</PRE>
  90. <PRE>
  91.     system "echo $arg";         # Insecure
  92.     system "/bin/echo", $arg;   # Secure (doesn't use sh)
  93.     system "echo $hid";         # Insecure
  94.     system "echo $data";        # Insecure until PATH set</PRE>
  95. <PRE>
  96.     $path = $ENV{'PATH'};       # $path now tainted</PRE>
  97. <PRE>
  98.     $ENV{'PATH'} = '/bin:/usr/bin';
  99.     delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};</PRE>
  100. <PRE>
  101.     $path = $ENV{'PATH'};       # $path now NOT tainted
  102.     system "echo $data";        # Is secure now!</PRE>
  103. <PRE>
  104.     open(FOO, "< $arg");        # OK - read-only file
  105.     open(FOO, "> $arg");        # Not OK - trying to write</PRE>
  106. <PRE>
  107.     open(FOO,"echo $arg|");     # Not OK, but...
  108.     open(FOO,"-|")
  109.         or exec 'echo', $arg;   # OK</PRE>
  110. <PRE>
  111.     $shout = `echo $arg`;       # Insecure, $shout now tainted</PRE>
  112. <PRE>
  113.     unlink $data, $arg;         # Insecure
  114.     umask $arg;                 # Insecure</PRE>
  115. <PRE>
  116.     exec "echo $arg";           # Insecure
  117.     exec "echo", $arg;          # Secure (doesn't use the shell)
  118.     exec "sh", '-c', $arg;      # Considered secure, alas!</PRE>
  119. <PRE>
  120.     @files = <*.c>;             # insecure (uses readdir() or similar)
  121.     @files = glob('*.c');       # insecure (uses readdir() or similar)</PRE>
  122. <P>If you try to do something insecure, you will get a fatal error saying
  123. something like ``Insecure dependency'' or ``Insecure $ENV{PATH}''.  Note that you
  124. can still write an insecure <STRONG>system</STRONG> or <STRONG>exec</STRONG>, but only by explicitly
  125. doing something like the ``considered secure'' example above.</P>
  126. <P>
  127. <H2><A NAME="laundering and detecting tainted data">Laundering and Detecting Tainted Data</A></H2>
  128. <P>To test whether a variable contains tainted data, and whose use would thus
  129. trigger an ``Insecure dependency'' message, check your nearby CPAN mirror
  130. for the <EM>Taint.pm</EM> module, which should become available around November
  131. 1997.  Or you may be able to use the following <EM>is_tainted()</EM> function.</P>
  132. <PRE>
  133.     sub is_tainted {
  134.         return ! eval {
  135.             join('',@_), kill 0;
  136.             1;
  137.         };
  138.     }</PRE>
  139. <P>This function makes use of the fact that the presence of tainted data
  140. anywhere within an expression renders the entire expression tainted.  It
  141. would be inefficient for every operator to test every argument for
  142. taintedness.  Instead, the slightly more efficient and conservative
  143. approach is used that if any tainted value has been accessed within the
  144. same expression, the whole expression is considered tainted.</P>
  145. <P>But testing for taintedness gets you only so far.  Sometimes you have just
  146. to clear your data's taintedness.  The only way to bypass the tainting
  147. mechanism is by referencing subpatterns from a regular expression match.
  148. Perl presumes that if you reference a substring using $1, $2, etc., that
  149. you knew what you were doing when you wrote the pattern.  That means using
  150. a bit of thought--don't just blindly untaint anything, or you defeat the
  151. entire mechanism.  It's better to verify that the variable has only good
  152. characters (for certain values of ``good'') rather than checking whether it
  153. has any bad characters.  That's because it's far too easy to miss bad
  154. characters that you never thought of.</P>
  155. <P>Here's a test to make sure that the data contains nothing but ``word''
  156. characters (alphabetics, numerics, and underscores), a hyphen, an at sign,
  157. or a dot.</P>
  158. <PRE>
  159.     if ($data =~ /^([-\@\w.]+)$/) {
  160.         $data = $1;                     # $data now untainted
  161.     } else {
  162.         die "Bad data in $data";        # log this somewhere
  163.     }</PRE>
  164. <P>This is fairly secure because <CODE>/\w+/</CODE> doesn't normally match shell
  165. metacharacters, nor are dot, dash, or at going to mean something special
  166. to the shell.  Use of <CODE>/.+/</CODE> would have been insecure in theory because
  167. it lets everything through, but Perl doesn't check for that.  The lesson
  168. is that when untainting, you must be exceedingly careful with your patterns.
  169. Laundering data using regular expression is the <EM>only</EM> mechanism for
  170. untainting dirty data, unless you use the strategy detailed below to fork
  171. a child of lesser privilege.</P>
  172. <P>The example does not untaint $data if <CODE>use locale</CODE> is in effect,
  173. because the characters matched by <CODE>\w</CODE> are determined by the locale.
  174. Perl considers that locale definitions are untrustworthy because they
  175. contain data from outside the program.  If you are writing a
  176. locale-aware program, and want to launder data with a regular expression
  177. containing <CODE>\w</CODE>, put <CODE>no locale</CODE> ahead of the expression in the same
  178. block.  See <A HREF="../../lib/Pod/perllocale.html#security">SECURITY in the perllocale manpage</A> for further discussion and examples.</P>
  179. <P>
  180. <H2><A NAME="switches on the #! line">Switches On the ``#!'' Line</A></H2>
  181. <P>When you make a script executable, in order to make it usable as a
  182. command, the system will pass switches to perl from the script's #!
  183. line.  Perl checks that any command line switches given to a setuid
  184. (or setgid) script actually match the ones set on the #! line.  Some
  185. Unix and Unix-like environments impose a one-switch limit on the #!
  186. line, so you may need to use something like <CODE>-wU</CODE> instead of <CODE>-w -U</CODE>
  187. under such systems.  (This issue should arise only in Unix or
  188. Unix-like environments that support #! and setuid or setgid scripts.)</P>
  189. <P>
  190. <H2><A NAME="cleaning up your path">Cleaning Up Your Path</A></H2>
  191. <P>For ``Insecure <CODE>$ENV{PATH}</CODE>'' messages, you need to set <CODE>$ENV{'PATH'}</CODE> to a
  192. known value, and each directory in the path must be non-writable by others
  193. than its owner and group.  You may be surprised to get this message even
  194. if the pathname to your executable is fully qualified.  This is <EM>not</EM>
  195. generated because you didn't supply a full path to the program; instead,
  196. it's generated because you never set your PATH environment variable, or
  197. you didn't set it to something that was safe.  Because Perl can't
  198. guarantee that the executable in question isn't itself going to turn
  199. around and execute some other program that is dependent on your PATH, it
  200. makes sure you set the PATH.</P>
  201. <P>The PATH isn't the only environment variable which can cause problems.
  202. Because some shells may use the variables IFS, CDPATH, ENV, and
  203. BASH_ENV, Perl checks that those are either empty or untainted when
  204. starting subprocesses. You may wish to add something like this to your
  205. setid and taint-checking scripts.</P>
  206. <PRE>
  207.     delete @ENV{qw(IFS CDPATH ENV BASH_ENV)};   # Make %ENV safer</PRE>
  208. <P>It's also possible to get into trouble with other operations that don't
  209. care whether they use tainted values.  Make judicious use of the file
  210. tests in dealing with any user-supplied filenames.  When possible, do
  211. opens and such <STRONG>after</STRONG> properly dropping any special user (or group!)
  212. privileges. Perl doesn't prevent you from opening tainted filenames for reading,
  213. so be careful what you print out.  The tainting mechanism is intended to
  214. prevent stupid mistakes, not to remove the need for thought.</P>
  215. <P>Perl does not call the shell to expand wild cards when you pass <STRONG>system</STRONG>
  216. and <STRONG>exec</STRONG> explicit parameter lists instead of strings with possible shell
  217. wildcards in them.  Unfortunately, the <STRONG>open</STRONG>, <STRONG>glob</STRONG>, and
  218. backtick functions provide no such alternate calling convention, so more
  219. subterfuge will be required.</P>
  220. <P>Perl provides a reasonably safe way to open a file or pipe from a setuid
  221. or setgid program: just create a child process with reduced privilege who
  222. does the dirty work for you.  First, fork a child using the special
  223. <STRONG>open</STRONG> syntax that connects the parent and child by a pipe.  Now the
  224. child resets its ID set and any other per-process attributes, like
  225. environment variables, umasks, current working directories, back to the
  226. originals or known safe values.  Then the child process, which no longer
  227. has any special permissions, does the <STRONG>open</STRONG> or other system call.
  228. Finally, the child passes the data it managed to access back to the
  229. parent.  Because the file or pipe was opened in the child while running
  230. under less privilege than the parent, it's not apt to be tricked into
  231. doing something it shouldn't.</P>
  232. <P>Here's a way to do backticks reasonably safely.  Notice how the <STRONG>exec</STRONG> is
  233. not called with a string that the shell could expand.  This is by far the
  234. best way to call something that might be subjected to shell escapes: just
  235. never call the shell at all.</P>
  236. <PRE>
  237.     use English;
  238.     die "Can't fork: $!" unless defined $pid = open(KID, "-|");
  239.     if ($pid) {           # parent
  240.         while (<KID>) {
  241.             # do something
  242.         }
  243.         close KID;
  244.     } else {
  245.         my @temp = ($EUID, $EGID);
  246.         $EUID = $UID;
  247.         $EGID = $GID;    #      initgroups() also called!
  248.         # Make sure privs are really gone
  249.         ($EUID, $EGID) = @temp;
  250.         die "Can't drop privileges" 
  251.                 unless $UID == $EUID  && $GID eq $EGID; 
  252.         $ENV{PATH} = "/bin:/usr/bin";
  253.         exec 'myprog', 'arg1', 'arg2' 
  254.             or die "can't exec myprog: $!";
  255.     }</PRE>
  256. <P>A similar strategy would work for wildcard expansion via <A HREF="../../lib/Pod/perlfunc.html#item_glob"><CODE>glob</CODE></A>, although
  257. you can use <A HREF="../../lib/Pod/perlfunc.html#item_readdir"><CODE>readdir</CODE></A> instead.</P>
  258. <P>Taint checking is most useful when although you trust yourself not to have
  259. written a program to give away the farm, you don't necessarily trust those
  260. who end up using it not to try to trick it into doing something bad.  This
  261. is the kind of security checking that's useful for set-id programs and
  262. programs launched on someone else's behalf, like CGI programs.</P>
  263. <P>This is quite different, however, from not even trusting the writer of the
  264. code not to try to do something evil.  That's the kind of trust needed
  265. when someone hands you a program you've never seen before and says, ``Here,
  266. run this.''  For that kind of safety, check out the Safe module,
  267. included standard in the Perl distribution.  This module allows the
  268. programmer to set up special compartments in which all system operations
  269. are trapped and namespace access is carefully controlled.</P>
  270. <P>
  271. <H2><A NAME="security bugs">Security Bugs</A></H2>
  272. <P>Beyond the obvious problems that stem from giving special privileges to
  273. systems as flexible as scripts, on many versions of Unix, set-id scripts
  274. are inherently insecure right from the start.  The problem is a race
  275. condition in the kernel.  Between the time the kernel opens the file to
  276. see which interpreter to run and when the (now-set-id) interpreter turns
  277. around and reopens the file to interpret it, the file in question may have
  278. changed, especially if you have symbolic links on your system.</P>
  279. <P>Fortunately, sometimes this kernel ``feature'' can be disabled.
  280. Unfortunately, there are two ways to disable it.  The system can simply
  281. outlaw scripts with any set-id bit set, which doesn't help much.
  282. Alternately, it can simply ignore the set-id bits on scripts.  If the
  283. latter is true, Perl can emulate the setuid and setgid mechanism when it
  284. notices the otherwise useless setuid/gid bits on Perl scripts.  It does
  285. this via a special executable called <STRONG>suidperl</STRONG> that is automatically
  286. invoked for you if it's needed.</P>
  287. <P>However, if the kernel set-id script feature isn't disabled, Perl will
  288. complain loudly that your set-id script is insecure.  You'll need to
  289. either disable the kernel set-id script feature, or put a C wrapper around
  290. the script.  A C wrapper is just a compiled program that does nothing
  291. except call your Perl program.   Compiled programs are not subject to the
  292. kernel bug that plagues set-id scripts.  Here's a simple wrapper, written
  293. in C:</P>
  294. <PRE>
  295.     #define REAL_PATH "/path/to/script"
  296.     main(ac, av)
  297.         char **av;
  298.     {
  299.         execv(REAL_PATH, av);
  300.     }</PRE>
  301. <P>Compile this wrapper into a binary executable and then make <EM>it</EM> rather
  302. than your script setuid or setgid.</P>
  303. <P>See the program <STRONG>wrapsuid</STRONG> in the <EM>eg</EM> directory of your Perl
  304. distribution for a convenient way to do this automatically for all your
  305. setuid Perl programs.  It moves setuid scripts into files with the same
  306. name plus a leading dot, and then compiles a wrapper like the one above
  307. for each of them.</P>
  308. <P>In recent years, vendors have begun to supply systems free of this
  309. inherent security bug.  On such systems, when the kernel passes the name
  310. of the set-id script to open to the interpreter, rather than using a
  311. pathname subject to meddling, it instead passes <EM>/dev/fd/3</EM>.  This is a
  312. special file already opened on the script, so that there can be no race
  313. condition for evil scripts to exploit.  On these systems, Perl should be
  314. compiled with <CODE>-DSETUID_SCRIPTS_ARE_SECURE_NOW</CODE>.  The <STRONG>Configure</STRONG>
  315. program that builds Perl tries to figure this out for itself, so you
  316. should never have to specify this yourself.  Most modern releases of
  317. SysVr4 and BSD 4.4 use this approach to avoid the kernel race condition.</P>
  318. <P>Prior to release 5.003 of Perl, a bug in the code of <STRONG>suidperl</STRONG> could
  319. introduce a security hole in systems compiled with strict POSIX
  320. compliance.</P>
  321. <P>
  322. <H2><A NAME="protecting your programs">Protecting Your Programs</A></H2>
  323. <P>There are a number of ways to hide the source to your Perl programs,
  324. with varying levels of ``security''.</P>
  325. <P>First of all, however, you <EM>can't</EM> take away read permission, because
  326. the source code has to be readable in order to be compiled and
  327. interpreted.  (That doesn't mean that a CGI script's source is
  328. readable by people on the web, though.)  So you have to leave the
  329. permissions at the socially friendly 0755 level.  This lets 
  330. people on your local system only see your source.</P>
  331. <P>Some people mistakenly regard this as a security problem.  If your program does
  332. insecure things, and relies on people not knowing how to exploit those
  333. insecurities, it is not secure.  It is often possible for someone to
  334. determine the insecure things and exploit them without viewing the
  335. source.  Security through obscurity, the name for hiding your bugs
  336. instead of fixing them, is little security indeed.</P>
  337. <P>You can try using encryption via source filters (Filter::* from CPAN).
  338. But crackers might be able to decrypt it.  You can try using the
  339. byte code compiler and interpreter described below, but crackers might
  340. be able to de-compile it.  You can try using the native-code compiler
  341. described below, but crackers might be able to disassemble it.  These
  342. pose varying degrees of difficulty to people wanting to get at your
  343. code, but none can definitively conceal it (this is true of every
  344. language, not just Perl).</P>
  345. <P>If you're concerned about people profiting from your code, then the
  346. bottom line is that nothing but a restrictive licence will give you
  347. legal security.  License your software and pepper it with threatening
  348. statements like ``This is unpublished proprietary software of XYZ Corp.
  349. Your access to it does not give you permission to use it blah blah
  350. blah.''  You should see a lawyer to be sure your licence's wording will
  351. stand up in court.</P>
  352. <P>
  353. <HR>
  354. <H1><A NAME="see also">SEE ALSO</A></H1>
  355. <P><A HREF="../../lib/Pod/perlrun.html">the perlrun manpage</A> for its description of cleaning up environment variables.</P>
  356. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  357. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  358. <STRONG><P CLASS=block> perlsec - Perl security</P></STRONG>
  359. </TD></TR>
  360. </TABLE>
  361.  
  362. </BODY>
  363.  
  364. </HTML>
  365.