]>
git.proxmox.com Git - pve-access-control.git/blob - PVE/Auth/LDAP.pm
1 package PVE
::Auth
::LDAP
;
11 use base
qw(PVE::Auth::Plugin);
20 description
=> "LDAP base domain name",
22 pattern
=> '\w+=[^,]+(,\s*\w+=[^,]+)*',
27 description
=> "LDAP user attribute name",
34 description
=> "LDAP bind domain name",
36 pattern
=> '\w+=[^,]+(,\s*\w+=[^,]+)*',
41 description
=> "LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.",
46 description
=> "Verify the server's SSL certificate",
52 description
=> "Path to the CA certificate store",
55 default => '/etc/ssl/certs',
58 description
=> "Path to the client certificate",
63 description
=> "Path to the client certificate key",
68 description
=> "LDAP filter for user sync.",
74 description
=> "Comma separated list of key=value pairs for specifying"
75 ." which LDAP attributes map to which PVE user field. For example,"
76 ." to map the LDAP attribute 'mail' to PVEs 'email', write "
77 ." 'email=mail'. By default, each PVE user field is represented "
78 ." by an LDAP attribute of the same name.",
81 pattern
=> '\w+=[^,]+(,\s*\w+=[^,]+)*',
84 description
=> "The objectclasses for users.",
86 default => 'inetorgperson, posixaccount, person, user',
87 format
=> 'ldap-simple-attr-list',
91 description
=> "LDAP base domain name for group sync. If not set, the"
92 ." base_dn will be used.",
94 pattern
=> '\w+=[^,]+(,\s*\w+=[^,]+)*',
99 description
=> "LDAP attribute representing a groups name. If not set"
100 ." or found, the first value of the DN will be used as name.",
102 format
=> 'ldap-simple-attr',
107 description
=> "LDAP filter for group sync.",
113 description
=> "The objectclasses for groups.",
115 default => 'groupOfNames, group, univentionGroup, ipausergroup',
116 format
=> 'ldap-simple-attr-list',
119 'sync-defaults-options' => {
120 description
=> "The default options for behavior of synchronizations.",
122 format
=> 'realm-sync-options',
126 description
=> "LDAP protocol mode.",
128 enum
=> [ 'ldap', 'ldaps', 'ldap+starttls'],
138 server2
=> { optional
=> 1 },
140 bind_dn
=> { optional
=> 1 },
141 password
=> { optional
=> 1 },
143 port
=> { optional
=> 1 },
144 secure
=> { optional
=> 1 },
145 sslversion
=> { optional
=> 1 },
146 default => { optional
=> 1 },
147 comment
=> { optional
=> 1 },
148 tfa
=> { optional
=> 1 },
149 verify
=> { optional
=> 1 },
150 capath
=> { optional
=> 1 },
151 cert
=> { optional
=> 1 },
152 certkey
=> { optional
=> 1 },
153 filter
=> { optional
=> 1 },
154 sync_attributes
=> { optional
=> 1 },
155 user_classes
=> { optional
=> 1 },
156 group_dn
=> { optional
=> 1 },
157 group_name_attr
=> { optional
=> 1 },
158 group_filter
=> { optional
=> 1 },
159 group_classes
=> { optional
=> 1 },
160 'sync-defaults-options' => { optional
=> 1 },
161 mode
=> { optional
=> 1 },
165 sub get_scheme_and_port
{
166 my ($class, $config) = @_;
168 my $scheme = $config->{mode
} // ($config->{secure
} ?
'ldaps' : 'ldap');
170 my $default_port = $scheme eq 'ldaps' ?
636 : 389;
171 my $port = $config->{port
} // $default_port;
173 return ($scheme, $port);
176 sub connect_and_bind
{
177 my ($class, $config, $realm) = @_;
179 my $servers = [$config->{server1
}];
180 push @$servers, $config->{server2
} if $config->{server2
};
182 my ($scheme, $port) = $class->get_scheme_and_port($config);
185 if ($config->{verify
}) {
186 $ldap_args{verify
} = 'require';
187 $ldap_args{clientcert
} = $config->{cert
} if $config->{cert
};
188 $ldap_args{clientkey
} = $config->{certkey
} if $config->{certkey
};
189 if (defined(my $capath = $config->{capath
})) {
191 $ldap_args{capath
} = $capath;
193 $ldap_args{cafile
} = $capath;
197 $ldap_args{verify
} = 'none';
200 if ($scheme ne 'ldap') {
201 $ldap_args{sslversion
} = $config->{sslversion
} || 'tlsv1_2';
204 my $ldap = PVE
::LDAP
::ldap_connect
($servers, $scheme, $port, \
%ldap_args);
209 if ($config->{bind_dn
}) {
210 $bind_dn = $config->{bind_dn
};
211 $bind_pass = ldap_get_credentials
($realm);
212 die "missing password for realm $realm\n" if !defined($bind_pass);
215 PVE
::LDAP
::ldap_bind
($ldap, $bind_dn, $bind_pass);
217 if (!$config->{base_dn
}) {
218 my $root = $ldap->root_dse(attrs
=> [ 'defaultNamingContext' ]);
219 $config->{base_dn
} = $root->get_value('defaultNamingContext');
227 # 'username@realm' => {
228 # 'attr1' => 'value1',
229 # 'attr2' => 'value2',
235 # or in list context:
238 # 'username@realm' => {
239 # 'attr1' => 'value1',
240 # 'attr2' => 'value2',
246 # 'uid=username,dc=....' => 'username@realm',
250 # the map of dn->username is needed for group membership sync
252 my ($class, $config, $realm) = @_;
254 my $ldap = $class->connect_and_bind($config, $realm);
256 my $user_name_attr = $config->{user_attr
} // 'uid';
257 my $ldap_attribute_map = {
258 $user_name_attr => 'username',
261 firstname
=> 'firstname',
262 lastname
=> 'lastname',
264 comment
=> 'comment',
268 foreach my $attr (PVE
::Tools
::split_list
($config->{sync_attributes
})) {
269 my ($ours, $ldap) = ($attr =~ m/^\s*(\w+)=(.*)\s*$/);
270 $ldap_attribute_map->{$ldap} = $ours;
273 my $filter = $config->{filter
};
274 my $basedn = $config->{base_dn
};
276 $config->{user_classes
} //= 'inetorgperson, posixaccount, person, user';
277 my $classes = [PVE
::Tools
::split_list
($config->{user_classes
})];
279 my $users = PVE
::LDAP
::query_users
($ldap, $filter, [keys %$ldap_attribute_map], $basedn, $classes);
284 foreach my $user (@$users) {
285 my $user_attributes = $user->{attributes
};
286 my $userid = $user_attributes->{$user_name_attr}->[0];
287 my $username = "$userid\@$realm";
289 # we cannot sync usernames that do not meet our criteria
290 eval { PVE
::Auth
::Plugin
::verify_username
($username) };
296 $ret->{$username} = {};
298 foreach my $attr (keys %$user_attributes) {
299 if (my $ours = $ldap_attribute_map->{$attr}) {
300 $ret->{$username}->{$ours} = $user_attributes->{$attr}->[0];
305 my $dn = $user->{dn
};
306 $dnmap->{$dn} = $username;
310 return wantarray ?
($ret, $dnmap) : $ret;
313 # needs a map for dn -> username, we get this from the get_users call
314 # otherwise we cannot determine the group membership
316 my ($class, $config, $realm, $dnmap) = @_;
318 my $filter = $config->{group_filter
};
319 my $basedn = $config->{group_dn
} // $config->{base_dn
};
320 my $attr = $config->{group_name_attr
};
321 $config->{group_classes
} //= 'groupOfNames, group, univentionGroup, ipausergroup';
322 my $classes = [PVE
::Tools
::split_list
($config->{group_classes
})];
324 my $ldap = $class->connect_and_bind($config, $realm);
326 my $groups = PVE
::LDAP
::query_groups
($ldap, $basedn, $classes, $filter, $attr);
330 foreach my $group (@$groups) {
331 my $name = $group->{name
};
332 if (!$name && $group->{dn
} =~ m/^[^=]+=([^,]+),/){
333 $name = PVE
::Tools
::trim
($1);
338 # we cannot sync groups that do not meet our criteria
339 eval { PVE
::AccessControl
::verify_groupname
($name) };
345 $ret->{$name} = { users
=> {} };
346 foreach my $member (@{$group->{members
}}) {
347 if (my $user = $dnmap->{$member}) {
348 $ret->{$name}->{users
}->{$user} = 1;
357 sub authenticate_user
{
358 my ($class, $config, $realm, $username, $password) = @_;
360 my $ldap = $class->connect_and_bind($config, $realm);
362 my $user_dn = PVE
::LDAP
::get_user_dn
($ldap, $username, $config->{user_attr
}, $config->{base_dn
});
363 PVE
::LDAP
::auth_user_dn
($ldap, $user_dn, $password);
369 my $ldap_pw_dir = "/etc/pve/priv/realm";
371 sub ldap_cred_file_name
{
373 return "${ldap_pw_dir}/${realmid}.pw";
379 my $cred_file = ldap_cred_file_name
($realmid);
382 } elsif (-e
"/etc/pve/priv/ldap/${realmid}.pw") {
383 # FIXME: remove fallback with 7.0 by doing a rename on upgrade from 6.x
384 return "/etc/pve/priv/ldap/${realmid}.pw";
390 sub ldap_set_credentials
{
391 my ($password, $realmid) = @_;
393 my $cred_file = ldap_cred_file_name
($realmid);
396 PVE
::Tools
::file_set_contents
($cred_file, $password);
401 sub ldap_get_credentials
{
404 if (my $cred_file = get_cred_file
($realmid)) {
405 return PVE
::Tools
::file_read_firstline
($cred_file);
410 sub ldap_delete_credentials
{
413 if (my $cred_file = get_cred_file
($realmid)) {
414 unlink($cred_file) or warn "removing LDAP credentials '$cred_file' failed: $!\n";
419 my ($class, $realm, $config, %param) = @_;
421 if (defined($param{password
})) {
422 ldap_set_credentials
($param{password
}, $realm);
424 ldap_delete_credentials
($realm);
429 my ($class, $realm, $config, %param) = @_;
431 return if !exists($param{password
});
433 if (defined($param{password
})) {
434 ldap_set_credentials
($param{password
}, $realm);
436 ldap_delete_credentials
($realm);
441 my ($class, $realm, $config) = @_;
443 ldap_delete_credentials
($realm);