]>
git.proxmox.com Git - pve-access-control.git/blob - PVE/Auth/Plugin.pm
1 package PVE
::Auth
::Plugin
;
8 use PVE
::SectionConfig
;
9 use PVE
::JSONSchema
qw(get_standard_option);
10 use PVE
::Cluster
qw(cfs_register_file cfs_read_file cfs_lock_file);
14 use base
qw(PVE::SectionConfig);
16 my $domainconfigfile = "domains.cfg";
18 cfs_register_file
($domainconfigfile,
19 sub { __PACKAGE__-
>parse_config(@_); },
20 sub { __PACKAGE__-
>write_config(@_); });
22 sub lock_domain_config
{
23 my ($code, $errmsg) = @_;
25 cfs_lock_file
($domainconfigfile, undef, $code);
28 $errmsg ?
die "$errmsg: $err" : die $err;
32 my $realm_regex = qr/[A-Za-z][A-Za-z0-9\.\-_]+/;
34 PVE
::JSONSchema
::register_format
('pve-realm', \
&pve_verify_realm
);
35 sub pve_verify_realm
{
36 my ($realm, $noerr) = @_;
38 if ($realm !~ m/^${realm_regex}$/) {
39 return undef if $noerr;
40 die "value does not look like a valid realm\n";
45 PVE
::JSONSchema
::register_standard_option
('realm', {
46 description
=> "Authentication domain ID",
47 type
=> 'string', format
=> 'pve-realm',
51 PVE
::JSONSchema
::register_format
('pve-userid', \
&verify_username
);
53 my ($username, $noerr) = @_;
55 $username = '' if !$username;
56 my $len = length($username);
58 die "user name '$username' is too short\n" if !$noerr;
62 die "user name '$username' is too long ($len > 64)\n" if !$noerr;
66 # we only allow a limited set of characters
67 # colon is not allowed, because we store usernames in
68 # colon separated lists)!
69 # slash is not allowed because it is used as pve API delimiter
70 # also see "man useradd"
71 if ($username =~ m!^([^\s:/]+)\@(${realm_regex})$!) {
72 return wantarray ?
($username, $1, $2) : $username;
75 die "value '$username' does not look like a valid user name\n" if !$noerr;
80 PVE
::JSONSchema
::register_standard_option
('userid', {
81 description
=> "User ID",
82 type
=> 'string', format
=> 'pve-userid',
86 PVE
::JSONSchema
::register_format
('pve-tfa-config', \
&verify_tfa_config
);
87 sub verify_tfa_config
{
88 my ($value, $noerr) = @_;
90 return $value if parse_tfa_config
($value);
92 return undef if $noerr;
94 die "unable to parse tfa option\n";
97 PVE
::JSONSchema
::register_standard_option
('tfa', {
98 description
=> "Use Two-factor authentication.",
99 type
=> 'string', format
=> 'pve-tfa-config',
104 sub parse_tfa_config
{
109 foreach my $kvp (split(/,/, $data)) {
111 if ($kvp =~ m/^type=(yubico|oath)$/) {
113 } elsif ($kvp =~ m/^id=(\S+)$/) {
115 } elsif ($kvp =~ m/^key=(\S+)$/) {
117 } elsif ($kvp =~ m/^url=(\S+)$/) {
124 return undef if !$res->{type
};
132 my $time = substr(Digest
::SHA
::sha1_base64
(time), 0, 8);
133 return crypt(encode
("utf8", $pw), "\$5\$$time\$");
138 type
=> { description
=> "Realm type." },
139 realm
=> get_standard_option
('realm'),
147 sub parse_section_header
{
148 my ($class, $line) = @_;
150 if ($line =~ m/^(\S+):\s*(\S+)\s*$/) {
151 my ($type, $realm) = (lc($1), $2);
152 my $errmsg = undef; # set if you want to skip whole section
153 eval { pve_verify_realm
($realm); };
155 my $config = {}; # to return additional attributes
156 return ($type, $realm, $errmsg, $config);
162 my ($class, $filename, $raw) = @_;
164 my $cfg = $class->SUPER::parse_config
($filename, $raw);
167 foreach my $realm (keys %{$cfg->{ids
}}) {
168 my $data = $cfg->{ids
}->{$realm};
169 # make sure there is only one default marker
170 if ($data->{default}) {
172 delete $data->{default};
178 if ($data->{comment
}) {
179 $data->{comment
} = PVE
::Tools
::decode_text
($data->{comment
});
184 # add default domains
186 $cfg->{ids
}->{pve
}->{type
} = 'pve'; # force type
187 $cfg->{ids
}->{pve
}->{comment
} = "Proxmox VE authentication server"
188 if !$cfg->{ids
}->{pve
}->{comment
};
190 $cfg->{ids
}->{pam
}->{type
} = 'pam'; # force type
191 $cfg->{ids
}->{pam
}->{plugin
} = 'PVE::Auth::PAM';
192 $cfg->{ids
}->{pam
}->{comment
} = "Linux PAM standard authentication"
193 if !$cfg->{ids
}->{pam
}->{comment
};
199 my ($class, $filename, $cfg) = @_;
201 foreach my $realm (keys %{$cfg->{ids
}}) {
202 my $data = $cfg->{ids
}->{$realm};
203 if ($data->{comment
}) {
204 $data->{comment
} = PVE
::Tools
::encode_text
($data->{comment
});
208 $class->SUPER::write_config
($filename, $cfg);
211 sub authenticate_user
{
212 my ($class, $config, $realm, $username, $password) = @_;
218 my ($class, $config, $realm, $username, $password) = @_;
220 my $type = $class->type();
222 die "can't set password on auth type '$type'\n";
226 my ($class, $config, $realm, $username) = @_;
228 # do nothing by default