Socket
Socket
Sign inDemoInstall

@sigstore/bundle

Package Overview
Dependencies
1
Maintainers
2
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @sigstore/bundle

Sigstore bundle type


Version published
Maintainers
2
Install size
247 kB
Created

Package description

What is @sigstore/bundle?

The @sigstore/bundle npm package is designed for working with Sigstore, a project aimed at improving the security of the software supply chain by enabling the easy adoption of cryptographic software signing. With this package, developers can create, verify, and work with signatures and signed software bundles, enhancing the security and integrity of software distribution.

What are @sigstore/bundle's main functionalities?

Creating a signature bundle

This feature allows developers to create a signature bundle for a given artifact (e.g., a software package or binary). The bundle includes the artifact's signature, the public key used for signing, and optionally, a certificate for the public key. This enhances the artifact's integrity and authenticity.

const { createBundle } = require('@sigstore/bundle');

async function signArtifact(artifactPath) {
  const bundle = await createBundle({
    artifactPath,
    privateKeyPath: './path/to/private/key',
    certificatePath: './path/to/certificate'
  });
  console.log('Bundle created:', bundle);
}

Verifying a signature bundle

This functionality enables the verification of a signature bundle to ensure the integrity and authenticity of the signed artifact. It checks the artifact's signature against the provided public key and, if a certificate is included, validates the certificate as well.

const { verifyBundle } = require('@sigstore/bundle');

async function verifyArtifact(bundlePath) {
  const verificationResult = await verifyBundle({
    bundlePath,
    publicKeyPath: './path/to/public/key'
  });
  console.log('Verification result:', verificationResult);
}

Other packages similar to @sigstore/bundle

Readme

Source

@sigstore/bundle · npm version CI Status Smoke Test Status

A JavaScript library for working with the Sigstore bundle format.

Features

  • TypeScript types for the different Sigstore bundle versions.
  • Bundle validation functions.
  • Support for serializing/deserializing bundles to/from JSON.

Prerequisites

  • Node.js version >= 14.17.0

Installation

npm install @sigstore/bundle

FAQs

Last updated on 10 Aug 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc