git » kxd » commit c85c750

tests: Include an OpenSSL configuration for our CA operations

author Alberto Bertogli
2014-04-27 04:37:59 UTC
committer Alberto Bertogli
2014-04-27 04:37:59 UTC
parent 23b2165c24bc6e28fde8bdc64d958354a760fcaa

tests: Include an OpenSSL configuration for our CA operations

When doing CA operations, OpenSSL relies significantly on the system
configuration in a way that make our tests depend on it (for example, with the
directory where the CA database is kept).

To make the tests more independent of the local OpenSSL configuration, this
patch includes its own, based on Debian's default.

Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>

tests/openssl.cnf +276 -0
tests/run_tests +12 -8

diff --git a/tests/openssl.cnf b/tests/openssl.cnf
new file mode 100644
index 0000000..9c8b4f3
--- /dev/null
+++ b/tests/openssl.cnf
@@ -0,0 +1,276 @@
+# OpenSSL configuration for kxd tests.
+#
+# This file is used in some of the kxd tests, to avoid depending on the local
+# configuration which can vary between different systems.
+#
+# It's only used for CA operations, so it focuses on that.
+# It is based on Debian's default configuration.
+#############################################################################
+
+# This definition stops the following lines choking if HOME isn't
+# defined.
+HOME			= .
+RANDFILE		= $ENV::HOME/.rnd
+
+[ ca ]
+default_ca	= CA_default
+
+[ CA_default ]
+
+dir		= ./kxd-ca		# 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 ctificates 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
+					# must be commented out to leave a V1 CRL
+crl		= $dir/crl.pem 		# The current CRL
+private_key	= $dir/private/cakey.pem # The private key
+RANDFILE	= $dir/private/.rand	# private random number file
+
+x509_extensions	= usr_cert		# The extentions 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
+
+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
+
+policy		= policy_anything
+
+[ 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 extentions 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
+
+# This is what PKIX recommends but some broken software chokes on critical
+# extensions.
+#basicConstraints = critical,CA:true
+# So we do this instead.
+basicConstraints = 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
+
diff --git a/tests/run_tests b/tests/run_tests
index 3117cf5..e02ae6c 100755
--- a/tests/run_tests
+++ b/tests/run_tests
@@ -38,6 +38,10 @@ import unittest
 BINS = os.path.abspath(
         os.path.dirname(os.path.realpath(__file__)) + "/../out")
 
+# Path to the test OpenSSL configuration.
+OPENSSL_CONF = os.path.abspath(
+        os.path.dirname(os.path.realpath(__file__)) + "/openssl.cnf")
+
 DEVNULL = open("/dev/null", "w")
 
 TEMPDIR = "/does/not/exist"
@@ -112,19 +116,20 @@ class CA(object):
         # TODO: This works because of Debian's default config; it needs to be
         # generalized, probably by including an openssl config to use.
         self.path = tempfile.mkdtemp(prefix="config-ca-", dir=TEMPDIR)
-        os.makedirs(self.path + "/demoCA/newcerts/")
+        os.makedirs(self.path + "/kxd-ca/newcerts/")
 
         try:
             # We need to run the CA commands from within the path.
             with pushd(self.path):
-                open("demoCA/index.txt", "w")
-                open("demoCA/serial", "w").write("1000\n")
+                open("kxd-ca/index.txt", "w")
+                open("kxd-ca/serial", "w").write("1000\n")
                 subprocess.check_output(
                         ["openssl", "req", "-new", "-x509", "-batch",
+                            "-config", OPENSSL_CONF,
                             "-subj",
-                            "/commonName=*" +
-                            "/organizationalUnitName=kxd-tests-ca:%s@%s" % (
-                                os.getlogin(), platform.node()),
+                              "/commonName=*" +
+                              "/organizationalUnitName=kxd-tests-ca:%s@%s" % (
+                                  os.getlogin(), platform.node()),
                             "-extensions", "v3_ca", "-nodes",
                             "-keyout", "cakey.pem",
                             "-out", "cacert.pem"],
@@ -137,8 +142,7 @@ class CA(object):
         try:
             with pushd(self.path):
                 subprocess.check_output(
-                        ["openssl", "ca", "-batch",
-                            "-policy", "policy_anything",
+                        ["openssl", "ca", "-batch", "-config", OPENSSL_CONF,
                             "-keyfile", "cakey.pem", "-cert", "cacert.pem",
                             "-in", csr,
                             "-out", "%s.pem" % os.path.splitext(csr)[0]],