[bug#40203] [PATCH] gnu: Add ROPgadget.

[bug#40203] [PATCH] gnu: Add ROPgadget.

[Jakub Kądziołka]

* gnu/packages/engineering.scm (ropgadget): New variable.
---
 gnu/packages/engineering.scm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/gnu/packages/engineering.scm b/gnu/packages/engineering.scm
index 28a30a6831..bacfc2fbf6 100644
--- a/gnu/packages/engineering.scm
+++ b/gnu/packages/engineering.scm
@@ -1306,6 +1306,28 @@ bindings for Python, Java, OCaml and more.")
 (define-public python2-capstone
   (package-with-python2 python-capstone))
 
+(define-public ropgadget
+  (package
+    (name "ropgadget")
+    (version "6.2")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (pypi-uri "ROPGadget" version))
+       (sha256
+        (base32
+         "0idiicgpijar9l9kqmfdh865c2mkfgxg0q7lpz77jc09l6q0afjh"))))
+    (build-system python-build-system)
+    (propagated-inputs
+     `(("python-capstone" ,python-capstone)))
+    (home-page "http://shell-storm.org/project/ROPgadget/")
+    (synopsis
+     "Gadget finder and auto-roper")
+    (description
+     "This tool lets you search for gadgets in binaries to help with ROP
+chain construction.")
+    (license license:bsd-3)))
+
 (define-public radare2
   (package
     (name "radare2")
-- 
2.25.2

[bug#40203] [PATCH] gnu: Add ROPgadget.

[Jack Hill]

[-- Attachment #1: Type: text/plain, Size: 512 bytes --]

On Tue, 24 Mar 2020, Jakub Kądziołka wrote:

[snip]

> +    (description
> +     "This tool lets you search for gadgets in binaries to help with ROP
> +chain construction.")

Perhaps we should expand what ROP means here. I as able to figure it out 
with some searching, but it would probably help non-domain experts know 
what this package is for.

I believe such a change would be in line with what the Guix manual 
recommends: https://guix.gnu.org/manual/en/html_node/Synopses-and-Descriptions.html

Best,
Jack

[bug#40203] [PATCH] gnu: Add ROPgadget.

[Jakub Kądziołka]

[-- Attachment #1: Type: text/plain, Size: 1167 bytes --]

On Tue, Mar 24, 2020 at 11:18:05AM -0400, Jack Hill wrote:
> On Tue, 24 Mar 2020, Jakub Kądziołka wrote:
> 
> [snip]
> 
> > +    (description
> > +     "This tool lets you search for gadgets in binaries to help with ROP
> > +chain construction.")
> 
> Perhaps we should expand what ROP means here. I as able to figure it out
> with some searching, but it would probably help non-domain experts know what
> this package is for.

Thanks, I totally forgot about non-domain experts when writing that
description. What do you think about this revised version?

    (synopsis "Semiautomatic return oriented programming")
    (description
     "This tool lets you search for @acronym{ROP, Return Oriented Programming}
gadgets in binaries. Some facilities are included for automatically generating
chains of gadgets to execute system calls.")

Also, is the file in which I've put this package right? I choose that
place because that's where radare2 is, and it has a relatively
similar purpose. However, radare2 is a loose fit already, so ROPgadget
would be two steps removed from the original purpose of the file...

Regards,
Jakub Kądziołka

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[bug#40203] [PATCH] gnu: Add ROPgadget.

[Jack Hill]

[-- Attachment #1: Type: text/plain, Size: 1323 bytes --]

On Tue, 24 Mar 2020, Jakub Kądziołka wrote:

> On Tue, Mar 24, 2020 at 11:18:05AM -0400, Jack Hill wrote:
>> On Tue, 24 Mar 2020, Jakub Kądziołka wrote:
>>
>> [snip]
>>
>>> +    (description
>>> +     "This tool lets you search for gadgets in binaries to help with ROP
>>> +chain construction.")
>>
>> Perhaps we should expand what ROP means here. I as able to figure it out
>> with some searching, but it would probably help non-domain experts know what
>> this package is for.
>
> Thanks, I totally forgot about non-domain experts when writing that
> description. What do you think about this revised version?
>
>    (synopsis "Semiautomatic return oriented programming")
>    (description
>     "This tool lets you search for @acronym{ROP, Return Oriented Programming}
> gadgets in binaries. Some facilities are included for automatically generating
> chains of gadgets to execute system calls.")

That makes it clearer to me, thanks!

> Also, is the file in which I've put this package right? I choose that
> place because that's where radare2 is, and it has a relatively
> similar purpose. However, radare2 is a loose fit already, so ROPgadget
> would be two steps removed from the original purpose of the file...

Indeed. (Package) organization is difficult. I don't think I have any 
useful insights.

Best,
Jack

[bug#40203] [PATCH v2] gnu: Add ROPgadget.

[Jakub Kądziołka]

* gnu/packages/cybersecurity.scm: New file.
(ropgadget): New variable.
* gnu/local.mk (GNU_SYSTEM_MODULES): Register the file.
---
I have decided to move the package to a separate file. I don't recall
ever doing that before, so I'm sending the package for another,
hopefully quick, round of review.

 gnu/local.mk                   |  1 +
 gnu/packages/cybersecurity.scm | 46 ++++++++++++++++++++++++++++++++++
 2 files changed, 47 insertions(+)
 create mode 100644 gnu/packages/cybersecurity.scm

diff --git a/gnu/local.mk b/gnu/local.mk
index 07b159c4fe..0a406dffa0 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -138,6 +138,7 @@ GNU_SYSTEM_MODULES =				\
   %D%/packages/cups.scm				\
   %D%/packages/curl.scm				\
   %D%/packages/cvassistant.scm			\
+  %D%/packages/cybersecurity.scm		\
   %D%/packages/cyrus-sasl.scm			\
   %D%/packages/databases.scm			\
   %D%/packages/datamash.scm			\
diff --git a/gnu/packages/cybersecurity.scm b/gnu/packages/cybersecurity.scm
new file mode 100644
index 0000000000..aedac03b8a
--- /dev/null
+++ b/gnu/packages/cybersecurity.scm
@@ -0,0 +1,46 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (gnu packages cybersecurity)
+  #:use-module (guix download)
+  #:use-module (guix packages)
+  #:use-module ((guix licenses) #:prefix license:)
+  #:use-module (guix build-system python)
+  #:use-module (gnu packages engineering))
+
+(define-public ropgadget
+  (package
+    (name "ropgadget")
+    (version "6.2")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (pypi-uri "ROPGadget" version))
+       (sha256
+        (base32
+         "0idiicgpijar9l9kqmfdh865c2mkfgxg0q7lpz77jc09l6q0afjh"))))
+    (build-system python-build-system)
+    (propagated-inputs
+     `(("python-capstone" ,python-capstone)))
+    (home-page "http://shell-storm.org/project/ROPgadget/")
+    (synopsis "Semiautomatic return oriented programming")
+    (description
+     "This tool lets you search for @acronym{ROP, Return Oriented Programming}
+gadgets in binaries.  Some facilities are included for automatically generating
+chains of gadgets to execute system calls.")
+    (license license:bsd-3)))
-- 
2.25.2

bug#40203: Done: [PATCH v2] gnu: Add ROPgadget.

[Jakub Kądziołka]

[-- Attachment #1: Type: text/plain, Size: 92 bytes --]

Pushed as commit 60eee3e6de2a11b425496bbdf90bfe1f807c8f49 after a review
from ngz on IRC.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]