chef 12.5.0.alpha.1 → 12.5.1

data/lib/chef/util/windows/net_use.rb

@@ -21,61 +21,18 @@
 #see also cmd.exe: net use /?
 
 require 'chef/util/windows'
+require 'chef/win32/net'
 
 class Chef::Util::Windows::NetUse < Chef::Util::Windows
-
-  private
-
-  USE_NOFORCE = 0
-  USE_FORCE = 1
-  USE_LOTS_OF_FORCE = 2 #every windows API should support this flag
-
-  USE_INFO_2 = [
-    [:local, nil],
-    [:remote, nil],
-    [:password, nil],
-    [:status, 0],
-    [:asg_type, 0],
-    [:refcount, 0],
-    [:usecount, 0],
-    [:username, nil],
-    [:domainname, nil]
-  ]
-
-  USE_INFO_2_TEMPLATE =
-    USE_INFO_2.collect { |field| field[1].class == Fixnum ? 'i' : 'L' }.join
-
-  SIZEOF_USE_INFO_2 = #sizeof(USE_INFO_2)
-    USE_INFO_2.inject(0) do |sum, item|
-      sum + (item[1].class == Fixnum ? 4 : PTR_SIZE)
-    end
-
-  def use_info_2(args)
-    USE_INFO_2.collect { |field|
-      args.include?(field[0]) ? args[field[0]] : field[1]
-    }
-  end
-
-  def use_info_2_pack(use)
-    use.collect { |v|
-      v.class == Fixnum ? v : str_to_ptr(multi_to_wide(v))
-    }.pack(USE_INFO_2_TEMPLATE)
+  def initialize(localname)
+    @use_name = localname
   end
 
-  def use_info_2_unpack(buffer)
-    use = Hash.new
-    USE_INFO_2.each_with_index do |field,offset|
-      use[field[0]] = field[1].class == Fixnum ?
-      dword_to_i(buffer, offset) : lpwstr_to_s(buffer, offset)
+  def to_ui2_struct(use_info)
+    use_info.inject({}) do |memo, (k,v)|
+      memo["ui2_#{k}".to_sym] = v
+      memo
     end
-    use
-  end
-
-  public
-
-  def initialize(localname)
-    @localname = localname
-    @name = multi_to_wide(localname)
   end
 
   def add(args)
@@ -84,38 +41,45 @@ class Chef::Util::Windows::NetUse < Chef::Util::Windows
       args = Hash.new
       args[:remote] = remote
     end
-    args[:local] ||= @localname
-    use = use_info_2(args)
-    buffer = use_info_2_pack(use)
-    rc = NetUseAdd.call(nil, 2, buffer, nil)
-    if rc != NERR_Success
-      raise ArgumentError, get_last_error(rc)
+    args[:local] ||= use_name
+    ui2_hash = to_ui2_struct(args)
+
+    begin
+      Chef::ReservedNames::Win32::Net.net_use_add_l2(nil, ui2_hash)
+    rescue Chef::Exceptions::Win32APIError => e
+      raise ArgumentError, e
     end
   end
 
-  def get_info
-    ptr  = 0.chr * PTR_SIZE
-    rc = NetUseGetInfo.call(nil, @name, 2, ptr)
-
-    if rc != NERR_Success
-      raise ArgumentError, get_last_error(rc)
+  def from_use_info_struct(ui2_hash)
+    ui2_hash.inject({}) do |memo, (k,v)|
+      memo[k.to_s.sub('ui2_', '').to_sym] = v
+      memo
     end
+  end
 
-    ptr = ptr.unpack('L')[0]
-    buffer = 0.chr * SIZEOF_USE_INFO_2
-    memcpy(buffer, ptr, buffer.size)
-    NetApiBufferFree(ptr)
-    use_info_2_unpack(buffer)
+  def get_info
+    begin
+      ui2 = Chef::ReservedNames::Win32::Net.net_use_get_info_l2(nil, use_name)
+      from_use_info_struct(ui2)
+    rescue Chef::Exceptions::Win32APIError => e
+      raise ArgumentError, e
+    end
   end
 
   def device
     get_info()[:remote]
   end
-  #XXX should we use some FORCE here?
+
   def delete
-    rc = NetUseDel.call(nil, @name, USE_NOFORCE)
-    if rc != NERR_Success
-      raise ArgumentError, get_last_error(rc)
+    begin
+      Chef::ReservedNames::Win32::Net.net_use_del(nil, use_name, :use_noforce)
+    rescue Chef::Exceptions::Win32APIError => e
+      raise ArgumentError, e
     end
   end
+
+  def use_name
+    @use_name
+  end
 end

data/lib/chef/util/windows/net_user.rb

@@ -88,7 +88,6 @@ class Chef::Util::Windows::NetUser < Chef::Util::Windows
 
   def initialize(username)
     @username = username
-    @name = multi_to_wide(username)
   end
 
   LOGON32_PROVIDER_DEFAULT = Security::LOGON32_PROVIDER_DEFAULT

data/lib/chef/util/windows/volume.rb

@@ -18,42 +18,42 @@
 
 #simple wrapper around Volume APIs. might be possible with WMI, but possibly more complex.
 
+require 'chef/win32/api/file'
 require 'chef/util/windows'
-require 'windows/volume'
 
 class Chef::Util::Windows::Volume < Chef::Util::Windows
-
-  private
-  include Windows::Volume
-  #XXX not defined in the current windows-pr release
-  DeleteVolumeMountPoint =
-    Windows::API.new('DeleteVolumeMountPoint', 'S', 'B') unless defined? DeleteVolumeMountPoint
-
-  public
+  attr_reader :mount_point
 
   def initialize(name)
     name += "\\" unless name =~ /\\$/ #trailing slash required
-    @name = name
+    @mount_point = name
   end
 
   def device
-    buffer = 0.chr * 256
-    if GetVolumeNameForVolumeMountPoint(@name, buffer, buffer.size)
-      return buffer[0,buffer.size].unpack("Z*")[0]
-    else
-      raise ArgumentError, get_last_error
+    begin
+      Chef::ReservedNames::Win32::File.get_volume_name_for_volume_mount_point(mount_point)
+    rescue Chef::Exceptions::Win32APIError => e
+      raise ArgumentError, e
     end
   end
 
   def delete
-    unless DeleteVolumeMountPoint.call(@name)
-      raise ArgumentError, get_last_error
+    begin
+      Chef::ReservedNames::Win32::File.delete_volume_mount_point(mount_point)
+    rescue Chef::Exceptions::Win32APIError => e
+      raise ArgumentError, e
     end
   end
 
   def add(args)
-    unless SetVolumeMountPoint(@name, args[:remote])
-      raise ArgumentError, get_last_error
+    begin
+      Chef::ReservedNames::Win32::File.set_volume_mount_point(mount_point, args[:remote])
+    rescue Chef::Exceptions::Win32APIError => e
+      raise ArgumentError, e
     end
   end
+
+  def mount_point
+    @mount_point
+  end
 end

data/lib/chef/version.rb

@@ -21,7 +21,7 @@
 
 class Chef
   CHEF_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
-  VERSION = '12.5.0.alpha.1'
+  VERSION = '12.5.1'
 end
 
 #
@@ -29,6 +29,6 @@ end
 #
 # NOTE: DO NOT Use the Chef::Version class on Chef::VERSIONs.  The
 #       Chef::Version class is for _cookbooks_ only, and cannot handle
-#       pre-release chef-client versions like "10.14.0.rc.2".  Please
-#       use Rubygem's Gem::Version class instead.
+#       pre-release versions like "10.14.0.rc.2".  Please use Rubygem's
+#       Gem::Version class instead.
 #

data/lib/chef/win32/api.rb

@@ -188,6 +188,7 @@ class Chef
         host.typedef :pointer, :PCRYPTPROTECT_PROMPTSTRUCT # Pointer to a CRYPTOPROTECT_PROMPTSTRUCT.
         host.typedef :pointer, :PDATA_BLOB # Pointer to a DATA_BLOB.
         host.typedef :pointer, :PTSTR # A PWSTR if UNICODE is defined, a PSTR otherwise.
+        host.typedef :pointer, :PSID
         host.typedef :pointer, :PUCHAR # Pointer to a UCHAR.
         host.typedef :pointer, :PUHALF_PTR # Pointer to a UHALF_PTR.
         host.typedef :pointer, :PUINT # Pointer to a UINT.

data/lib/chef/win32/api/file.rb

@@ -20,6 +20,7 @@
 require 'chef/win32/api'
 require 'chef/win32/api/security'
 require 'chef/win32/api/system'
+require 'chef/win32/unicode'
 
 class Chef
   module ReservedNames::Win32
@@ -450,6 +451,25 @@ BOOL WINAPI DeviceIoControl(
 =end
         safe_attach_function :DeviceIoControl, [:HANDLE, :DWORD, :LPVOID, :DWORD, :LPVOID, :DWORD, :LPDWORD, :pointer], :BOOL
 
+
+#BOOL WINAPI DeleteVolumeMountPoint(
+  #_In_ LPCTSTR lpszVolumeMountPoint
+#);
+        safe_attach_function :DeleteVolumeMountPointW, [:LPCTSTR], :BOOL
+
+#BOOL WINAPI SetVolumeMountPoint(
+  #_In_ LPCTSTR lpszVolumeMountPoint,
+  #_In_ LPCTSTR lpszVolumeName
+#);
+        safe_attach_function :SetVolumeMountPointW, [:LPCTSTR, :LPCTSTR], :BOOL
+
+#BOOL WINAPI GetVolumeNameForVolumeMountPoint(
+  #_In_  LPCTSTR lpszVolumeMountPoint,
+  #_Out_ LPTSTR  lpszVolumeName,
+  #_In_  DWORD   cchBufferLength
+#);
+        safe_attach_function :GetVolumeNameForVolumeMountPointW, [:LPCTSTR, :LPTSTR, :DWORD], :BOOL
+
         ###############################################
         # Helpers
         ###############################################

data/lib/chef/win32/api/net.rb

@@ -17,6 +17,7 @@
 #
 
 require 'chef/win32/api'
+require 'chef/win32/unicode'
 
 class Chef
   module ReservedNames::Win32
@@ -40,6 +41,10 @@ class Chef
         UF_NORMAL_ACCOUNT      = 0x000200
         UF_DONT_EXPIRE_PASSWD  = 0x010000
 
+        USE_NOFORCE = 0
+        USE_FORCE = 1
+        USE_LOTS_OF_FORCE = 2 #every windows API should support this flag
+
         NERR_Success = 0
         NERR_InvalidComputer = 2351
         NERR_NotPrimary = 2226
@@ -49,41 +54,13 @@ class Chef
         NERR_BadPassword = 2203
         NERR_PasswordTooShort = 2245
         NERR_UserNotFound = 2221
+        NERR_GroupNotFound = 2220
         ERROR_ACCESS_DENIED = 5
+        ERROR_MORE_DATA = 234
 
         ffi_lib "netapi32"
 
-        class USER_INFO_3 < FFI::Struct
-          layout :usri3_name, :LPWSTR,
-            :usri3_password, :LPWSTR,
-            :usri3_password_age, :DWORD,
-            :usri3_priv, :DWORD,
-            :usri3_home_dir, :LPWSTR,
-            :usri3_comment, :LPWSTR,
-            :usri3_flags, :DWORD,
-            :usri3_script_path, :LPWSTR,
-            :usri3_auth_flags, :DWORD,
-            :usri3_full_name, :LPWSTR,
-            :usri3_usr_comment, :LPWSTR,
-            :usri3_parms, :LPWSTR,
-            :usri3_workstations, :LPWSTR,
-            :usri3_last_logon, :DWORD,
-            :usri3_last_logoff, :DWORD,
-            :usri3_acct_expires, :DWORD,
-            :usri3_max_storage, :DWORD,
-            :usri3_units_per_week, :DWORD,
-            :usri3_logon_hours, :PBYTE,
-            :usri3_bad_pw_count, :DWORD,
-            :usri3_num_logons, :DWORD,
-            :usri3_logon_server, :LPWSTR,
-            :usri3_country_code, :DWORD,
-            :usri3_code_page, :DWORD,
-            :usri3_user_id, :DWORD,
-            :usri3_primary_group_id, :DWORD,
-            :usri3_profile, :LPWSTR,
-            :usri3_home_dir_drive, :LPWSTR,
-            :usri3_password_expired, :DWORD
-
+        module StructHelpers
           def set(key, val)
             val = if val.is_a? String
               encoded = if val.encoding == Encoding::UTF_16LE
@@ -115,6 +92,47 @@ class Chef
             end
           end
 
+          def as_ruby
+            members.inject({}) do |memo, key|
+              memo[key] = get(key)
+              memo
+            end
+          end
+        end
+
+
+        class USER_INFO_3 < FFI::Struct
+          include StructHelpers
+          layout :usri3_name, :LPWSTR,
+            :usri3_password, :LPWSTR,
+            :usri3_password_age, :DWORD,
+            :usri3_priv, :DWORD,
+            :usri3_home_dir, :LPWSTR,
+            :usri3_comment, :LPWSTR,
+            :usri3_flags, :DWORD,
+            :usri3_script_path, :LPWSTR,
+            :usri3_auth_flags, :DWORD,
+            :usri3_full_name, :LPWSTR,
+            :usri3_usr_comment, :LPWSTR,
+            :usri3_parms, :LPWSTR,
+            :usri3_workstations, :LPWSTR,
+            :usri3_last_logon, :DWORD,
+            :usri3_last_logoff, :DWORD,
+            :usri3_acct_expires, :DWORD,
+            :usri3_max_storage, :DWORD,
+            :usri3_units_per_week, :DWORD,
+            :usri3_logon_hours, :PBYTE,
+            :usri3_bad_pw_count, :DWORD,
+            :usri3_num_logons, :DWORD,
+            :usri3_logon_server, :LPWSTR,
+            :usri3_country_code, :DWORD,
+            :usri3_code_page, :DWORD,
+            :usri3_user_id, :DWORD,
+            :usri3_primary_group_id, :DWORD,
+            :usri3_profile, :LPWSTR,
+            :usri3_home_dir_drive, :LPWSTR,
+            :usri3_password_expired, :DWORD
+
           def usri3_logon_hours
             val = self[:usri3_logon_hours]
             if !val.nil? && !val.null?
@@ -123,19 +141,66 @@ class Chef
               nil
             end
           end
+        end
 
-          def as_ruby
-            members.inject({}) do |memo, key|
-              memo[key] = get(key)
-              memo
-            end
-          end
+        class LOCALGROUP_MEMBERS_INFO_0 < FFI::Struct
+          layout :lgrmi0_sid, :PSID
         end
 
         class LOCALGROUP_MEMBERS_INFO_3 < FFI::Struct
           layout :lgrmi3_domainandname, :LPWSTR
         end
 
+        class LOCALGROUP_INFO_0 < FFI::Struct
+          layout :lgrpi0_name, :LPWSTR
+        end
+
+        class USE_INFO_2 < FFI::Struct
+          include StructHelpers
+
+          layout :ui2_local, :LMSTR,
+            :ui2_remote, :LMSTR,
+            :ui2_password, :LMSTR,
+            :ui2_status, :DWORD,
+            :ui2_asg_type, :DWORD,
+            :ui2_refcount, :DWORD,
+            :ui2_usecount, :DWORD,
+            :ui2_username, :LPWSTR,
+            :ui2_domainname, :LMSTR
+        end
+
+
+#NET_API_STATUS NetLocalGroupAdd(
+  #_In_  LPCWSTR servername,
+  #_In_  DWORD   level,
+  #_In_  LPBYTE  buf,
+  #_Out_ LPDWORD parm_err
+#);
+        safe_attach_function :NetLocalGroupAdd, [
+          :LPCWSTR, :DWORD, :LPBYTE, :LPDWORD
+        ], :DWORD
+
+#NET_API_STATUS NetLocalGroupDel(
+  #_In_ LPCWSTR servername,
+  #_In_ LPCWSTR groupname
+#);
+        safe_attach_function :NetLocalGroupDel, [:LPCWSTR, :LPCWSTR], :DWORD
+
+#NET_API_STATUS NetLocalGroupGetMembers(
+  #_In_    LPCWSTR    servername,
+  #_In_    LPCWSTR    localgroupname,
+  #_In_    DWORD      level,
+  #_Out_   LPBYTE     *bufptr,
+  #_In_    DWORD      prefmaxlen,
+  #_Out_   LPDWORD    entriesread,
+  #_Out_   LPDWORD    totalentries,
+  #_Inout_ PDWORD_PTR resumehandle
+#);
+        safe_attach_function :NetLocalGroupGetMembers, [
+          :LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :DWORD,
+          :LPDWORD, :LPDWORD, :PDWORD_PTR
+        ], :DWORD
+
 # NET_API_STATUS NetUserEnum(
 #   _In_     LPCWSTR servername,
 #   _In_     DWORD level,
@@ -146,12 +211,15 @@ class Chef
 #   _Out_    LPDWORD totalentries,
 #   _Inout_  LPDWORD resume_handle
 # );
-        safe_attach_function :NetUserEnum, [ :LPCWSTR, :DWORD, :DWORD, :LPBYTE, :DWORD, :LPDWORD, :LPDWORD, :LPDWORD ], :DWORD
+        safe_attach_function :NetUserEnum, [
+          :LPCWSTR, :DWORD, :DWORD, :LPBYTE,
+          :DWORD, :LPDWORD, :LPDWORD, :LPDWORD
+        ], :DWORD
 
 # NET_API_STATUS NetApiBufferFree(
 #   _In_  LPVOID Buffer
 # );
-        safe_attach_function :NetApiBufferFree, [ :LPVOID ], :DWORD
+        safe_attach_function :NetApiBufferFree, [:LPVOID], :DWORD
 
 #NET_API_STATUS NetUserAdd(
   #_In_  LMSTR   servername,
@@ -159,7 +227,9 @@ class Chef
   #_In_  LPBYTE  buf,
   #_Out_ LPDWORD parm_err
 #);
-        safe_attach_function :NetUserAdd, [:LMSTR, :DWORD, :LPBYTE, :LPDWORD ], :DWORD
+        safe_attach_function :NetUserAdd, [
+          :LMSTR, :DWORD, :LPBYTE, :LPDWORD
+        ], :DWORD
 
 #NET_API_STATUS NetLocalGroupAddMembers(
 #  _In_ LPCWSTR servername,
@@ -168,7 +238,31 @@ class Chef
 #  _In_ LPBYTE  buf,
 #  _In_ DWORD   totalentries
 #);
-        safe_attach_function :NetLocalGroupAddMembers, [:LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :DWORD ], :DWORD
+        safe_attach_function :NetLocalGroupAddMembers, [
+          :LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :DWORD
+        ], :DWORD
+
+#NET_API_STATUS NetLocalGroupSetMembers(
+#  _In_ LPCWSTR servername,
+#  _In_ LPCWSTR groupname,
+#  _In_ DWORD   level,
+#  _In_ LPBYTE  buf,
+#  _In_ DWORD   totalentries
+#);
+        safe_attach_function :NetLocalGroupSetMembers, [
+          :LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :DWORD
+        ], :DWORD
+
+#NET_API_STATUS NetLocalGroupDelMembers(
+#  _In_ LPCWSTR servername,
+#  _In_ LPCWSTR groupname,
+#  _In_ DWORD   level,
+#  _In_ LPBYTE  buf,
+#  _In_ DWORD   totalentries
+#);
+        safe_attach_function :NetLocalGroupDelMembers, [
+          :LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :DWORD
+        ], :DWORD
 
 #NET_API_STATUS NetUserGetInfo(
 #  _In_  LPCWSTR servername,
@@ -176,7 +270,9 @@ class Chef
 #  _In_  DWORD   level,
 #  _Out_ LPBYTE  *bufptr
 #);
-        safe_attach_function :NetUserGetInfo, [:LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE], :DWORD
+        safe_attach_function :NetUserGetInfo, [
+          :LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE
+        ], :DWORD
 
 #NET_API_STATUS NetApiBufferFree(
 #  _In_ LPVOID Buffer
@@ -190,7 +286,9 @@ class Chef
 #  _In_  LPBYTE  buf,
 #  _Out_ LPDWORD parm_err
 #);
-        safe_attach_function :NetUserSetInfo, [:LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :LPDWORD], :DWORD
+        safe_attach_function :NetUserSetInfo, [
+          :LPCWSTR, :LPCWSTR, :DWORD, :LPBYTE, :LPDWORD
+        ], :DWORD
 
 #NET_API_STATUS NetUserDel(
 #  _In_ LPCWSTR servername,
@@ -198,6 +296,28 @@ class Chef
 #);
         safe_attach_function :NetUserDel, [:LPCWSTR, :LPCWSTR], :DWORD
 
+#NET_API_STATUS NetUseDel(
+  #_In_ LMSTR UncServerName,
+  #_In_ LMSTR UseName,
+  #_In_ DWORD ForceCond
+#);
+        safe_attach_function :NetUseDel, [:LMSTR, :LMSTR, :DWORD], :DWORD
+
+#NET_API_STATUS NetUseGetInfo(
+  #_In_  LMSTR  UncServerName,
+  #_In_  LMSTR  UseName,
+  #_In_  DWORD  Level,
+  #_Out_ LPBYTE *BufPtr
+#);
+        safe_attach_function :NetUseGetInfo, [:LMSTR, :LMSTR, :DWORD, :pointer], :DWORD
+
+#NET_API_STATUS NetUseAdd(
+  #_In_  LMSTR   UncServerName,
+  #_In_  DWORD   Level,
+  #_In_  LPBYTE  Buf,
+  #_Out_ LPDWORD ParmError
+#);
+        safe_attach_function :NetUseAdd, [:LMSTR, :DWORD, :LPBYTE, :LPDWORD], :DWORD
       end
     end
   end