@interledger/http-signature-utils - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "@interledger/http-signature-utils",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "Provides utilities for working with HTTP signatures",
		"repository": {
		"type": "git",
		"url": "https://github.com/interledger/open-payments.git",
		"directory": "packages/http-signature-utils"
		},
		"publishConfig": {
		"access": "public"
		},
		"homepage": "https://github.com/interledger/open-payments/tree/main/packages/http-signature-utils#readme",
		"author": "Interledger Tech Team <tech@interledger.org>",
		@@ -6,0 +15,0 @@ "main": "dist/index.js",

README.md

		# HTTP Signature Utils Library

		The Library includes
		This library provides tools for working with [HTTP Message Signatures](https://datatracker.ietf.org/doc/draft-ietf-httpbis-message-signatures):

		- loading Ed25519 keys from file or creating them
		- generating JWKs from Ed25519 keys
		- creating HTTP signature headers
		- validate and verify HTTP signature headers
		- Loading Ed25519 keys from a file or creating them
		- Generating JWKs from Ed25519 keys
		- Creating HTTP Signature headers & digests
		- Validating and verifying HTTP Signature headers

		## Local Development
		HTTP Message Signatures are used for protecting the integrity of [Open Payments](https://docs.openpayments.guide/) API requests.

		### Building
		## Installation

		From the monorepo root directory:
		You can install the package using:

		```shell
		pnpm --filter http-signature-utils build
		npm install @interledger/http-signature-utils
		```

		### Testing

		From the monorepo root directory:

		```shell
		pnpm --filter http-signature-utils test
		```

		## Usage

		Load or generate a private key
		Load or generate a private Ed25519 key:

		@@ -36,3 +28,3 @@ ```ts

		Create JWK from private key
		Create JWK from private Ed25519 key:

		@@ -46,3 +38,3 @@ ```ts

		Create Signature Headers
		Create signature headers:

		@@ -64,3 +56,3 @@ ```ts

		Create Signature and Content Headers
		Create signature and content headers:

		@@ -82,3 +74,3 @@ ```ts

		Validate Signature and Content Headers
		Validate signature and content headers:

		@@ -101,3 +93,3 @@ ```ts

		Verify signature
		Verify signature:

		@@ -104,0 +96,0 @@ ```ts

New alerts