]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/CIFSPlugin.pm
1 package PVE
::Storage
::CIFSPlugin
;
6 use PVE
::Tools
qw(run_command);
9 use PVE
::Storage
::Plugin
;
10 use PVE
::JSONSchema
qw(get_standard_option);
12 use base
qw(PVE::Storage::Plugin);
14 # CIFS helper functions
17 my ($server, $share, $mountpoint, $mountdata) = @_;
19 $server = "[$server]" if Net
::IP
::ip_is_ipv6
($server);
20 my $source = "//${server}/$share";
21 $mountdata = PVE
::ProcFSTools
::parse_proc_mounts
() if !$mountdata;
23 return $mountpoint if grep {
25 $_->[0] =~ m
|^\Q
$source\E/?$| &&
26 $_->[1] eq $mountpoint
31 sub cifs_cred_file_name
{
33 return "/etc/pve/priv/storage/${storeid}.pw";
36 sub cifs_delete_credentials
{
39 if (my $cred_file = get_cred_file
($storeid)) {
40 unlink($cred_file) or warn "removing cifs credientials '$cred_file' failed: $!\n";
44 sub cifs_set_credentials
{
45 my ($password, $storeid) = @_;
47 my $cred_file = cifs_cred_file_name
($storeid);
48 mkdir "/etc/pve/priv/storage";
50 PVE
::Tools
::file_set_contents
($cred_file, "password=$password\n");
58 my $cred_file = cifs_cred_file_name
($storeid);
67 my ($server, $share, $mountpoint, $storeid, $smbver, $user, $domain) = @_;
69 $server = "[$server]" if Net
::IP
::ip_is_ipv6
($server);
70 my $source = "//${server}/$share";
72 my $cmd = ['/bin/mount', '-t', 'cifs', $source, $mountpoint, '-o', 'soft', '-o'];
74 if (my $cred_file = get_cred_file
($storeid)) {
75 push @$cmd, "username=$user", '-o', "credentials=$cred_file";
76 push @$cmd, '-o', "domain=$domain" if defined($domain);
78 push @$cmd, 'guest,username=guest';
81 push @$cmd, '-o', defined($smbver) ?
"vers=$smbver" : "vers=default";
83 run_command
($cmd, errmsg
=> "mount error");
94 content
=> [ { images
=> 1, rootdir
=> 1, vztmpl
=> 1, iso
=> 1,
95 backup
=> 1, snippets
=> 1}, { images
=> 1 }],
96 format
=> [ { raw
=> 1, qcow2
=> 1, vmdk
=> 1 } , 'raw' ],
103 description
=> "CIFS share.",
107 description
=> "Password for accessing the share/datastore.",
112 description
=> "CIFS domain.",
118 description
=> "SMB protocol version. 'default' if not set, negotiates the highest SMB2+"
119 ." version supported by both the client and server.",
121 default => 'default',
122 enum
=> ['default', '2.0', '2.1', '3', '3.0', '3.11'],
130 path
=> { fixed
=> 1 },
131 server
=> { fixed
=> 1 },
132 share
=> { fixed
=> 1 },
133 nodes
=> { optional
=> 1 },
134 disable
=> { optional
=> 1 },
135 maxfiles
=> { optional
=> 1 },
136 'prune-backups' => { optional
=> 1 },
137 content
=> { optional
=> 1 },
138 format
=> { optional
=> 1 },
139 username
=> { optional
=> 1 },
140 password
=> { optional
=> 1},
141 domain
=> { optional
=> 1},
142 smbversion
=> { optional
=> 1},
143 mkdir => { optional
=> 1 },
144 bwlimit
=> { optional
=> 1 },
145 preallocation
=> { optional
=> 1 },
151 my ($class, $sectionId, $config, $create, $skipSchemaCheck) = @_;
153 $config->{path
} = "/mnt/pve/$sectionId" if $create && !$config->{path
};
155 return $class->SUPER::check_config
($sectionId, $config, $create, $skipSchemaCheck);
158 # Storage implementation
161 my ($class, $storeid, $scfg, %sensitive) = @_;
163 if (defined($sensitive{password
})) {
164 cifs_set_credentials
($sensitive{password
}, $storeid);
165 if (!exists($scfg->{username
})) {
166 warn "storage $storeid: ignoring password parameter, no user set\n";
169 cifs_delete_credentials
($storeid);
176 my ($class, $storeid, $scfg, %sensitive) = @_;
178 return if !exists($sensitive{password
});
180 if (defined($sensitive{password
})) {
181 cifs_set_credentials
($sensitive{password
}, $storeid);
182 if (!exists($scfg->{username
})) {
183 warn "storage $storeid: ignoring password parameter, no user set\n";
186 cifs_delete_credentials
($storeid);
193 my ($class, $storeid, $scfg) = @_;
195 cifs_delete_credentials
($storeid);
201 my ($class, $storeid, $scfg, $cache) = @_;
203 $cache->{mountdata
} = PVE
::ProcFSTools
::parse_proc_mounts
()
204 if !$cache->{mountdata
};
206 my $path = $scfg->{path
};
207 my $server = $scfg->{server
};
208 my $share = $scfg->{share
};
211 if !cifs_is_mounted
($server, $share, $path, $cache->{mountdata
});
213 return $class->SUPER::status
($storeid, $scfg, $cache);
216 sub activate_storage
{
217 my ($class, $storeid, $scfg, $cache) = @_;
219 $cache->{mountdata
} = PVE
::ProcFSTools
::parse_proc_mounts
()
220 if !$cache->{mountdata
};
222 my $path = $scfg->{path
};
223 my $server = $scfg->{server
};
224 my $share = $scfg->{share
};
226 if (!cifs_is_mounted
($server, $share, $path, $cache->{mountdata
})) {
228 mkpath
$path if !(defined($scfg->{mkdir}) && !$scfg->{mkdir});
230 die "unable to activate storage '$storeid' - " .
231 "directory '$path' does not exist\n" if ! -d
$path;
233 cifs_mount
($server, $share, $path, $storeid, $scfg->{smbversion
},
234 $scfg->{username
}, $scfg->{domain
});
237 $class->SUPER::activate_storage
($storeid, $scfg, $cache);
240 sub deactivate_storage
{
241 my ($class, $storeid, $scfg, $cache) = @_;
243 $cache->{mountdata
} = PVE
::ProcFSTools
::parse_proc_mounts
()
244 if !$cache->{mountdata
};
246 my $path = $scfg->{path
};
247 my $server = $scfg->{server
};
248 my $share = $scfg->{share
};
250 if (cifs_is_mounted
($server, $share, $path, $cache->{mountdata
})) {
251 my $cmd = ['/bin/umount', $path];
252 run_command
($cmd, errmsg
=> 'umount error');
256 sub check_connection
{
257 my ($class, $storeid, $scfg) = @_;
259 my $servicename = '//'.$scfg->{server
}.'/'.$scfg->{share
};
261 my $cmd = ['/usr/bin/smbclient', $servicename, '-d', '0'];
263 if (defined($scfg->{smbversion
}) && $scfg->{smbversion
} ne 'default') {
264 # max-protocol version, so basically only relevant for smb2 vs smb3
265 push @$cmd, '-m', "smb" . int($scfg->{smbversion
});
268 if (my $cred_file = get_cred_file
($storeid)) {
269 push @$cmd, '-U', $scfg->{username
}, '-A', $cred_file;
270 push @$cmd, '-W', $scfg->{domain
} if defined($scfg->{domain
});
272 push @$cmd, '-U', 'Guest','-N';
274 push @$cmd, '-c', 'echo 1 0';
277 my $out = sub { $out_str .= shift };
279 eval { run_command
($cmd, timeout
=> 10, outfunc
=> $out, errfunc
=> sub {}) };
282 die "$out_str\n" if defined($out_str) &&
283 ($out_str =~ m/NT_STATUS_ACCESS_DENIED/);
290 # FIXME remove on the next APIAGE reset.
291 # Deprecated, use get_volume_attribute instead.
292 sub get_volume_notes
{
294 PVE
::Storage
::DirPlugin
::get_volume_notes
($class, @_);
297 # FIXME remove on the next APIAGE reset.
298 # Deprecated, use update_volume_attribute instead.
299 sub update_volume_notes
{
301 PVE
::Storage
::DirPlugin
::update_volume_notes
($class, @_);
304 sub get_volume_attribute
{
305 return PVE
::Storage
::DirPlugin
::get_volume_attribute
(@_);
308 sub update_volume_attribute
{
309 return PVE
::Storage
::DirPlugin
::update_volume_attribute
(@_);