From fbda283da89f9bd10cd5092e3f4bcbc9ad31fd39 Mon Sep 17 00:00:00 2001 From: German Eichberger Date: Mon, 18 Jun 2018 12:02:50 -0700 Subject: [PATCH] Adds the issuer to the CAs Octavia is using certificate authorities to manage the amp communication but the built-in ansible certificate commands can't generate proper CA certificates (they omit the necessary X509 extensions) nor properly sign CSRs and reference the CA. The changes here replace the parts where ansible's certificate commands fall short with running the openssl command directly. To do so it sets up the necessary files, directories, and templates an openssl config file. Once ansible's certificate capabilities improve we can retire those commands. Also improve tests so we gate when this fails. Change-Id: Iaae462844d783bd6086ce6a2816ea01cafc14e6d --- defaults/main.yml | 9 +- tasks/octavia_certs.yml | 40 +++-- tasks/octavia_certs_install.yml | 45 ++++-- templates/openssl.conf.j2 | 263 ++++++++++++++++++++++++++++++++ tests/os_octavia-overrides.yml | 2 +- tests/test-octavia.yml | 2 + 6 files changed, 323 insertions(+), 38 deletions(-) create mode 100644 templates/openssl.conf.j2 diff --git a/defaults/main.yml b/defaults/main.yml index 31c250e8..dfe261b2 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -393,9 +393,14 @@ octavia_cert_key_length_server: '4096' # key length octavia_cert_cipher_server: 'aes256' octavia_cert_cipher_client: 'aes256' octavia_cert_key_length_client: '4096' # key length -octavia_cert_server_ca_common_name: 'www.example.com' # change this to something more real -octavia_cert_client_ca_common_name: 'www.example.com' # change this to something more real +octavia_cert_server_ca_subject: '/C=US/ST=Denial/L=Nowhere/O=Dis/CN=www.example.com' # change this to something more real +octavia_cert_client_ca_subject: '/C=US/ST=Denial/L=Nowhere/O=Dis/CN=www.example.com' # change this to something more real octavia_cert_client_req_common_name: 'www.example.com' # change this to something more real +octavia_cert_client_req_country_name: 'US' +octavia_cert_client_req_state_or_province_name: 'Denial' +octavia_cert_client_req_locality_name: 'Nowhere' +octavia_cert_client_req_organization_name: 'Dis' +octavia_cert_validity_days: 1825 # 5 years octavia_generate_client_cert: True # generate self signed client certs octavia_generate_certs: True diff --git a/tasks/octavia_certs.yml b/tasks/octavia_certs.yml index 0a426880..e445cb87 100644 --- a/tasks/octavia_certs.yml +++ b/tasks/octavia_certs.yml @@ -20,21 +20,16 @@ cipher: "{{ octavia_cert_cipher_server }}" size: "{{ octavia_cert_key_length_server }}" -- name: Create server CA CSR - openssl_csr: - path: "{{ octavia_cert_dir }}/ca_server_01.csr" - common_name: "{{ octavia_cert_server_ca_common_name }}" - privatekey_path: "{{ octavia_ca_private_key }}" - privatekey_passphrase: "{{ octavia_ca_private_key_passphrase }}" - - name: Create server CA certificate - openssl_certificate: - path: "{{ octavia_ca_certificate }}" - privatekey_path: "{{ octavia_ca_private_key }}" - privatekey_passphrase: "{{ octavia_ca_private_key_passphrase }}" - csr_path: "{{ octavia_cert_dir }}/ca_server_01.csr" - provider: selfsigned - owner: "{{ lookup('env', 'USER') }}" + command: > + openssl req -x509 -passin pass:'{{ octavia_ca_private_key_passphrase }}' -new -nodes -key {{ octavia_ca_private_key }} \ + -config {{ octavia_cert_dir }}/openssl.cnf \ + -subj "{{ octavia_cert_server_ca_subject }}" \ + -days {{ octavia_cert_validity_days }} \ + -out {{ octavia_ca_certificate }} + args: + chdir: "{{ octavia_cert_dir }}" + creates: "{{ octavia_ca_certificate }}" - name: Generate Octavia client certificate block: @@ -47,16 +42,19 @@ openssl_csr: path: "{{ octavia_cert_dir }}/client.csr" common_name: "{{ octavia_cert_client_req_common_name }}" + country_name: "{{ octavia_cert_client_req_country_name }}" + state_or_province_name: "{{ octavia_cert_client_req_state_or_province_name }}" + locality_name: "{{ octavia_cert_client_req_locality_name }}" + organization_name: "{{ octavia_cert_client_req_organization_name }}" privatekey_path: "{{ octavia_cert_dir }}/client.key" - name: Create client certificate - openssl_certificate: - path: "{{ octavia_cert_dir }}/client-.pem" - privatekey_path: "{{ octavia_ca_private_key }}" - privatekey_passphrase: "{{ octavia_ca_private_key_passphrase }}" - csr_path: "{{ octavia_cert_dir }}/client.csr" - provider: selfsigned - owner: "{{ lookup('env', 'USER') }}" + command: > + openssl ca -passin pass:'{{ octavia_ca_private_key_passphrase }}' -config {{ octavia_cert_dir }}/openssl.cnf \ + -in client.csr -days {{ octavia_cert_validity_days }} -out client-.pem -batch + args: + chdir: "{{ octavia_cert_dir }}" + creates: "{{ octavia_cert_dir }}/client-.pem" # use cat to avoid mangling the certs - name: Generate single pem client.pem diff --git a/tasks/octavia_certs_install.yml b/tasks/octavia_certs_install.yml index ab84012e..d12dcbce 100644 --- a/tasks/octavia_certs_install.yml +++ b/tasks/octavia_certs_install.yml @@ -33,6 +33,28 @@ - { path: "{{ octavia_cert_dir }}/newcerts", mode: '0750'} - { path: "{{ octavia_cert_dir }}/private", mode: '0750'} +# ansible's openssl_certificate can't create X509 extensions +# but you need CA: true in Basic Constrainst to have a CA cert + +# set up openssl for use +- name: Touch index.txt + file: + path: "{{ octavia_cert_dir }}/index.txt" + state: touch + mode: 0755 + +- name: Init serial + copy: + content: "01" + dest: "{{ octavia_cert_dir }}/serial" + force: no + +- name: Generate openssl.conf + template: + src: "templates/openssl.conf.j2" + dest: "{{ octavia_cert_dir }}/openssl.cnf" + mode: 0440 + # These are run at the very first installation of Octavia # While Octavia acts as a CA for the server certificates, # for the amphora it only needs a client certificate and @@ -51,21 +73,16 @@ cipher: "{{ octavia_cert_cipher_client }}" size: "{{ octavia_cert_key_length_client }}" - - name: Create client CA CSR - openssl_csr: - path: "{{ octavia_cert_dir }}/ca_01.csr" - common_name: "{{ octavia_cert_client_ca_common_name }}" - privatekey_path: "{{ octavia_client_ca_key }}" - privatekey_passphrase: "{{ octavia_cert_client_password }}" - - name: Create client CA certificate - openssl_certificate: - path: "{{ octavia_client_ca }}" - privatekey_path: "{{ octavia_client_ca_key }}" - privatekey_passphrase: "{{ octavia_cert_client_password }}" - csr_path: "{{ octavia_cert_dir }}/ca_01.csr" - provider: selfsigned - owner: "{{ lookup('env', 'USER') }}" + command: > + openssl req -x509 -passin pass:'{{ octavia_cert_client_password }}' -new -nodes -key {{ octavia_client_ca_key }} \ + -config {{ octavia_cert_dir }}/openssl.cnf \ + -subj "{{ octavia_cert_client_ca_subject }}" \ + -days {{ octavia_cert_validity_days }} \ + -out {{ octavia_client_ca }} + args: + chdir: "{{ octavia_cert_dir }}" + creates: "{{ octavia_client_ca }}" when: octavia_generate_client_cert | bool == True diff --git a/templates/openssl.conf.j2 b/templates/openssl.conf.j2 new file mode 100644 index 00000000..a6d2c120 --- /dev/null +++ b/templates/openssl.conf.j2 @@ -0,0 +1,263 @@ +# +# OpenSSL example configuration file. +# This is mostly being used for generation of certificate requests. +# +# This definition stops the following lines choking if HOME isn't +# defined. +HOME = . +RANDFILE = $ENV::HOME/.rnd +# Extra OBJECT IDENTIFIER info: +#oid_file = $ENV::HOME/.oid +oid_section = new_oids +# 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 = "{{ octavia_cert_dir }}" # 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 = "{{ octavia_client_ca }}" # 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 = {{ octavia_client_ca_key }}# The private key +RANDFILE = $dir/private/.rand # private random number file +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 +# 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 +#################################################################### +[ 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) +default_policy = tsa_policy1 # Policy if request did not specify it + # (optional) +other_policies = tsa_policy2, tsa_policy3 # acceptable policies (optional) +digests = md5, sha1 # 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) \ No newline at end of file diff --git a/tests/os_octavia-overrides.yml b/tests/os_octavia-overrides.yml index c414a903..704e2a46 100644 --- a/tests/os_octavia-overrides.yml +++ b/tests/os_octavia-overrides.yml @@ -16,7 +16,7 @@ ## gate cloud provides reliabley. To cut down on gate errors this will ## disbale the tests which spin up an amphora ## As of 4/6/18 zuul runs out of memory testing with this enabled -test_octavia_amphora: False +test_octavia_amphora: True # Test Octavia standalone octavia_v2: True diff --git a/tests/test-octavia.yml b/tests/test-octavia.yml index 33e6ccef..52e33476 100644 --- a/tests/test-octavia.yml +++ b/tests/test-octavia.yml @@ -116,6 +116,7 @@ environment: "{{ env }}" register: lb_active until: lb_active.stdout == "ACTIVE" + failed_when: lb_active.stdout == "ERROR" retries: 50 delay: 10 tags: @@ -132,6 +133,7 @@ environment: "{{ env }}" register: lb_active until: lb_active.stdout == "ACTIVE" + failed_when: lb_active.stdout == "ERROR" retries: 10 delay: 10 tags: