hipcheck-sdk
| Crates.io | hipcheck-sdk |
| lib.rs | hipcheck-sdk |
| version | 0.6.1 |
| created_at | 2024-10-10 21:14:13.379566+00 |
| updated_at | 2025-05-02 19:21:32.404556+00 |
| description | SDK for writing Hipcheck plugins in Rust |
| homepage | https://hipcheck.mitre.org |
| repository | https://github.com/mitre/hipcheck |
| max_upload_size | |
| id | 1404497 |
| size | 103,737 |
(j-lanson)
documentation
README
Hipcheck Rust Plugin SDK ✓
A software development kit to help with writing plugins in Rust for the Hipcheck dependency analysis tool.
Overview
Hipcheck is a software dependency analyiss tool that helps identify risky project management practices and potential supply-chain attacks. It uses a plugin-based anaylsis architecture, such that Hipcheck users can write and release their own plugins that integrate seamlessly with the core binary and other analyses. The Rust plugin SDK provides the boilerplate code for defining a plugin and communicating with Hipcheck core over gRPC, allowing plugin authors to focus on the business logic of their plugin query endpoints.
Getting Started
The Hipcheck website has a guide for writing plugins using the Rust
SDK. For examples of using the SDK, the plugins/ subdirectory
of the Hipcheck repository contains a suite of plugins maintained by the
Hipcheck team that are all written with the SDK. See the docs.rs
page for the official documentation.
Links
Docs | Guide | [Examples][plugin-src]
License
Hipcheck's software is licensed under the Apache 2.0 license, which can be
found in the LICENSE file in this repository.