1 package PVE
::Certificate
;
7 use Encode
qw(decode encode);
8 use MIME
::Base64
qw(decode_base64 encode_base64);
11 use PVE
::JSONSchema
qw(get_standard_option);
13 Net
::SSLeay
::load_error_strings
();
14 Net
::SSLeay
::randomize
();
16 PVE
::JSONSchema
::register_format
('pem-certificate', sub {
17 my ($content, $noerr) = @_;
19 return check_pem
($content, noerr
=> $noerr);
22 PVE
::JSONSchema
::register_format
('pem-certificate-chain', sub {
23 my ($content, $noerr) = @_;
25 return check_pem
($content, noerr
=> $noerr, multiple
=> 1);
28 PVE
::JSONSchema
::register_format
('pem-string', sub {
29 my ($content, $noerr) = @_;
31 return check_pem
($content, noerr
=> $noerr, label
=> qr/.*?/);
34 PVE
::JSONSchema
::register_standard_option
('pve-certificate-info', {
41 fingerprint
=> get_standard_option
('fingerprint-sha256', {
46 description
=> 'Certificate subject name.',
51 description
=> 'Certificate issuer name.',
56 description
=> 'Certificate\'s notBefore timestamp (UNIX epoch).',
57 renderer
=> 'timestamp',
62 description
=> 'Certificate\'s notAfter timestamp (UNIX epoch).',
63 renderer
=> 'timestamp',
68 description
=> 'List of Certificate\'s SubjectAlternativeName entries.',
77 description
=> 'Certificate in PEM format',
78 format
=> 'pem-certificate',
81 'public-key-type' => {
83 description
=> 'Certificate\'s public key algorithm',
86 'public-key-bits' => {
88 description
=> 'Certificate\'s public key size',
95 my $b64_char_re = qr![0-9A-Za-z\+/]!;
98 return qr!-----BEGIN\ $label-----(?:\s|\n)*!;
100 my $footer_re = sub {
102 return qr!-----END\ $label-----(?:\s|\n)*!;
107 my $header = $header_re->($label);
108 my $footer = $footer_re->($label);
112 (?
:(?
:$b64_char_re)+\s
*\n)*
113 (?
:$b64_char_re)*(?
:=\s
*\n=|={0,2})?\s
*\n
118 sub strip_leading_text
{
121 my $header = $header_re->(qr/.*?/);
122 $content =~ s/^.*?(?=$header)//s;
127 my ($content, %opts) = @_;
128 my $label = $opts{label
} // 'CERTIFICATE';
130 my $header = $header_re->($label);
131 return split(/(?=$header)/,$content);
135 my ($content, %opts) = @_;
137 my $label = $opts{label
} // 'CERTIFICATE';
138 my $multiple = $opts{multiple
};
139 my $noerr = $opts{noerr
};
141 $content = strip_leading_text
($content);
143 my $re = $pem_re->($label);
145 $re = qr/($re\n+)*$re/ if $multiple;
147 if ($content =~ /^$re$/) {
150 return undef if $noerr;
151 die "not a valid PEM-formatted string.\n";
158 my $header = $header_re->(qr/.*?/);
159 my $footer = $footer_re->(qr/.*?/);
161 $content = strip_leading_text
($content);
163 # only take first PEM entry
164 $content =~ s/^$header$//mg;
165 $content =~ s/$footer.*//sg;
167 $content = decode_base64
($content);
173 my ($content, %opts) = @_;
175 my $label = $opts{label
} // 'CERTIFICATE';
177 my $b64 = encode_base64
($content, '');
178 $b64 = join("\n", ($b64 =~ /.{1,64}/sg));
179 return "-----BEGIN $label-----\n$b64\n-----END $label-----\n";
184 Net
::SSLeay
::die_now
($msg);
189 Net
::SSLeay
::print_errs
();
193 my $read_certificate = sub {
194 my ($cert_path) = @_;
196 die "'$cert_path' does not exist!\n" if ! -e
$cert_path;
198 my $bio = Net
::SSLeay
::BIO_new_file
($cert_path, 'r')
199 or $ssl_die->("unable to read '$cert_path' - $!\n");
201 my $cert = Net
::SSLeay
::PEM_read_bio_X509
($bio);
202 Net
::SSLeay
::BIO_free
($bio);
203 die "unable to read certificate from '$cert_path'\n" if !$cert;
208 sub convert_asn1_to_epoch
{
209 my ($asn1_time) = @_;
211 $ssl_die->("invalid ASN1 time object\n") if !$asn1_time;
212 my $iso_time = Net
::SSLeay
::P_ASN1_TIME_get_isotime
($asn1_time);
213 $ssl_die->("unable to parse ASN1 time\n") if $iso_time eq '';
214 return Date
::Parse
::str2time
($iso_time);
217 sub get_certificate_fingerprint
{
218 my ($cert_path) = @_;
220 my $cert = $read_certificate->($cert_path);
222 my $fp = Net
::SSLeay
::X509_get_fingerprint
($cert, 'sha256');
223 Net
::SSLeay
::X509_free
($cert);
225 die "unable to get fingerprint for '$cert_path' - got empty value\n"
226 if !defined($fp) || $fp eq '';
231 sub certificate_matches_key
{
232 my ($cert_path, $key_path) = @_;
234 die "No certificate path given!\n" if !$cert_path;
235 die "No certificate key path given!\n" if !$key_path;
237 die "Certificate at '$cert_path' does not exist!\n" if ! -e
$cert_path;
238 die "Certificate key '$key_path' does not exist!\n" if ! -e
$key_path;
240 my $ctx = Net
::SSLeay
::CTX_new
()
242 "Failed to create SSL context in order to verify private key"
246 my $filetype = &Net
::SSLeay
::FILETYPE_PEM
;
248 Net
::SSLeay
::CTX_use_PrivateKey_file
($ctx, $key_path, $filetype)
250 "Failed to load private key from '$key_path' into SSL context"
253 Net
::SSLeay
::CTX_use_certificate_file
($ctx, $cert_path, $filetype)
255 "Failed to load certificate from '$cert_path' into SSL context"
258 Net
::SSLeay
::CTX_check_private_key
($ctx)
260 "Failed to validate private key and certificate"
265 Net
::SSLeay
::CTX_free
($ctx);
272 sub get_certificate_info
{
273 my ($cert_path) = @_;
275 my $cert = $read_certificate->($cert_path);
277 my $parse_san = sub {
279 while (my ($type, $value) = splice(@_, 0, 2)) {
280 if ($type != 2 && $type != 7) {
281 warn "unexpected SAN type encountered: $type\n";
286 my $hex = unpack("H*", $value);
287 if (length($hex) == 8) {
289 $value = join(".", unpack("C4C4C4C4", $value));
290 } elsif (length($hex) == 32) {
292 $value = join(":", unpack("H4H4H4H4H4H4H4H4", $value));
294 warn "cannot parse SAN IP entry '0x${hex}'\n";
306 $info->{fingerprint
} = Net
::SSLeay
::X509_get_fingerprint
($cert, 'sha256');
308 my $subject = Net
::SSLeay
::X509_get_subject_name
($cert);
310 $info->{subject
} = Net
::SSLeay
::X509_NAME_oneline
($subject);
313 my $issuer = Net
::SSLeay
::X509_get_issuer_name
($cert);
315 $info->{issuer
} = Net
::SSLeay
::X509_NAME_oneline
($issuer);
318 eval { $info->{notbefore
} = convert_asn1_to_epoch
(Net
::SSLeay
::X509_get_notBefore
($cert)) };
320 eval { $info->{notafter
} = convert_asn1_to_epoch
(Net
::SSLeay
::X509_get_notAfter
($cert)) };
323 $info->{san
} = $parse_san->(Net
::SSLeay
::X509_get_subjectAltNames
($cert));
324 $info->{pem
} = Net
::SSLeay
::PEM_get_string_X509
($cert);
326 my $pub_key = eval { Net
::SSLeay
::X509_get_pubkey
($cert) };
329 $info->{'public-key-type'} = Net
::SSLeay
::OBJ_nid2sn
(Net
::SSLeay
::EVP_PKEY_id
($pub_key));
330 $info->{'public-key-bits'} = Net
::SSLeay
::EVP_PKEY_bits
($pub_key);
331 Net
::SSLeay
::EVP_PKEY_free
($pub_key);
334 Net
::SSLeay
::X509_free
($cert);
336 $cert_path =~ s!^.*/!!g;
337 $info->{filename
} = $cert_path;
342 # Checks whether certificate expires before $timestamp (UNIX epoch)
344 my ($cert_path, $timestamp) = @_;
346 $timestamp //= time();
348 my $cert = $read_certificate->($cert_path);
349 my $not_after = eval { convert_asn1_to_epoch
(Net
::SSLeay
::X509_get_notAfter
($cert)) };
352 Net
::SSLeay
::X509_free
($cert);
356 return ($not_after < $timestamp) ?
1 : 0;
359 # Create a CSR and certificate key for a given order
360 # returns path to CSR file or path to CSR and key files
365 my $bits = delete($attr{bits
}) // 4096;
366 my $dig_alg = delete($attr{digest
}) // 'sha256';
367 my $pem_key = delete($attr{private_key
});
370 my $identifiers = delete($attr{identifiers
});
372 die "Identifiers are required to generate a CSR.\n"
373 if !defined($identifiers);
375 my $san = [ map { $_->{value
} } grep { $_->{type
} eq 'dns' } @$identifiers ];
376 die "DNS identifiers are required to generate a CSR.\n" if !scalar @$san;
379 my $common_name = delete($attr{common_name
}) // $san->[0];
381 my $md = eval { Net
::SSLeay
::EVP_get_digestbyname
($dig_alg) };
382 die "Invalid digest algorithm '$dig_alg'\n" if !$md;
384 my ($bio, $pk, $req);
387 my ($warn, $die_msg) = @_;
388 $ssl_warn->() if $warn;
390 Net
::SSLeay
::X509_REQ_free
($req) if $req;
391 Net
::SSLeay
::EVP_PKEY_free
($pk) if $pk;
392 Net
::SSLeay
::BIO_free
($bio) if $bio;
394 die $die_msg if $die_msg;
397 # this unfortunately causes a small memory leak, since there is no
398 # X509_NAME_free() (yet)
399 my $name = Net
::SSLeay
::X509_NAME_new
();
400 $ssl_die->("Failed to allocate X509_NAME object\n") if !$name;
401 my $add_name_entry = sub {
404 my $res = Net
::SSLeay
::X509_NAME_add_entry_by_txt
(
407 &Net
::SSLeay
::MBSTRING_UTF8
,
411 $cleanup->(1, "Failed to add '$k'='$v' to DN\n") if !$res;
414 $add_name_entry->('CN', $common_name);
415 for (qw(C ST L O OU)) {
416 if (defined(my $v = $attr{$_})) {
417 $add_name_entry->($_, $v);
421 if (defined($pem_key)) {
422 my $bio_s_mem = Net
::SSLeay
::BIO_s_mem
();
423 $cleanup->(1, "Failed to allocate BIO_s_mem for private key\n")
426 $bio = Net
::SSLeay
::BIO_new
($bio_s_mem);
427 $cleanup->(1, "Failed to allocate BIO for private key\n") if !$bio;
429 $cleanup->(1, "Failed to write PEM-encoded key to BIO\n")
430 if Net
::SSLeay
::BIO_write
($bio, $pem_key) <= 0;
432 $pk = Net
::SSLeay
::PEM_read_bio_PrivateKey
($bio);
433 $cleanup->(1, "Failed to read private key into EVP_PKEY\n") if !$pk;
435 $pk = Net
::SSLeay
::EVP_PKEY_new
();
436 $cleanup->(1, "Failed to allocate EVP_PKEY for private key\n") if !$pk;
438 my $rsa = Net
::SSLeay
::RSA_generate_key
($bits, 65537);
439 $cleanup->(1, "Failed to generate RSA key pair\n") if !$rsa;
441 $cleanup->(1, "Failed to assign RSA key to EVP_PKEY\n")
442 if !Net
::SSLeay
::EVP_PKEY_assign_RSA
($pk, $rsa);
445 $req = Net
::SSLeay
::X509_REQ_new
();
446 $cleanup->(1, "Failed to allocate X509_REQ\n") if !$req;
448 $cleanup->(1, "Failed to set subject name\n")
449 if (!Net
::SSLeay
::X509_REQ_set_subject_name
($req, $name));
451 Net
::SSLeay
::P_X509_REQ_add_extensions
(
453 &Net
::SSLeay
::NID_key_usage
=> 'digitalSignature,keyEncipherment',
454 &Net
::SSLeay
::NID_basic_constraints
=> 'CA:FALSE',
455 &Net
::SSLeay
::NID_ext_key_usage
=> 'serverAuth,clientAuth',
456 &Net
::SSLeay
::NID_subject_alt_name
=> join(',', map { "DNS:$_" } @$san),
457 ) or $cleanup->(1, "Failed to add extensions to CSR\n");
459 $cleanup->(1, "Failed to set public key\n")
460 if !Net
::SSLeay
::X509_REQ_set_pubkey
($req, $pk);
462 $cleanup->(1, "Failed to set CSR version\n")
463 if !Net
::SSLeay
::X509_REQ_set_version
($req, 2);
465 $cleanup->(1, "Failed to sign CSR\n")
466 if !Net
::SSLeay
::X509_REQ_sign
($req, $pk, $md);
468 my $pk_pem = Net
::SSLeay
::PEM_get_string_PrivateKey
($pk);
469 my $req_pem = Net
::SSLeay
::PEM_get_string_X509_REQ
($req);
473 return wantarray ?
($req_pem, $pk_pem) : $req_pem;