[Bug 2022372] Re: Backport for deprecated int_from_bytes to int.from_bytes

[Heather Lemon]

** Description changed:

  [ Impact ]
  
- A method from cryptographic_utils was deprecated and replaced.
- This affects both python-secretstorage and python3-secretstorage
- with the python3-cryptography dependency from the Ubuntu Cloud Archive.
+ There is an issue when using the combination of the debian 
+ python3-secretstorage package with the UCA version of a third party dependency 
+ called python3-cryptography. Executing openstack commands or running 
+ `from secretstorage.dhcrypto import Session` shows warning messages like this 
+ in the logs `CryptographyDeprecationWarning: int_from_bytes is deprecated, 
+ use int.from_bytes instead`. 
  
- It also deprecates the usage of utils.int_from_bytes: pyca/cryptography#5609
- int_from_bytes is deprecated in favor of int.from_bytes which ships with Python 3
- 
- We are cherry-picking 2 commits from upstream,
- ad7c45e493fff48f897487d6aff63f4fff021d31 and
- 08c7010322ecec0de1e51cc51d5ed9db34a38aa3 to address the unnecessary
- logging when using any Openstack command, or automating the
- install/upgrade of services on OpenStack.
+ We chose to do a partial revert of this commit as bringing in the unit
+ tests would add an extra third-party dependency.
  
  [ Test Plan ]
  
  # This is the expected output
  python3
  >>> from secretstorage.dhcrypto import Session
  >>> session = Session()
  >>> exit()
  
+ # install focal version of python3-secretstorage module from debian 
+ sudo apt-get install python3-secretstorage=2.3.1-2ubuntu1
+ 
+ # install uca focal-yoga version of python3-cryptography
+ sudo apt-add-repository -y cloud-archive:yoga
+ sudo apt install -y python3-cryptography
+ 
  Installing and running the dhcrypto module from python-secretstorage
  shows after installing the package from the cloud-archive we see logger
  warnings messages from the deprecated method. Yoga has the updated
  python3-cryptography module with the upstream Debian fixes.
- 
- sudo apt-add-repository -y cloud-archive:yoga
- sudo apt install -y python3-cryptography
  
  python3
  >>> from secretstorage.dhcrypto import Session
  /usr/lib/python3/dist-packages/secretstorage/dhcrypto.py:15: CryptographyDeprecationWarning: int_from_bytes is deprecated, use int.from_bytes instead
    from cryptography.utils import int_from_bytes
  /usr/lib/python3/dist-packages/secretstorage/util.py:19: CryptographyDeprecationWarning: int_from_bytes is deprecated, use int.from_bytes instead
    from cryptography.utils import int_from_bytes
  >>> exit()
  
+ Ensure unit tests pass and no regressions are found.
+ 
+ Deploy focal yoga openstack instance. Execute openstack commands 
+ and ensure warning message like those above are no longer reported in the logs.  
+ 
+ 
  [ Where problems could occur ]
- 
- This does not include the cryptography module update which python3-secretstorage depends on. [1] We are also still supporting Python2 with this cherry-picked patch.
- Build-Depends: debhelper-compat (= 13),
-                dh-python,
-                python3-all
-                python3-cryptography,
-                python3-jeepney
-                python3-setuptools,
-                python3-sphinx
  
  The impact is low as this fixes a deprecated method from a 3rd party
  library.
  
- It allows one to create, edit and delete secret items, manipulate
- secret collections, and search for items matching given attributes.
- It also supports locking and unlocking collections.
+ Ensure that python3-secretstorage has no regressions.
  
  [ Other Info ]
  
  [0] upstream debian link - https://salsa.debian.org/python-team/packages/python-secretstorage/-/commit/e24df79cf7d62f11c2906d5aa0f4885cefeafbbf
  [1] Github conversation link - https://github.com/mitya57/secretstorage/pull/27
  [2] upstream cherrypick author other - https://github.com/mitya57/secretstorage/pull/27
+ [3] https://github.com/pyca/cryptography/commit/5528a3182fdd6ed1c44c126d451a87bcf39e79de

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

Title:
  Backport for deprecated int_from_bytes to int.from_bytes

Status in Ubuntu Cloud Archive:
  Invalid
Status in Ubuntu Cloud Archive yoga series:
  In Progress
Status in python-secretstorage package in Ubuntu:
  Invalid
Status in python-secretstorage source package in Bionic:
  Invalid
Status in python-secretstorage source package in Focal:
  Won't Fix
Status in python-secretstorage source package in Jammy:
  Invalid
Status in python-secretstorage source package in Kinetic:
  Invalid

Bug description:
  [ Impact ]

  There is an issue when using the combination of the debian 
  python3-secretstorage package with the UCA version of a third party dependency 
  called python3-cryptography. Executing openstack commands or running 
  `from secretstorage.dhcrypto import Session` shows warning messages like this 
  in the logs `CryptographyDeprecationWarning: int_from_bytes is deprecated, 
  use int.from_bytes instead`. 

  We chose to do a partial revert of this commit as bringing in the unit
  tests would add an extra third-party dependency.

  [ Test Plan ]

  # This is the expected output
  python3
  >>> from secretstorage.dhcrypto import Session
  >>> session = Session()
  >>> exit()

  # install focal version of python3-secretstorage module from debian 
  sudo apt-get install python3-secretstorage=2.3.1-2ubuntu1

  # install uca focal-yoga version of python3-cryptography
  sudo apt-add-repository -y cloud-archive:yoga
  sudo apt install -y python3-cryptography

  Installing and running the dhcrypto module from python-secretstorage
  shows after installing the package from the cloud-archive we see
  logger warnings messages from the deprecated method. Yoga has the
  updated python3-cryptography module with the upstream Debian fixes.

  python3
  >>> from secretstorage.dhcrypto import Session
  /usr/lib/python3/dist-packages/secretstorage/dhcrypto.py:15: CryptographyDeprecationWarning: int_from_bytes is deprecated, use int.from_bytes instead
    from cryptography.utils import int_from_bytes
  /usr/lib/python3/dist-packages/secretstorage/util.py:19: CryptographyDeprecationWarning: int_from_bytes is deprecated, use int.from_bytes instead
    from cryptography.utils import int_from_bytes
  >>> exit()

  Ensure unit tests pass and no regressions are found.

  Deploy focal yoga openstack instance. Execute openstack commands 
  and ensure warning message like those above are no longer reported in the logs.  

  
  [ Where problems could occur ]

  The impact is low as this fixes a deprecated method from a 3rd party
  library.

  Ensure that python3-secretstorage has no regressions.

  [ Other Info ]

  [0] upstream debian link - https://salsa.debian.org/python-team/packages/python-secretstorage/-/commit/e24df79cf7d62f11c2906d5aa0f4885cefeafbbf
  [1] Github conversation link - https://github.com/mitya57/secretstorage/pull/27
  [2] upstream cherrypick author other - https://github.com/mitya57/secretstorage/pull/27
  [3] https://github.com/pyca/cryptography/commit/5528a3182fdd6ed1c44c126d451a87bcf39e79de

To manage notifications about this bug go to:
https://bugs.launchpad.net/cloud-archive/+bug/2022372/+subscriptions