Merge branch 'master' into rorcz
[girocco.git] / Girocco / User.pm
blob92a929ae1d139beaa09c6daf33b1549a0e1968cc
1 package Girocco::User;
3 use strict;
4 use warnings;
6 use Digest::MD5 qw(md5);
8 use Girocco::Config;
9 use Girocco::CGI;
10 use Girocco::Util;
11 use Girocco::SSHUtil;
13 BEGIN {
14 eval {
15 require Digest::SHA;
16 Digest::SHA->import(
17 qw(sha1_hex)
18 );1} ||
19 eval {
20 require Digest::SHA1;
21 Digest::SHA1->import(
22 qw(sha1_hex)
23 );1} ||
24 eval {
25 require Digest::SHA::PurePerl;
26 Digest::SHA::PurePerl->import(
27 qw(sha1_hex)
28 );1} ||
29 die "One of Digest::SHA or Digest::SHA1 or Digest::SHA::PurePerl "
30 . "must be available\n";
33 sub _gen_uuid {
34 my $self = shift;
36 $self->{uuid} = '' unless $self->{uuid};
37 my @md5;
39 no warnings;
40 @md5 = unpack('C*', md5(time . $$ . rand() . join(':',%$self)));
42 $md5[6] = 0x40 | ($md5[6] & 0x0F); # Version 4 -- random
43 $md5[8] = 0x80 | ($md5[8] & 0x3F); # RFC 4122 specification
44 return sprintf(
45 '%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x',
46 @md5);
49 sub _remove_ssh_leftovers {
50 my $self = shift;
51 system "rm -f '$Girocco::Config::chroot/etc/sshkeys/$self->{name}'";
52 system "rm -f '$Girocco::Config::chroot/etc/sshcerts/${Girocco::Config::nickname}_$self->{name}'_user_*.pem";
55 sub _passwd_add {
56 my $self = shift;
57 my (undef, undef, $gid) = getgrnam($Girocco::Config::owning_group||'');
58 my $owngroupid = $gid ? $gid : 65534;
59 Girocco::User->load($self->{name}) and die "User $self->{name} already exists";
60 $self->{uuid} = $self->_gen_uuid;
61 my $email_uuid = join ',', $self->{email}, $self->{uuid};
62 filedb_atomic_append(jailed_file('/etc/passwd'),
63 join(':', $self->{name}, 'x', '\i', $owngroupid, $email_uuid, '/', '/bin/git-shell-verify'));
64 $self->_remove_ssh_leftovers;
67 sub _passwd_update {
68 my $self = shift;
69 filedb_atomic_edit(jailed_file('/etc/passwd'),
70 sub {
71 $_ = $_[0];
72 chomp;
73 if ($self->{name} eq (split /:/)[0]) {
74 # preserve all but login name and comment field
75 my @fields=split(/:/, $_, -1);
76 $fields[0] = $self->{name};
77 $self->{uuid} = (split(',', $fields[4]))[1] || '';
78 $self->{uuid} or $self->{uuid} = $self->_gen_uuid;
79 $fields[4] = join(',', $self->{email}, $self->{uuid});
80 return join(':', @fields)."\n";
81 } else {
82 return "$_\n";
88 sub _passwd_remove {
89 my $self = shift;
90 $self->_remove_ssh_leftovers;
91 filedb_atomic_edit(jailed_file('/etc/passwd'),
92 sub {
93 $self->{name} ne (split /:/)[0] and return $_;
98 sub _sshkey_path {
99 my $self = shift;
100 '/etc/sshkeys/'.$self->{name};
103 sub _sshkey_load {
104 my $self = shift;
105 open F, '<', jailed_file($self->_sshkey_path) or die "sshkey load failed: $!";
106 my @keys = ();
107 my $auth = '';
108 my $authtype = '';
109 while (<F>) {
110 chomp;
111 if (/^ssh-(?:dss|rsa) /) {
112 push @keys, $_;
113 } elsif (/^# ([A-Z]+)AUTH ([0-9a-f]+) (\d+)/) {
114 my $expire = $3;
115 $auth = $2 unless (time >= $expire);
116 $authtype = $1 if $auth;
119 close F;
120 my $keys = join("\n", @keys); chomp $keys;
121 ($keys, $auth, $authtype);
124 sub _trimkeys {
125 my $keys = shift;
126 my @lines = ();
127 foreach (split /\r\n|\r|\n/, $keys) {
128 next if /^[ \t]*$/ || /^[ \t]*#/;
129 push(@lines, $_);
131 return join("\n", @lines);
134 sub _sshkey_save {
135 my $self = shift;
136 $self->{keys} = _trimkeys($self->{keys} || '');
137 open F, '>', jailed_file($self->_sshkey_path) or die "sshkey save failed: $!";
138 if (defined($self->{auth}) && $self->{auth}) {
139 my $expire = time + 24 * 3600;
140 my $typestr = $self->{authtype} ? uc($self->{authtype}) : 'REPO';
141 print F "# ${typestr}AUTH $self->{auth} $expire\n";
143 print F $self->{keys};
144 print F "\n" if $self->{keys};
145 close F;
146 chmod 0664, jailed_file($self->_sshkey_path);
149 # private constructor, do not use
150 sub _new {
151 my $class = shift;
152 my ($name) = @_;
153 Girocco::User::valid_name($name) or die "refusing to create user with invalid name ($name)!";
154 my $proj = { name => $name };
156 bless $proj, $class;
159 # public constructor #0
160 # creates a virtual user not connected to disk record
161 # you can conjure() it later to disk
162 sub ghost {
163 my $class = shift;
164 my ($name) = @_;
165 my $self = $class->_new($name);
166 $self;
169 # public constructor #1
170 sub load {
171 my $class = shift;
172 my ($name) = @_;
174 open F, '<', jailed_file("/etc/passwd") or die "user load failed: $!";
175 while (<F>) {
176 chomp;
177 @_ = split /:/;
178 next unless (shift eq $name);
180 my $self = $class->_new($name);
182 my $email_uuid;
183 (undef, $self->{uid}, undef, $email_uuid) = @_;
184 ($self->{keys}, $self->{auth}, $self->{authtype}) = $self->_sshkey_load;
185 ($self->{email}, $self->{uuid}) = split ',', $email_uuid;
187 close F;
188 $self->{uuid} or $self->_passwd_update;
189 return $self;
191 close F;
192 undef;
195 # public constructor #2
196 sub load_by_uid {
197 my $class = shift;
198 my ($uid) = @_;
200 open F, '<', jailed_file("/etc/passwd") or die "user load failed: $!";
201 while (<F>) {
202 chomp;
203 @_ = split /:/;
204 next unless ($_[2] eq $uid);
206 my $self = $class->_new($_[0]);
208 my $email_uuid;
209 (undef, undef, $self->{uid}, undef, $email_uuid) = @_;
210 ($self->{keys}, $self->{auth}, $self->{authtype}) = $self->_sshkey_load;
211 ($self->{email}, $self->{uuid}) = split ',', $email_uuid;
213 close F;
214 $self->{uuid} or $self->_passwd_update;
215 return $self;
217 close F;
218 undef;
221 # $user may not be in sane state if this returns false!
222 sub cgi_fill {
223 my $self = shift;
224 my ($gcgi) = @_;
225 my $cgi = $gcgi->cgi;
227 $self->{name} = $gcgi->wparam('name');
228 Girocco::User::valid_name($self->{name})
229 or $gcgi->err("Name contains invalid characters.");
231 $self->{email} = $gcgi->wparam('email');
232 valid_email($self->{email})
233 or $gcgi->err("Your email sure looks weird...?");
235 $self->keys_fill($gcgi);
238 sub update_email {
239 my $self = shift;
240 my $gcgi = shift;
241 my $email = shift || '';
243 if (valid_email($email)) {
244 $self->{email} = $email;
245 $self->_passwd_update;
246 } else {
247 $gcgi->err("Your email sure looks weird...?");
250 not $gcgi->err_check;
253 sub _checkkey {
254 my $key = shift;
255 my ($type, $bits, $fingerprint, $comment) = sshpub_validate($key);
256 return $type ? 1 : 0;
259 sub keys_fill {
260 my $self = shift;
261 my ($gcgi) = @_;
262 my $cgi = $gcgi->cgi;
264 $self->{keys} = _trimkeys($cgi->param('keys'));
265 length($self->{keys}) <= 4096
266 or $gcgi->err("The list of keys is more than 4kb. Do you really need that much?");
267 foreach my $key (split /\r?\n/, $self->{keys}) {
268 my ($type, $bits, $fingerprint, $comment);
269 ($type, $bits, $fingerprint, $comment) = sshpub_validate($key)
270 if $key =~ /^ssh-(?:dss|rsa) [0-9A-Za-z+\/=]+ \S+@\S+$/;
271 if (!$type) {
272 my $keyval = CGI::escapeHTML($key);
273 my $dsablurb = '';
274 $dsablurb = ' or ssh-dss' unless $Girocco::Config::disable_dsa;
275 $gcgi->err(<<EOT);
276 Your ssh key ("$keyval") appears to have an invalid format
277 (does not start with ssh-rsa$dsablurb or does not end with <tt>\@</tt>-identifier) -
278 maybe your browser has split a single key onto multiple lines?
280 } elsif ($Girocco::Config::disable_dsa && $type eq 'ssh-dss') {
281 my $keyval = CGI::escapeHTML($key);
282 $gcgi->err(<<EOT);
283 Your ssh key ("$keyval") appears to be of type dsa but only rsa keys are
284 supported - please generate an rsa key (starts with ssh-rsa) and try again
286 } elsif ($Girocco::Config::min_key_length && $bits < $Girocco::Config::min_key_length) {
287 my $keyval = CGI::escapeHTML($key);
288 $gcgi->err(<<EOT);
289 Your ssh key ("$keyval") appears to have only $bits bit(s) but at least
290 $Girocco::Config::min_key_length are required - please generate a longer key
295 not $gcgi->err_check;
298 sub keys_save {
299 my $self = shift;
301 $self->_sshkey_save;
304 sub keys_html_list {
305 my $self = shift;
306 my @keys = split(/\r?\n/, $self->{keys});
307 return '' if !@keys;
308 my $html = "<ol>\n";
309 my %types = ('ssh-dss' => 'DSA', 'ssh-rsa' => 'RSA');
310 my $line = 0;
311 foreach (@keys) {
312 ++$line;
313 my ($type, $bits, $fingerprint, $comment) = sshpub_validate($_);
314 next unless $type && $types{$type};
315 my $euser = CGI::escapeHTML(CGI::Util::escape($self->{name}));
316 $html .= "<li>$bits <tt>$fingerprint</tt> ($types{$type}) $comment";
317 $html .= "<br /><a target=\"_blank\" ".
318 "href=\"@{[url_path($Girocco::Config::webadmurl)]}/usercert.cgi/$euser/$line/".
319 $Girocco::Config::nickname."_${euser}_user_$line.pem\">".
320 "download https push user authentication certificate</a> <sup>".
321 "<a target=\"_blank\" href=\"@{[url_path($Girocco::Config::htmlurl)]}/httpspush.html\">".
322 "(learn more)</a></sup>"
323 if $type eq 'ssh-rsa' && $Girocco::Config::httpspushurl &&
324 $Girocco::Config::clientcert &&
325 $Girocco::Config::clientkey;
326 $html .= "</li>\n";
328 $html .= "</ol>\n";
329 return $html;
332 sub gen_auth {
333 my $self = shift;
334 my ($type) = @_;
335 $type = 'REPO' unless $type && $type =~ /^[A-Z]+$/;
337 $self->{authtype} = $type;
338 $self->{auth} = sha1_hex(time . $$ . rand() . $self->{keys});
339 $self->_sshkey_save;
340 $self->{auth};
343 sub del_auth {
344 my $self = shift;
346 delete $self->{auth};
347 delete $self->{authtype};
350 sub get_projects {
351 my $self = shift;
353 return @{$self->{projects}} if defined($self->{projects});
354 my @projects = filedb_atomic_grep(jailed_file('/etc/group'),
355 sub {
356 $_ = $_[0];
357 chomp;
358 my ($group, $users) = (split /:/)[0,3];
359 $group if $users && $users =~ /(^|,)\Q$self->{name}\E(,|$)/;
362 $self->{projects} = \@projects;
363 @{$self->{projects}};
366 sub conjure {
367 my $self = shift;
369 $self->_passwd_add;
370 $self->_sshkey_save;
373 sub remove {
374 my $self = shift;
376 require Girocco::Project;
377 foreach ($self->get_projects) {
378 if (Girocco::Project::does_exist($_)) {
379 my $project = Girocco::Project->load($_);
380 $project->update if $project->remove_user($self->{name});
384 $self->_passwd_remove;
387 ### static methods
389 sub valid_name {
390 $_ = $_[0];
391 /^[a-zA-Z0-9+._-]+$/;
394 sub does_exist {
395 my ($name) = @_;
396 Girocco::User::valid_name($name) or die "tried to query for user with invalid name $name!";
397 (-e jailed_file("/etc/sshkeys/$name"));
400 sub resolve_uid {
401 my ($name) = @_;
402 $Girocco::Config::chrooted and undef; # TODO for ACLs within chroot
403 scalar(getpwnam($name));