2 # ***************************************************************************
4 # * Project ___| | | | _ \| |
5 # * / __| | | | |_) | |
6 # * | (__| |_| | _ <| |___
7 # * \___|\___/|_| \_\_____|
9 # * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
11 # * This software is licensed as described in the file COPYING, which
12 # * you should have received as part of this distribution. The terms
13 # * are also available at https://curl.haxx.se/docs/copyright.html.
15 # * You may opt to use, copy, modify, merge, publish, distribute and/or sell
16 # * copies of the Software, and permit persons to whom the Software is
17 # * furnished to do so, under the terms of the COPYING file.
19 # * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
20 # * KIND, either express or implied.
22 # ***************************************************************************
23 # This Perl script creates a fresh ca-bundle.crt file for use with libcurl.
24 # It downloads certdata.txt from Mozilla's source tree (see URL below),
25 # then parses certdata.txt and extracts CA Root Certificates into PEM format.
26 # These are then processed with the OpenSSL commandline tool to produce the
27 # final ca-bundle.crt file.
28 # The script is based on the parse-certs script written by Roland Krikava.
29 # This Perl script works on almost any platform since its only external
30 # dependency is the OpenSSL commandline tool for optional text listing.
31 # Hacked by Guenter Knauf.
38 use vars qw($opt_b $opt_d $opt_f $opt_h $opt_i $opt_k $opt_l $opt_m $opt_n $opt_p $opt_q $opt_s $opt_t $opt_u $opt_v $opt_w);
42 my $MOD_SHA = "Digest::SHA";
43 eval "require $MOD_SHA";
45 $MOD_SHA = "Digest::SHA::PurePerl";
46 eval "require $MOD_SHA";
48 eval "require LWP::UserAgent";
52 'https://hg.mozilla.org/projects/nss/raw-file/default/lib/ckfw/builtins/certdata.txt',
54 'https://hg.mozilla.org/mozilla-central/raw-file/default/security/nss/lib/ckfw/builtins/certdata.txt',
56 'https://hg.mozilla.org/releases/mozilla-beta/raw-file/default/security/nss/lib/ckfw/builtins/certdata.txt',
58 'https://hg.mozilla.org/releases/mozilla-release/raw-file/default/security/nss/lib/ckfw/builtins/certdata.txt',
63 # If the OpenSSL commandline is not in search path you can configure it here!
64 my $openssl = 'openssl';
68 $opt_w = 76; # default base64 encoded lines length
70 # default cert types to include in the output (default is to include CAs which may issue SSL server certs)
71 my $default_mozilla_trust_purposes = "SERVER_AUTH";
72 my $default_mozilla_trust_levels = "TRUSTED_DELEGATOR";
73 $opt_p = $default_mozilla_trust_purposes . ":" . $default_mozilla_trust_levels;
75 my @valid_mozilla_trust_purposes = (
94 my @valid_mozilla_trust_levels = (
95 "TRUSTED_DELEGATOR", # CAs
96 "NOT_TRUSTED", # Don't trust these certs.
97 "MUST_VERIFY_TRUST", # This explicitly tells us that it ISN'T a CA but is otherwise ok. In other words, this should tell the app to ignore any other sources that claim this is a CA.
98 "TRUSTED" # This cert is trusted, but only for itself and not for delegates (i.e. it is not a CA).
101 my $default_signature_algorithms = $opt_s = "MD5";
103 my @valid_signature_algorithms = (
112 $Getopt::Std::STANDARD_HELP_VERSION = 1;
113 getopts('bd:fhiklmnp:qs:tuvw:');
115 if(!defined($opt_d)) {
116 # to make plain "-d" use not cause warnings, and actually still work
120 # Use predefined URL or else custom URL specified on command line.
122 if(defined($urls{$opt_d})) {
123 $url = $urls{$opt_d};
124 if(!$opt_k && $url !~ /^https:\/\//i) {
125 die "The URL for '$opt_d' is not HTTPS. Use -k to override (insecure).\n";
132 my $curl = `curl -V`;
135 print ("=" x 78 . "\n");
136 print "Script Version : $version\n";
137 print "Perl Version : $]\n";
138 print "Operating System Name : $^O\n";
139 print "Getopt::Std.pm Version : ${Getopt::Std::VERSION}\n";
140 print "Encode::Encoding.pm Version : ${Encode::Encoding::VERSION}\n";
141 print "MIME::Base64.pm Version : ${MIME::Base64::VERSION}\n";
142 print "LWP::UserAgent.pm Version : ${LWP::UserAgent::VERSION}\n" if($LWP::UserAgent::VERSION);
143 print "LWP.pm Version : ${LWP::VERSION}\n" if($LWP::VERSION);
144 print "Digest::SHA.pm Version : ${Digest::SHA::VERSION}\n" if ($Digest::SHA::VERSION);
145 print "Digest::SHA::PurePerl.pm Version : ${Digest::SHA::PurePerl::VERSION}\n" if ($Digest::SHA::PurePerl::VERSION);
146 print ("=" x 78 . "\n");
149 sub warning_message() {
150 if ( $opt_d =~ m/^risk$/i ) { # Long Form Warning and Exit
151 print "Warning: Use of this script may pose some risk:\n";
153 print " 1) If you use HTTP URLs they are subject to a man in the middle attack\n";
154 print " 2) Default to 'release', but more recent updates may be found in other trees\n";
155 print " 3) certdata.txt file format may change, lag time to update this script\n";
156 print " 4) Generally unwise to blindly trust CAs without manual review & verification\n";
157 print " 5) Mozilla apps use additional security checks aren't represented in certdata\n";
158 print " 6) Use of this script will make a security engineer grind his teeth and\n";
159 print " swear at you. ;)\n";
161 } else { # Short Form Warning
162 print "Warning: Use of this script may pose some risk, -d risk for more details.\n";
167 print "Usage:\t${0} [-b] [-d<certdata>] [-f] [-i] [-k] [-l] [-n] [-p<purposes:levels>] [-q] [-s<algorithms>] [-t] [-u] [-v] [-w<l>] [<outputfile>]\n";
168 print "\t-b\tbackup an existing version of ca-bundle.crt\n";
169 print "\t-d\tspecify Mozilla tree to pull certdata.txt or custom URL\n";
170 print "\t\t Valid names are:\n";
171 print "\t\t ", join( ", ", map { ( $_ =~ m/$opt_d/ ) ? "$_ (default)" : "$_" } sort keys %urls ), "\n";
172 print "\t-f\tforce rebuild even if certdata.txt is current\n";
173 print "\t-i\tprint version info about used modules\n";
174 print "\t-k\tallow URLs other than HTTPS, enable HTTP fallback (insecure)\n";
175 print "\t-l\tprint license info about certdata.txt\n";
176 print "\t-m\tinclude meta data in output\n";
177 print "\t-n\tno download of certdata.txt (to use existing)\n";
178 print wrap("\t","\t\t", "-p\tlist of Mozilla trust purposes and levels for certificates to include in output. Takes the form of a comma separated list of purposes, a colon, and a comma separated list of levels. (default: $default_mozilla_trust_purposes:$default_mozilla_trust_levels)"), "\n";
179 print "\t\t Valid purposes are:\n";
180 print wrap("\t\t ","\t\t ", join( ", ", "ALL", @valid_mozilla_trust_purposes ) ), "\n";
181 print "\t\t Valid levels are:\n";
182 print wrap("\t\t ","\t\t ", join( ", ", "ALL", @valid_mozilla_trust_levels ) ), "\n";
183 print "\t-q\tbe really quiet (no progress output at all)\n";
184 print wrap("\t","\t\t", "-s\tcomma separated list of certificate signatures/hashes to output in plain text mode. (default: $default_signature_algorithms)\n");
185 print "\t\t Valid signature algorithms are:\n";
186 print wrap("\t\t ","\t\t ", join( ", ", "ALL", @valid_signature_algorithms ) ), "\n";
187 print "\t-t\tinclude plain text listing of certificates\n";
188 print "\t-u\tunlink (remove) certdata.txt after processing\n";
189 print "\t-v\tbe verbose and print out processed CAs\n";
190 print "\t-w <l>\twrap base64 output lines after <l> chars (default: ${opt_w})\n";
194 sub VERSION_MESSAGE() {
195 print "${0} version ${version} running Perl ${]} on ${^O}\n";
198 warning_message() unless ($opt_q || $url =~ m/^(ht|f)tps:/i );
199 HELP_MESSAGE() if ($opt_h);
204 print STDERR $output . "\n" unless $opt_q;
210 return defined(List::Util::first { $target eq $_ } @_);
213 # Parses $param_string as a case insensitive comma separated list with optional whitespace
214 # validates that only allowed parameters are supplied
215 sub parse_csv_param($$@) {
216 my $description = shift;
217 my $param_string = shift;
218 my @valid_values = @_;
221 s/^\s+//; # strip leading spaces
222 s/\s+$//; # strip trailing spaces
223 uc $_ # return the modified string as upper case
224 } split( ',', $param_string );
226 # Find all values which are not in the list of valid values or "ALL"
227 my @invalid = grep { !is_in_list($_,"ALL",@valid_values) } @values;
229 if ( scalar(@invalid) > 0 ) {
230 # Tell the user which parameters were invalid and print the standard help message which will exit
231 print "Error: Invalid ", $description, scalar(@invalid) == 1 ? ": " : "s: ", join( ", ", map { "\"$_\"" } @invalid ), "\n";
235 @values = @valid_values if ( is_in_list("ALL",@values) );
242 if ($Digest::SHA::VERSION || $Digest::SHA::PurePerl::VERSION) {
243 open(FILE, $_[0]) or die "Can't open '$_[0]': $!";
245 $result = $MOD_SHA->new(256)->addfile(*FILE)->hexdigest;
248 # Use OpenSSL command if Perl Digest::SHA modules not available
249 $result = `"$openssl" dgst -r -sha256 "$_[0]"`;
250 $result =~ s/^([0-9a-f]{64}) .+/$1/is;
258 open(C, "<$_[0]") || return 0;
261 if($_ =~ /^\#\# SHA256: (.*)/) {
270 if ( $opt_p !~ m/:/ ) {
271 print "Error: Mozilla trust identifier list must include both purposes and levels\n";
275 (my $included_mozilla_trust_purposes_string, my $included_mozilla_trust_levels_string) = split( ':', $opt_p );
276 my @included_mozilla_trust_purposes = parse_csv_param( "trust purpose", $included_mozilla_trust_purposes_string, @valid_mozilla_trust_purposes );
277 my @included_mozilla_trust_levels = parse_csv_param( "trust level", $included_mozilla_trust_levels_string, @valid_mozilla_trust_levels );
279 my @included_signature_algorithms = parse_csv_param( "signature algorithm", $opt_s, @valid_signature_algorithms );
281 sub should_output_cert(%) {
282 my %trust_purposes_by_level = @_;
284 foreach my $level (@included_mozilla_trust_levels) {
285 # for each level we want to output, see if any of our desired purposes are included
286 return 1 if ( defined( List::Util::first { is_in_list( $_, @included_mozilla_trust_purposes ) } @{$trust_purposes_by_level{$level}} ) );
292 my $crt = $ARGV[0] || 'ca-bundle.crt';
293 (my $txt = $url) =~ s@(.*/|\?.*)@@g;
295 my $stdout = $crt eq '-';
299 my $oldhash = oldhash($crt);
301 report "SHA256 of old file: $oldhash";
304 report "Downloading $txt ...";
306 # If we have an HTTPS URL then use curl
307 if($url =~ /^https:\/\//i) {
309 if($curl =~ /^Protocols:.* https( |$)/m) {
310 report "Get certdata with curl!";
311 my $proto = !$opt_k ? "--proto =https" : "";
312 my $quiet = $opt_q ? "-s" : "";
313 my @out = `curl -w %{response_code} $proto $quiet -o "$txt" "$url"`;
314 if(!$? && @out && $out[0] == 200) {
316 report "Downloaded $txt";
319 report "Failed downloading via HTTPS with curl";
320 if(-e $txt && !unlink($txt)) {
321 report "Failed to remove '$txt': $!";
326 report "curl lacks https support";
330 report "curl not found";
334 # If nothing was fetched then use LWP
336 if($url =~ /^https:\/\//i) {
337 report "Falling back to HTTP";
338 $url =~ s/^https:\/\//http:\/\//i;
341 report "URLs other than HTTPS are disabled by default, to enable use -k";
344 report "Get certdata with LWP!";
345 if(!defined(${LWP::UserAgent::VERSION})) {
346 report "LWP is not available (LWP::UserAgent not found)";
349 my $ua = new LWP::UserAgent(agent => "$0/$version");
351 $resp = $ua->mirror($url, $txt);
352 if($resp && $resp->code eq '304') {
353 report "Not modified";
354 exit 0 if -e $crt && !$opt_f;
358 report "Downloaded $txt";
360 if(!$resp || $resp->code !~ /^(?:200|304)$/) {
361 report "Unable to download latest data: "
362 . ($resp? $resp->code . ' - ' . $resp->message : "LWP failed");
363 exit 1 if -e $crt || ! -r $txt;
368 my $filedate = $resp ? $resp->last_modified : (stat($txt))[9];
369 my $datesrc = "as of";
371 # mxr.mozilla.org gave us a time, hg.mozilla.org does not!
373 $datesrc="downloaded on";
376 # get the hash from the download file
377 my $newhash= sha256($txt);
379 if(!$opt_f && $oldhash eq $newhash) {
380 report "Downloaded file identical to previous run\'s source file. Exiting";
381 if($opt_u && -e $txt && !unlink($txt)) {
382 report "Failed to remove $txt: $!\n";
387 report "SHA256 of new file: $newhash";
389 my $currentdate = scalar gmtime($filedate);
391 my $format = $opt_t ? "plain text and " : "";
393 open(CRT, '> -') or die "Couldn't open STDOUT: $!\n";
395 open(CRT,">$crt.~") or die "Couldn't open $crt.~: $!\n";
399 ## Bundle of CA Root Certificates
401 ## Certificate data from Mozilla ${datesrc}: ${currentdate} GMT
403 ## This is a bundle of X.509 certificates of public Certificate Authorities
404 ## (CA). These were automatically extracted from Mozilla's root certificates
405 ## file (certdata.txt). This file can be found in the mozilla source tree:
408 ## It contains the certificates in ${format}PEM format and therefore
409 ## can be directly used with curl / libcurl / php_curl, or with
410 ## an Apache+mod_ssl webserver for SSL client authentication.
411 ## Just configure this file as the SSLCACertificateFile.
413 ## Conversion done with mk-ca-bundle.pl version $version.
419 report "Processing '$txt' ...";
423 my $start_of_cert = 0;
428 open(TXT,"$txt") or die "Couldn't open $txt: $!\n";
430 if (/\*\*\*\*\* BEGIN LICENSE BLOCK \*\*\*\*\*/) {
436 last if (/\*\*\*\*\* END LICENSE BLOCK \*\*\*\*\*/);
439 elsif(/^# (Issuer|Serial Number|Subject|Not Valid Before|Not Valid After |Fingerprint \(MD5\)|Fingerprint \(SHA1\)):/) {
451 # CKA_NSS_SERVER_DISTRUST_AFTER MULTILINE_OCTAL
452 # \062\060\060\066\061\067\060\060\060\060\060\060\132
455 if (/^CKA_NSS_SERVER_DISTRUST_AFTER (CK_BBOOL CK_FALSE|MULTILINE_OCTAL)/) {
456 if($1 eq "MULTILINE_OCTAL") {
461 my @octets = split(/\\/);
464 push @timestamp, chr(oct);
467 # A trailing Z in the timestamp signifies UTC
468 if($timestamp[12] ne "Z") {
469 report "distrust date stamp is not using UTC";
471 # Example date: 200617000000Z
472 # Means 2020-06-17 00:00:00 UTC
474 timegm($timestamp[10] . $timestamp[11], # second
475 $timestamp[8] . $timestamp[9], # minute
476 $timestamp[6] . $timestamp[7], # hour
477 $timestamp[4] . $timestamp[5], # day
478 ($timestamp[2] . $timestamp[3]) - 1, # month
479 "20" . $timestamp[0] . $timestamp[1]); # year
480 if(time >= $distrustat) {
481 # not trusted anymore
483 report "Skipping: $caname is not trusted anymore" if ($opt_v);
493 # this is a match for the start of a certificate
494 if (/^CKA_CLASS CK_OBJECT_CLASS CKO_CERTIFICATE/) {
497 if ($start_of_cert && /^CKA_LABEL UTF8 \"(.*)\"/) {
500 my %trust_purposes_by_level;
501 if ($start_of_cert && /^CKA_VALUE MULTILINE_OCTAL/) {
506 my @octets = split(/\\/);
509 $cka_value .= chr(oct);
513 if(/^CKA_CLASS CK_OBJECT_CLASS CKO_NSS_TRUST/ && $valid) {
514 # now scan the trust part to determine how we should trust this cert
517 if (/^CKA_TRUST_([A-Z_]+)\s+CK_TRUST\s+CKT_NSS_([A-Z_]+)\s*$/) {
518 if ( !is_in_list($1,@valid_mozilla_trust_purposes) ) {
519 report "Warning: Unrecognized trust purpose for cert: $caname. Trust purpose: $1. Trust Level: $2";
520 } elsif ( !is_in_list($2,@valid_mozilla_trust_levels) ) {
521 report "Warning: Unrecognized trust level for cert: $caname. Trust purpose: $1. Trust Level: $2";
523 push @{$trust_purposes_by_level{$2}}, $1;
528 if ( !should_output_cert(%trust_purposes_by_level) ) {
530 report "Skipping: $caname" if ($opt_v);
532 my $data = $cka_value;
539 my $encoded = MIME::Base64::encode_base64($data, '');
540 $encoded =~ s/(.{1,${opt_w}})/$1\n/g;
541 my $pem = "-----BEGIN CERTIFICATE-----\n"
543 . "-----END CERTIFICATE-----\n";
544 print CRT "\n$caname\n";
545 print CRT @precert if($opt_m);
546 my $maxStringLength = length(decode('UTF-8', $caname, Encode::FB_CROAK | Encode::LEAVE_SRC));
548 foreach my $key (keys %trust_purposes_by_level) {
549 my $string = $key . ": " . join(", ", @{$trust_purposes_by_level{$key}});
550 $maxStringLength = List::Util::max( length($string), $maxStringLength );
551 print CRT $string . "\n";
554 print CRT ("=" x $maxStringLength . "\n");
559 foreach my $hash (@included_signature_algorithms) {
560 $pipe = "|$openssl x509 -" . $hash . " -fingerprint -noout -inform PEM";
562 $pipe .= " >> $crt.~";
563 close(CRT) or die "Couldn't close $crt.~: $!";
565 open(TMP, $pipe) or die "Couldn't open openssl pipe: $!";
567 close(TMP) or die "Couldn't close openssl pipe: $!";
569 open(CRT, ">>$crt.~") or die "Couldn't open $crt.~: $!";
572 $pipe = "|$openssl x509 -text -inform PEM";
574 $pipe .= " >> $crt.~";
575 close(CRT) or die "Couldn't close $crt.~: $!";
577 open(TMP, $pipe) or die "Couldn't open openssl pipe: $!";
579 close(TMP) or die "Couldn't close openssl pipe: $!";
581 open(CRT, ">>$crt.~") or die "Couldn't open $crt.~: $!";
584 report "Parsing: $caname" if ($opt_v);
592 close(TXT) or die "Couldn't close $txt: $!\n";
593 close(CRT) or die "Couldn't close $crt.~: $!\n";
595 if ($opt_b && -e $crt) {
597 while (-e "$crt.~${bk}~") {
600 rename $crt, "$crt.~${bk}~" or die "Failed to create backup $crt.~$bk}~: $!\n";
602 unlink( $crt ) or die "Failed to remove $crt: $!\n";
604 rename "$crt.~", $crt or die "Failed to rename $crt.~ to $crt: $!\n";
606 if($opt_u && -e $txt && !unlink($txt)) {
607 report "Failed to remove $txt: $!\n";
609 report "Done ($certnum CA certs processed, $skipnum skipped).";