Convert NetLocalGroupAdd to use FFI

3 files changed, 134 insertions, 106 deletions

diff --git a/lib/chef/util/windows/net_group.rb b/lib/chef/util/windows/net_group.rb
index 924bd392f9..24ee29257c 100644
--- a/lib/chef/util/windows/net_group.rb
+++ b/lib/chef/util/windows/net_group.rb
@@ -1,106 +1,109 @@
-#
-# Author:: Doug MacEachern (<dougm@vmware.com>)
-# Copyright:: Copyright (c) 2010 VMware, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'chef/util/windows'
-
-#wrapper around a subset of the NetGroup* APIs.
-#nothing Chef specific, but not complete enough to be its own gem, so util for now.
-class Chef::Util::Windows::NetGroup < Chef::Util::Windows
-
-  private
-
-  def pack_str(s)
-    [str_to_ptr(s)].pack('L')
-  end
-
-  def modify_members(members, func)
-    buffer = 0.chr * (members.size * PTR_SIZE)
-    members.each_with_index do |member,offset|
-      buffer[offset*PTR_SIZE,PTR_SIZE] = pack_str(multi_to_wide(member))
-    end
-    rc = func.call(nil, @name, 3, buffer, members.size)
-    if rc != NERR_Success
-      raise ArgumentError, get_last_error(rc)
-    end
-  end
-
-  public
-
-  def initialize(groupname)
-    @name = multi_to_wide(groupname)
-  end
-
-  def local_get_members
-    group_members = []
-    handle = 0.chr * PTR_SIZE
-    rc = ERROR_MORE_DATA
-
-    while rc == ERROR_MORE_DATA
-      ptr   = 0.chr * PTR_SIZE
-      nread = 0.chr * PTR_SIZE
-      total = 0.chr * PTR_SIZE
-
-      rc = NetLocalGroupGetMembers.call(nil, @name, 0, ptr, -1,
-                                        nread, total, handle)
-      if (rc == NERR_Success) || (rc == ERROR_MORE_DATA)
-        ptr = ptr.unpack('L')[0]
-        nread = nread.unpack('i')[0]
-        members = 0.chr * (nread * PTR_SIZE ) #nread * sizeof(LOCALGROUP_MEMBERS_INFO_0)
-        memcpy(members, ptr, members.size)
-
-        # 1 pointer field in LOCALGROUP_MEMBERS_INFO_0, offset 0 is lgrmi0_sid
-        nread.times do |i|
-          sid_address = members[i * PTR_SIZE, PTR_SIZE].unpack('L')[0]
-          sid_ptr = FFI::Pointer.new(sid_address)
-          member_sid = Chef::ReservedNames::Win32::Security::SID.new(sid_ptr)
-          group_members << member_sid.to_s
-        end
-        NetApiBufferFree(ptr)
-      else
-        raise ArgumentError, get_last_error(rc)
-      end
-    end
-    group_members
-  end
-
-  def local_add
-    rc = NetLocalGroupAdd.call(nil, 0, pack_str(@name), nil)
-    if rc != NERR_Success
-      raise ArgumentError, get_last_error(rc)
-    end
-  end
-
-  def local_set_members(members)
-    modify_members(members, NetLocalGroupSetMembers)
-  end
-
-  def local_add_members(members)
-    modify_members(members, NetLocalGroupAddMembers)
-  end
-
-  def local_delete_members(members)
-    modify_members(members, NetLocalGroupDelMembers)
-  end
-
-  def local_delete
-    rc = NetLocalGroupDel.call(nil, @name)
-    if rc != NERR_Success
-      raise ArgumentError, get_last_error(rc)
-    end
-  end
-end
+#

+# Author:: Doug MacEachern (<dougm@vmware.com>)

+# Copyright:: Copyright (c) 2010 VMware, Inc.

+# License:: Apache License, Version 2.0

+#

+# Licensed under the Apache License, Version 2.0 (the "License");

+# you may not use this file except in compliance with the License.

+# You may obtain a copy of the License at

+#

+#     http://www.apache.org/licenses/LICENSE-2.0

+#

+# Unless required by applicable law or agreed to in writing, software

+# distributed under the License is distributed on an "AS IS" BASIS,

+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+# See the License for the specific language governing permissions and

+# limitations under the License.

+#

+

+require 'chef/util/windows'

+require 'chef/win32/net'

+

+#wrapper around a subset of the NetGroup* APIs.

+#nothing Chef specific, but not complete enough to be its own gem, so util for now.

+class Chef::Util::Windows::NetGroup < Chef::Util::Windows

+

+  private

+

+  def pack_str(s)

+    [str_to_ptr(s)].pack('L')

+  end

+

+  def modify_members(members, func)

+    buffer = 0.chr * (members.size * PTR_SIZE)

+    members.each_with_index do |member,offset|

+      buffer[offset*PTR_SIZE,PTR_SIZE] = pack_str(multi_to_wide(member))

+    end

+    rc = func.call(nil, @name, 3, buffer, members.size)

+    if rc != NERR_Success

+      raise ArgumentError, get_last_error(rc)

+    end

+  end

+

+  public

+

+  def initialize(groupname)

+    @name = multi_to_wide(groupname)

+    @groupname = groupname

+  end

+

+  def local_get_members

+    group_members = []

+    handle = 0.chr * PTR_SIZE

+    rc = ERROR_MORE_DATA

+

+    while rc == ERROR_MORE_DATA

+      ptr   = 0.chr * PTR_SIZE

+      nread = 0.chr * PTR_SIZE

+      total = 0.chr * PTR_SIZE

+

+      rc = NetLocalGroupGetMembers.call(nil, @name, 0, ptr, -1,

+                                        nread, total, handle)

+      if (rc == NERR_Success) || (rc == ERROR_MORE_DATA)

+        ptr = ptr.unpack('L')[0]

+        nread = nread.unpack('i')[0]

+        members = 0.chr * (nread * PTR_SIZE ) #nread * sizeof(LOCALGROUP_MEMBERS_INFO_0)

+        memcpy(members, ptr, members.size)

+

+        # 1 pointer field in LOCALGROUP_MEMBERS_INFO_0, offset 0 is lgrmi0_sid

+        nread.times do |i|

+          sid_address = members[i * PTR_SIZE, PTR_SIZE].unpack('L')[0]

+          sid_ptr = FFI::Pointer.new(sid_address)

+          member_sid = Chef::ReservedNames::Win32::Security::SID.new(sid_ptr)

+          group_members << member_sid.to_s

+        end

+        NetApiBufferFree(ptr)

+      else

+        raise ArgumentError, get_last_error(rc)

+      end

+    end

+    group_members

+  end

+

+  def local_add

+    begin

+      Chef::ReservedNames::Win32::NetUser::net_local_group_add(nil, @groupname)

+    rescue Chef::Exceptions::Win32APIError => e

+      raise ArgumentError, e

+    end

+  end

+

+  def local_set_members(members)

+    modify_members(members, NetLocalGroupSetMembers)

+  end

+

+  def local_add_members(members)

+    modify_members(members, NetLocalGroupAddMembers)

+  end

+

+  def local_delete_members(members)

+    modify_members(members, NetLocalGroupDelMembers)

+  end

+

+  def local_delete

+    rc = NetLocalGroupDel.call(nil, @name)

+    if rc != NERR_Success

+      raise ArgumentError, get_last_error(rc)

+    end

+  end

+end

diff --git a/lib/chef/win32/api/net.rb b/lib/chef/win32/api/net.rb
index 72caf46628..d2a05523ed 100644
--- a/lib/chef/win32/api/net.rb
+++ b/lib/chef/win32/api/net.rb
@@ -136,6 +136,18 @@ class Chef
           layout :lgrmi3_domainandname, :LPWSTR
         end
 
+        class LOCALGROUP_INFO_0 < FFI::Struct
+          layout :lgrpi0_name, :LPWSTR
+        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 NetUserEnum(
 #   _In_     LPCWSTR servername,
 #   _In_     DWORD level,
diff --git a/lib/chef/win32/net.rb b/lib/chef/win32/net.rb
index 1349091eb9..ce6b64e255 100644
--- a/lib/chef/win32/net.rb
+++ b/lib/chef/win32/net.rb
@@ -106,6 +106,19 @@ END
         raise Chef::Exceptions::Win32APIError, msg + "\n" + formatted_message
       end
 
+      def self.net_local_group_add(server_name, group_name)
+        server_name = wstring(server_name)
+        group_name = wstring(group_name)
+
+        buf = LOCALGROUP_INFO_0.new
+        buf[:lgrpi0_name] = FFI::MemoryPointer.from_string(group_name)
+
+        rc = NetLocalGroupAdd(server_name, 0, buf, nil)
+        if rc != NERR_Success
+          net_api_error!(rc)
+        end
+      end
+
       def self.net_user_add_l3(server_name, args)
         buf = default_user_info_3