win32-file-security 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0cbba9bdb2c474a89f0c9a7bfd316d11f5340ed
-  data.tar.gz: fe8f1a9b21770c3adefd4753bd1dde13e3b126ed
+  metadata.gz: d234ea5f580422f9afe3ca568dca698212b4c31c
+  data.tar.gz: a3bee9399b1407bc23609a44315194cb361ef9c3
 SHA512:
-  metadata.gz: ed0b4e85d4864cace4bd070483b4c7efbfd131c15a9c35236494ca1142d4b4cd674f31a2d2dd46f06970a8b6bb73f83b204737dab63f5775ef2ebfea1f5120d4
-  data.tar.gz: 31d4bec21d22a52d3f889c8631b1cf63eb61cc52317ee5356ca1816195a0b11dbdab1c379dab25d29496afe5a960a78b4d0611ecb212fbb373f971ea4f212e86
+  metadata.gz: 3e119edd6768169b2b37995be0656b59d3dbf304eedc2ba7f1ddffa4d3f130d3519e6cbf1cbe6e918813a04cf0049820630c3c71c23093603f5f2be19b7308ec
+  data.tar.gz: f3e9124fdd6acaea83dfd678ad150ea057695e2e600cfa443047776efa4877ae0b59c3c40975be6404dd0e59eb72e5f96696230f99d020754a2c78ec3e8b18f7

data/CHANGES

@@ -1,3 +1,9 @@
+= 1.0.5 - 2-May-2015
+* Added the File.supports_acls? singleton method.
+* The File.get_permissions and File.set_permissions methods now explicitly
+  raise an error if the filesystem does not support ACL's.
+* Fixed some deprecation warnings in the test suite.
+
 = 1.0.4 - 2-May-2014
 * All methods that accept a filename argument now honor objects that implement
   either to_str or to_path.

data/MANIFEST

@@ -7,6 +7,10 @@
 * lib/win32/file/windows/constants.rb
 * lib/win32/file/windows/functions.rb
 * lib/win32/file/windows/structs.rb
+* test/test_win32_file_security_acls.rb
+* test/test_win32_file_security_constants.rb
 * test/test_win32_file_security_encryption.rb
+* test/test_win32_file_security_ffi.rb
+* test/test_win32_file_security_ownership.rb
 * test/test_win32_file_security_permissions.rb
 * test/test_win32_file_security_version.rb

data/lib/win32/file/security.rb

@@ -12,7 +12,7 @@ class File
   extend Windows::File::Functions
 
   # The version of the win32-file library
-  WIN32_FILE_SECURITY_VERSION = '1.0.4'
+  WIN32_FILE_SECURITY_VERSION = '1.0.5'
 
   class << self
     remove_method(:chown)
@@ -61,15 +61,15 @@ class File
     end
 
     # Returns whether or not the root path of the specified file is
-    # encryptable. If a relative path is specified, it will check against
-    # the root of the current directory.
+    # encryptable. If no path or a relative path is specified, it will
+    # check against the root of the current directory.
     #
     # Be sure to include a trailing slash if specifying a root path.
     #
     # Examples:
     #
     #   p File.encryptable?
-    #   p File.encryptable?("D:\\")
+    #   p File.encryptable?("D:/")
     #   p File.encryptable?("C:/foo/bar.txt") # Same as 'C:\'
     #
     def encryptable?(file = nil)
@@ -102,6 +102,49 @@ class File
       bool
     end
 
+
+    # Returns whether or not the root path of the specified file supports
+    # ACL's. If no path or a relative path is specified, it will check against
+    # the root of the current directory.
+    #
+    # Be sure to include a trailing slash if specifying a root path.
+    #
+    # Examples:
+    #
+    #   p File.supports_acls?
+    #   p File.supports_acls?("D:/")
+    #   p File.supports_acls?("C:/foo/bar.txt") # Same as 'C:\'
+    #
+    def supports_acls?(file = nil)
+      bool = false
+      flags_ptr = FFI::MemoryPointer.new(:ulong)
+
+      if file
+        file = File.expand_path(string_check(file))
+        wide_file = file.wincode
+
+        if !PathIsRootW(wide_file)
+          unless PathStripToRootW(wide_file)
+            raise SystemCallError.new("PathStripToRoot", FFI.errno)
+          end
+        end
+      else
+        wide_file = nil
+      end
+
+      unless GetVolumeInformationW(wide_file, nil, 0, nil, nil, flags_ptr, nil, 0)
+        raise SystemCallError.new("GetVolumeInformation", FFI.errno)
+      end
+
+      flags = flags_ptr.read_ulong
+
+      if flags & FILE_PERSISTENT_ACLS > 0
+        bool = true
+      end
+
+      bool
+    end
+
     # Encrypts a file or directory. All data streams in a file are encrypted.
     # All new files created in an encrypted directory are encrypted.
     #
@@ -159,6 +202,14 @@ class File
     #   }
     #
     def get_permissions(file, host=nil)
+      # Check local filesystem to see if it supports ACL's. If not, bail early
+      # because the GetFileSecurity function will not fail on an unsupported FS.
+      if host.nil?
+        unless supports_acls?(file)
+          raise ArgumentError, "Filesystem does not implement ACL support"
+        end
+      end
+
       wide_file = string_check(file).wincode
       wide_host = host ? host.wincode : nil
 
@@ -321,6 +372,12 @@ class File
     #   File.set_permissions(file, "host\\userid" => File::GENERIC_ALL)
     #
     def set_permissions(file, perms)
+      # Check local filesystem to see if it supports ACL's. If not, bail early
+      # because the GetFileSecurity function will not fail on an unsupported FS.
+      unless supports_acls?(file)
+        raise ArgumentError, "Filesystem does not implement ACL support"
+      end
+
       wide_file = string_check(file).wincode
       raise TypeError unless perms.kind_of?(Hash)
 

data/lib/win32/file/security/constants.rb

@@ -16,6 +16,9 @@ module Windows
       TOKEN_QUERY                = 0x00000008
       TOKEN_ADJUST_PRIVILEGES    = 0x0020
 
+      ERROR_NOT_SUPPORTED = 50
+      ERROR_NO_SECURITY_ON_OBJECT = 1350
+
       TokenUser                  = 1
       TokenGroups                = 2
 

data/test/test_win32_file_security_acls.rb

@@ -0,0 +1,28 @@
+##############################################################################
+# test_win32_file_acls.rb
+#
+# Test case for the File.supports_acls? method.
+##############################################################################
+require 'test-unit'
+require 'win32/file/security'
+require 'socket'
+require 'etc'
+
+class TC_Win32_File_Security_ACLS < Test::Unit::TestCase
+  def setup
+    @dir = "C:/"
+  end
+
+  test "supports_acls? basic functionality" do
+    assert_respond_to(File, :supports_acls?)
+    assert_boolean(File.supports_acls?(@dir))
+  end
+
+  test "supports_acls? returns the expected results" do
+    assert_true(File.supports_acls?(@dir))
+  end
+
+  def teardown
+    @perms = nil
+  end
+end

data/test/test_win32_file_security_encryption.rb

@@ -83,7 +83,7 @@ class TC_Win32_File_Security_Encryption < Test::Unit::TestCase
   end
 
   def self.shutdown
-    File.delete(@@file) if File.exists?(@@file)
+    File.delete(@@file) if File.exist?(@@file)
     @@file = nil
     @@host = nil
   end

data/test/test_win32_file_security_ownership.rb

@@ -145,7 +145,7 @@ class TC_Win32_File_Security_Ownership < Test::Unit::TestCase
 
   def teardown
     @elevated = nil
-    File.delete(@@file) if File.exists?(@@file)
+    File.delete(@@file) if File.exist?(@@file)
   end
 
   def self.shutdown

data/test/test_win32_file_security_permissions.rb

@@ -5,7 +5,6 @@
 # use the 'rake test' or 'rake test:perms' task to run this.
 ##############################################################################
 require 'test-unit'
-require 'test/unit'
 require 'win32/file/security'
 require 'socket'
 require 'etc'
@@ -80,7 +79,7 @@ class TC_Win32_File_Security_Permissions < Test::Unit::TestCase
   end
 
   def self.shutdown
-    File.delete(@@file) if File.exists?(@@file)
+    File.delete(@@file) if File.exist?(@@file)
     @@file = nil
     @@host = nil
     @@user = nil

data/test/test_win32_file_security_version.rb

@@ -8,6 +8,6 @@ require 'win32/file/security'
 
 class TC_Win32_File_Security_Version < Test::Unit::TestCase
   test "version is set to expected value" do
-    assert_equal('1.0.4', File::WIN32_FILE_SECURITY_VERSION)
+    assert_equal('1.0.5', File::WIN32_FILE_SECURITY_VERSION)
   end
 end

data/win32-file-security.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-file-security'
-  spec.version    = '1.0.4'
+  spec.version    = '1.0.5'
   spec.authors    = ['Daniel J. Berger', 'Park Heesob']
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32-file-security
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-03 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: win32-security
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sys-admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -88,6 +88,7 @@ files:
 - lib/win32/file/security/functions.rb
 - lib/win32/file/security/helper.rb
 - lib/win32/file/security/structs.rb
+- test/test_win32_file_security_acls.rb
 - test/test_win32_file_security_constants.rb
 - test/test_win32_file_security_encryption.rb
 - test/test_win32_file_security_ffi.rb
@@ -105,21 +106,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 2.2.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: File security methods for the File class on MS Windows
 test_files:
+- test/test_win32_file_security_acls.rb
 - test/test_win32_file_security_constants.rb
 - test/test_win32_file_security_encryption.rb
 - test/test_win32_file_security_ffi.rb