summaryrefslogtreecommitdiff
path: root/lib/chef/provider/user/windows.rb
blob: f7ab96b0e92dca0f784d745bb45b710fa7b5f138 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
#
# Author:: Doug MacEachern (<dougm@vmware.com>)
# Copyright:: Copyright 2010-2019, 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_relative "../user"
require_relative "../../exceptions"
require_relative "../../util/windows/net_user" if Chef::Platform.windows?

class Chef
  class Provider
    class User
      class Windows < Chef::Provider::User
        provides :windows_user
        provides :user, os: "windows"

        def initialize(new_resource, run_context)
          super
          @net_user = Chef::Util::Windows::NetUser.new(new_resource.username)
        end

        def load_current_resource
          if new_resource.gid
            logger.warn("The 'gid' (or 'group') property is not implemented on the Windows platform. Please use the `members` property of the  'group' resource to assign a user to a group.")
          end

          @current_resource = Chef::Resource::User::WindowsUser.new(new_resource.name)
          current_resource.username(new_resource.username)
          begin
            user_info = @net_user.get_info
            current_resource.uid(user_info[:user_id])
            current_resource.full_name(user_info[:full_name])
            current_resource.comment(user_info[:comment])
            current_resource.home(user_info[:home_dir])
            current_resource.shell(user_info[:script_path])
          rescue Chef::Exceptions::UserIDNotFound => e
            # e.message should be "The user name could not be found" but checking for that could cause a localization bug
            @user_exists = false
            logger.trace("#{new_resource} does not exist (#{e.message})")
          end

          current_resource
        end

        # Check to see if the user needs any changes
        #
        # === Returns
        # <true>:: If a change is required
        # <false>:: If the users are identical
        def compare_user
          @change_desc = []
          if new_resource.password && !@net_user.validate_credentials(new_resource.password)
            @change_desc << "update password"
          end

          %i{uid comment home shell full_name}.any? do |user_attrib|
            new_val = new_resource.send(user_attrib)
            cur_val = current_resource.send(user_attrib)
            if !new_val.nil? && new_val != cur_val
              @change_desc << "change #{user_attrib} from #{cur_val} to #{new_val}"
            end
          end

          !@change_desc.empty?
        end

        def create_user
          @net_user.add(**set_options)
        end

        def manage_user
          @net_user.update(**set_options)
        end

        def remove_user
          @net_user.delete
        end

        def check_lock
          @net_user.check_enabled
        end

        def lock_user
          @net_user.disable_account
        end

        def unlock_user
          @net_user.enable_account
        end

        def set_options
          opts = { name: new_resource.username }

          field_list = {
            "full_name" => "full_name",
            "comment" => "comment",
            "home" => "home_dir",
            "uid" => "user_id",
            "shell" => "script_path",
            "password" => "password",
          }

          field_list.sort_by { |a| a[0] }.each do |field, option|
            field_symbol = field.to_sym
            next unless current_resource.send(field_symbol) != new_resource.send(field_symbol)
            next unless new_resource.send(field_symbol)

            unless field_symbol == :password
              logger.trace("#{new_resource} setting #{field} to #{new_resource.send(field_symbol)}")
            end
            opts[option.to_sym] = new_resource.send(field_symbol)
          end
          opts
        end

      end
    end
  end
end