** Description changed:

  [Impact]
  
  A connection session is opened, but the TLS parameters (timeout, ca,
  cert and key) are not actually set for the session.  This prevents use
  of TLS for the etcd3gw package.
  
  [Test Plan]
  
  # Create self signed certs
  
  openssl req -x509 -out localhost.crt -keyout localhost.key -newkey rsa:4096 
-nodes -sha256 -out localhost.csr
  *make sure the key has an empty password
  
  #download binaries & launch etcd locally with TLS enabled
  
  wget https://github.com/etcd-
  io/etcd/releases/download/v3.3.13/etcd-v3.3.13-linux-amd64.tar.gz
  
  tar -zxvf etcd-v3.3.14-linux-amd64.tar.gz
  
  cd etcd-v3.3.14-linux-amd64/
  sudo cp etcd etcdctl /usr/bin/
  
  # spin up ectd server
  etcd --name infra0 --data-dir infra0 --cert-file=localhost.crt 
--key-file=localhost.key --advertise-client-urls=https://127.0.0.1:2379 
--listen-client-urls=https://127.0.0.1:2379
  *note I named my directory infra0
  
  #test connection with health endpoint:
  
  curl --cacert localhost.crt --key localhost.key --cert localhost.crt
  https://127.0.0.1:2379/health
  
  #if successful, the etcd server is configured with https
  {"health": "true"}
  
  Modify ~/python-etcd3gw-0.2.1/etcd3gw/tests/test_client.py
  
  def test_client_tls(self):
- client = Etcd3Client(host="127.0.0.1", protocol="https", 
ca_cert="/root/etcdserver.crt", cert_key="/root/etcdserver.key",
-         cert_cert="/root/etcdserver.crt", timeout=10)
-         client.create("foo", value="bar")
-         client.get("foo")
+         client = Etcd3Client(host="127.0.0.1", protocol="https", 
ca_cert="/home/heather/etcdserver.crt",
+          cert_key="/home/heather/etcdserver.key",
+          cert_cert="/home/heather/etcdserver.crt", 
+          timeout=10)
+     client.create("foo", value="bar")
+     client.put("foo")
+     resp = client.get("foo")
+     print(resp)
  
  # Run the newly added unit test
  
  python3 -m unittest test_client.TestEtcd3Gateway.test_client_tls
  
  We get an error in both the unit test and an error from the etcd server
  unit test error we are looking for:
  
  OpenSSL.SSL.Error: [('SSL routines', 'tls_process_server_certificate',
  'certificate verify failed')] related etcd error: I | embed: rejected
  connection from "127.0.0.1:44244" (error "remote error: tls: bad
  certificate", ServerName "")
  
  If you are testing with the added unit test, then make sure there is no
  etcd server running already.
  
  Unit test console output:
  
- python3 -m unittest test_client.TestEtcd3Gateway.test_client_tls
- /home/heather/.local/lib/python3.8/site-packages/urllib3/connection.py:455: 
SubjectAltNameWarning: Certificate for 127.0.0.1 has no `subjectAltName`, 
falling back to check for a `commonName` for now. This feature is being removed 
by major browsers and deprecated by RFC 2818. (See 
https://github.com/urllib3/urllib3/issues/497 for details.)
-   warnings.warn(
- 127.0.0.1 - - [25/Feb/2021 16:43:48] "GET /health HTTP/1.1" 200 -
+ root@ubuntu-bionic:~/githubsource-pythonetcd3gw/etcd3-gateway/etcd3gw/tests# 
python3 -m unittest test_client.TestEtcd3Gateway.test_client_tls
+ /usr/lib/python3/dist-packages/urllib3/connection.py:358: 
SubjectAltNameWarning: Certificate for 127.0.0.1 has no `subjectAltName`, 
falling back to check for a `commonName` for now. This feature is being removed 
by major browsers and deprecated by RFC 2818. (See 
https://github.com/shazow/urllib3/issues/497 for details.)
+   SubjectAltNameWarning
+ [b'bar']
+ /usr/lib/python3/dist-packages/testtools/testcase.py:719: ResourceWarning: 
unclosed <ssl.SSLSocket fd=3, family=AddressFamily.AF_INET, 
type=SocketKind.SOCK_STREAM, proto=6, laddr=('127.0.0.1', 38392), 
raddr=('127.0.0.1', 2379)>
+   return self._get_test_method()()
  .
  ----------------------------------------------------------------------
- Ran 1 test in 0.107s
+ Ran 1 test in 0.048s
  
  OK
- ---------
- The unit test I've made is an echo of the test_client.py code we've just 
updated. 
  
- # 
+ The unit test I've made is an echo of the test_client.py code we've just
+ updated.
+ 
+ #
  Testing out the new unit test from the source code changes.
  
- I have added a new unit test that tests the setting of TLS params. 
- You can run the unit test with: 
+ I have added a new unit test that tests the setting of TLS params.
+ You can run the unit test with:
  
  python3 -m unittest
  
  again make sure there's no etcd server already running.
- 
  
  [Where Problems Could Occur]
  
  This adds TLS parameters (if provided) to the session, so regressions
  would involve failed connections, possibly those without TLS that had
  TLS params incorrectly provided before.
  
  [Other]
  
  the upstream bug is https://github.com/dims/etcd3-gateway/issues/20
  fixed upstream with pull request https://github.com/dims/etcd3-gateway/pull/21
  via commit 90b7a19cdc4daa1230d7f15c10b113abdefdc8c0
  
  that commit is contained in version 0.2.2, which is not yet pulled into
  Debian, so this patch is needed in Debian, as well as Bionic and Focal.
  This package was not included in Xenial.

-- 
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1820083

Title:
  TLS params not set for session

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/python-etcd3gw/+bug/1820083/+subscriptions

-- 
ubuntu-bugs mailing list
ubuntu-bugs@lists.ubuntu.com
https://lists.ubuntu.com/mailman/listinfo/ubuntu-bugs

Reply via email to