1 package PVE
::APIClient
::LWP
;
6 use IO
::Socket
::SSL
; # important for SSL_verify_callback
11 use Data
::Dumper
; # fixme: remove
12 use HTTP
::Request
::Common
;
14 use PVE
::APIClient
::Exception
qw(raise);
16 my $extract_data = sub {
19 croak
"undefined result" if !defined($res);
20 croak
"undefined result data" if !exists($res->{data
});
26 my ($self, $path, $param) = @_;
28 return $self->call('GET', $path, $param);
32 my ($self, $path, $param) = @_;
34 return $extract_data->($self->call('GET', $path, $param));
38 my ($self, $path, $param) = @_;
40 return $self->call('POST', $path, $param);
44 my ($self, $path, $param) = @_;
46 return $extract_data->($self->call('POST', $path, $param));
50 my ($self, $path, $param) = @_;
52 return $self->call('PUT', $path, $param);
56 my ($self, $path, $param) = @_;
58 return $extract_data->($self->call('PUT', $path, $param));
62 my ($self, $path, $param) = @_;
64 return $self->call('DELETE', $path, $param);
68 my ($self, $path, $param) = @_;
70 return $extract_data->($self->call('DELETE', $path, $param));
73 sub update_csrftoken
{
74 my ($self, $csrftoken) = @_;
76 $self->{csrftoken
} = $csrftoken;
78 my $agent = $self->{useragent
};
80 $agent->default_header('CSRFPreventionToken', $self->{csrftoken
});
84 my ($self, $ticket) = @_;
86 my $agent = $self->{useragent
};
88 $self->{ticket
} = $ticket;
90 my $encticket = uri_escape
($ticket);
91 my $cookie = "$self->{cookie_name}=$encticket; path=/; secure;";
92 $agent->default_header('Cookie', $cookie);
99 $uri->scheme($self->{protocol
});
100 $uri->host($self->{host
});
101 $uri->port($self->{port
});
102 $uri->path('/api2/json/access/ticket');
104 my $ua = $self->{useragent
};
106 delete $self->{last_unknown_fingerprint
};
108 my $exec_login = sub {
109 return $ua->post($uri, {
110 username
=> $self->{username
} || 'unknown',
111 password
=> $self->{password
} || ''});
114 my $response = $exec_login->();
116 if (!$response->is_success) {
117 if (my $fp = delete($self->{last_unknown_fingerprint
})) {
118 if ($self->manual_verify_fingerprint($fp)) {
119 $response = $exec_login->(); # try again
124 if (!$response->is_success) {
125 raise
($response->status_line ."\n", code
=> $response->code)
128 my $res = from_json
($response->decoded_content, {utf8
=> 1, allow_nonref
=> 1});
130 my $data = $extract_data->($res);
132 # TODO: make it possible to use tfa
133 if ($data->{ticket
} =~ m/^PVE:tfa!/) {
134 die "TFA in API is not yet implemented! Try disabling TFA for the user.\n";
137 $self->update_ticket($data->{ticket
});
138 $self->update_csrftoken($data->{CSRFPreventionToken
});
143 sub manual_verify_fingerprint
{
144 my ($self, $fingerprint) = @_;
146 if (!$self->{manual_verification
}) {
147 raise
("fingerprint '$fingerprint' not verified, abort!\n");
150 print "The authenticity of host '$self->{host}' can't be established.\n" .
151 "X509 SHA256 key fingerprint is $fingerprint.\n" .
152 "Are you sure you want to continue connecting (yes/no)? ";
154 my $answer = <STDIN
>;
156 my $valid = ($answer =~ m/^\s*yes\s*$/i) ?
1 : 0;
158 $self->{cached_fingerprints
}->{$fingerprint} = $valid;
160 raise
("Fingerprint not verified, abort!\n") if !$valid;
162 if (my $cb = $self->{register_fingerprint_cb
}) {
163 $cb->($fingerprint) if $valid;
170 my ($self, $method, $path, $param) = @_;
172 delete $self->{last_unknown_fingerprint
};
174 my $ticket = $self->{ticket
};
176 my $ua = $self->{useragent
};
178 # fixme: check ticket lifetime?
180 if (!$ticket && $self->{username
} && $self->{password
}) {
184 my $uri = URI-
>new();
185 $uri->scheme($self->{protocol
});
186 $uri->host($self->{host
});
187 $uri->port($self->{port
});
191 if ($path !~ m!^api2/!) {
192 $uri->path("api2/json/$path");
197 #print "CALL $method : " . $uri->as_string() . "\n";
199 my $exec_method = sub {
202 if ($method eq 'GET') {
203 $uri->query_form($param);
204 $response = $ua->request(HTTP
::Request
::Common
::GET
($uri));
205 } elsif ($method eq 'POST') {
206 $response = $ua->request(HTTP
::Request
::Common
::POST
($uri, Content
=> $param));
207 } elsif ($method eq 'PUT') {
208 # We use another temporary URI object to format
209 # the application/x-www-form-urlencoded content.
211 my $tmpurl = URI-
>new('http:');
212 $tmpurl->query_form(%$param);
213 my $content = $tmpurl->query;
215 $response = $ua->request(HTTP
::Request
::Common
::PUT
($uri, 'Content-Type' => 'application/x-www-form-urlencoded', Content
=> $content));
217 } elsif ($method eq 'DELETE') {
218 $response = $ua->request(HTTP
::Request
::Common
::DELETE
($uri));
220 raise
("method $method not implemented\n");
225 my $response = $exec_method->();
227 if (my $fp = delete($self->{last_unknown_fingerprint
})) {
228 if ($self->manual_verify_fingerprint($fp)) {
229 $response = $exec_method->(); # try again
233 #print "RESP: " . Dumper($response) . "\n";
235 my $ct = $response->header('Content-Type') || '';
237 if ($response->is_success) {
239 raise
("got unexpected content type", code
=> $response->code)
240 if $ct !~ m
|application
/json
|;
242 return from_json
($response->decoded_content, {utf8
=> 1, allow_nonref
=> 1});
246 my $msg = $response->message;
248 return if $ct !~ m
|application
/json
|;
249 my $res = from_json
($response->decoded_content, {utf8
=> 1, allow_nonref
=> 1});
250 return $res->{errors
};
253 raise
("$msg\n", code
=> $response->code, errors
=> $errors);
257 my $verify_cert_callback = sub {
258 my ($self, $cert) = @_;
260 # check server certificate against cache of pinned FPs
261 # get fingerprint of server certificate
262 my $fp = Net
::SSLeay
::X509_get_fingerprint
($cert, 'sha256');
263 return 0 if !defined($fp) || $fp eq ''; # error
265 my $valid = $self->{cached_fingerprints
}->{$fp};
266 return $valid if defined($valid); # return cached result
268 if (my $cb = $self->{verify_fingerprint_cb
}) {
269 $valid = $cb->($cert);
270 $self->{cached_fingerprints
}->{$fp} = $valid;
274 $self->{last_unknown_fingerprint
} = $fp;
280 my ($class, %param) = @_;
282 my $ssl_default_opts = { verify_hostname
=> 0 };
283 my $ssl_opts = $param{ssl_opts
} || $ssl_default_opts;
286 username
=> $param{username
},
287 password
=> $param{password
},
288 host
=> $param{host
} || 'localhost',
289 port
=> $param{port
},
290 protocol
=> $param{protocol
},
291 cookie_name
=> $param{cookie_name
} // 'PVEAuthCookie',
292 manual_verification
=> $param{manual_verification
},
293 cached_fingerprints
=> $param{cached_fingerprints
} || {},
294 verify_fingerprint_cb
=> $param{verify_fingerprint_cb
},
295 register_fingerprint_cb
=> $param{register_fingerprint_cb
},
296 ssl_opts
=> $ssl_opts,
297 timeout
=> $param{timeout
} || 60,
301 if (!$ssl_opts->{SSL_verify_callback
}) {
302 $ssl_opts->{'SSL_verify_mode'} = SSL_VERIFY_PEER
;
303 $ssl_opts->{'SSL_verify_callback'} = sub {
304 my (undef, undef, undef, undef, $cert, $depth) = @_;
306 # we don't care about intermediate or root certificates
307 return 1 if $depth != 0;
309 return $verify_cert_callback->($self, $cert);
313 if (!$self->{port
}) {
314 $self->{port
} = $self->{host
} eq 'localhost' ?
85 : 8006;
316 if (!$self->{protocol
}) {
317 $self->{protocol
} = $self->{host
} eq 'localhost' ?
'http' : 'https';
320 $self->{useragent
} = LWP
::UserAgent-
>new(
321 protocols_allowed
=> [ 'http', 'https'],
322 ssl_opts
=> $ssl_opts,
323 timeout
=> $self->{timeout
},
324 keep_alive
=> $param{keep_alive
} // 50,
327 $self->{useragent
}->default_header('Accept-Encoding' => 'gzip'); # allow gzip
329 $self->update_ticket($param{ticket
}) if $param{ticket
};
330 $self->update_csrftoken($param{csrftoken
}) if $param{csrftoken
};