[Package Request]: StackHawk HawkScan

Open
#87,479 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
java, powershell
Domain
cli, security

Research direction

Start with manifests/s/stackhawk/hawkscan/2.9.0/stackhawk.hawkscan.yaml and compare its zip, nested portable, and dependency fields with the winget 1.4 schema. Run winget validate and the reported winget install command to investigate discovery; done means the supported manifest format and required runtime behavior are established.

Written by the indexing model from the issue text.

Description

Help-Wanted Issue-Feature Package-Request
Package Requested
  • I would like help so I can submit the manifest.
  • I would like someone else to build the manifest.
  • I have performed a search and couldn't find this package.
  • I have checked that the installer for this package is not contained in a .zip file
  • I think there is a new version available and I have provided the URL.
Please provide the following information

Okay so yes it is contained in a zip file, and yes .zip installers are not available until winget-cli 1.4 goes GA and reaches 50% adoption.

However even with zip installer support I'm unsure if our package and similar others can be fully supported.
The provided manifest passes winget validate on v1.4.2161-preview:

# yaml-language-server: $schema=https://aka.ms/winget-manifest.singleton.1.4.0.schema.json

PackageIdentifier: stackhawk.hawkscan
PackageVersion: 2.9.0
PackageName: hawkscan
PackageLocale: en-US
Publisher: StackHawk
License: Proprietary
Copyright: (c) 2022 StackHawk
MinimumOSVersion: 10.0.0.0
InstallerType: zip
InstallModes:
- silentWithProgress
- silent
UpgradeBehavior: uninstallPrevious
Installers:
  - Architecture: neutral
    InstallerType: zip
    InstallerUrl: https://download.stackhawk.com/hawk/cli/hawk-2.9.0.zip
    InstallerSha256: e31ec72c0f7196cd67afad624a14f70bf5a02fa4031191d85cc1d998a39db72f
    NestedInstallerType: portable
    NestedInstallerFiles:
      - RelativeFilePath: hawk.ps1
        PortableCommandAlias: hawk
PublisherUrl: https://www.stackhawk.com
PublisherSupportUrl: https://support.stackhawk.com
PrivacyUrl: https://www.stackhawk.com/privacy-policy
LicenseUrl: https://www.stackhawk.com/terms-of-service
PackageUrl: https://docs.stackhawk.com/stackhawk-cli
ReleaseNotesUrl: https://docs.stackhawk.com/changelog.html
ShortDescription: KaaKaww! Helping developers to find, triage and fix security bugs!
Documentations:
  - DocumentLabel: Documentation
  - DocumentUrl: https://docs.stackhawk.com/
  - DocumentLabel: API Docs
  - DocumentUrl: https://apidocs.stackhawk.com
Moniker: hawkscan
Tags:
- api
- application
- security
- appsec
- hawk
- scan
- kaakaww
- stackhawk
ManifestType: singleton
ManifestVersion: 1.4.0

StackHawk HawkScan is a CLI for scanning running web applications for software vulnerabilities. hawk is the alias for the bash/powershell file that we supply that calls java -jar ... to run the java executable. Our package doesn't have an installer, rather it can unpack a hawk.ps1 script to alias.

A few questions:

  • This scenario of portable java applications launched from shell scripts and no formal installer also applies to #65391 #30972 #2964 #756 and a bunch of other java ecosystem packages I bet. Given the upcoming roadmap and experimental support for zipInstall, could our manifest submission be supported with the anticipated 1.4 winget release ?

  • These packages depend on a java runtime environment being installed, which might relate to package dependencies. I don't think this requirement is as critical, and theres plenty of flavors of java as it is to choose from, but is the experimental dependencies support also slated for 1.4 and could that address the JRE requirements of packages?

  • Did I get the singleton manifest file format correct? and package updates will be supported with the singleton format as part of the 1.4 release?

  • Running winget install manifests/s/stackhawk/hawkscan/2.9.0/stackhawk.hawkscan.yaml reports No package found matching input criteria. I don't think that means success but how do I debug further?

We look forward to adding our sweet CLI to the winget-pkgs repository 🦅

Dominant language
No language data
Stars
11.1k
Forks
9.7k
Avg merge
1h 32m
Merged PRs (30d)
376

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/winget-pkgs

All issues in microsoft/winget-pkgs

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.