Bug 1759276 - Review Request: keylime - A TPM based remote boot attestation and run time integrity measurement solution.
Summary: Review Request: keylime - A TPM based remote boot attestation and run time in...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-10-07 18:11 UTC by Luke Hinds
Modified: 2019-12-13 16:55 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2019-12-13 16:55:09 UTC
Type: Bug
Embargoed:
eclipseo: fedora-review+


Attachments (Terms of Use)

Description Luke Hinds 2019-10-07 18:11:09 UTC
Spec URL: https://raw.githubusercontent.com/keylime/keylime-rpm/master/keylime.spec
SRPM URL: https://github.com/keylime/keylime-rpm/blob/master/SRPMS/keylime-5.2.0-1.src.rpm?raw=true

Description: Keylime is a TPM based remote boot attestation and run time integrity measurement solution.
Fedora Account System Username: lhinds

$ rpmlint keylime-5.2.0-1.src.rpm

1 packages and 0 specfiles checked; 0 errors, 0 warnings.

Comment 1 Robert-André Mauchin 🐧 2019-10-07 20:20:04 UTC
 - Not used in Fedora:

Group: Development/Libraries
Vendor: Keylime Developers

AutoReq: no

 - Not right and not needed:
 
%defattr(755,root,root)

 -  This is useless:

%define name keylime
%define version 5.2.0
%define release 1

 Use the normal RPM fields, don't redefine them, also don't forget the %{?dist} tag in Release:

Name:    keylime
Version: 5.2.0
Release: 1%{?dist}

 - Don't reinclude all the *.py:

%{python3_sitelib}/%{srcname}/ca_util.py
%{python3_sitelib}/%{srcname}/cloud_agent.py
%{python3_sitelib}/%{srcname}/cloud_verifier_common.py
%{python3_sitelib}/%{srcname}/cloud_verifier_tornado.py
%{python3_sitelib}/%{srcname}/ima_emulator_adapter.py
%{python3_sitelib}/%{srcname}/provider_platform_init.py
%{python3_sitelib}/%{srcname}/provider_registrar.py
%{python3_sitelib}/%{srcname}/provider_vtpm_add.py
%{python3_sitelib}/%{srcname}/registrar.py
%{python3_sitelib}/%{srcname}/tenant.py
%{python3_sitelib}/%{srcname}/tenant_webapp.py
%{python3_sitelib}/%{srcname}/user_data_encrypt.py

  You already included them by stating: %{python3_sitelib}/%{srcname}

 - Don't include this twice as well:

%{_sysconfdir}/%{srcname}.conf
%config(noreplace) %{_sysconfdir}/%{srcname}.conf

→ Only this is necessary:

%config(noreplace) %{_sysconfdir}/%{srcname}.conf

 - Use a better name for your archive:

Source0:        https://github.com/keylime/keylime/archive/%{version}/%{name}-%{version}.tar.gz

- This does not respect the FHS:

%{_prefix}/%{srcname}/static/*

See https://docs.fedoraproject.org/en-US/packaging-guidelines/#_exceptions_2

This should probably go to %{_datadir}/%{srcname} (/usr/share/keylime) Ask upstream to fix their install process.

 - Not needed as %?python_enable_dependency_generator is enabled by default. Add this macro manually for EPEL.

Requires: python3-pyyaml
Requires: python3-m2crypto
Requires: python3-cryptography
Requires: python3-tornado
Requires: python3-simplejson
Requires: python3-requests
Requires: python3-zmq

See https://fedoraproject.org/wiki/Changes/EnablingPythonGenerators

 - You need to include the SystemD scriptlets: see https://docs.fedoraproject.org/en-US/packaging-guidelines/Scriptlets/#Systemd

BuildRequires: systemd-rpm-macros

[…]

%post
%systemd_post %{srcname}_agent.service
%systemd_post %{srcname}_verifier.service
%systemd_post %{srcname}_registrar.service

%preun
%systemd_preun %{srcname}_agent.service
%systemd_preun %{srcname}_verifier.service
%systemd_preun %{srcname}_registrar.service

%postun
%systemd_postun_with_restart %{srcname}_agent.service
%systemd_postun_with_restart %{srcname}_verifier.service
%systemd_postun_with_restart %{srcname}_registrar.service

Comment 2 Robert-André Mauchin 🐧 2019-10-07 20:40:22 UTC
Can't be installed:

DEBUG util.py:593:  Error: 
DEBUG util.py:593:   Problem: conflicting requests
DEBUG util.py:593:    - nothing provides python3.8dist(tornado) < 6 needed by keylime-5.2.0-1.fc32.noarch

python-tornado is 6.0.2 in F31/32.

Comment 3 Robert-André Mauchin 🐧 2019-10-07 20:46:20 UTC
 - Remove shebang *in %prep*:


keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/ca_util.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/cloud_agent.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/cloud_verifier_common.py 644 /usr/bin/python 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/cloud_verifier_tornado.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/ima_emulator_adapter.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/provider_platform_init.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/provider_registrar.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/provider_vtpm_add.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/registrar.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/tenant.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/tenant_webapp.py 644 /usr/bin/python3 
keylime.noarch: E: non-executable-script /usr/lib/python3.8/site-packages/keylime/user_data_encrypt.py 644 /usr/bin/python3 

See https://fedoraproject.org/wiki/Packaging_tricks#Remove_shebang_from_Python_libraries

Comment 4 Robert-André Mauchin 🐧 2019-10-07 20:48:55 UTC
 - Include MIT in the License files annd add a comment explaining the license breakdown (i.e. for icons) and add keylime/static/icons/ICON-LICENSE to %license in %files.

Comment 5 Luke Hinds 2019-10-07 21:01:49 UTC
Regarding #c3 - those are not libraries, they are CLI `entry_points` and need to be execution able and have a shebang.

I will look into #c1 tomorrow (thanks for outline everything), in regards to #c2 I guess that must be coming from setup.py which I am surprised is being sourced, as we use the `python3-tornado` package in Depends. I will move it up to 6.0.2 upstream.

Comment 6 Robert-André Mauchin 🐧 2019-10-07 21:28:32 UTC
(In reply to Luke Hinds from comment #5)
> Regarding #c3 - those are not libraries, they are CLI `entry_points` and
> need to be execution able and have a shebang.
> 
Should not be necessary.


> I will look into #c1 tomorrow (thanks for outline everything), in regards to
> #c2 I guess that must be coming from setup.py which I am surprised is being
> sourced, as we use the `python3-tornado` package in Depends. I will move it
> up to 6.0.2 upstream.

As said previously, we are now using an automatic dependency generator which reads setup.py


Proposed patch for static files:

diff -up keylime-5.2.0/setup.py.orig keylime-5.2.0/setup.py
--- keylime-5.2.0/setup.py.orig	2019-10-07 18:27:32.000000000 +0200
+++ keylime-5.2.0/setup.py	2019-10-07 23:22:20.893659697 +0200
@@ -49,8 +49,7 @@ if '--with-clime' in sys.argv:
     sys.argv.remove('--with-clime')
 
 # enumerate all of the data files we need to package up
-data_files = [(d, [path.join(d,f) for f in files]) for d,_,files in walk("keylime/static")]
-data_files.append(('package_default', ['keylime.conf']))
+data_files = [('/etc', ['keylime.conf'])]
 
 setup(
     name='keylime',
@@ -104,6 +103,7 @@ setup(
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     packages=['keylime'],
+    package_data={'keylime': ['static/*/*', 'static/*/*/*']},
 
     # List run-time dependencies here.  These will be installed by pip when
     # your project is installed. For an analysis of "install_requires" vs pip's



I haven't tested it to see if static files aro found by the script.

Comment 7 Luke Hinds 2019-10-08 21:08:23 UTC
static files and tornado version clause of < 6 removed.

https://github.com/keylime/keylime/pull/185

Will start to proceed and address other items and then post when ready for next review cycle.

Comment 8 Luke Hinds 2019-12-12 13:05:18 UTC
We have completed fully porting to Tornado 6 & > , so we can start packaging review again.

Spec URL: https://raw.githubusercontent.com/keylime/keylime-rpm/master/keylime.spec
SRPM URL: https://github.com/keylime/keylime-rpm/blob/master/SRPMS/keylime-5.4.1-1.src.rpm

Comment 9 Robert-André Mauchin 🐧 2019-12-12 14:49:47 UTC
warning: bogus date in %changelog: Mon Dec 12 2019 Luke Hinds <lhinds> 5.4.1-1

 - The 12 is a Thursday

 - License is BSD not MIT: https://github.com/keylime/keylime/blob/master/LICENSE

License: BSD

 - Use a better name for your archive:

Source0:        https://github.com/keylime/keylime/archive/%{version}/%{name}-%{version}.tar.gz

 - Use install -p to keep timestamps. Also you seem to have made an error in the last service: the wrong file is copied to %{srcname}_registrar.service

install -pm 644 %{srcname}.conf \
    %{buildroot}%{_sysconfdir}/%{srcname}.conf

install -pm 644 ./services/%{srcname}_agent.service \
    %{buildroot}%{_unitdir}/%{srcname}_agent.service

install -pm 644 ./services/%{srcname}_verifier.service \
    %{buildroot}%{_unitdir}/%{srcname}_verifier.service

install -pm 644 ./services/%{srcname}_registrar.service \
    %{buildroot}%{_unitdir}/%{srcname}_registrar.service

 - You need to run the SystemD scriplets for your service files, see https://docs.fedoraproject.org/en-US/packaging-guidelines/Scriptlets/#_systemd

BuildRequires: systemd-rpm-macros

[…]

%post
%systemd_post %{srcname}_agent.service
%systemd_post %{srcname}_verifier.service
%systemd_post %{srcname}_registrar.service

%preun
%systemd_preun %{srcname}_agent.service
%systemd_preun %{srcname}_verifier.service
%systemd_preun %{srcname}_registrar.service

%postun
%systemd_postun_with_restart %{srcname}_agent.service
%systemd_postun_with_restart %{srcname}_verifier.service
%systemd_postun_with_restart %{srcname}_registrar.service

 - Add keylime/static/icons/ICON-LICENSE to the %license and add MIT to the License field with a comment explaining the license breakdown:

# Main program: BSD
# Icons: MIT
License: BSD and MIT

[…]

%files
%license LICENSE keylime/static/icons/ICON-LICENSE

 - Not needed:

%defattr(755,root,root)

These files do not need to be executable for the program to run correctly.

This is not needed either: you already included the files by previously stating %{python3_sitelib}/%{srcname}/, this adds duplicates:

%{python3_sitelib}/%{srcname}/ca_util.py
%{python3_sitelib}/%{srcname}/cloud_agent.py
%{python3_sitelib}/%{srcname}/cloud_verifier_common.py
%{python3_sitelib}/%{srcname}/cloud_verifier_tornado.py
%{python3_sitelib}/%{srcname}/ima_emulator_adapter.py
%{python3_sitelib}/%{srcname}/provider_platform_init.py
%{python3_sitelib}/%{srcname}/provider_registrar.py
%{python3_sitelib}/%{srcname}/provider_vtpm_add.py
%{python3_sitelib}/%{srcname}/registrar.py
%{python3_sitelib}/%{srcname}/tenant.py
%{python3_sitelib}/%{srcname}/tenant_webapp.py
%{python3_sitelib}/%{srcname}/user_data_encrypt.py




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

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


Issues:
=======
- Package does not contain duplicates in %files.
  Note: warning: File listed twice: /usr/lib/python3.8/site-
  packages/keylime/ca_util.py
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/#_duplicate_files
- 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.
  Note: License file ICON-LICENSE is not marked as %license
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/LicensingGuidelines/#_license_text
- systemd_post is invoked in %post, systemd_preun in %preun, and
  systemd_postun in %postun for Systemd service files.
  Note: Systemd service file(s) in keylime
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/Scriptlets/#_scriptlets


===== 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", "BSD 2-clause "Simplified" License",
     "Expat License". 187 files have unknown license. Detailed output of
     licensecheck in /home/bob/packaging/review/keylime/review-
     keylime/licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[!]: Each %files section contains %defattr if rpm < 4.4
     Note: %defattr present but not needed
[-]: 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.
[x]: Package contains systemd file(s) if in need.
[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 30720 bytes in 1 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]: Package requires other packages for directories it uses.
[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]: %config files are marked noreplace or the reason is justified.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Permissions on files are set properly.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: No %config files under /usr.
[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

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== 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).
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[-]: %check is present and all tests pass.
[!]: 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]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: keylime-5.4.1-1.fc32.noarch.rpm
          keylime-5.4.1-1.fc32.src.rpm
keylime.noarch: W: no-manual-page-for-binary keylime_agent
keylime.noarch: W: no-manual-page-for-binary keylime_ca
keylime.noarch: W: no-manual-page-for-binary keylime_ima_emulator
keylime.noarch: W: no-manual-page-for-binary keylime_provider_platform_init
keylime.noarch: W: no-manual-page-for-binary keylime_provider_registrar
keylime.noarch: W: no-manual-page-for-binary keylime_provider_vtpm_add
keylime.noarch: W: no-manual-page-for-binary keylime_registrar
keylime.noarch: W: no-manual-page-for-binary keylime_tenant
keylime.noarch: W: no-manual-page-for-binary keylime_userdata_encrypt
keylime.noarch: W: no-manual-page-for-binary keylime_verifier
keylime.noarch: W: no-manual-page-for-binary keylime_webapp
keylime.src: E: specfile-error warning: bogus date in %changelog: Mon Dec 12 2019 Luke Hinds <lhinds> 5.4.1-1
2 packages and 0 specfiles checked; 1 errors, 11 warnings.

Comment 10 Luke Hinds 2019-12-12 15:44:29 UTC
What constitutes a "better name"? It's current the software name and release version, what would make it better? Give an example if you can,

Comment 12 Robert-André Mauchin 🐧 2019-12-12 17:47:35 UTC
(In reply to Luke Hinds from comment #10)
> What constitutes a "better name"? It's current the software name and release
> version, what would make it better? Give an example if you can,

Current name of your archive contains only the version.tar.gz. Change I am proposing would be name-version.tar.gz

Comment 13 Robert-André Mauchin 🐧 2019-12-12 17:49:36 UTC
i.e. from

Source0:        https://github.com/keylime/keylime/archive/%{version}.tar.gz

to

Source0:        https://github.com/keylime/keylime/archive/%{version}/%{name}-%{version}.tar.gz


Package is approved. Please fix the aforementioned issue before import.

Comment 14 Luke Hinds 2019-12-12 18:51:23 UTC
Thanks for all your support Robert.

Regarding the package name, this is a little tricky as that is how github generates releases, when tag a release (using semtec... github generates the tarball / zip accordingly using the same tag naming.

https://github.com/keylime/keylime/releases

Its the same for other GH hosted projects, for example:

https://github.com/kubernetes/kubernetes/releases
https://github.com/apache/spark/releases
https://github.com/torvalds/linux/releases

Comment 15 Gwyn Ciesla 2019-12-13 15:07:14 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/keylime

Comment 16 Robert-André Mauchin 🐧 2019-12-13 15:10:40 UTC
Github accepts Source URL like I posted to allow rename of the archive.

Comment 17 Luke Hinds 2019-12-13 16:55:09 UTC
understood, we have another release being built soon, will update the spec to the Source URL


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