Installations

npm install dag-jose-utils

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

20.5.1

NPM Version

9.8.0 Score

78.4

Supply Chain

84.4

Quality

82.8

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

0

Total

5

Closed

0

Merged

5

Issues

Open

0

Total

1

Closed

1

Releases

1

v0.1.0

Published on 01 Oct 2020

View all 1 releases

Contributors

7

Unable to fetch Contributors

View all 7 contributors

Languages

1

TypeScript

TypeScript (100%)

Developer

ceramicnetwork

Download Statistics

Total Downloads

943,108

Last Day

461

Last Week

5,357

Last Month

23,259

Last Year

374,771

GitHub Statistics

9 Stars

18 Commits

3 Forks

6 Watching

4 Branches

7 Contributors

Maintainers

9

Package Meta Information

Latest Version

4.0.0

Package Id

dag-jose-utils@4.0.0

Unpacked Size

7.05 kB

Size

2.59 kB

File Count

4

NPM Version

9.8.0

Node Version

20.5.1

Publised On

03 Jan 2024

Total Downloads

Cumulative downloads

Total Downloads

943,108

Last day

-36.2%

461

Compared to previous day

Last week

47.3%

5,357

Compared to previous week

Last month

-7.3%

23,259

Compared to previous month

Last year

35.5%

374,771

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

@ipld/dag-cbor multiformats

Dev Dependencies

15

@jest/globals @skypack/package-check @swc/cli @swc/core @swc/jest @typescript-eslint/eslint-plugin @typescript-eslint/parser del-cli eslint eslint-config-3box eslint-plugin-jest jest prettier turbo typescript

Versions

dag-jose-utils

This library provides utilities for using the DAG-JOSE IPLD codec. It uses DAG-CBOR to encode payloads and cleartexts to CIDs.

Installation

First install the package

$ npm i --save dag-jose-utils

Importing

1import {
2  encodePayload,
3  prepareCleartext,
4  decodeCleartext,
5  encodeIdentityCID,
6  decodeIdentityCID,
7  toJWSPayload,
8  toJWSStrings
9} from 'dag-jose-utils'

API

EncodedPayload

1interface EncodedPayload {
2  cid: CID
3  linkedBlock: Uint8Array
4}

encodePayload(payload: Record<string, any>): Promise

Prepares a payload to be signed in a JWS. Note that you will need to encode the encodePayload.cid.bytes as base64url before signing.

prepareCleartext(cleartext: Record<string, any>, blockSize?: number): Uint8Array

Prepares a cleartext object to be encrypted in a JWE. By default the blockSize for padding is 24.

decodeCleartext(b: Uint8Array): Record<string, any>

Decode a decrypted cleartext to an ipld object.

encodeIdentityCID(obj: Record<string, any>): CID

Encode an ipld object as a CID that uses the identity hash.

decodeIdentityCID(cid: CID): Record<string, any>

Decode an ipld object from a CID that uses the identity hash.

toJWSPayload(payload: EncodedPayload | CID): string

Transform an EncodedPayload (from encodePayload()) or a CID into a JWS string for use with createJWS() in did-jwt. The string form is simply the Base64url encoded form of the CID's byte representation.

toJWSStrings(jose: any): string[]

Transform a DagJWS object from ipld-dag-jose into an array of strings for each signature in the object. The strings can then be verified using verifyJWS() in did-jwt.

Maintainer

Joel Thorstensson

License

MIT or APACHE

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

9

License

Determines if the project has defined a license.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3.3

/10

Last Scanned on 2024-12-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More