;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2020 Jakub Kądziołka <kuba@kadziolka.net>
;;; Copyright © 2020, 2021 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2021 c4droid <c4droid@foxmail.com>
;;; Copyright © 2021 Raghav Gururajan <rg@raghavgururajan.name>
;;;
;;; 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 git-download)
  #:use-module (guix packages)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix build-system cmake)
  #:use-module (guix build-system python)
  #:use-module (gnu packages cpp)
  #:use-module (gnu packages engineering)
  #:use-module (gnu packages pkg-config)
  #:use-module (gnu packages python)
  #:use-module (gnu packages python-xyz)
  #:use-module (gnu packages python-crypto)
  #:use-module (gnu packages python-web)
  #:use-module (gnu packages time)
  #:use-module (gnu packages bioinformatics)      ;python-intervaltree
  #:use-module (gnu packages emulators))

(define-public blacksmith
  (let ((commit "c8e65b709a83665f9528efdedcf064abdb04859f")
        (revision "0"))
    (package
      (name "blacksmith")
      (version
       (git-version "0.0.1" revision commit))
      (source
       (origin
         (method git-fetch)
         (uri
          (git-reference
           (url "https://github.com/comsec-group/blacksmith")
           (commit commit)))
         (file-name (git-file-name name version))
         (sha256
          (base32 "0kyp71wndf527dgza5iks5m5vj543mvxp5w7cjd8x0pilmd1xrls"))
         (modules '((guix build utils)))
         (snippet
          `(begin
             (delete-file-recursively "external")
             (substitute* "CMakeLists.txt"
               (("add_subdirectory\\(external\\)") "")
               (("[ \t]*FetchContent_MakeAvailable\\(asmjit\\)")
                (string-append "find_package(asmjit)\n"
                               "find_package(nlohmann_json)")))
             #t))))
      (build-system cmake-build-system)
      (arguments
       `(#:tests? #f                    ;no test-suite
         #:imported-modules
         ((guix build copy-build-system)
          ,@%cmake-build-system-modules)
         #:modules
         (((guix build copy-build-system)
           #:prefix copy:)
          (guix build cmake-build-system)
          (guix build utils))
         #:phases
         (modify-phases %standard-phases
           (add-after 'unpack 'fix-build
             (lambda _
               (substitute* "CMakeLists.txt"
                 ;; Use default C++ standard instead.
                 (("cxx_std_17") "")
                 ;; This project tries to link argagg library,
                 ;; which doesn't exist, as argagg project
                 ;; is a single header file.
                 (("argagg") ""))))
           (replace 'install
             (lambda args
               (apply (assoc-ref copy:%standard-phases 'install)
                      #:install-plan
                      '(("." "bin"
                         #:include ("blacksmith"))
                        ("." "lib"
                         #:include-regexp ("\\.a$")))
                      args))))))
      (native-inputs
       `(("pkg-config" ,pkg-config)))
      (inputs
       `(("argagg" ,argagg)
         ("asmjit" ,asmjit)
         ("json" ,json)))
      (home-page "https://comsec.ethz.ch/research/dram/blacksmith")
      (synopsis "Rowhammer fuzzer with non-uniform and frequency-based patterns")
      (description "Blacksmith is an implementation of Rowhammer fuzzer that
crafts novel non-uniform Rowhammer access patterns based on the concepts of
frequency, phase, and amplitude.  It is able to bypass recent
@acronym{TRR, Target Row Refresh}in-DRAM mitigations effectively and as such can
could trigger bit flips.")
      (license license:expat))))

(define-public ropgadget
  (package
    (name "ropgadget")
    (version "6.6")
    (source
     (origin
       (method url-fetch)
       (uri (pypi-uri "ROPGadget" version))
       (sha256
        (base32 "08ms7x4af07970ij9899l75sghnxsa7xyx73gkn6gv0l05p1hqfw"))))
    (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)))

(define-public pwntools
  (package
    (name "pwntools")
    (version "4.4.0")
    (source
     (origin
       (method url-fetch)
       (uri (pypi-uri "pwntools" version))
       (sha256
        (base32
         "1qw7j0wwm1878aia08gyw5xljjr26qsbp45w65n4qff672sha5n5"))))
    (build-system python-build-system)
    (arguments
     '(#:tests? #f))                 ;XXX: needs a specific version of unicorn
    (propagated-inputs
     `(("capstone" ,capstone)
       ("python-dateutil" ,python-dateutil)
       ("python-intervaltree" ,python-intervaltree)
       ("python-mako" ,python-mako)
       ("python-packaging" ,python-packaging)
       ("python-paramiko" ,python-paramiko)
       ("python-psutil" ,python-psutil)
       ("python-pyelftools" ,python-pyelftools)
       ("python-pygments" ,python-pygments)
       ("python-pyserial" ,python-pyserial)
       ("python-pysocks" ,python-pysocks)
       ("python-requests" ,python-requests)
       ("ropgadget" ,ropgadget)
       ("python-six" ,python-six)
       ("python-sortedcontainers"
        ,python-sortedcontainers)
       ("unicorn" ,unicorn)))
    (home-page "https://github.com/Gallopsled/pwntools")
    (synopsis
     "Capture-the-flag (CTF) framework and exploit development library")
    (description
     "Pwntools is a capture-the-flag (CTF) framework and exploit development library.
Written in Python, it is designed for rapid prototyping and development, and
intended to make exploit writing as simple as possible.")
    (license license:expat)))