Bug 2255917

Summary: Review Request: rust-sequoia-chameleon-gnupg - Sequoia's reimplementation of the GnuPG interface
Product: [Fedora] Fedora Reporter: Fabio Valentini <decathorpe>
Component: Package ReviewAssignee: Ben Beasley <code>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: rawhideCC: code, package-review
Target Milestone: ---Keywords: AutomationTriaged
Target Release: ---Flags: code: fedora-review+
Hardware: Unspecified   
OS: Unspecified   
URL: https://crates.io/crates/sequoia-chameleon-gnupg
Whiteboard:
Fixed In Version: rust-sequoia-chameleon-gnupg-0.4.0-1.fc40 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2024-01-13 14:51:36 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
The .spec file difference from Copr build 6815993 to 6871234 none

Description Fabio Valentini 2023-12-26 16:33:55 UTC 
Spec URL: https://decathorpe.fedorapeople.org/rust-sequoia-chameleon-gnupg.spec
SRPM URL: https://decathorpe.fedorapeople.org/rust-sequoia-chameleon-gnupg-0.4.0-1.fc39.src.rpm

Description:
Sequoia's reimplementation of the GnuPG interface.

Fedora Account System Username: decathorpe
Comment 1 Fedora Review Service 2023-12-26 16:53:03 UTC 
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6815993
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2255917-rust-sequoia-chameleon-gnupg/fedora-rawhide-x86_64/06815993-rust-sequoia-chameleon-gnupg/fedora-review/review.txt

Please take a look if any issues were found.


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.
Comment 2 Ben Beasley 2024-01-07 17:47:30 UTC 
I am able to review this without bug 2255915 since the editdistancek is only a test dependency, and the tests are not enabled.
Comment 3 Ben Beasley 2024-01-07 17:50:21 UTC 
Package Review
==============

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

The package is based on the output of rust2rpm, simplifying the review.

The following differences are noted:

- The tests are disabled due to missing dependencies. While rust-ntest was
  packaged since the review was posted, there is still no rust-interprocess.

  Since this package is security-relevant, it would be especially nice to
  enable the tests at some point.

- Patches make two changes that are reasonable to do downstream-only:

  * drop features for unavailable crypto backends
  * build with OpenSSL crypto backend

- A patch ports from the home-dir crate to shellexpand, calling the former
  obsolete.

  This makes sense to do upstream, and in fact I found that you offered it there:

  # https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/merge_requests/111
  # https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/commit/03f23a7f960f1cc0ff74b499c0c2d1ce657e9a52

  Please add a spec-file comment to document the patch upstream status.

- The license expression was correctly constructed based on
  %cargo_license_summary.


===== Issues =====

- The upstream status of the patch to migrate from home-dir to shellexpand
  should be documented. Please add a link to the merge request and/or commit:

  # https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/merge_requests/111
  # https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/commit/03f23a7f960f1cc0ff74b499c0c2d1ce657e9a52

- The file src/err-codes.h.in is taken from libgpg-error and retains the
  LGPL-2.1-or-later license of that package, but the Cargo.toml file only
  mentions the “overall” license of GPL-3.0-or-later. At minimum, it looks like
  the base package License needs to change from

    License:        GPL-3.0-or-later

  to

    License:        GPL-3.0-or-later AND LGPL-2.1-or-later

  based on current Fedora license guidelines that prohibit using an “effective
  license.” Does that mean you should patch Cargo.toml and/or ask upstream to
  change it? I don’t know; you’re the Rust expert here. ;-)

  There *is* a LGPL-2.1-or-later term in the binary RPM’s License, but that is
  by chance, from buffered-reader and several sequioa-* crates.

  The bundling should also be indicated, something like:

    # A single header describing error codes, err-codes.h.in, is copied from
    # libgpg-error. Since this is not a public header file, unbundling is not
    # possible. It is not clear exactly which version of libgpg-error this file
    # was copied from.
    Provides:       bundled(libgpg-error)

- Rpmlint reports:

    sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl /usr/bin/gpg-sq SSL_CTX_set_cipher_list

  https://docs.fedoraproject.org/en-US/packaging-guidelines/CryptoPolicies/#_cc_applications

  I know that calling SSL_CTX_set_cipher_list() is OK as long as the string is
  "PROFILE=SYSTEM". That function isn’t mentioned in the source code, so the
  call is happening in a dependency (so if there isa  bug, it isn’t in this
  package).

  In dependency crate source openssl-0.10.62/src/ssl/connector.rs, I see:

    impl SslConnector {
        /// Creates a new builder for TLS connections.
        ///
        /// The default configuration is subject to change, and is currently derived from Python.
        pub fn builder(method: SslMethod) -> Result<SslConnectorBuilder, ErrorStack> {
            let mut ctx = ctx(method)?;
            ctx.set_default_verify_paths()?;
            ctx.set_cipher_list(
                "DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK",
            )?;
            setup_verify(&mut ctx);
    
            Ok(SslConnectorBuilder(ctx))
        }
        […]
    }

  There are other hard-coded cipher lists in SslAcceptor, but they are in
  functions explicitly corresponding to configurations recommended by Mozilla
  (mozilla_intermediate_v5, mozilla_intermediate, mozilla_modern), which seems
  like is should probably be acceptable.

  It seems likely that the builder function above is called, but I’m not sure
  how to prove that or otherwise further analyze this. I did find
  DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK in the
  output of “strings gpg-sv”, which supports the above theory.

  Anyway, *if* there is a failure to respect the system crypto policy it’s
  probably not due to anything in this package’s, so I am not sure whether it
  should block this review, but it does appear that this needs investigating.

===== Notes =====

- Rpmlint reports:

    sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpg-sq
    sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpgv-sq

  Man pages are always desired,
  https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages, but the
  help2man output for these commands is not great, so there isn’t much to be
  done here unless we want to maintain them by hand.

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

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[!]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "GNU General Public License, Version
     3", "GNU General Public License v3.0 or later", "*No copyright* GNU
     General Public License v3.0 or later", "GNU Lesser General Public
     License v2.1 or later". 212 files have unknown license. Detailed
     output of licensecheck in /home/ben/Downloads/review/2255917-rust-
     sequoia-chameleon-gnupg/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.

     $ rpm -qL -p results/sequoia-chameleon-gnupg-0.4.0-1.fc40.x86_64.rpm 
     /usr/share/licenses/sequoia-chameleon-gnupg/LICENSE.dependencies
     /usr/share/licenses/sequoia-chameleon-gnupg/LICENSE.txt

[x]: %build honors applicable compiler flags or justifies otherwise.
[!]: Package contains no bundled libraries without FPC exception.

     No FPC exception is required, as we have
     https://docs.fedoraproject.org/en-US/packaging-guidelines/#bundling now,
     but the bundling of src/err-codes.h.in from libgpg-error should be
     indicated and its license should appear in the overall License expression.

[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.
[x]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 21096 bytes in 2 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[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]: The License field must be a valid SPDX expression.
[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]: Packages must not store files under /srv, /opt or /usr/local

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

Generic:
[-]: 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in sequoia-
     chameleon-gnupg
[?]: Package functions as described.

     The commands print their help messages. The tests are not executed, and I
     don’t have a good interactive test in mind.

[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[!]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.

     The upstream status of the patch to migrate from home-dir to shellexpand
     should be documented. Please add a link to the merge request and/or
     commit.

[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[j]: Package should compile and build into binary rpms on all supported
     architectures.

     https://koji.fedoraproject.org/koji/taskinfo?taskID=111436943

[!]: %check is present and all tests pass.

     Tests are omitted due to missing interprocess crate dependency.

[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[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).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: sequoia-chameleon-gnupg-0.4.0-1.fc40.x86_64.rpm
          rust-sequoia-chameleon-gnupg-debugsource-0.4.0-1.fc40.x86_64.rpm
          rust-sequoia-chameleon-gnupg-0.4.0-1.fc40.src.rpm
=============================================== rpmlint session starts ===============================================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.12/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/tmpypznas1r')]
checks: 31, packages: 3

sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpg-sq
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpgv-sq
sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl /usr/bin/gpg-sq SSL_CTX_set_cipher_list
================ 3 packages and 0 specfiles checked; 0 errors, 3 warnings, 0 badness; has taken 0.4 s ================




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/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: 32, packages: 2

sequoia-chameleon-gnupg.x86_64: W: unused-direct-shlib-dependency /usr/bin/gpg-sq /lib64/libsqlite3.so.0
sequoia-chameleon-gnupg.x86_64: W: unused-direct-shlib-dependency /usr/bin/gpgv-sq /lib64/libsqlite3.so.0
sequoia-chameleon-gnupg.x86_64: E: spelling-error ('reimplementation', 'Summary(en_US) reimplementation -> re implementation, re-implementation, implementation')
sequoia-chameleon-gnupg.x86_64: E: spelling-error ('reimplementation', '%description -l en_US reimplementation -> re implementation, re-implementation, implementation')
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpg-sq
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpgv-sq
sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl /usr/bin/gpg-sq SSL_CTX_set_cipher_list
 2 packages and 0 specfiles checked; 2 errors, 5 warnings, 7 filtered, 2 badness; has taken 0.3 s 



Source checksums
----------------
https://crates.io/api/v1/crates/sequoia-chameleon-gnupg/0.4.0/download#/sequoia-chameleon-gnupg-0.4.0.crate :
  CHECKSUM(SHA256) this package     : a11b0fe2e73b22da4a77feef705c4f104b5cd1f7a61914e88c1ca3a5be460c1a
  CHECKSUM(SHA256) upstream package : a11b0fe2e73b22da4a77feef705c4f104b5cd1f7a61914e88c1ca3a5be460c1a


Requires
--------
sequoia-chameleon-gnupg (rpmlib, GLIBC filtered):
    ld-linux-x86-64.so.2()(64bit)
    libbz2.so.1()(64bit)
    libc.so.6()(64bit)
    libcrypto.so.3()(64bit)
    libcrypto.so.3(OPENSSL_3.0.0)(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    libgcc_s.so.1(GCC_3.3)(64bit)
    libgcc_s.so.1(GCC_4.2.0)(64bit)
    libm.so.6()(64bit)
    libsqlite3.so.0()(64bit)
    libssl.so.3()(64bit)
    libssl.so.3(OPENSSL_3.0.0)(64bit)
    rtld(GNU_HASH)

rust-sequoia-chameleon-gnupg-debugsource (rpmlib, GLIBC filtered):



Provides
--------
sequoia-chameleon-gnupg:
    sequoia-chameleon-gnupg
    sequoia-chameleon-gnupg(x86-64)

rust-sequoia-chameleon-gnupg-debugsource:
    rust-sequoia-chameleon-gnupg-debugsource
    rust-sequoia-chameleon-gnupg-debugsource(x86-64)



Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24
Command line :/usr/bin/fedora-review -b 2255917
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Generic
Disabled plugins: SugarActivity, Perl, Haskell, Python, fonts, Java, R, PHP, Ocaml, C/C++
Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH
Comment 4 Fabio Valentini 2024-01-07 18:09:30 UTC 
Thank you for the comprehensive review! I'll respond to your points inline.

I will post a new version of the package as soon as I'm back at my Fedora machine.

(In reply to Ben Beasley from comment #3)
> Package Review
> ==============
> 
> Legend:
> [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
> 
> The package is based on the output of rust2rpm, simplifying the review.
> 
> The following differences are noted:
> 
> - The tests are disabled due to missing dependencies. While rust-ntest was
>   packaged since the review was posted, there is still no rust-interprocess.
> 
>   Since this package is security-relevant, it would be especially nice to
>   enable the tests at some point.

Yes, I agree. That is why I already packaged ntest and submitted a review request for editdistancek.
I did not want to package the interprocess crate, since it pulls in additional dependencies, and it itself and some of its dependencies are problematic wrt/ packaging. The interprocess crate appears to be used only for *some* integration tests, so with editdistancek and ntest available, I should be able to run most of the test suite.

> - Patches make two changes that are reasonable to do downstream-only:
> 
>   * drop features for unavailable crypto backends
>   * build with OpenSSL crypto backend

The default crypto backend is Nettle, but with OpenSSL being the preferred crypto library in Fedora, I thought it would make sense to switch. This also matches what we do in rpm-sequoia.

> - A patch ports from the home-dir crate to shellexpand, calling the former
>   obsolete.
> 
>   This makes sense to do upstream, and in fact I found that you offered it
> there:
> 
>   #
> https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/merge_requests/111
>   #
> https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/commit/
> 03f23a7f960f1cc0ff74b499c0c2d1ce657e9a52
> 
>   Please add a spec-file comment to document the patch upstream status.
> 
> - The license expression was correctly constructed based on
>   %cargo_license_summary.
> 
> 
> ===== Issues =====
> 
> - The upstream status of the patch to migrate from home-dir to shellexpand
>   should be documented. Please add a link to the merge request and/or commit:
> 
>   #
> https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/merge_requests/111
>   #
> https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/commit/
> 03f23a7f960f1cc0ff74b499c0c2d1ce657e9a52

Sure, I will do that. I forgot that this MR was merged just *after* the 0.4.0 release.

> - The file src/err-codes.h.in is taken from libgpg-error and retains the
>   LGPL-2.1-or-later license of that package, but the Cargo.toml file only
>   mentions the “overall” license of GPL-3.0-or-later. At minimum, it looks
> like
>   the base package License needs to change from
> 
>     License:        GPL-3.0-or-later
> 
>   to
> 
>     License:        GPL-3.0-or-later AND LGPL-2.1-or-later
> 
>   based on current Fedora license guidelines that prohibit using an
> “effective
>   license.” Does that mean you should patch Cargo.toml and/or ask upstream to
>   change it? I don’t know; you’re the Rust expert here. ;-)
> 
>   There *is* a LGPL-2.1-or-later term in the binary RPM’s License, but that
> is
>   by chance, from buffered-reader and several sequioa-* crates.
> 
>   The bundling should also be indicated, something like:
> 
>     # A single header describing error codes, err-codes.h.in, is copied from
>     # libgpg-error. Since this is not a public header file, unbundling is not
>     # possible. It is not clear exactly which version of libgpg-error this
> file
>     # was copied from.
>     Provides:       bundled(libgpg-error)

Good catch. I will add both for the next revision of the package (as soon as I'm back at my Linux machine).

> - Rpmlint reports:
> 
>     sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl
> /usr/bin/gpg-sq SSL_CTX_set_cipher_list
> 
>  
> https://docs.fedoraproject.org/en-US/packaging-guidelines/CryptoPolicies/
> #_cc_applications
> 
>   I know that calling SSL_CTX_set_cipher_list() is OK as long as the string
> is
>   "PROFILE=SYSTEM". That function isn’t mentioned in the source code, so the
>   call is happening in a dependency (so if there isa  bug, it isn’t in this
>   package).
> 
>   In dependency crate source openssl-0.10.62/src/ssl/connector.rs, I see:
> 
>     impl SslConnector {
>         /// Creates a new builder for TLS connections.
>         ///
>         /// The default configuration is subject to change, and is currently
> derived from Python.
>         pub fn builder(method: SslMethod) -> Result<SslConnectorBuilder,
> ErrorStack> {
>             let mut ctx = ctx(method)?;
>             ctx.set_default_verify_paths()?;
>             ctx.set_cipher_list(
>                
> "DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK",
>             )?;
>             setup_verify(&mut ctx);
>     
>             Ok(SslConnectorBuilder(ctx))
>         }
>         […]
>     }
> 
>   There are other hard-coded cipher lists in SslAcceptor, but they are in
>   functions explicitly corresponding to configurations recommended by Mozilla
>   (mozilla_intermediate_v5, mozilla_intermediate, mozilla_modern), which
> seems
>   like is should probably be acceptable.
> 
>   It seems likely that the builder function above is called, but I’m not sure
>   how to prove that or otherwise further analyze this. I did find
>   DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK in
> the
>   output of “strings gpg-sv”, which supports the above theory.
> 
>   Anyway, *if* there is a failure to respect the system crypto policy it’s
>   probably not due to anything in this package’s, so I am not sure whether it
>   should block this review, but it does appear that this needs investigating.

Hm. I've seen similar issues in other Rust packages that use the OpenSSL bindings.
But I agree, since the code in question is not in this package, it should be "fixed" (if there *is* something to be fixed) in the actual place the code is located.

I *could* switch the crypto backend back to Nettle, I'm sure that would silence the rpmlint warning (but I don't even know if Nettle follows the system crypto policy :))

> ===== Notes =====
> 
> - Rpmlint reports:
> 
>     sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpg-sq
>     sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpgv-sq
> 
>   Man pages are always desired,
>   https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages, but
> the
>   help2man output for these commands is not great, so there isn’t much to be
>   done here unless we want to maintain them by hand.

Most Sequoia PGP projects ship their own actual man pages, but they rely on the translation layer from the "clap" command line parser -> man page. But this project does *not* use "clap" for parsing command line arguments, so that's not possible here. I agree that "help2man" isn't really helpful here, so I'd say I'd rather ship *no* manpages (and let people use the "--help" flag) than ship sub-par or broken man pages.
Comment 5 Fabio Valentini 2024-01-07 20:20:26 UTC 
Spec URL: https://decathorpe.fedorapeople.org/rust-sequoia-chameleon-gnupg.spec
SRPM URL: https://decathorpe.fedorapeople.org/rust-sequoia-chameleon-gnupg-0.4.0-1.fc39.src.rpm

Changes from the previous version:

- updated License tag from "GPL-3.0-or-later" to "GPL-3.0-or-later AND LGPL-2.1-or-later" and added a comment which license applies to what
- documented the upstream commit for the merged MR to port from home-dir to shellexpand
- add "Provided: bundled(libgpg-error)" to the binary package and document which file is bundled and that it's from an unknown version

I will investigate the possible issue with the OpenSSL policy and file a tracking bug with rust-openssl.
Comment 6 Fabio Valentini 2024-01-07 20:37:38 UTC 
Upon further investigation, I cannot find any code path in sequoia-chameleon-gnupg or sequoia-openpgp that results in a call to `(SSL_CTX_)set_cipher_list`. They do not use the `SslConnector::builder()` method either. As far as I can tell, sequoia-openpgp uses only some specific ciphers directly, and does not set an "allowed" list of ciphers for a context at all.

Maybe this is a false positive from rpmlint?
Comment 7 Fedora Review Service 2024-01-08 05:02:37 UTC 
Created attachment 2007705 [details]
The .spec file difference from Copr build 6815993 to 6871234
Comment 8 Fedora Review Service 2024-01-08 05:02:39 UTC 
Copr build:
https://copr.fedorainfracloud.org/coprs/build/6871234
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2255917-rust-sequoia-chameleon-gnupg/fedora-rawhide-x86_64/06871234-rust-sequoia-chameleon-gnupg/fedora-review/review.txt

Please take a look if any issues were found.


---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.
Comment 9 Ben Beasley 2024-01-13 13:40:16 UTC 
Package Review
==============

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

The spec-file diff since the previous review is:

--- ../../srpm-unpacked/rust-sequoia-chameleon-gnupg.spec       2023-12-25 19:00:00.000000000 -0500
+++ ./srpm-unpacked/rust-sequoia-chameleon-gnupg.spec   2024-01-06 19:00:00.000000000 -0500
@@ -9,7 +9,9 @@
 Release:        %autorelease
 Summary:        Sequoia's reimplementation of the GnuPG interface
 
-License:        GPL-3.0-or-later
+# * sequoia-chameleon-gnupg: GPL-3.0-or-later
+# * bundled source file from libgpg-error: LGPL-2.1-or-later
+License:        GPL-3.0-or-later AND LGPL-2.1-or-later
 URL:            https://crates.io/crates/sequoia-chameleon-gnupg
 Source:         %{crates_source}
 # Manually created patch for downstream crate metadata changes
@@ -17,6 +19,8 @@
 # * drop features for unavailable crypto backends
 # * build with OpenSSL crypto backend
 Patch:          sequoia-chameleon-gnupg-fix-metadata.diff
+# * backport upstream patch to port from "home-dir" to "shellexpand":
+#   https://gitlab.com/sequoia-pgp/sequoia-chameleon-gnupg/-/commit/03f23a7
 Patch:          0001-port-from-home-dir-to-shellexpand.patch
 
 BuildRequires:  cargo-rpm-macros >= 24
@@ -49,6 +53,9 @@
 License:        GPL-3.0-or-later AND Apache-2.0 AND BSD-3-Clause AND BSL-1.0 AND LGPL-2.0-or-later AND MIT AND MPL-2.0 AND Unicode-DFS-2016 AND (0BSD OR MIT OR Apache-2.0) AND (Apache-2.0 OR BSL-1.0) AND (Apache-2.0 OR MIT) AND (Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT) AND (BSD-2-Clause OR Apache-2.0 OR MIT) AND (MIT OR Apache-2.0 OR Zlib) AND (Unlicense OR MIT)
 # LICENSE.dependencies contains a full license breakdown
 
+# includes a copy of src/err-codes.h.in from libgpg-error (unknown version)
+Provides:       bundled(libgpg-error)
+
 %description -n %{crate} %{_description}
 
 %files       -n %{crate}


===== Notes (no change required for approval) =====

- The tests are disabled. Since this package is security-relevant, it would be
  especially nice to enable the tests at some point. You said:

    The interprocess crate appears to be used only for *some* integration
    tests, so with editdistancek and ntest available, I should be able to run
    most of the test suite.

  If it’s possible to enable some tests as soon as this is imported, please
  consider it.

- The LGPL-2.1-or-later license term and the virtual Provides for the file
  src/err-codes.h.in bundled from libgpg-error are now correctly handled.
  Thanks!

- The upstream status for 0001-port-from-home-dir-to-shellexpand.patch is now
  correctly indicated in the spec file.

- You’ve reported doing a best-effort manual audit of the source code that
  suggests that the SslConnector::builder() is never called, which suggests
  that the rpmlint message

    sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl /usr/bin/gpg-sq SSL_CTX_set_cipher_list

  may be not be significant to this package. I’m prepared to believe that the
  whole-program optimization (across crates) may not be be powerful enough to
  remove the call site in the openssl crate even if it’s unreachable in the
  binary. I believe all rpmlint can tell is that the SSL_CTX_set_cipher_list
  symbol is linked.

  This might still need fixing in the rust-openssl crate, though, for the sake
  of other programs outside the Sequoia project.

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

Generic:
[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", "GNU General Public License, Version
     3", "GNU General Public License v3.0 or later", "*No copyright* GNU
     General Public License v3.0 or later", "GNU Lesser General Public
     License v2.1 or later". 212 files have unknown license. Detailed
     output of licensecheck in /home/ben/Downloads/review/2255917-rust-
     sequoia-chameleon-gnupg/20240111/2255917-rust-sequoia-chameleon-
     gnupg/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.

     $ rpm -qL -p results/sequoia-chameleon-gnupg-0.4.0-1.fc40.x86_64.rpm 
     /usr/share/licenses/sequoia-chameleon-gnupg/LICENSE.dependencies
     /usr/share/licenses/sequoia-chameleon-gnupg/LICENSE.txt

[x]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[x]: %build honors applicable compiler flags or justifies otherwise.
[x]: Package contains no bundled libraries without FPC exception.

     Bundling from libgpg-error is documented in accordance with the
     relevant guidelines.

[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: 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.
[x]: Useful -debuginfo package or justification otherwise.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 21096 bytes in 2 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[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]: The License field must be a valid SPDX expression.
[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]: Packages must not store files under /srv, /opt or /usr/local

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

Generic:
[-]: 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in sequoia-
     chameleon-gnupg
[x]: Package functions as described.

     (tests pass)

[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.

     This worked in the initial review; I didn’t do another scratch build
     because I didn’t see any changes that I expected could break it.

[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[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).
[x]: Large data in /usr/share should live in a noarch subpackage if package
     is arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: sequoia-chameleon-gnupg-0.4.0-1.fc40.x86_64.rpm
          rust-sequoia-chameleon-gnupg-debugsource-0.4.0-1.fc40.x86_64.rpm
          rust-sequoia-chameleon-gnupg-0.4.0-1.fc40.src.rpm
=============================================== rpmlint session starts ===============================================
rpmlint: 2.4.0
configuration:
    /usr/lib/python3.12/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/tmpxdynw3yc')]
checks: 31, packages: 3

rust-sequoia-chameleon-gnupg.spec:57: W: unversioned-explicit-provides bundled(libgpg-error)
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpg-sq
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpgv-sq
sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl /usr/bin/gpg-sq SSL_CTX_set_cipher_list
================ 3 packages and 0 specfiles checked; 0 errors, 4 warnings, 0 badness; has taken 0.4 s ================




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/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: 32, packages: 2

sequoia-chameleon-gnupg.x86_64: W: unused-direct-shlib-dependency /usr/bin/gpg-sq /lib64/libsqlite3.so.0
sequoia-chameleon-gnupg.x86_64: W: unused-direct-shlib-dependency /usr/bin/gpgv-sq /lib64/libsqlite3.so.0
sequoia-chameleon-gnupg.x86_64: E: spelling-error ('reimplementation', 'Summary(en_US) reimplementation -> re implementation, re-implementation, implementation')
sequoia-chameleon-gnupg.x86_64: E: spelling-error ('reimplementation', '%description -l en_US reimplementation -> re implementation, re-implementation, implementation')
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpg-sq
sequoia-chameleon-gnupg.x86_64: W: no-manual-page-for-binary gpgv-sq
sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl /usr/bin/gpg-sq SSL_CTX_set_cipher_list
 2 packages and 0 specfiles checked; 2 errors, 5 warnings, 7 filtered, 2 badness; has taken 0.3 s 



Source checksums
----------------
https://crates.io/api/v1/crates/sequoia-chameleon-gnupg/0.4.0/download#/sequoia-chameleon-gnupg-0.4.0.crate :
  CHECKSUM(SHA256) this package     : a11b0fe2e73b22da4a77feef705c4f104b5cd1f7a61914e88c1ca3a5be460c1a
  CHECKSUM(SHA256) upstream package : a11b0fe2e73b22da4a77feef705c4f104b5cd1f7a61914e88c1ca3a5be460c1a


Requires
--------
sequoia-chameleon-gnupg (rpmlib, GLIBC filtered):
    ld-linux-x86-64.so.2()(64bit)
    libbz2.so.1()(64bit)
    libc.so.6()(64bit)
    libcrypto.so.3()(64bit)
    libcrypto.so.3(OPENSSL_3.0.0)(64bit)
    libgcc_s.so.1()(64bit)
    libgcc_s.so.1(GCC_3.0)(64bit)
    libgcc_s.so.1(GCC_3.3)(64bit)
    libgcc_s.so.1(GCC_4.2.0)(64bit)
    libm.so.6()(64bit)
    libsqlite3.so.0()(64bit)
    libssl.so.3()(64bit)
    libssl.so.3(OPENSSL_3.0.0)(64bit)
    rtld(GNU_HASH)

rust-sequoia-chameleon-gnupg-debugsource (rpmlib, GLIBC filtered):



Provides
--------
sequoia-chameleon-gnupg:
    bundled(libgpg-error)
    sequoia-chameleon-gnupg
    sequoia-chameleon-gnupg(x86-64)

rust-sequoia-chameleon-gnupg-debugsource:
    rust-sequoia-chameleon-gnupg-debugsource
    rust-sequoia-chameleon-gnupg-debugsource(x86-64)



Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24
Command line :/usr/bin/fedora-review -b 2255917
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api
Disabled plugins: SugarActivity, Haskell, fonts, Perl, PHP, R, C/C++, Java, Ocaml, Python
Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH
Comment 10 Ben Beasley 2024-01-13 13:40:28 UTC 
APPROVED
Comment 11 Fabio Valentini 2024-01-13 14:07:49 UTC 
(In reply to Ben Beasley from comment #9)

> ===== Notes (no change required for approval) =====
> 
> - The tests are disabled. Since this package is security-relevant, it would
> be
>   especially nice to enable the tests at some point. You said:
> 
>     The interprocess crate appears to be used only for *some* integration
>     tests, so with editdistancek and ntest available, I should be able to run
>     most of the test suite.
> 
>   If it’s possible to enable some tests as soon as this is imported, please
>   consider it.

I will try to enable running at least *some* tests ASAP.

> - You’ve reported doing a best-effort manual audit of the source code that
>   suggests that the SslConnector::builder() is never called, which suggests
>   that the rpmlint message
> 
>     sequoia-chameleon-gnupg.x86_64: W: crypto-policy-non-compliance-openssl
> /usr/bin/gpg-sq SSL_CTX_set_cipher_list
> 
>   may be not be significant to this package. I’m prepared to believe that the
>   whole-program optimization (across crates) may not be be powerful enough to
>   remove the call site in the openssl crate even if it’s unreachable in the
>   binary. I believe all rpmlint can tell is that the SSL_CTX_set_cipher_list
>   symbol is linked.
> 
>   This might still need fixing in the rust-openssl crate, though, for the
> sake
>   of other programs outside the Sequoia project.

Yes. Best I can tell, no code path from this package reaches SSL_CTX_set_cipher_list, so it might really be just that the symbol is linked.

I've just opened a tracking issue with the package for the openssl crate to track this for other packages. It might be a good idea to change the "default" initialization for the cipher list to "PROFILE=SYSTEM" instead of the list hard-coded in the openssl crate's code base.

https://bugzilla.redhat.com/show_bug.cgi?id=2258234

========================================

Thank you for the thorough review!
Comment 12 Fedora Admin user for bugzilla script actions 2024-01-13 14:08:28 UTC 
The Pagure repository was created at https://src.fedoraproject.org/rpms/rust-sequoia-chameleon-gnupg
Comment 13 Fabio Valentini 2024-01-13 14:51:36 UTC 
Imported and built for rawhide:
https://bodhi.fedoraproject.org/updates/FEDORA-2024-f9b86cb19a

Will figure out running tests and builds for stable branches later.