File-Policy-1.005/0000755000177600001460000000000010254023475015112 5ustar simonftechnical00000000000000File-Policy-1.005/README0000644000177600001460000000255010254023323015764 0ustar simonftechnical00000000000000File::Policy v1.005 (c) BBC 2004. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt QUICK START: Install File::Policy by unpacking the tarball and running the following commands in the source directory: perl Makefile.PL make make test make install Then delete the source directory tree since it's no longer needed. By using File::Policy (or File::Slurp::WithinPolicy) in your code you get File::Policy::Default by, erm, default. This imposes no restrictions on filepaths, but does provide reasonable default temp and log dirs for you. See the POD for File::Policy::Default to see how these paths are determined. To implement your own custom policy cp File/Policy/Default.pm File/Policy/YourPolicy.pm and modify YourPolicy accordingly. Then, create a file File/Policy/Config.pm with: use constant IMPLEMENTATION => 'YourPolicy'; run 'perldoc File::Policy' to read the full documentation. SAMPLE: See samples/lib/File/Policy/Simple.pm for an example of a custom policy. DEPENDENCIES: Pod::Test and Pod::Test::Coverage are used by two of the unit tests if present - otherwise these 2 tests should skip gracefully. Tests require Test::Assertions and Log::Trace which is why these are listed in the PREREQ_PM in Makefile.PL. File-Policy-1.005/COPYING0000644000177600001460000004313110254023317016142 0ustar simonftechnical00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License. File-Policy-1.005/t/0000755000177600001460000000000010254023475015355 5ustar simonftechnical00000000000000File-Policy-1.005/t/pod.t0000644000177600001460000000020110254023323016305 0ustar simonftechnical00000000000000use Test::More; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok(); File-Policy-1.005/t/file_policy.t0000644000177600001460000000262010254023317020033 0ustar simonftechnical00000000000000#!/usr/local/bin/perl # # Unit test for File::Policy # # -t Trace # -T Deep trace # BEGIN { unshift @INC, "../lib", "./lib"; $^W = 0; #Stop overriding constant raising a warning } use strict; use Test::Assertions qw(test); use Log::Trace; use Getopt::Std; use vars qw($opt_t $opt_T); getopts("tT"); plan tests; #Move into the t directory chdir('t') if(-d 't'); #Compilation require File::Policy::Config; #./lib/File/Policy/Config.pm *File::Policy::Config::IMPLEMENTATION = sub() {"Default"}; #Override the value set in the config module require File::Policy; #../lib/File/Policy.pm ASSERT($INC{'File/Policy.pm'}, "Compiled File::Policy version $File::Policy::VERSION"); #Tracing import Log::Trace qw(print) if($opt_t); import Log::Trace ('print' => {Deep => 1}) if($opt_T); #Test fully qualified interface import File::Policy; no strict 'refs'; my %stash = %{'File::Policy::'}; ASSERT(scalar(grep {$stash{$_}} qw(check_safe get_log_dir get_temp_dir)) == 3, "available in package"); #Test exports import File::Policy qw(:all); %stash = %{'::'}; #DUMP(\%stash); ASSERT(scalar(grep {$stash{$_}} qw(check_safe get_log_dir get_temp_dir)) == 3, "exported"); #Test default implementation $ENV{TEMP}="tmp"; ASSERT(get_temp_dir() eq "tmp", "get_tmp_dir"); $ENV{LOGDIR}="logdir"; ASSERT(get_log_dir() eq "logdir", "get_log_dir"); my $rv = eval {check_safe("\x00",'r')}; TRACE($rv, $@); ASSERT($rv && !$@, "check_safe"); File-Policy-1.005/t/file_slurp_withinpolicy.t0000644000177600001460000001004010254023317022476 0ustar simonftechnical00000000000000#!/usr/local/bin/perl # # Test harness for File::Slurp::WithinPolicy # $Id: file_slurp_withinpolicy.t,v 1.3 2005/06/15 10:40:04 simonf Exp $ # use strict; use lib qw(./lib ../lib); use File::Policy qw(:all); use File::Slurp::WithinPolicy qw(:all); use Test::Assertions 'test'; use Log::Trace; use Getopt::Std; use Cwd; use vars qw($opt_t $opt_T $opt_s); getopts("tTs"); plan tests; #So if can find config files even when run from make if (-d 't') { chdir 't'; } #Tracing import Log::Trace qw(print) if($opt_t); import Log::Trace ('print' => {Deep => 1}) if($opt_T); my $i; my $o; my $root = cwd(); # clear the decks for the temp files unlink("$root/FSWP_TEST", "$root/FSWP_TEST_LIST", "$root/FSWP_TEST_REF", "$root/FSWP_TEST_BLOCK", "$root/FSWP_TEST_APPEND"); # let's set $/ to be something unusual to check we can handle it $/ = 'r'; #################################################################### # simple read and write $o = 'this is a test'; ASSERT( overwrite_file("$root/FSWP_TEST", $o) , 'write file - string'); ASSERT( ($i = read_file("$root/FSWP_TEST")) , 'read back'); ASSERT( ($i eq $o), 'ensure data matches' ); #################################################################### # Write by reference $o = 'this is a reference test'; ASSERT( write_file("$root/FSWP_TEST_REF", \$o) , 'write file - string reference'); ASSERT( $i = read_file("$root/FSWP_TEST_REF") , 'read back'); ASSERT( ($i eq $o) , 'ensure data matches'); #################################################################### # Read back into a buffer ref $o = 't' x 100000; ASSERT( write_file("$root/FSWP_TEST_REF", {buf_ref => \$o}) , 'write file - string reference 1e5 bytes'); my $refString; read_file("$root/FSWP_TEST_REF", buf_ref => \$refString); TRACE("length = ".length($refString)); ASSERT( (ref \$refString eq 'SCALAR'), 'right reference type'); ASSERT( (length($refString) == 100000), 'correct length'); ASSERT( ($refString eq $o), 'correct string'); #################################################################### # testing the list-context read. my @list; $o = "line1$/line2$/line3$/line4$/line5$/"; ASSERT( write_file("$root/FSWP_TEST_LIST", $o) , 'write file - multiline'); eval q{ @list = read_file("$root/FSWP_TEST_LIST");}; DUMP(\@list); ASSERT( (! $@) , 'read back list - eval outcome'); ASSERT( ($#list > 0) , 'read back list - has array filled'); ASSERT( ($list[0] eq "line1$/") , 'ensure data matches'); #################################################################### # now let's check we don't have any nasty block IO problems # big file $o = (int(rand(1000)) . int(rand(1000)) . int(rand(1000)) . int(rand(1000))) x 5000; ASSERT( write_file("$root/FSWP_TEST_BLOCK", \$o) , 'write file - block'); ASSERT( $i = read_file("$root/FSWP_TEST_BLOCK") , 'read back'); ASSERT( ($i eq $o) , 'ensure data matches'); #################################################################### # appending to file, with gratuitious pause $o = (int(rand(1000)) . int(rand(1000)) . int(rand(1000)) . int(rand(1000))) x 250; ASSERT( append_file("$root/FSWP_TEST_APPEND", \$o) , 'append file - many times'); for (2..10) { append_file("$root/FSWP_TEST_APPEND", \$o); } sleep(1); for (11..20) { append_file("$root/FSWP_TEST_APPEND", \$o); } ASSERT( ($i = read_file("$root/FSWP_TEST_APPEND")) , 'read back'); ASSERT( ($i eq ($o x 20)) , 'ensure data matches'); #################################################################### # Reading directories @list = grep /^FSWP/, sort &read_dir($root); DUMP(\@list); ASSERT(EQUAL( \@list, [ 'FSWP_TEST', 'FSWP_TEST_APPEND', 'FSWP_TEST_BLOCK', 'FSWP_TEST_LIST', 'FSWP_TEST_REF', ]), "read_dir"); #################################################################### # test error conditions ASSERT( DIED(sub { read_file("$root/FSWP_Icon\r"); } ), 'bad chars' ); ASSERT( DIED(sub { read_file("$root/FSWP_NONEXISTENT"); } ), 'doesnt exist' ); #################################################################### # cleanup unlink("$root/FSWP_TEST", "$root/FSWP_TEST_LIST", "$root/FSWP_TEST_REF", "$root/FSWP_TEST_BLOCK", "$root/FSWP_TEST_APPEND") unless ($opt_s); File-Policy-1.005/t/pod_coverage.t0000644000177600001460000000033010254023323020163 0ustar simonftechnical00000000000000use Test::More; eval "use Test::Pod::Coverage 1.00"; plan skip_all => "Test::Pod::Coverage 1.00 required for testing POD Coverage" if $@; all_pod_coverage_ok({ also_private => [ qr/^[A-Z_]+$/ ], }); #Ignore all caps File-Policy-1.005/t/lib/0000755000177600001460000000000010254023475016123 5ustar simonftechnical00000000000000File-Policy-1.005/t/lib/File/0000755000177600001460000000000010254023475017002 5ustar simonftechnical00000000000000File-Policy-1.005/t/lib/File/Policy/0000755000177600001460000000000010254023475020241 5ustar simonftechnical00000000000000File-Policy-1.005/t/lib/File/Policy/Config.pm0000644000177600001460000000103110254023320021764 0ustar simonftechnical00000000000000############################################################################### # Purpose : Selection of FILE I/O policy # Author : John Alden # Created : March 2005 # CVS : $Id: Config.pm,v 1.2 2005/03/31 17:28:26 sysadm Exp $ ############################################################################### # This is the default configuration - please update as necessary ############################################################################### package File::Policy::Config; use constant IMPLEMENTATION => 'Default'; 1; File-Policy-1.005/samples/0000755000177600001460000000000010254023475016556 5ustar simonftechnical00000000000000File-Policy-1.005/samples/lib/0000755000177600001460000000000010254023475017324 5ustar simonftechnical00000000000000File-Policy-1.005/samples/lib/File/0000755000177600001460000000000010254023475020203 5ustar simonftechnical00000000000000File-Policy-1.005/samples/lib/File/Policy/0000755000177600001460000000000010254023475021442 5ustar simonftechnical00000000000000File-Policy-1.005/samples/lib/File/Policy/Simple.pm0000644000177600001460000000715110254023317023230 0ustar simonftechnical00000000000000############################################################################### # Purpose : Very Simple File IO policies # Author : Murray Walker # Created : May 2005 # CVS : $Id: Simple.pm,v 1.1 2005/05/18 15:56:45 johna Exp $ ############################################################################### package File::Policy::Default; use strict; use File::Spec::Functions; use Carp; use vars qw($VERSION @EXPORT_OK %EXPORT_TAGS @ISA); @ISA = qw(Exporter); @EXPORT_OK = qw(get_temp_dir get_log_dir check_safe); %EXPORT_TAGS = ('all' => \@EXPORT_OK); $VERSION = sprintf"%d.%03d", q$Revision: 1.1 $ =~ /: (\d+)\.(\d+)/; sub get_temp_dir { return $ENV{TEMP} || File::Spec::Functions::tmpdir(); } sub get_log_dir { return $ENV{LOGDIR} || File::Spec::Functions::curdir(); } sub check_safe { my ($name, $mode) = @_; croak("mode must be r, w or a") unless($mode eq 'r' || $mode eq 'w' || $mode eq 'a'); # Don't allow writing to any file in /etc if ( ($mode eq 'w' || $mode eq 'a') and ($name =~ /^\/etc\//) ) { die("you are not allowed to write to files in /etc/ : '$name'"); } # Don't allow passwd files to be read if ( ($mode eq 'r' || $mode eq 'a') and ($name =~ /^\/etc\/passwd/ || $name =~ /^\/etc\/shadow/) ) { die("you are not allowed to read passwd files"); } # Don't allow any access to any .configuration files in # users home directories if ($name =~ /^\/home\/[^\/]+\/\./) { die("you cannot access users . files (eg, .pinerc)"); } return 1; } 1; =head1 NAME File::Policy::Simple - Simple policy for file I/O functions =head1 SYNOPSIS use File::Policy; use File::Policy qw/check_safe/; # to import a specific subroutine use File::Policy qw/:all/; # to import all subroutines # Ensure File::Policy::Config is updated with the appropriate # default policy. For example # package File::Policy::Config; # use constant IMPLEMENTATION => 'Simple'; # 1; #Checking I/O policy check_safe($filename, 'r'); # Check it is okay for reading check_safe($filename, 'w'); # Check it is okay for writing to check_safe($filename, 'a'); # Check it is okay for both reading & writing #Portable directory locations $logdir = get_log_dir(); $tmpdir = get_temp_dir(); =head1 DESCRIPTION This defines a simple policy for file I/O with modules such as File::Slurp::WithinPolicy. Use IN NO WAY implies any safety to your file I/O, it is simply provided to help demonstrate how you might implement a File Policy at your site. =head1 FUNCTIONS =over 4 =item check_safe check_safe( FILENAME , MODE ); Checks a filename is safe - dies if not. MODE is r, w, or a Using File::Policy::Simple will prevent code that calls check_safe from: * Writing to any file under /etc/ * Reading from /etc/passwd or /etc/shadow * Accessing in any way a .configuration file in a users home directory =item get_temp_dir $temporary_directory = get_temp_dir(); Returns the path to temporary directory from the TEMP environment variable or File::Spec::Functions::tmpdir(). Note that any return value will have been cleared of a trailing slash. =item get_log_dir $log_directory = get_log_dir(); Returns the path to log directory from the LOGDIR environment variable or the current directory. Note that any return value will have been cleared of a trailing slash. =back =head1 VERSION $Revision: 1.1 $ on $Date: 2005/05/18 15:56:45 $ by $Author: johna $ =head1 AUTHOR Murray Walker =head1 COPYRIGHT (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt =cut File-Policy-1.005/lib/0000755000177600001460000000000010254023475015660 5ustar simonftechnical00000000000000File-Policy-1.005/lib/File/0000755000177600001460000000000010254023475016537 5ustar simonftechnical00000000000000File-Policy-1.005/lib/File/Policy/0000755000177600001460000000000010254023475017776 5ustar simonftechnical00000000000000File-Policy-1.005/lib/File/Policy/Default.pm0000644000177600001460000000500110254023317021707 0ustar simonftechnical00000000000000############################################################################### # Purpose : Default (unrestricted) File I/O policies # Author : John Alden # Created : March 2005 # CVS : $Id: Default.pm,v 1.6 2005/05/18 15:57:28 johna Exp $ ############################################################################### package File::Policy::Default; use strict; use File::Spec::Functions; use Carp; use vars qw($VERSION @EXPORT_OK %EXPORT_TAGS @ISA); @ISA = qw(Exporter); @EXPORT_OK = qw(get_temp_dir get_log_dir check_safe); %EXPORT_TAGS = ('all' => \@EXPORT_OK); $VERSION = sprintf"%d.%03d", q$Revision: 1.6 $ =~ /: (\d+)\.(\d+)/; sub get_temp_dir { return $ENV{TEMP} || File::Spec::Functions::tmpdir(); } sub get_log_dir { return $ENV{LOGDIR} || File::Spec::Functions::curdir(); } sub check_safe { my ($name, $mode) = @_; croak("mode must be r or w") unless($mode eq 'r' || $mode eq 'w'); return 1; } 1; =head1 NAME File::Policy::Default - Default policy for file I/O functions =head1 SYNOPSIS use File::Policy; use File::Policy qw/check_safe/; # to import a specific subroutine use File::Policy qw/:all/; # to import all subroutines #Checking I/O policy check_safe($filename, 'r'); check_safe($filename, 'w'); #Portable directory locations $logdir = get_log_dir(); $tmpdir = get_temp_dir(); =head1 DESCRIPTION This defines the default (unrestricted) policy for file I/O with modules such as File::Slurp::WithinPolicy. You may replace this default policy with one for your organisation. =head1 FUNCTIONS =over 4 =item check_safe check_safe( FILENAME , MODE ); Checks a filename is safe - dies if not. MODE is r (read) or w (write). Default is no restrictions on file I/O. =item get_temp_dir $temporary_directory = get_temp_dir(); Returns the path to temporary directory from the TEMP environment variable or File::Spec::Functions::tmpdir(). Note that any return value will have been cleared of a trailing slash. =item get_log_dir $log_directory = get_log_dir(); Returns the path to log directory from the LOGDIR environment variable or the current directory. Note that any return value will have been cleared of a trailing slash. =back =head1 VERSION $Revision: 1.6 $ on $Date: 2005/05/18 15:57:28 $ by $Author: johna $ =head1 AUTHOR John Alden =head1 COPYRIGHT (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt =cut File-Policy-1.005/lib/File/Slurp/0000755000177600001460000000000010254023475017644 5ustar simonftechnical00000000000000File-Policy-1.005/lib/File/Slurp/WithinPolicy.pm0000644000177600001460000000527410254023317022627 0ustar simonftechnical00000000000000############################################################################### # Purpose : Hide site-dependent FS policies beneath a well-known interface # Author : John Alden # Created : March 2005 # CVS : $Id: WithinPolicy.pm,v 1.4 2005/06/15 10:40:21 simonf Exp $ ############################################################################### package File::Slurp::WithinPolicy; use strict; use Carp; use Exporter; use Fcntl ':flock'; use File::Slurp(); use File::Policy; use vars qw($VERSION @EXPORT_OK %EXPORT_TAGS @ISA); @ISA = qw(Exporter); @EXPORT_OK = qw(read_file write_file append_file overwrite_file read_dir); %EXPORT_TAGS = ('all' => \@EXPORT_OK); $VERSION = sprintf"%d.%03d", q$Revision: 1.4 $ =~ /: (\d+)\.(\d+)/; sub read_file { File::Policy::check_safe( $_[0], 'r' ); goto &File::Slurp::read_file; } sub write_file { File::Policy::check_safe( $_[0], 'w' ); goto &File::Slurp::write_file; } sub append_file { File::Policy::check_safe( $_[0], 'w' ); goto &File::Slurp::append_file; } sub overwrite_file { File::Policy::check_safe( $_[0], 'w' ); goto &File::Slurp::overwrite_file; } sub read_dir { File::Policy::check_safe( $_[0], 'r' ); goto &File::Slurp::read_dir; } 1; =head1 NAME File::Slurp::WithinPolicy - Applies filesystem policies to File::Slurp =head1 SYNOPSIS use File::Slurp::WithinPolicy qw(:all); my $text = read_file( 'filename' ); my @lines = read_file( 'filename' ); write_file( 'filename', $text ); append_file( 'filename', $more_text ); overwrite_file( 'filename', $text ); my @files = read_dir( '/path/to/dir' ); =head1 DESCRIPTION This provides the File::Slurp interface within a policy defined by File::Policy. By default, File::Policy is a no-op and this behaves identically to File::Slurp. System administrators may want to override the default File::Policy implementation to enforce a local filesystem policy (see L). =head1 FUNCTIONS =head2 read_dir See L =head2 read_file See L =head2 write_file See L =head2 append_file See L =head2 overwrite_file See L =head1 EXPORTS By default, nothing is exported. The C<:all> tag can be used to export everything. Individual methods can also be exported. =head1 SEE ALSO L, L =head1 VERSION $Revision: 1.4 $ on $Date: 2005/06/15 10:40:21 $ by $Author: simonf $ =head1 AUTHOR John Alden =head1 COPYRIGHT (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt =cut File-Policy-1.005/lib/File/Policy.pm0000644000177600001460000001201610254023317020327 0ustar simonftechnical00000000000000############################################################################### # Purpose : Interface to File I/O policies # Author : John Alden # Created : March 2005 # CVS : $Id: Policy.pm,v 1.5 2005/05/18 15:58:21 johna Exp $ ############################################################################### package File::Policy; use strict; use vars qw($VERSION $Aliased); $VERSION = sprintf"%d.%03d", q$Revision: 1.5 $ =~ /: (\d+)\.(\d+)/; $Aliased = 0; sub import { my $package = shift; #Allow default implementation to be set in a config module my $default_implementation = 'Default'; eval { require File::Policy::Config; $default_implementation = &File::Policy::Config::IMPLEMENTATION; }; my $impl = $default_implementation; #Currently no way of overriding default - could be extended later die("Invalid File::Policy package - $impl") unless($impl =~ /^[\w:]+$/); #Sanitize package name $impl = "File::Policy::" . $impl; TRACE("File::Policy Implementation: ". $impl); #Export symbols to caller eval "require $impl"; die("Unable to compile $impl - $@") if($@); ++ local $Exporter::ExportLevel; #Bypass this module in caller() $impl->import(@_); #Alias symbols into this package too for fully qualified access unless($Aliased) { foreach(qw(check_safe get_log_dir get_temp_dir)) { no strict 'refs'; *{"File::Policy::$_"} = *{"${impl}::$_"}; } $Aliased = 1; } } #Stubs compatible with Log::Trace sub TRACE{} sub DUMP{} 1; =head1 NAME File::Policy - Site policy for file I/O functions =head1 SYNOPSIS use File::Policy; use File::Policy qw/check_safe/; # to import a specific subroutine use File::Policy qw/:all/; # to import all subroutines #Checking I/O policy check_safe($filename, 'r'); check_safe($filename, 'w'); #Preferred directory locations $logdir = get_log_dir(); $tmpdir = get_temp_dir(); =head1 DESCRIPTION This defines the policy for file I/O with modules such as File::Slurp::WithinPolicy. The purpose is to allow systems administrators to define locations and restrictions for applications' file I/O and give app developers a policy to follow. Note that the module doesn't ENFORCE the policy - application developers can choose to ignore it (and systems administrators can choose not to install their applications if they do!). You may control which policy gets applied by creating a File::Policy::Config module with an IMPLEMENTATION constant. You may write your own policy as a module within the File::Policy:: namespace. By default (if no File::Policy::Config is present), the File::Policy::Default policy gets applied which doesn't impose any restrictions and provides reasonable default locations for temporary and log files. The motivation behind this module was a standard, flexible approach to allow a site wide file policy to be defined. This will be most useful in large environments where a few sysadmins are responsible for code written by many other people. Simply ensuring that submitted code calls check_safe() ensures file access is sane, reducing the amount of effort required to do a security audit. If your code is not security audit'd, or you are the only developer at your site, this might be overkill. However you may consider it good practise regardless and protection against paths in your code getting corrupted accidently or maliciously in the future. There are two major benefits of using this module. One, sites that do implement a policy can more easily integrate your code in a standard way. If you have a file policy at your site, you can apply different policies (via File::Policy::Config) in different environments (production, integration test, development) and the appropriate policy is automatically applied without having to change your code or configs. =head1 FUNCTIONS =over 4 =item check_safe check_safe( FILENAME , MODE ); Checks FILENAME is safe - dies if not. MODE is r (read) or w (write). =item get_temp_dir $temporary_directory = get_temp_dir(); Returns the path to temporary directory. Note that any return value will have been cleared of a trailing slash. =item get_log_dir $log_directory = get_log_dir(); Returns the path to log directory. Note that any return value will have been cleared of a trailing slash. =back =head1 DEFINING YOUR OWN POLICY To implement your own custom policy cp File/Policy/Default.pm File/Policy/YourPolicy.pm and modify YourPolicy accordingly. Then, create File/Policy/Config.pm contaning: use constant IMPLEMENTATION => 'YourPolicy'; Now having used File::Policy, calling check_safe in your scripts will enforce your policy (as well as give you access to log and temp paths in locations you recommend). =head1 SEE ALSO L, L =head1 VERSION $Revision: 1.5 $ on $Date: 2005/05/18 15:58:21 $ by $Author: johna $ =head1 AUTHOR John Alden =head1 COPYRIGHT (c) BBC 2005. This program is free software; you can redistribute it and/or modify it under the GNU GPL. See the file COPYING in this distribution, or http://www.gnu.org/licenses/gpl.txt =cut File-Policy-1.005/MANIFEST0000644000177600001460000000053210254023462016237 0ustar simonftechnical00000000000000Changes COPYING Makefile.PL MANIFEST MANIFEST.SKIP README lib/File/Policy.pm lib/File/Policy/Default.pm lib/File/Slurp/WithinPolicy.pm t/lib/File/Policy/Config.pm t/file_policy.t t/file_slurp_withinpolicy.t samples/lib/File/Policy/Simple.pm t/pod.t t/pod_coverage.t META.yml Module meta-data (added by MakeMaker) File-Policy-1.005/META.yml0000644000177600001460000000070710254023474016366 0ustar simonftechnical00000000000000# http://module-build.sourceforge.net/META-spec.html #XXXXXXX This is a prototype!!! It will change in the future!!! XXXXX# name: File-Policy version: 1.005 version_from: lib/File/Policy.pm installdirs: site requires: File::Slurp: 0 File::Spec::Functions: 0 Log::Trace: 0 Test::Assertions: 0 distribution_type: module generated_by: ExtUtils::MakeMaker version 6.17 File-Policy-1.005/MANIFEST.SKIP0000644000177600001460000000016710254023317017007 0ustar simonftechnical00000000000000^blib ^bak ~$ (?:^|/)[Mm]akefile(?:\.old)?$ (?:^|/)pm_to_blib$ ^File-Policy-\d+\.\d+\.(zip|tar\.gz|tgz)$ [Cc][Vv][Ss]/ File-Policy-1.005/Changes0000644000177600001460000000007510254023317016402 0ustar simonftechnical00000000000000Web Jun 15 14:00:00 2005 - 1.005 Initial public release File-Policy-1.005/Makefile.PL0000644000177600001460000000105610254023317017061 0ustar simonftechnical00000000000000use ExtUtils::MakeMaker; WriteMakefile( NAME => 'File::Policy', VERSION_FROM => 'lib/File/Policy.pm', PREREQ_PM => { 'File::Spec::Functions' => 0, 'Test::Assertions' => 0, 'Log::Trace' => 0, 'File::Slurp' => 0, }, ABSTRACT_FROM => 'lib/File/Policy.pm', AUTHOR => 'British Broadcasting Corporation', );