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 $self->update_ticket($data->{ticket
});
133 $self->update_csrftoken($data->{CSRFPreventionToken
});
138 sub manual_verify_fingerprint
{
139 my ($self, $fingerprint) = @_;
141 if (!$self->{manual_verification
}) {
142 raise
("fingerprint '$fingerprint' not verified, abort!\n");
145 print "The authenticity of host '$self->{host}' can't be established.\n" .
146 "X509 SHA256 key fingerprint is $fingerprint.\n" .
147 "Are you sure you want to continue connecting (yes/no)? ";
151 my $valid = ($answer =~ m/^\s*yes\s*$/i) ?
1 : 0;
153 $self->{cached_fingerprints
}->{$fingerprint} = $valid;
155 raise
("Fingerprint not verified, abort!\n") if !$valid;
157 if (my $cb = $self->{register_fingerprint_cb
}) {
158 $cb->($fingerprint) if $valid;
165 my ($self, $method, $path, $param) = @_;
167 delete $self->{last_unknown_fingerprint
};
169 my $ticket = $self->{ticket
};
171 my $ua = $self->{useragent
};
173 # fixme: check ticket lifetime?
175 if (!$ticket && $self->{username
} && $self->{password
}) {
179 my $uri = URI-
>new();
180 $uri->scheme($self->{protocol
});
181 $uri->host($self->{host
});
182 $uri->port($self->{port
});
186 if ($path !~ m!^api2/!) {
187 $uri->path("api2/json/$path");
192 #print "CALL $method : " . $uri->as_string() . "\n";
194 my $exec_method = sub {
197 if ($method eq 'GET') {
198 $uri->query_form($param);
199 $response = $ua->request(HTTP
::Request
::Common
::GET
($uri));
200 } elsif ($method eq 'POST') {
201 $response = $ua->request(HTTP
::Request
::Common
::POST
($uri, Content
=> $param));
202 } elsif ($method eq 'PUT') {
203 # We use another temporary URI object to format
204 # the application/x-www-form-urlencoded content.
206 my $tmpurl = URI-
>new('http:');
207 $tmpurl->query_form(%$param);
208 my $content = $tmpurl->query;
210 $response = $ua->request(HTTP
::Request
::Common
::PUT
($uri, 'Content-Type' => 'application/x-www-form-urlencoded', Content
=> $content));
212 } elsif ($method eq 'DELETE') {
213 $response = $ua->request(HTTP
::Request
::Common
::DELETE
($uri));
215 raise
("method $method not implemented\n");
220 my $response = $exec_method->();
222 if (my $fp = delete($self->{last_unknown_fingerprint
})) {
223 if ($self->manual_verify_fingerprint($fp)) {
224 $response = $exec_method->(); # try again
228 #print "RESP: " . Dumper($response) . "\n";
230 my $ct = $response->header('Content-Type') || '';
232 if ($response->is_success) {
234 raise
("got unexpected content type", code
=> $response->code)
235 if $ct !~ m
|application
/json
|;
237 return from_json
($response->decoded_content, {utf8
=> 1, allow_nonref
=> 1});
241 my $msg = $response->message;
243 return if $ct !~ m
|application
/json
|;
244 my $res = from_json
($response->decoded_content, {utf8
=> 1, allow_nonref
=> 1});
245 return $res->{errors
};
248 raise
("$msg\n", code
=> $response->code, errors
=> $errors);
252 my $verify_cert_callback = sub {
253 my ($self, $cert) = @_;
255 # check server certificate against cache of pinned FPs
256 # get fingerprint of server certificate
257 my $fp = Net
::SSLeay
::X509_get_fingerprint
($cert, 'sha256');
258 return 0 if !defined($fp) || $fp eq ''; # error
260 my $valid = $self->{cached_fingerprints
}->{$fp};
261 return $valid if defined($valid); # return cached result
263 if (my $cb = $self->{verify_fingerprint_cb
}) {
264 $valid = $cb->($cert);
265 $self->{cached_fingerprints
}->{$fp} = $valid;
269 $self->{last_unknown_fingerprint
} = $fp;
275 my ($class, %param) = @_;
277 my $ssl_default_opts = { verify_hostname
=> 0 };
278 my $ssl_opts = $param{ssl_opts
} || $ssl_default_opts;
281 username
=> $param{username
},
282 password
=> $param{password
},
283 host
=> $param{host
} || 'localhost',
284 port
=> $param{port
},
285 protocol
=> $param{protocol
},
286 cookie_name
=> $param{cookie_name
} // 'PVEAuthCookie',
287 manual_verification
=> $param{manual_verification
},
288 cached_fingerprints
=> $param{cached_fingerprints
} || {},
289 verify_fingerprint_cb
=> $param{verify_fingerprint_cb
},
290 register_fingerprint_cb
=> $param{register_fingerprint_cb
},
291 ssl_opts
=> $ssl_opts,
292 timeout
=> $param{timeout
} || 60,
296 if (!$ssl_opts->{SSL_verify_callback
}) {
297 $ssl_opts->{'SSL_verify_mode'} = SSL_VERIFY_PEER
;
298 $ssl_opts->{'SSL_verify_callback'} = sub {
299 my (undef, undef, undef, undef, $cert, $depth) = @_;
301 # we don't care about intermediate or root certificates
302 return 1 if $depth != 0;
304 return $verify_cert_callback->($self, $cert);
308 if (!$self->{port
}) {
309 $self->{port
} = $self->{host
} eq 'localhost' ?
85 : 8006;
311 if (!$self->{protocol
}) {
312 $self->{protocol
} = $self->{host
} eq 'localhost' ?
'http' : 'https';
315 $self->{useragent
} = LWP
::UserAgent-
>new(
316 protocols_allowed
=> [ 'http', 'https'],
317 ssl_opts
=> $ssl_opts,
318 timeout
=> $self->{timeout
},
319 keep_alive
=> $param{keep_alive
} // 50,
322 $self->{useragent
}->default_header('Accept-Encoding' => 'gzip'); # allow gzip
324 $self->update_ticket($param{ticket
}) if $param{ticket
};
325 $self->update_csrftoken($param{csrftoken
}) if $param{csrftoken
};