snapcraft.yaml

###############################################################################
#        _       _             _   _            _____  _
#       | |     | |           | | | |          |  __ \(_)
#       | | ___ | |__  _ __   | |_| |__   ___  | |__) |_ _ __  _ __   ___ _ __
#   _   | |/ _ \| '_ \| '_ \  | __| '_ \ / _ \ |  _  /| | '_ \| '_ \ / _ \ '__|
#  | |__| | (_) | | | | | | | | |_| | | |  __/ | | \ \| | |_) | |_) |  __/ |
#   \____/ \___/|_| |_|_| |_|  \__|_| |_|\___| |_|  \_\_| .__/| .__/ \___|_|
#                                                       | |   | |
#                                                       |_|   |_|
#
# Copyright (c) 2019-2024 Claudio André <dev at claudioandre.slmail.me>
#
# This program comes with ABSOLUTELY NO WARRANTY; express or implied.
#
# This program 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, as expressed in version 2, seen at
# http://www.gnu.org/licenses/gpl-2.0.html
###############################################################################
# Recipe to create the snap package
# More info at https://github.com/openwall/john-packages
---
name: john-the-ripper
version: 1.9J1+2404

base: core24
confinement: strict
grade: stable #TODO: [stable or devel] edit before release (BLEEDING_RELEASE)

assumes: [snapd2.41]
adopt-info: john-the-ripper

license: GPL-2.0
title: John the Ripper CE Auditing Tool
summary: Password security auditing and recovery tool
description: |
  [Openwall's](https://openwall.com/) John the Ripper (JtR) is a fast password cracker,
  currently available for many flavors of Unix and for Windows. Its primary
  purpose is to detect weak Unix passwords. Besides several crypt(3) password hash
  types most commonly found on various Unix systems, supported out of the box are
  Windows LM hashes, various macOS password hashes, as well as many
  non-hashes such as SSH private keys, encrypted filesystems such as macOS .dmg files
  and "sparse bundles", encrypted archives such as ZIP, RAR, and 7z,
  encrypted document files such as PDF and Microsoft Office's, plus lots of
  other hashes and ciphers.

icon: com.openwall.John.png

apps:
  john-the-ripper:
    command: bin/john
    plugs: [home, removable-media]
  opencl:
    command: bin/john
    plugs: [home, removable-media]
  dmg2john:
    command: bin/dmg2john
    plugs: [home, removable-media]
  hccap2john:
    command: bin/hccap2john
    plugs: [home, removable-media]
  racf2john:
    command: bin/racf2john
    plugs: [home, removable-media]
  vncpcap2john:
    command: bin/vncpcap2john
    plugs: [home, removable-media]
  zip2john:
    command: bin/zip2john
    plugs: [home, removable-media]
  gpg2john:
    command: bin/gpg2john
    plugs: [home, removable-media]
  keepass2john:
    command: bin/keepass2john
    plugs: [home, removable-media]
  putty2john:
    command: bin/putty2john
    plugs: [home, removable-media]
  rar2john:
    command: bin/rar2john
    plugs: [home, removable-media]
  uaf2john:
    command: bin/uaf2john
    plugs: [home, removable-media]
  wpapcap2john:
    command: bin/wpapcap2john
    plugs: [home, removable-media]
  info:
    command: bin/run-john.sh
    desktop: com.openwall.John.desktop

parts:
  john-the-ripper:
    plugin: nil
    after: [john-packages]
    source: https://github.com/openwall/john.git
    source-commit: f9fedd238b0b1d69181c1fef033b85c787e96e57
    source-depth: 10

    override-build: |
      cp "$SNAPCRAFT_STAGE"/build.sh .
      ./build.sh

      craftctl set version="$(cat version.txt)"

      mkdir -p ../install/etc/bash_completion
      cp run/john.*_completion ../install/etc/bash_completion/

    build-packages:
      - build-essential
      - libssl-dev
      - libgmp-dev
      - libpcap-dev
      - libbz2-dev
      - zlib1g-dev
      - git
      - wget
      - curl
      - patch
      # OpenCL stuff is available only in X86 architecture
      - on amd64:
          - libpocl-dev
          - ocl-icd-opencl-dev
          - pocl-opencl-icd

    organize:
      ../build/run/: bin/
      ../build/doc/: doc/
      ../build/README.md: README.md

  libs:
    plugin: nil

    stage-packages:
      - libgomp1
      - libpcap0.8
      - on amd64:
          - ocl-icd-libopencl1

  john-packages:
    plugin: nil
    source: .

    override-build: |
      cp deploy/metadata/com.openwall.John.desktop .
      cp deploy/metadata/run-john.sh .
      cp deploy/snap/build.sh $SNAPCRAFT_STAGE

    organize:
      ../build/com.openwall.John.desktop: com.openwall.John.desktop
      ../build/run-john.sh: bin/run-john.sh