Bug 1594430 - Review Request: python-ROPGadget - A tool to find ROP gadgets in program files
Summary: Review Request: python-ROPGadget - A tool to find ROP gadgets in program files
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: 1597417
TreeView+ depends on / blocked
 
Reported: 2018-06-22 23:05 UTC by W. Michael Petullo
Modified: 2018-07-12 14:18 UTC (History)
4 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2018-07-03 15:18:35 UTC
Type: ---
Embargoed:
eclipseo: fedora-review+


Attachments (Terms of Use)

Description W. Michael Petullo 2018-06-22 23:05:28 UTC
Spec URL: https://www.flyn.org/SRPMS/python-ROPGadget.spec
SRPM URL: https://www.flyn.org/SRPMS/python-ROPGadget-5.4-1.fc28.src.rpm
Description:
ROPGadget lets you search your gadgets on your binaries to facilitate
your ROP exploitation. ROPgadget supports ELF, PE and Mach-O format on
x86, x64, ARM, ARM64, PowerPC, SPARC and MIPS architectures.

Fedora Account System Username: mikep

Comment 1 Marcel Plch 2018-06-25 14:16:15 UTC
Note that I am not a packager yet and this is an informal review.
-----------------------------------------------------------------

LGTM, just a few small things:

1) Get rid of the top-directory asterisks in %files. (overall the more specific you are in %files, the better)
2) Notify upstream to include license file. (GLPv2 is very intersting license, though)
3) Python3 bindings for capstone are called capstone-python3
4) Fix the rpmlint warnings.

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

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


Issues:
=======
- Package installs properly.
  Note: Installation errors (see attachment)
  See: https://fedoraproject.org/wiki/Packaging:Guidelines


===== 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.
[-]: 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]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "*No copyright* GPL (v3 or later)", "Unknown or generated". 8
     files have unknown license. Detailed output of licensecheck in
     /home/mplch/reviews/1594430-python-ROPGadget/licensecheck.txt
[-]: License file installed when any subpackage combination is installed.
[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.
[-]: Development files must be in a -devel package
[-]: 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.
[?]: 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]: Package is not known to require an ExcludeArch tag.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[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 must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: All build dependencies are listed in BuildRequires, except for any
     that are listed in the exceptions section of Packaging Guidelines.
[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 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

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]: 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python2-ROPGadget , python3-ROPGadget
[x]: Package functions as described.
[x]: Latest version is packaged.
[-]: Package does not include license text files separate from upstream.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[-]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %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:
[!]: Rpmlint is run on all installed packages.
     Note: Mock build failed
     See: http://fedoraproject.org/wiki/Packaging/Guidelines#rpmlint
[x]: Spec file according to URL is the same as in SRPM.


Installation errors
-------------------
INFO: mock.py version 1.4.10 starting (python version = 3.6.5)...
Start: init plugins
INFO: selinux disabled
Finish: init plugins
Start: run
Start: chroot init
INFO: calling preinit hooks
INFO: enabled root cache
INFO: enabled dnf cache
Start: cleaning dnf metadata
Finish: cleaning dnf metadata
INFO: enabled HW Info plugin
Mock Version: 1.4.10
INFO: Mock Version: 1.4.10
Finish: chroot init
INFO: installing package(s): /home/mplch/reviews/1594430-python-ROPGadget/results/python3-ROPGadget-5.4-1.fc29.noarch.rpm /home/mplch/reviews/1594430-python-ROPGadget/results/python2-ROPGadget-5.4-1.fc29.noarch.rpm
ERROR: Command failed: 
 # /usr/bin/dnf --installroot /var/lib/mock/fedora-rawhide-x86_64/root/ --releasever 28 --disableplugin=local --setopt=deltarpm=False install /home/mplch/reviews/1594430-python-ROPGadget/results/python3-ROPGadget-5.4-1.fc29.noarch.rpm /home/mplch/reviews/1594430-python-ROPGadget/results/python2-ROPGadget-5.4-1.fc29.noarch.rpm



Rpmlint
-------
Checking: python2-ROPGadget-5.4-1.fc29.noarch.rpm
          python3-ROPGadget-5.4-1.fc29.noarch.rpm
          python-ROPGadget-5.4-1.fc29.src.rpm
python2-ROPGadget.noarch: W: no-documentation
python2-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/__init__.py /usr/bin/env python2
python2-ROPGadget.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/__init__.py 644 /usr/bin/env python2
python2-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx64.py /usr/bin/env python2
python2-ROPGadget.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx64.py 644 /usr/bin/env python2
python2-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx86.py /usr/bin/env python2
python2-ROPGadget.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx86.py 644 /usr/bin/env python2
python2-ROPGadget.noarch: W: no-manual-page-for-binary ROPgadget
python3-ROPGadget.noarch: W: no-documentation
python3-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/__init__.py /usr/bin/env python2
python3-ROPGadget.noarch: E: non-executable-script /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/__init__.py 644 /usr/bin/env python2
python3-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx64.py /usr/bin/env python2
python3-ROPGadget.noarch: E: non-executable-script /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx64.py 644 /usr/bin/env python2
python3-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx86.py /usr/bin/env python2
python3-ROPGadget.noarch: E: non-executable-script /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx86.py 644 /usr/bin/env python2
python3-ROPGadget.noarch: W: no-manual-page-for-binary ROPgadget
3 packages and 0 specfiles checked; 12 errors, 4 warnings.

Comment 2 Robert-André Mauchin 🐧 2018-06-25 20:35:36 UTC
 - Grab the license directly fron the Github repo and install it: https://raw.githubusercontent.com/JonathanSalwan/ROPgadget/282d8516f21c85b17cab95165620bb4009cc68a0/COPYING

(Please note the license change for the next release).

 - Tests fail because you're missing python-capstone as a BR:

+ /usr/bin/python2 setup.py test
running test
Searching for capstone
Reading https://pypi.org/simple/capstone/

BuildRequires:  %{py2_dist capstone}
BuildRequires:  %{py3_dist capstone}

 - Install fails like Marcel Plch mentionned because python3-capstone is packaged as capstone-python3: a good opportunity to use the standardized names macros:

Requires:  %{py2_dist capstone}

   and

Requires:  %{py3_dist capstone}

 - There's no test provided so no need to run %check

 - %{_bindir}/* should only be installed with the latest binaries you installed with py_install, so in the python3 subpackage. If you want to install both Python 2 and Python 3 binaries, copy them with a suffix:

%install
%py2_install
mv %{buildroot}%{_bindir}/%{srcname} %{buildroot}%{_bindir}/%{srcname}-%{python2_version}
ln -s %{_bindir}/%{srcname}-%{python2_version} %{buildroot}%{_bindir}/%{srcname}-2
%py3_install
mv %{buildroot}%{_bindir}/%{srcname} %{buildroot}%{_bindir}/%{srcname}-%{python3_version}
ln -s %{_bindir}/%{srcname}-%{python3_version} %{buildroot}%{_bindir}/%{srcname}-3
ln -s %{_bindir}/%{srcname}-%{python3_version} %{buildroot}%{_bindir}/%{srcname}

  Then in %files:

%files -n python2-%{srcname}
%{_bindir}/%{srcname}-%{python2_version}
%{_bindir}/%{srcname}-2

%files -n python3-%{srcname}
%{_bindir}/%{srcname}-%{python3_version}
%{_bindir}/%{srcname}-3
%{_bindir}/%{srcname}

 - As Marcel Plch said, be more specific in %files:

%files -n python2-%{srcname}
%{python2_sitelib}/ropgadget
%{python2_sitelib}/%{srcname}-%{version}-py?.?.egg-info

%files -n python3-%{srcname}
%{python3_sitelib}/ropgadget
%{python3_sitelib}/%{srcname}-%{version}-py?.?.egg-info
%{_bindir}/*

 - Remove the shebangs in %prep from:

ropchain/arch/__init__.py
ropchain/arch/ropmakerx64.py
ropchain/arch/ropmakerx86.py

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






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

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



===== 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]: 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]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "*No copyright* GPL (v3 or later)", "Unknown or generated". 8
     files have unknown license. Detailed output of licensecheck in
     /home/bob/packaging/review/python-ROPGadget/review-python-
     ROPGadget/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[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.
[-]: 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]: Package is not known to require an ExcludeArch tag.
[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 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 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

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]: 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).
[-]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python2-ROPGadget , python3-ROPGadget
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: 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.
[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]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python2-ROPGadget-5.4-1.fc29.noarch.rpm
          python3-ROPGadget-5.4-1.fc29.noarch.rpm
          python-ROPGadget-5.4-1.fc29.src.rpm
python2-ROPGadget.noarch: W: no-documentation
python2-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/__init__.py /usr/bin/env python2
python2-ROPGadget.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/__init__.py 644 /usr/bin/env python2
python2-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx64.py /usr/bin/env python2
python2-ROPGadget.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx64.py 644 /usr/bin/env python2
python2-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx86.py /usr/bin/env python2
python2-ROPGadget.noarch: E: non-executable-script /usr/lib/python2.7/site-packages/ropgadget/ropchain/arch/ropmakerx86.py 644 /usr/bin/env python2
python2-ROPGadget.noarch: W: no-manual-page-for-binary ROPgadget
python3-ROPGadget.noarch: W: no-documentation
python3-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/__init__.py /usr/bin/env python2
python3-ROPGadget.noarch: E: non-executable-script /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/__init__.py 644 /usr/bin/env python2
python3-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx64.py /usr/bin/env python2
python3-ROPGadget.noarch: E: non-executable-script /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx64.py 644 /usr/bin/env python2
python3-ROPGadget.noarch: E: wrong-script-interpreter /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx86.py /usr/bin/env python2
python3-ROPGadget.noarch: E: non-executable-script /usr/lib/python3.6/site-packages/ropgadget/ropchain/arch/ropmakerx86.py 644 /usr/bin/env python2
python3-ROPGadget.noarch: W: no-manual-page-for-binary ROPgadget
3 packages and 0 specfiles checked; 12 errors, 4 warnings.

Comment 3 Miro Hrončok 2018-06-25 20:50:32 UTC
(In reply to Robert-André Mauchin from comment #2)
>  - %{_bindir}/* should only be installed with the latest binaries you
> installed with py_install, so in the python3 subpackage. If you want to
> install both Python 2 and Python 3 binaries, copy them with a suffix:
> 
> %install
> %py2_install
> mv %{buildroot}%{_bindir}/%{srcname}
> %{buildroot}%{_bindir}/%{srcname}-%{python2_version}
> ln -s %{_bindir}/%{srcname}-%{python2_version}
> %{buildroot}%{_bindir}/%{srcname}-2
> %py3_install
> mv %{buildroot}%{_bindir}/%{srcname}
> %{buildroot}%{_bindir}/%{srcname}-%{python3_version}
> ln -s %{_bindir}/%{srcname}-%{python3_version}
> %{buildroot}%{_bindir}/%{srcname}-3
> ln -s %{_bindir}/%{srcname}-%{python3_version}
> %{buildroot}%{_bindir}/%{srcname}
> 
>   Then in %files:
> 
> %files -n python2-%{srcname}
> %{_bindir}/%{srcname}-%{python2_version}
> %{_bindir}/%{srcname}-2
> 
> %files -n python3-%{srcname}
> %{_bindir}/%{srcname}-%{python3_version}
> %{_bindir}/%{srcname}-3
> %{_bindir}/%{srcname}


Please don't. Juts put them to the python3 package. Unless you provide a good reason why ROPGadget should behave differently under python3 and python2.

Pro tip: is the python2 package even needed?

Comment 4 W. Michael Petullo 2018-06-28 02:24:55 UTC
Spec URL: https://www.flyn.org/SRPMS/python-ROPGadget.spec
SRPM URL: https://www.flyn.org/SRPMS/python-ROPGadget-5.4-1.fc28.src.rpm
Description:
ROPGadget lets you search your gadgets on your binaries to facilitate
your ROP exploitation. ROPgadget supports ELF, PE and Mach-O format on
x86, x64, ARM, ARM64, PowerPC, SPARC and MIPS architectures.

Fedora Account System Username: mikep

I think my changes address comments #1, #2, and #3.

Rpmlint still notes the lack of a manpage, but the distribution does not include one.

Comment 5 Robert-André Mauchin 🐧 2018-07-03 13:50:01 UTC
Seems good, package approved.

Comment 6 Gwyn Ciesla 2018-07-03 15:04:53 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-ROPGadget

Comment 7 Fedora Update System 2018-07-03 15:16:34 UTC
python-ROPGadget-5.4-1.fc28 has been submitted as an update to Fedora 28. https://bodhi.fedoraproject.org/updates/FEDORA-2018-82d60cb6db

Comment 8 W. Michael Petullo 2018-07-03 15:17:51 UTC
Thank you!

Comment 9 Fedora Update System 2018-07-04 18:20:46 UTC
python-ROPGadget-5.4-1.fc28 has been pushed to the Fedora 28 testing repository. If problems still persist, please make note of it in this bug report.
See https://fedoraproject.org/wiki/QA:Updates_Testing for
instructions on how to install test updates.
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2018-82d60cb6db

Comment 10 Fedora Update System 2018-07-12 14:18:48 UTC
python-ROPGadget-5.4-1.fc28 has been pushed to the Fedora 28 stable repository. If problems still persist, 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.