[Bug 2030482] Re: [MIR] s390-tools Rust dependencies (vendored)
Mark Esler
2030482 at bugs.launchpad.net
Fri Oct 6 01:33:10 UTC 2023
I reviewed s300-tools 2.28.0-0ubuntu2 and 2.29.0-0ubuntu2 as released in
Mantic's development. This shouldn't be considered a full audit, but rather
a quick gauge of maintainability.
s390-tools already exists in main. This review only considers novel Rust
code which has not been included in main before.
Most Rust additions are bindings between s390-tools and other tools, such
as rust-openssl, rust-libc, and rust-curl. Vendored packages are not being
reviewed. rustc/cargo package contains ~700 vendored packages. s390-tools
defensively limits the number of vendored packages ++1
Note, that the s390x deb packages is ~4x larger than debs for other archs,
as expected. Security's uaudit tooling is designed for amd64. Due to
urgency, only amd64 was compiled and s390x debs between Lunar and Mantic
were compared for this review.
Please also note that Rust tools are not included in s390-tools-signed.
The Security team thanks Simon Choplin for his work to define Rust code in
main: https://wiki.ubuntu.com/RustCodeInMain
s390-tools are: Tools for use with the s390 Linux kernel and device
drivers
- CVE History:
- only CVE in history only affects SUSE
- see vendored security history above
- GitHub Issue and PR tracker are maintained
- changelog since 2.26.0 (lunar main) not concerning
- Build-Depends?
- see new ./rust-vendor/
- pre/post inst/rm scripts?
- d/s390-tools-statd.postinst loads systemd module
- already existed in s390-tools lunar main
- see systemd below
- d/s390-tools-zkey.postinst adds zkeyadm group, and sets folders/files
to 0770 root:zkeyadm
- already existed in s390-tools lunar main
- d/s390-tools.postinst no longer exists in mantic
- d/debian/s390-tools.postinst.s390x does
- many .install scripts
- s390-tools-data.install is new
- adds genprotimg bins
- in lunar, genprotimg was in d/not-installed
- not Rust related, future C review needed
- https://github.com/ibm-s390-linux/s390-tools/tree/master/genprotimg
- init scripts?
- none
- systemd units?
- already existed in s390-tools lunar main
- no re-review
- see mon_tools and d/modules-load.d/s390-tools.conf
- dbus services?
- none
- setuid binaries?
- none
- binaries in PATH?
- amd64 binaries:
- all are root:root owned
- /usr/bin/genprotimg
- /usr/bin/pvattest
- /usr/bin/pvextract-hdr
- s390x binaries not reviewed
- sudo fragments?
- none
- polkit files?
- none
- udev rules?
- none
- unit tests / autopkgtests?
- see MIR review notes on tests
- some new Rust code contains tests
- cron jobs?
- none
- Build logs:
- see MIR review about noisy logs
- overall, mantic's build logs are much better than lunar's
- note: only novel, non-vendored, Rust code is being considered for MIR
- see header
- related ./debian/ code is not a concern
- diff -qr lunar/s390-tools-2.26.0/ mantic/s390-tools-2.29.0/
- Only ./rust/ directory requires review!
- Processes spawned?
- none detected
- only std::process::ExitCode
- Memory management?
- unsafe std::ptr::write_volatile used to zero secrets, ++1
- defensive memory use
- File IO?
- std::fs use
- see ./rust/pv/src/uvdevice.rs
- static path /sys/firmware/uv/prot_virt_guest
- Logging?
- yes, see pv::misc::PvLogger
- Environment variable usage?
- DEP_OPENSSL_CONF
- DEP_OPENSSL_VERSION_NUMBER
- S390_TOOLS_RELEASE
- CARGO_PKG_NAME
- CARGO_PKG_VERSION
- Use of privileged functions?
- ioctl looks dangerous
- likely less dangerous than asm predecessor
- is uvdevice's test necessary?
- do we ship mock_libc? if so, is there a benefit in the deb?
- Use of cryptography / random number sources etc?
- OpenSSL
- implementation not checked
- if s390-tools is FIPS relevant, will request review post-MIR
- Use of temp files?
- none
- Use of networking?
- curl at al.
- confined environments only
- Use of WebKit?
- none
- Use of PolicyKit?
- none
- Any significant cppcheck results?
- C results need investigation
- not Rust related
- Any significant Coverity results?
- many new results between 2.28.0 and 2.29.0
- C results need investigation
- especially genprotimg
- see coverity-2.28.0.txt
- not Rust related
- is rust/pv/Cargo.toml:32 safe?
- see coverity-2.29.0.txt
- Any significant shellcheck results?
- worth review
- not Rust related
- Any significant semgrep results?
- C results look interesting
This brief security MIR is an exception. Security may conduct further
reviews and report issues to owning team--this is not a required condition
for Mantic's ACK.
genprotimg needs review.
Is ./usr/share/s390-tools/netboot/Dockerfile required in the s390x deb?
The s390-tools developers maintain a high quality code base and have taken
steps to ensure security.
Only s390-tools 2.29.0 in Mantic's proposed contains d/README.source!
Security team ACKs for promoting s390-tools main.
** Changed in: s390-tools (Ubuntu)
Assignee: Ubuntu Security Team (ubuntu-security) => (unassigned)
** Changed in: s390-tools (Ubuntu)
Status: Confirmed => Fix Committed
--
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to s390-tools in Ubuntu.
https://bugs.launchpad.net/bugs/2030482
Title:
[MIR] s390-tools Rust dependencies (vendored)
Status in s390-tools package in Ubuntu:
Fix Committed
Bug description:
[Availability]
The package s390-tools is already in Ubuntu main, and is re-reviewed due to signinficant changes in the package (new Rust code-base, including vendored dependencies).
The package s390-tools builds for the architectures it is designed to work on.
It currently builds and works for architectures: s390x, and to a much more limited extent, amd64, arm64 and ppc64el
Link to package https://launchpad.net/ubuntu/+source/s390-tools
[Rationale]
- The package s390-tools is required in Ubuntu main for hardware enablement on s390x machines
- The package s390-tools will not generally be useful for a large part of
our user base, but is important/helpful still because it's necessary for the proper operation
of IBM Z mainframe.
- There is no other/better way to solve this that is already in main or
should go universe->main instead of this.
- The package s390-tools is required in Ubuntu main no later than
Mantic Beta freeze
[Security]
- No CVEs/security issues in this software in the past (CVE-2021-25316 doesn't apply)
- no `suid` or `sgid` binaries
- There are a lot of binaries in /sbin, which is expected as they are used for machine administration.
- Package does install services, timers or recurring jobs
* cpacfstatsd -> system statistics
* cpi.service -> used to provide system data to the hypervisor
* cpuplugd.service -> CPU hotplug
* dumpconf.service -> Configures dumps on panics
* iucvtty-login at .service, ttyrun-getty at .service -> TTY handling
* mon_fsstatd.service, mon_procd.service -> monitoring
Vendored dependencies security history:
- https://github.com/rustsec/advisory-db/blob/main/crates/once_cell/RUSTSEC-2019-0017.md
- https://github.com/rustsec/advisory-db/tree/main/crates/openssl
-> Note that while the vendored crate is affected by RUSTSEC-2023-0044 the
relevant function is never called by the compiled binary, either directly or
indirectly.
- https://github.com/rustsec/advisory-db/blob/main/crates/serde_yaml/RUSTSEC-2018-0005.md
- https://github.com/rustsec/advisory-db/blob/main/crates/socket2/RUSTSEC-2020-0079.md
There doesn't seem to be any specific security features attached to
those services.
In addition, there are several udev rules shipped with the software,
to deal with s390-specific hardware.
- Packages does not contain extensions to security-sensitive software
(filters, scanners, plugins, UI skins, ...)
[Quality assurance - function/usage]
- The package works well right after install
[Quality assurance - maintenance]
- The package is maintained well in Ubuntu/Upstream and does
not have too many, long-term & critical, open bugs
- Ubuntu https://bugs.launchpad.net/ubuntu/+source/s390-tools/+bug
-> mostly feature requests
- Upstream's bug tracker: https://github.com/ibm-s390-linux/s390-tools/issues
Note that we've completely diverged from Debian, so their package isn't relevant to this MIR.
Upstream is heavily involved with the Ubuntu packaging, often providing us with verifications for SRUs
and tests of potential packages.
- The package does deal with exotic hardware, the Canonical Partners Engineering team has access
to the relevant machines to be able to test, fix and verify bugs.
[Quality assurance - testing]
- The package does not run a test at build time because no test suite is
provided upstream. Things recently changed a bit with the new Rust code
having a few tests, but I'm reluctant to enable them as the vendored
dependency tree would more than double in size (compressed!)
- The package does not run an autopkgtest.
- The package can not be well tested at build or autopkgtest time
because the majority of tools inside of the package need either:
- a special hardware level (for example z14 for secure boot, z15 for secure execution aka confidential computing) and/or
- a native (LPAR) installation (for lowest level hardware access) and/or
- special configuration settings (in the LPAR activation profile, for exampel for counters) and/or
- specially assigned hardware cards (like crypto, RoCE, NVMe, or other hardware) and/or
- hardware cards setup in a special way (for example in case of crypto with a master key set) and/or
- run the hardware management console (hmc) in different modes (PR/SM vs DPM, but there is no simple way to switch between modes)To make up for that:
It's contractually agreed with our partner that the partner runs (and is in charge of) the testing on hardware that we do not have at Canonical (that is btw. also the case for SRUs) and that we (actually Solutions QA) do (does) a manual test around GA (that incl. s390-tools, but also manual and autoinstallations, which again make use of various s390-tools components) for every Ubuntu release, where the result is added to an overall test spreadsheet for that particular Ubuntu release for s390x.
The corresponding S-QA doc is: https://docs.google.com/document/d/1ixvRDgEHNjZwOujYJ9hmfbQte9A05ffOTrKi_PK82cs
- It is not possible to leave s390-tools in universe, since a lot of it's content (like bootloader, tools to activate hardware - just to name a few) are mandatory at install time and are required even for a base and minimal installation.
[Quality assurance - packaging]
- debian/watch is present and works
- debian/control defines a correct Maintainer field
- Recent build logs
https://launchpadlibrarian.net/682423862/buildlog_ubuntu-mantic-s390x.s390-tools_2.29.0-0ubuntu1_BUILDING.txt.gz
There is the usual issue of noisy Rust warnings in the dependencies.
- Lintian output is attached. It doesn't look very good, probably due to the
fact that since the package basically only fully build on s390x we rarely
produce binary packages on development machines, which is where Lintian runs
would usually scream at us.
- Lintian overrides are present, but ok because they're about Ubuntu-specific
source fields.
- This package does not rely on obsolete or about to be demoted packages.
- This package has no python2 or GTK2 dependencies
- The package will be installed by default on s390x, but does not ask debconf
questions higher than medium
- Packaging and build is fairly easy, link to debian/rules:
https://git.launchpad.net/ubuntu/+source/s390-tools/tree/debian/rules
There's a little bit of complexity due to the signing requirements, the fact
that is mostly builds on s390x, and also due to the Rust integration, but it's
still mostly straightforward.
[UI standards]
- Application is not end-user facing (does not need translation)
[Dependencies]
- No further depends or recommends dependencies that are not yet in main
[Standards compliance]
- This package correctly follows FHS and Debian Policy
[Maintenance/Owner]
- Foundations team is already subscribed to the package. Note that most of the
day-to-day work is done by Frank Heimes
- This does not use static builds using static archive from other
packages.
- The Foundations team is aware of the implications of vendored code and (as
alerted by the security team) commits to provide updates and backports
to the security team for any affected vendored code for the lifetime
of the release (including ESM).
- This package uses vendored rust code tracked in the Vendored-Sources-Rust field
in the package, refreshing that code is outlined in debian/README.source (not yet uploaded, see attached debdiff)
- This package is rust based and vendors all non language-runtime dependencies.
To be noted, upstream has defined a policy regarding which Rust dependencies
are acceptable, whic hseems fairly sensible and should reduce the inevitable growth
of that dep tree:
https://github.com/ibm-s390-linux/s390-tools/tree/master/rust#what-
third-party-crates-can-be-used-for-s390-tools
- The package has been built in the archive more recently than the last
test rebuild
Feature request: bug #2030316
Original s390-tools MIR: bug #1521984
To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/s390-tools/+bug/2030482/+subscriptions
More information about the foundations-bugs
mailing list