node-html-pdf icon indicating copy to clipboard operation
node-html-pdf copied to clipboard

html-pdf fails with Debian 10 due to new version of OpenSSL

Open DigitalLeaves opened this issue 4 years ago • 14 comments

After upgrading to Debian 10, html-pdf stopped working. That's because phantomjs, used by html-pdf fails when parsing /etc/ssl/openssl.cnf

This is the error when trying to run the example test that will generate the businesscard.pdf:

TAP version 13
# allows custom html and css
not ok 1 Error: html-pdf: Received the exit code '1' Auto configuration failed 139625719701120:error:25066067:DSO support routines:DLFCN_LOAD:could not load the shared library:dso_dlfcn.c:185:filename(libssl_conf.so): libssl_conf.so: cannot open shared object file: No such file or directory 139625719701120:error:25070067:DSO support routines:DSO_load:could not load the shared library:dso_lib.c:244: 139625719701120:error:0E07506E:configuration file routines:MODULE_LOAD_DSO:error loading dso:conf_mod.c:285:module=ssl_conf, path=ssl_conf 139625719701120:error:0E076071:configuration file routines:MODULE_RUN:unknown module name:conf_mod.c:222:module=ssl_conf 
  ---
    operator: error
    expected: |-
      undefined
    actual: |-
      [Error: html-pdf: Received the exit code '1'
Auto configuration failed
139625719701120:error:25066067:DSO support routines:DLFCN_LOAD:could not load the shared library:dso_dlfcn.c:185:filename(libssl_conf.so): libssl_conf.so: cannot open shared object file: No such file or directory
139625719701120:error:25070067:DSO support routines:DSO_load:could not load the shared library:dso_lib.c:244:
139625719701120:error:0E07506E:configuration file routines:MODULE_LOAD_DSO:error loading dso:conf_mod.c:285:module=ssl_conf, path=ssl_conf
139625719701120:error:0E076071:configuration file routines:MODULE_RUN:unknown module name:conf_mod.c:222:module=ssl_conf
]
    at: <anonymous> (/tmp/examples/businesscard/test.js:24:7)
    stack: |-
      Error: html-pdf: Received the exit code '1'
      Auto configuration failed
      139625719701120:error:25066067:DSO support routines:DLFCN_LOAD:could not load the shared library:dso_dlfcn.c:185:filename(libssl_conf.so): libssl_conf.so: cannot open shared object file: No such file or directory
      139625719701120:error:25070067:DSO support routines:DSO_load:could not load the shared library:dso_lib.c:244:
      139625719701120:error:0E07506E:configuration file routines:MODULE_LOAD_DSO:error loading dso:conf_mod.c:285:module=ssl_conf, path=ssl_conf
      139625719701120:error:0E076071:configuration file routines:MODULE_RUN:unknown module name:conf_mod.c:222:module=ssl_conf
      
          at ChildProcess.respond (/tmp/examples/businesscard/node_modules/html-pdf/lib/pdf.js:121:31)
          at ChildProcess.emit (events.js:197:13)
          at Process.ChildProcess._handle.onexit (internal/child_process.js:254:12)
  ...
/tmp/examples/businesscard/test.js:25
    t.assert(pdf.filename, 'Returns the filename')
                 ^

TypeError: Cannot read property 'filename' of null
    at /tmp/examples/businesscard/test.js:25:18
    at ChildProcess.respond (/tmp/examples/businesscard/node_modules/html-pdf/lib/pdf.js:126:14)
    at ChildProcess.emit (events.js:197:13)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:254:12)

Setting that config file to an empty file solves the problem, but this is obviously not a long-term solution:

TAP version 13
# allows custom html and css
ok 1 null
ok 2 Returns the filename
ok 3 Saves the file to the desired destination

1..3
# tests 3
# pass  3

# ok

The default /etc/ssl/openssl.cnf file with debian 10 is:

#
# OpenSSL example configuration file.
# This is mostly being used for generation of certificate requests.
#

# Note that you can include other files from the main configuration
# file using the .include directive.
#.include filename

# This definition stops the following lines choking if HOME isn't
# defined.
HOME                    = .

# Extra OBJECT IDENTIFIER info:
#oid_file               = $ENV::HOME/.oid
oid_section             = new_oids

# System default
openssl_conf = default_conf

# To use this configuration file with the "-extfile" option of the
# "openssl x509" utility, name here the section containing the
# X.509v3 extensions to use:
# extensions            =
# (Alternatively, use a configuration file that has only
# X.509v3 extensions in its main [= default] section.)

[ new_oids ]    

# We can add new OIDs in here for use by 'ca', 'req' and 'ts'.
# Add a simple OID like this:           
# testoid1=1.2.3.4
# Or use config file substitution like this:
# testoid2=${testoid1}.5.6

# Policies used by the TSA examples.    
tsa_policy1 = 1.2.3.4.1                 
tsa_policy2 = 1.2.3.4.5.6
tsa_policy3 = 1.2.3.4.5.7

####################################################################
[ ca ]
default_ca      = CA_default            # The default ca section

####################################################################
[ CA_default ]
                                
dir             = ./demoCA              # Where everything is kept
certs           = $dir/certs            # Where the issued certs are kept
crl_dir         = $dir/crl              # Where the issued crl are kept
database        = $dir/index.txt        # database index file.
#unique_subject = no                    # Set to 'no' to allow creation of
                                        # several certs with same subject.
new_certs_dir   = $dir/newcerts         # default place for new certs.

certificate     = $dir/cacert.pem       # The CA certificate
serial          = $dir/serial           # The current serial number
crlnumber       = $dir/crlnumber        # the current crl number
crl             = $dir/crl.pem          # The current CRL
private_key     = $dir/private/cakey.pem# The private key

x509_extensions = usr_cert              # The extensions to add to the cert

# Comment out the following two lines for the "traditional"
# (and highly broken) format.
name_opt        = ca_default            # Subject Name options
cert_opt        = ca_default            # Certificate field options

# Extension copying option: use with caution.
# copy_extensions = copy

# Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs
# so this is commented out by default to leave a V1 CRL.
# crlnumber must also be commented out to leave a V1 CRL.
# crl_extensions        = crl_ext

default_days    = 365                   # how long to certify for
default_crl_days= 30                    # how long before next CRL
default_md      = default               # use public key default MD
preserve        = no                    # keep passed DN ordering

# A few difference way of specifying how similar the request should look
# For type CA, the listed attributes must be the same, and the optional
# and supplied fields are just that :-)
policy          = policy_match

# For the CA policy
[ policy_match ]
countryName             = match
stateOrProvinceName     = match
organizationName        = match
organizationalUnitName  = optional
commonName              = supplied
emailAddress            = optional

# For the 'anything' policy
# At this point in time, you must list all acceptable 'object'
# types.
[ policy_anything ]
countryName             = optional
stateOrProvinceName     = optional
localityName            = optional
organizationName        = optional
organizationalUnitName  = optional
commonName              = supplied
emailAddress            = optional

####################################################################
[ req ]
default_bits            = 2048
default_keyfile         = privkey.pem
distinguished_name      = req_distinguished_name
attributes              = req_attributes
x509_extensions = v3_ca # The extensions to add to the self signed cert

# Passwords for private keys if not present they will be prompted for
# input_password = secret
# output_password = secret

# This sets a mask for permitted string types. There are several options.
# default: PrintableString, T61String, BMPString.
# pkix   : PrintableString, BMPString (PKIX recommendation before 2004)
# utf8only: only UTF8Strings (PKIX recommendation after 2004).
# nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings).
# MASK:XXXX a literal mask value.
# WARNING: ancient versions of Netscape crash on BMPStrings or UTF8Strings.
string_mask = utf8only

# req_extensions = v3_req # The extensions to add to a certificate request

[ req_distinguished_name ]
countryName                     = Country Name (2 letter code)
countryName_default             = AU
countryName_min                 = 2
countryName_max                 = 2

stateOrProvinceName             = State or Province Name (full name)
stateOrProvinceName_default     = Some-State

localityName                    = Locality Name (eg, city)

0.organizationName              = Organization Name (eg, company)
0.organizationName_default      = Internet Widgits Pty Ltd

# we can do this but it is not needed normally :-)
#1.organizationName             = Second Organization Name (eg, company)
#1.organizationName_default     = World Wide Web Pty Ltd

organizationalUnitName          = Organizational Unit Name (eg, section)
#organizationalUnitName_default =

commonName                      = Common Name (e.g. server FQDN or YOUR name)
commonName_max                  = 64

emailAddress                    = Email Address
emailAddress_max                = 64

# SET-ex3                       = SET extension number 3

[ req_attributes ]
challengePassword               = A challenge password
challengePassword_min           = 4
challengePassword_max           = 20

unstructuredName                = An optional company name

[ usr_cert ]

# These extensions are added when 'ca' signs a request.

# This goes against PKIX guidelines but some CAs do it and some software
# requires this to avoid interpreting an end user certificate as a CA.

basicConstraints=CA:FALSE

# Here are some examples of the usage of nsCertType. If it is omitted
# the certificate can be used for anything *except* object signing.

# This is OK for an SSL server.
# nsCertType                    = server

# For an object signing certificate this would be used.
# nsCertType = objsign

# For normal client use this is typical
# nsCertType = client, email

# and for everything including object signing:
# nsCertType = client, email, objsign

# This is typical in keyUsage for a client certificate.
# keyUsage = nonRepudiation, digitalSignature, keyEncipherment

# This will be displayed in Netscape's comment listbox.
nsComment                       = "OpenSSL Generated Certificate"

# PKIX recommendations harmless if included in all certificates.
subjectKeyIdentifier=hash
authorityKeyIdentifier=keyid,issuer

# This stuff is for subjectAltName and issuerAltname.
# Import the email address.
# subjectAltName=email:copy
# An alternative to produce certificates that aren't
# deprecated according to PKIX.
# subjectAltName=email:move

# Copy subject details
# issuerAltName=issuer:copy

#nsCaRevocationUrl              = http://www.domain.dom/ca-crl.pem
#nsBaseUrl
#nsRevocationUrl
#nsRenewalUrl
#nsCaPolicyUrl
#nsSslServerName

# This is required for TSA certificates.
# extendedKeyUsage = critical,timeStamping

[ v3_req ]

# Extensions to add to a certificate request
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment

[ v3_ca ]


# Extensions for a typical CA


# PKIX recommendation.

subjectKeyIdentifier=hash

authorityKeyIdentifier=keyid:always,issuer

basicConstraints = critical,CA:true

# Key usage: this is typical for a CA certificate. However since it will
# prevent it being used as an test self-signed certificate it is best
# left out by default.
# keyUsage = cRLSign, keyCertSign

# Some might want this also
# nsCertType = sslCA, emailCA

# Include email address in subject alt name: another PKIX recommendation
# subjectAltName=email:copy
# Copy issuer details
# issuerAltName=issuer:copy

# DER hex encoding of an extension: beware experts only!
# obj=DER:02:03
# Where 'obj' is a standard or added object
# You can even override a supported extension:
# basicConstraints= critical, DER:30:03:01:01:FF

[ crl_ext ]

# CRL extensions.
# Only issuerAltName and authorityKeyIdentifier make any sense in a CRL.

# issuerAltName=issuer:copy
authorityKeyIdentifier=keyid:always

[ proxy_cert_ext ]
# These extensions should be added when creating a proxy certificate

# This goes against PKIX guidelines but some CAs do it and some software
# requires this to avoid interpreting an end user certificate as a CA.

basicConstraints=CA:FALSE
# Here are some examples of the usage of nsCertType. If it is omitted
# the certificate can be used for anything *except* object signing.

# This is OK for an SSL server.
# nsCertType                    = server

# For an object signing certificate this would be used.
# nsCertType = objsign

# For normal client use this is typical
# nsCertType = client, email

# and for everything including object signing:
# nsCertType = client, email, objsign

# This is typical in keyUsage for a client certificate.
# keyUsage = nonRepudiation, digitalSignature, keyEncipherment

# This will be displayed in Netscape's comment listbox.
nsComment                       = "OpenSSL Generated Certificate"

# PKIX recommendations harmless if included in all certificates.
subjectKeyIdentifier=hash
authorityKeyIdentifier=keyid,issuer

# This stuff is for subjectAltName and issuerAltname.
# Import the email address.
# subjectAltName=email:copy
# An alternative to produce certificates that aren't
# deprecated according to PKIX.
# subjectAltName=email:move

# Copy subject details
# issuerAltName=issuer:copy

#nsCaRevocationUrl              = http://www.domain.dom/ca-crl.pem
#nsBaseUrl
#nsRevocationUrl
#nsRenewalUrl
#nsCaPolicyUrl
#nsSslServerName

# This really needs to be in place for it to be a proxy certificate.
proxyCertInfo=critical,language:id-ppl-anyLanguage,pathlen:3,policy:foo

####################################################################
[ tsa ]

default_tsa = tsa_config1       # the default TSA section

[ tsa_config1 ]

# These are used by the TSA reply generation only.
dir             = ./demoCA              # TSA root directory
serial          = $dir/tsaserial        # The current serial number (mandatory)
crypto_device   = builtin               # OpenSSL engine to use for signing
signer_cert     = $dir/tsacert.pem      # The TSA signing certificate
                                    # (optional)
certs           = $dir/cacert.pem       # Certificate chain to include in reply
                                        # (optional)
signer_key      = $dir/private/tsakey.pem # The TSA private key (optional)
signer_digest  = sha256                 # Signing digest to use. (Optional)
default_policy  = tsa_policy1           # Policy if request did not specify it
                                        # (optional)
other_policies  = tsa_policy2, tsa_policy3      # acceptable policies (optional)
digests     = sha1, sha256, sha384, sha512  # Acceptable message digests (mandatory)
accuracy        = secs:1, millisecs:500, microsecs:100  # (optional)
clock_precision_digits  = 0     # number of digits after dot. (optional)
ordering                = yes   # Is ordering defined for timestamps?
                                # (optional, default: no)
tsa_name                = yes   # Must the TSA name be included in the reply?
                                # (optional, default: no)
ess_cert_id_chain       = no    # Must the ESS cert id chain be included?
                                # (optional, default: no)
ess_cert_id_alg         = sha1  # algorithm to compute certificate
                                # identifier (optional, default: sha1)
[default_conf]
ssl_conf = ssl_sect

[ssl_sect]
system_default = system_default_sect

[system_default_sect]
MinProtocol = TLSv1.2
CipherString = DEFAULT@SECLEVEL=2

DigitalLeaves avatar Sep 29 '19 15:09 DigitalLeaves

More info: it seems all the problem is in this line. Commenting it makes the error go away:

# System default
openssl_conf = default_conf

DigitalLeaves avatar Sep 29 '19 19:09 DigitalLeaves

More info: it seems all the problem is in this line. Commenting it makes the error go away:

# System default
openssl_conf = default_conf

Same issue for me when migrating on Debian10. Your patch works fine !

pigeonvictor avatar Oct 04 '19 07:10 pigeonvictor

Thank you !

Franckapik avatar Dec 03 '19 14:12 Franckapik

More info: it seems all the problem is in this line. Commenting it makes the error go away:

# System default
openssl_conf = default_conf

Thank you, saved my day !

harloveleen avatar Jan 03 '20 21:01 harloveleen

Hi, I have this same issue running on this environment :

os : Ubuntu 18.04.3 LTS node : v8.10.0 html-pdf : latest

but I don't have this line inside /etc/ssl/openssl.cnf file

# System default
openssl_conf = default_conf

ZBilel avatar Apr 01 '20 10:04 ZBilel

Same problem here. If you don't want (or can't) override your OpenSSL system configuration, you can use OPENSSL_CONF env var to load a custom config file without openssl_conf parameter

cp  /etc/ssl/openssl.cnf /tmp/html-pdf-openssl.cnf
sed -i '/openssl_conf/d' /tmp/html-pdf-openssl.cnf
OPENSSL_CONF=/tmp/html-pdf-openssl.cnf html-pdf test/businesscard.html businesscard.pdf

cypx avatar Aug 11 '20 13:08 cypx

Any news on this ? I don't want to override my OPENSSL_CONF

robinalexandre avatar May 27 '21 14:05 robinalexandre

This issue persists on Ubuntu 21.04 and like the other person mentioned...

# System default
openssl_conf = default_conf

...does not exist.

jscul avatar Jul 20 '21 21:07 jscul

Two years later, the problem persists in Debian 11. Exact same error. Is this package being maintained?

DigitalLeaves avatar Dec 07 '21 12:12 DigitalLeaves

The issue still persists. Any drop-in replacement available for html-pdf ?

vikram-ma-fsmk avatar Apr 08 '22 09:04 vikram-ma-fsmk

I guess we need to move on from this lib to another solution to generate PDF. Any thought? Do you know a better approach to tackle this issue - Generating pdf from html in NodeJS - with less pain @cypx @DigitalLeaves @pigeonvictor @Franckapik @jscul

I am even thinking about using other languages to do that for me. Thanks.

kasir-barati avatar May 04 '22 11:05 kasir-barati

Solution without devOps

  • fixed SSL issue: simulate empty config https://github.com/bazelbuild/rules_closure/issues/351#issuecomment-1116945290
  • html-pdf assept options for childprocess wich will be paseed into phantomJs
  • node_modules/html-pdf/lib/pdf.js:89 (childProcessOptions)
  • https://nodejs.org/api/child_process.html
  • added env object to childProcessOptions for overriding OPENSSL_CONF
pdf.create(html, {
      childProcessOptions: {
        env: {
          OPENSSL_CONF: '/dev/null',
        },
      }
    });
    

opengeekslabap avatar May 17 '22 11:05 opengeekslabap

Solução sem DevOps

pdf.create(html, {
      childProcessOptions: {
        env: {
          OPENSSL_CONF: '/dev/null',
        },
      }
    });
    

This worked for me!

victordsantoss avatar Jun 24 '22 04:06 victordsantoss

Solução sem DevOps

pdf.create(html, {
      childProcessOptions: {
        env: {
          OPENSSL_CONF: '/dev/null',
        },
      }
    });
    

This worked for me!

Hey, are there any side effects using this option?

Batur123 avatar Sep 22 '23 11:09 Batur123