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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
#
# Author:: Seth Chisamore (<schisamo@chef.io>)
# Author:: Mark Mzyk (<mmzyk@ospcode.com>)
# Copyright:: Copyright 2011-2016, Chef Software 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/mixin/wide_string"
require "chef/win32/api/file"
require "chef/win32/api/security"
require "chef/win32/error"
require "chef/win32/unicode"
class Chef
module ReservedNames::Win32
class File
include Chef::ReservedNames::Win32::API::File
extend Chef::ReservedNames::Win32::API::File
include Chef::Mixin::WideString
extend Chef::Mixin::WideString
# Creates a symbolic link called +new_name+ for the file or directory
# +old_name+.
#
# This method requires Windows Vista or later to work. Otherwise, it
# returns nil as per MRI.
#
def self.link(old_name, new_name)
raise Errno::ENOENT, "(#{old_name}, #{new_name})" unless ::File.exist?(old_name) || ::File.symlink?(old_name)
# TODO do a check for CreateHardLinkW and
# raise NotImplemented exception on older Windows
old_name = encode_path(old_name)
new_name = encode_path(new_name)
unless CreateHardLinkW(new_name, old_name, nil)
Chef::ReservedNames::Win32::Error.raise!
end
end
# Creates a symbolic link called +new_name+ for the file or directory
# +old_name+.
#
# This method requires Windows Vista or later to work. Otherwise, it
# returns nil as per MRI.
#
def self.symlink(old_name, new_name)
# raise Errno::ENOENT, "(#{old_name}, #{new_name})" unless ::File.exist?(old_name) || ::File.symlink?(old_name)
# TODO do a check for CreateSymbolicLinkW and
# raise NotImplemented exception on older Windows
flags = ::File.directory?(old_name) ? SYMBOLIC_LINK_FLAG_DIRECTORY : 0
old_name = encode_path(old_name)
new_name = encode_path(new_name)
unless CreateSymbolicLinkW(new_name, old_name, flags)
Chef::ReservedNames::Win32::Error.raise!
end
end
# Return true if the named file is a symbolic link, false otherwise.
#
# This method requires Windows Vista or later to work. Otherwise, it
# always returns false as per MRI.
#
def self.symlink?(file_name)
is_symlink = false
path = encode_path(file_name)
if ::File.exists?(file_name) || ::File.symlink?(file_name)
if (GetFileAttributesW(path) & FILE_ATTRIBUTE_REPARSE_POINT) > 0
file_search_handle(file_name) do |handle, find_data|
if find_data[:dw_reserved_0] == IO_REPARSE_TAG_SYMLINK
is_symlink = true
end
end
end
end
is_symlink
end
# Returns the path of the of the symbolic link referred to by +file+.
#
# Requires Windows Vista or later. On older versions of Windows it
# will raise a NotImplementedError, as per MRI.
#
def self.readlink(link_name)
raise Errno::ENOENT, link_name unless ::File.exists?(link_name) || ::File.symlink?(link_name)
symlink_file_handle(link_name) do |handle|
# Go to DeviceIoControl to get the symlink information
# http://msdn.microsoft.com/en-us/library/windows/desktop/aa364571(v=vs.85).aspx
reparse_buffer = FFI::MemoryPointer.new(MAXIMUM_REPARSE_DATA_BUFFER_SIZE)
parsed_size = FFI::Buffer.new(:long).write_long(0)
if DeviceIoControl(handle, FSCTL_GET_REPARSE_POINT, nil, 0, reparse_buffer, MAXIMUM_REPARSE_DATA_BUFFER_SIZE, parsed_size, nil) == 0
Chef::ReservedNames::Win32::Error.raise!
end
# Ensure it's a symbolic link
reparse_buffer = REPARSE_DATA_BUFFER.new(reparse_buffer)
if reparse_buffer[:ReparseTag] != IO_REPARSE_TAG_SYMLINK
raise Errno::EACCES, "#{link_name} is not a symlink"
end
# Return the link destination (strip off \??\ at the beginning, which is a local filesystem thing)
link_dest = reparse_buffer.reparse_buffer.substitute_name
if link_dest =~ /^\\\?\?\\/
link_dest = link_dest[4..-1]
end
link_dest
end
end
# Gets the short form of a path (Administrator -> ADMINI~1)
def self.get_short_path_name(path)
path = path.to_wstring
size = GetShortPathNameW(path, nil, 0)
if size == 0
Chef::ReservedNames::Win32::Error.raise!
end
result = FFI::MemoryPointer.new :char, (size + 1) * 2
if GetShortPathNameW(path, result, size + 1) == 0
Chef::ReservedNames::Win32::Error.raise!
end
result.read_wstring(size)
end
# Gets the long form of a path (ADMINI~1 -> Administrator)
def self.get_long_path_name(path)
path = path.to_wstring
size = GetLongPathNameW(path, nil, 0)
if size == 0
Chef::ReservedNames::Win32::Error.raise!
end
result = FFI::MemoryPointer.new :char, (size + 1) * 2
if GetLongPathNameW(path, result, size + 1) == 0
Chef::ReservedNames::Win32::Error.raise!
end
result.read_wstring(size)
end
def self.info(file_name)
Info.new(file_name)
end
def self.version_info(file_name)
VersionInfo.new(file_name)
end
def self.verify_links_supported!
begin
CreateSymbolicLinkW(nil)
rescue Chef::Exceptions::Win32APIFunctionNotImplemented => e
raise e
rescue Exception
# things are ok.
end
end
def self.file_access_check(path, desired_access)
security_descriptor = Chef::ReservedNames::Win32::Security.get_file_security(path)
token_rights = Chef::ReservedNames::Win32::Security::TOKEN_IMPERSONATE |
Chef::ReservedNames::Win32::Security::TOKEN_QUERY |
Chef::ReservedNames::Win32::Security::TOKEN_DUPLICATE |
Chef::ReservedNames::Win32::Security::STANDARD_RIGHTS_READ
token = Chef::ReservedNames::Win32::Security.open_process_token(
Chef::ReservedNames::Win32::Process.get_current_process,
token_rights)
duplicate_token = token.duplicate_token(:SecurityImpersonation)
mapping = Chef::ReservedNames::Win32::Security::GENERIC_MAPPING.new
mapping[:GenericRead] = Chef::ReservedNames::Win32::Security::FILE_GENERIC_READ
mapping[:GenericWrite] = Chef::ReservedNames::Win32::Security::FILE_GENERIC_WRITE
mapping[:GenericExecute] = Chef::ReservedNames::Win32::Security::FILE_GENERIC_EXECUTE
mapping[:GenericAll] = Chef::ReservedNames::Win32::Security::FILE_ALL_ACCESS
Chef::ReservedNames::Win32::Security.access_check(security_descriptor, duplicate_token,
desired_access, mapping)
end
def self.delete_volume_mount_point(mount_point)
unless DeleteVolumeMountPointW(wstring(mount_point))
Chef::ReservedNames::Win32::Error.raise!
end
end
def self.set_volume_mount_point(mount_point, name)
unless SetVolumeMountPointW(wstring(mount_point), wstring(name))
Chef::ReservedNames::Win32::Error.raise!
end
end
def self.get_volume_name_for_volume_mount_point(mount_point)
buffer = FFI::MemoryPointer.new(2, 128)
unless GetVolumeNameForVolumeMountPointW(wstring(mount_point), buffer, buffer.size / buffer.type_size)
Chef::ReservedNames::Win32::Error.raise!
end
buffer.read_wstring
end
# ::File compat
class << self
alias :stat :info
end
end
end
end
require "chef/win32/file/info"
require "chef/win32/file/version_info"
|
