Bug 2214364 - Review Request: rust-rustls-webpki - Web PKI X.509 Certificate Verification
Summary: Review Request: rust-rustls-webpki - Web PKI X.509 Certificate Verification
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: blinxen
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 2182860 2183557
TreeView+ depends on / blocked
 
Reported: 2023-06-12 18:36 UTC by Fabio Valentini
Modified: 2023-06-28 18:03 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-06-28 18:03:22 UTC
Type: ---
Embargoed:
h-k-81: fedora-review+


Attachments (Terms of Use)

Description Fabio Valentini 2023-06-12 18:36:21 UTC
Spec URL: https://decathorpe.fedorapeople.org/rust-rustls-webpki.spec
SRPM URL: https://decathorpe.fedorapeople.org/rust-rustls-webpki-0.100.1-1.fc38.src.rpm

Description:
Web PKI X.509 Certificate Verification.

Fedora Account System Username: decathorpe

Comment 1 Fabio Valentini 2023-06-12 18:36:24 UTC
This package built on koji:  https://koji.fedoraproject.org/koji/taskinfo?taskID=102070991

Comment 2 blinxen 2023-06-26 19:43:56 UTC
Taking this review

General comments:

- Package was generated with rust2rpm and changes were made
- License field was specified by the packager because upstream did not specify it in the crate metadata. The main branch has this fixed but it now includes both ISC and BSD-3-Clause. My understanding is that BSD-3-Clause is only required for tests. The code itself is licensed under ISC.
- The tests directory along with the third-party directory are excluded from the binary RPM. Not specifying the BSD-3-Clause license should be OK here.

Questions:

- The crate depends on `ring` which is architecture dependent. Why is the package "noarch"? Does the "supported_arches" macro have some kind of magic powers?
- Both build and check sections are dependent on the arch but the install section is not. Why? Does "cargo install" not also build the crate if it was not built before?
- You drop all integration tests because of missing files in the published crate. Some tests have their files published with the crate, so technically they could be run. Did you miss this or did I see wrong?

Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed



===== MUST items =====

Generic:
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "BSD 3-Clause License". 85 files have
     unknown license. Detailed output of licensecheck in /var/lib/copr-
     rpmbuild/results/rust-rustls-webpki/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: %build honors applicable compiler flags or justifies otherwise.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[x]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[!]: Package is not known to require an ExcludeArch tag.
[x]: Package complies to the Packaging Guidelines
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package must not depend on deprecated() packages.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 0 bytes in 0 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[x]: Reviewer should test that the package builds in mock.
[x]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in rust-
     rustls-webpki-devel , rust-rustls-webpki+default-devel , rust-rustls-
     webpki+alloc-devel , rust-rustls-webpki+std-devel
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[!]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).


Rpmlint
-------
Checking: rust-rustls-webpki-devel-0.100.1-1.fc38.noarch.rpm
          rust-rustls-webpki+default-devel-0.100.1-1.fc38.noarch.rpm
          rust-rustls-webpki+alloc-devel-0.100.1-1.fc38.noarch.rpm
          rust-rustls-webpki+std-devel-0.100.1-1.fc38.noarch.rpm
          rust-rustls-webpki-0.100.1-1.fc38.src.rpm
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmpgqtyxykf')]
checks: 31, packages: 5

rust-rustls-webpki+alloc-devel.noarch: W: no-documentation
rust-rustls-webpki+default-devel.noarch: W: no-documentation
rust-rustls-webpki+std-devel.noarch: W: no-documentation
 5 packages and 0 specfiles checked; 0 errors, 3 warnings, 0 badness; has taken 0.2 s




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.11/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 31, packages: 4

rust-rustls-webpki+std-devel.noarch: W: no-documentation
rust-rustls-webpki+alloc-devel.noarch: W: no-documentation
rust-rustls-webpki+default-devel.noarch: W: no-documentation
 4 packages and 0 specfiles checked; 0 errors, 3 warnings, 0 badness; has taken 0.0 s



Source checksums
----------------
https://crates.io/api/v1/crates/rustls-webpki/0.100.1/download#/rustls-webpki-0.100.1.crate :
  CHECKSUM(SHA256) this package     : d6207cd5ed3d8dca7816f8f3725513a34609c0c765bf652b8c3cb4cfd87db46b
  CHECKSUM(SHA256) upstream package : d6207cd5ed3d8dca7816f8f3725513a34609c0c765bf652b8c3cb4cfd87db46b


Requires
--------
rust-rustls-webpki-devel (rpmlib, GLIBC filtered):
    (crate(ring) >= 0.16.19 with crate(ring) < 0.17.0~)
    (crate(untrusted/default) >= 0.7.1 with crate(untrusted/default) < 0.8.0~)
    cargo

rust-rustls-webpki+default-devel (rpmlib, GLIBC filtered):
    cargo
    crate(rustls-webpki)
    crate(rustls-webpki/std)

rust-rustls-webpki+alloc-devel (rpmlib, GLIBC filtered):
    (crate(ring/alloc) >= 0.16.19 with crate(ring/alloc) < 0.17.0~)
    cargo
    crate(rustls-webpki)

rust-rustls-webpki+std-devel (rpmlib, GLIBC filtered):
    cargo
    crate(rustls-webpki)
    crate(rustls-webpki/alloc)



Provides
--------
rust-rustls-webpki-devel:
    crate(rustls-webpki)
    rust-rustls-webpki-devel

rust-rustls-webpki+default-devel:
    crate(rustls-webpki/default)
    rust-rustls-webpki+default-devel

rust-rustls-webpki+alloc-devel:
    crate(rustls-webpki/alloc)
    rust-rustls-webpki+alloc-devel

rust-rustls-webpki+std-devel:
    crate(rustls-webpki/std)
    rust-rustls-webpki+std-devel



Generated by fedora-review 0.9.0 (6761b6c) last change: 2022-08-23
Command line :/usr/bin/fedora-review --no-colors --prebuilt --rpm-spec --name rust-rustls-webpki --mock-config /var/lib/copr-rpmbuild/results/configs/child.cfg
Buildroot used: fedora-38-x86_64
Active plugins: Generic, Shell-api
Disabled plugins: Java, Haskell, Ocaml, PHP, C/C++, fonts, SugarActivity, Python, Perl, R
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 3 Fabio Valentini 2023-06-26 19:52:17 UTC
(In reply to blinxen from comment #2)
> Taking this review
> 
> General comments:
> 
> - Package was generated with rust2rpm and changes were made
> - License field was specified by the packager because upstream did not
> specify it in the crate metadata. The main branch has this fixed but it now
> includes both ISC and BSD-3-Clause. My understanding is that BSD-3-Clause is
> only required for tests. The code itself is licensed under ISC.

Meh, I guess I'll file an issue with upstream to clarify the license. Including BSD-3-Clause in the crate metadata if it only applies to test data that's not linked into binaries that seems off to me.

> - The tests directory along with the third-party directory are excluded from
> the binary RPM. Not specifying the BSD-3-Clause license should be OK here.
> 
> Questions:
> 
> - The crate depends on `ring` which is architecture dependent. Why is the
> package "noarch"? Does the "supported_arches" macro have some kind of magic
> powers?

No, the idea is that the package is available on all architectures to prevent broken dependencies, but it will not compile on unsupported architectures.
This is why %cargo_build and %cargo_test are wrapped in "%if supported_arches" conditions.

> - Both build and check sections are dependent on the arch but the install
> section is not. Why? Does "cargo install" not also build the crate if it was
> not built before?

The "%cargo_install" macro does not run "cargo install" for library crates, but only "cargo package" to copy library sources. So no, it does not compile. Otherwise the scratch build would also have failed.

> - You drop all integration tests because of missing files in the published
> crate. Some tests have their files published with the crate, so technically
> they could be run. Did you miss this or did I see wrong?

I didn't miss it. But the way the tests are written, they attempt to include files at compile time (i.e. `include_bytes!()` macro). This breaks compiling the tests/integration.rs file even if I tried to skip tests with missing data with "%cargo_test -- -- --skip foo" ... I don't think it's worth my time to manually go through this file for every update to patch out tests that don't compile.

Comment 4 Fabio Valentini 2023-06-26 20:05:22 UTC
I've filed upstream issue about whether including BSD-3-Clause in the license metadata is correct:
https://github.com/rustls/webpki/issues/101

Comment 5 Fabio Valentini 2023-06-27 23:25:11 UTC
The upstream project has now applied a change that's basically equivalent to the current downstream patch:
https://github.com/rustls/webpki/pull/102

So I think having just "ISC" as license should definitely be OK now.
Since the test data is not included in built RPMs anyway it was OK before this clarification as well, since License tag only applies to RPMs, not SRPMs, but it's good to have upstream clarification. :)

Comment 6 blinxen 2023-06-28 16:04:26 UTC
> I don't think it's worth my time to manually go through this file for every update to patch out tests that don't compile.

Makes sense

> Since the test data is not included in built RPMs anyway it was OK before this clarification as well, since License tag only applies to RPMs, not SRPMs, but it's good to have upstream clarification. :)

:+1:

APPROVED

Comment 7 Fabio Valentini 2023-06-28 16:14:05 UTC
Thanks for the review!

Comment 8 Fedora Admin user for bugzilla script actions 2023-06-28 16:14:12 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/rust-rustls-webpki

Comment 9 Fedora Update System 2023-06-28 18:02:13 UTC
FEDORA-2023-ba79702e54 has been submitted as an update to Fedora 39. https://bodhi.fedoraproject.org/updates/FEDORA-2023-ba79702e54

Comment 10 Fedora Update System 2023-06-28 18:03:22 UTC
FEDORA-2023-ba79702e54 has been pushed to the Fedora 39 stable repository.
If problem still persists, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.