home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / FileSecurity.pm < prev    next >
Text File  |  2004-01-12  |  6KB  |  309 lines
  1. package Win32::FileSecurity;
  2.  
  3. #
  4. # FileSecurity.pm
  5. # By Monte Mitzelfelt, monte@conchas.nm.org
  6. # Larry Wall's Artistic License applies to all related Perl
  7. #  and C code for this module
  8. # Thanks to the guys at ActiveWare!
  9. # ver 0.67 ALPHA 1997.07.07
  10. #
  11.  
  12. require Exporter;
  13. require DynaLoader;
  14. use Carp ;
  15. use Win32;
  16.  
  17. $VERSION = '1.04';
  18.  
  19. croak "The Win32::FileSecurity module works only on Windows NT" if not Win32::IsWinNT();
  20.  
  21. @ISA= qw( Exporter DynaLoader );
  22.  
  23. require Exporter ;
  24. require DynaLoader ;
  25.  
  26. @ISA = qw(Exporter DynaLoader) ;
  27. @EXPORT_OK = qw(
  28.     Get
  29.     Set
  30.     EnumerateRights
  31.     MakeMask
  32.     DELETE
  33.     READ_CONTROL
  34.     WRITE_DAC
  35.     WRITE_OWNER
  36.     SYNCHRONIZE
  37.     STANDARD_RIGHTS_REQUIRED
  38.     STANDARD_RIGHTS_READ
  39.     STANDARD_RIGHTS_WRITE
  40.     STANDARD_RIGHTS_EXECUTE
  41.     STANDARD_RIGHTS_ALL
  42.     SPECIFIC_RIGHTS_ALL
  43.     ACCESS_SYSTEM_SECURITY
  44.     MAXIMUM_ALLOWED
  45.     GENERIC_READ
  46.     GENERIC_WRITE
  47.     GENERIC_EXECUTE
  48.     GENERIC_ALL
  49.     F
  50.     FULL
  51.     R
  52.     READ
  53.     C
  54.     CHANGE
  55.     A
  56.     ADD
  57.            ) ;
  58.  
  59. sub AUTOLOAD {
  60.     local($constname);
  61.     ($constname = $AUTOLOAD) =~ s/.*:://;
  62.     #reset $! to zero to reset any current errors.
  63.     local $! = 0;
  64.     $val = constant($constname);
  65.     if($! != 0) {
  66.     if($! =~ /Invalid/) {
  67.         $AutoLoader::AUTOLOAD = $AUTOLOAD;
  68.         goto &AutoLoader::AUTOLOAD;
  69.     }
  70.     else {
  71.         ($pack,$file,$line) = caller;
  72.         die "Your vendor has not defined Win32::FileSecurity macro "
  73.            ."$constname, used in $file at line $line.";
  74.     }
  75.     }
  76.     eval "sub $AUTOLOAD { $val }";
  77.     goto &$AUTOLOAD;
  78. }
  79.  
  80. bootstrap Win32::FileSecurity;
  81.  
  82. 1;
  83.  
  84. __END__
  85.  
  86. =head1 NAME
  87.  
  88. Win32::FileSecurity - manage FileSecurity Discretionary Access Control Lists in perl
  89.  
  90. =head1 SYNOPSIS
  91.  
  92.     use Win32::FileSecurity;
  93.  
  94. =head1 DESCRIPTION
  95.  
  96. This module offers control over the administration of system FileSecurity DACLs.  
  97. You may want to use Get and EnumerateRights to get an idea of what mask values
  98. correspond to what rights as viewed from File Manager.
  99.  
  100. =head1 CONSTANTS
  101.  
  102.   DELETE, READ_CONTROL, WRITE_DAC, WRITE_OWNER,
  103.   SYNCHRONIZE, STANDARD_RIGHTS_REQUIRED, 
  104.   STANDARD_RIGHTS_READ, STANDARD_RIGHTS_WRITE,
  105.   STANDARD_RIGHTS_EXECUTE, STANDARD_RIGHTS_ALL,
  106.   SPECIFIC_RIGHTS_ALL, ACCESS_SYSTEM_SECURITY, 
  107.   MAXIMUM_ALLOWED, GENERIC_READ, GENERIC_WRITE,
  108.   GENERIC_EXECUTE, GENERIC_ALL, F, FULL, R, READ,
  109.   C, CHANGE
  110.  
  111. =head1 FUNCTIONS
  112.  
  113. =head2 NOTE:
  114.  
  115. All of the functions return false if they fail, unless otherwise noted.
  116. Errors returned via $! containing both Win32 GetLastError() and a text message
  117. indicating Win32 function that failed.
  118.  
  119. =over 10
  120.  
  121. =item constant( $name, $set )
  122.  
  123. Stores the value of named constant $name into $set.
  124. Same as C<$set = Win32::FileSecurity::NAME_OF_CONSTANT();>.
  125.  
  126. =item Get( $filename, \%permisshash )
  127.  
  128. Gets the DACLs of a file or directory.
  129.  
  130. =item Set( $filename, \%permisshash )
  131.  
  132. Sets the DACL for a file or directory.
  133.  
  134. =item EnumerateRights( $mask, \@rightslist )
  135.  
  136. Turns the bitmask in $mask into a list of strings in @rightslist.
  137.  
  138. =item MakeMask( qw( DELETE READ_CONTROL ) )
  139.  
  140. Takes a list of strings representing constants and returns a bitmasked
  141. integer value.
  142.  
  143. =back
  144.  
  145. =head2 %permisshash
  146.  
  147. Entries take the form $permisshash{USERNAME} = $mask ;
  148.  
  149. =head1 EXAMPLE1
  150.  
  151.     # Gets the rights for all files listed on the command line.
  152.     use Win32::FileSecurity qw(Get EnumerateRights);
  153.     
  154.     foreach( @ARGV ) {
  155.     next unless -e $_ ;
  156.     if ( Get( $_, \%hash ) ) {
  157.         while( ($name, $mask) = each %hash ) {
  158.         print "$name:\n\t"; 
  159.         EnumerateRights( $mask, \@happy ) ;
  160.         print join( "\n\t", @happy ), "\n";
  161.         }
  162.     }
  163.     else {
  164.         print( "Error #", int( $! ), ": $!" ) ;
  165.     }
  166.     }
  167.  
  168. =head1 EXAMPLE2
  169.  
  170.     # Gets existing DACL and modifies Administrator rights
  171.     use Win32::FileSecurity qw(MakeMask Get Set);
  172.     
  173.     # These masks show up as Full Control in File Manager
  174.     $file = MakeMask( qw( FULL ) );
  175.     
  176.     $dir = MakeMask( qw(
  177.         FULL
  178.     GENERIC_ALL
  179.     ) );
  180.     
  181.     foreach( @ARGV ) {
  182.     s/\\$//;
  183.     next unless -e;
  184.     Get( $_, \%hash ) ;
  185.     $hash{Administrator} = ( -d ) ? $dir : $file ;
  186.     Set( $_, \%hash ) ;
  187.     }
  188.  
  189. =head1 COMMON MASKS FROM CACLS AND WINFILE
  190.  
  191. =head2 READ
  192.  
  193.     MakeMask( qw( FULL ) ); # for files
  194.     MakeMask( qw( READ GENERIC_READ GENERIC_EXECUTE ) ); # for directories
  195.  
  196. =head2 CHANGE
  197.  
  198.     MakeMask( qw( CHANGE ) ); # for files
  199.     MakeMask( qw( CHANGE GENERIC_WRITE GENERIC_READ GENERIC_EXECUTE ) ); # for directories
  200.  
  201. =head2 ADD & READ
  202.  
  203.     MakeMask( qw( ADD GENERIC_READ GENERIC_EXECUTE ) ); # for directories only!
  204.  
  205. =head2 FULL
  206.  
  207.     MakeMask( qw( FULL ) ); # for files
  208.     MakeMask( qw( FULL  GENERIC_ALL ) ); # for directories
  209.  
  210. =head1 RESOURCES
  211.  
  212. From Microsoft: check_sd
  213.     http://premium.microsoft.com/download/msdn/samples/2760.exe
  214.  
  215. (thanks to Guert Schimmel at Sybase for turning me on to this one)
  216.  
  217. =head1 VERSION
  218.  
  219. 1.03 ALPHA    97-12-14
  220.  
  221. =head1 REVISION NOTES
  222.  
  223. =over 10
  224.  
  225. =item 1.03 ALPHA 1998.01.11
  226.  
  227. Imported diffs from 0.67 (parent) version
  228.  
  229. =item 1.02 ALPHA 1997.12.14
  230.  
  231. Pod fixes, @EXPORT list additions <gsar@activestate.com>
  232.  
  233. Fix unitialized vars on unknown ACLs <jmk@exc.bybyte.de>
  234.  
  235. =item 1.01 ALPHA 1997.04.25
  236.  
  237. CORE Win32 version imported from 0.66 <gsar@activestate.com>
  238.  
  239. =item 0.67 ALPHA 1997.07.07
  240.  
  241. Kludged bug in mapping bits to separate ACE's.  Notably, this screwed
  242. up CHANGE access by leaving out a delete bit in the
  243. C<INHERIT_ONLY_ACE | OBJECT_INHERIT_ACE> Access Control Entry.
  244.  
  245. May need to rethink...
  246.  
  247. =item 0.66 ALPHA 1997.03.13
  248.  
  249. Fixed bug in memory allocation check
  250.  
  251. =item 0.65 ALPHA 1997.02.25
  252.  
  253. Tested with 5.003 build 303
  254.  
  255. Added ISA exporter, and @EXPORT_OK
  256.  
  257. Added F, FULL, R, READ, C, CHANGE as composite pre-built mask names.
  258.  
  259. Added server\ to keys returned in hash from Get
  260.  
  261. Made constants and MakeMask case insensitive (I don't know why I did that)
  262.  
  263. Fixed mask comparison in ListDacl and Enumerate Rights from simple & mask
  264. to exact bit match ! ( ( x & y ) ^ x ) makes sure all bits in x
  265. are set in y
  266.  
  267. Fixed some "wild" pointers
  268.  
  269. =item 0.60 ALPHA 1996.07.31
  270.  
  271. Now suitable for file and directory permissions
  272.  
  273. Included ListDacl.exe in bundle for debugging
  274.  
  275. Added "intuitive" inheritance for directories, basically functions like FM
  276. triggered by presence of GENERIC_ rights this may need to change
  277.  
  278. see EXAMPLE2
  279.  
  280. Changed from AddAccessAllowedAce to AddAce for control over inheritance
  281.  
  282. =item 0.51 ALPHA 1996.07.20
  283.  
  284. Fixed memory allocation bug
  285.  
  286. =item 0.50 ALPHA 1996.07.29
  287.  
  288. Base functionality
  289.  
  290. Using AddAccessAllowedAce
  291.  
  292. Suitable for file permissions
  293.  
  294. =back
  295.  
  296. =head1 KNOWN ISSUES / BUGS
  297.  
  298. =over 10
  299.  
  300. =item 1
  301.  
  302. May not work on remote drives.
  303.  
  304. =item 2
  305.  
  306. Errors croak, don't return via $! as documented.
  307.  
  308. =cut
  309.