Installation

npm install --save @types/cose-js

Summary

This package contains type definitions for cose-js (https://github.com/erdtman/COSE-JS).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cose-js.

index.d.ts

1/// <reference types="node" />
2
3import { Readable } from "stream";
4
5export type BufferLike = string | Buffer | ArrayBuffer | Uint8Array | Uint8ClampedArray | DataView | Readable;
6
7export interface HeaderParameters {
8    partyUNonce?: BufferLike;
9    static_key_id?: BufferLike;
10    static_key?: BufferLike;
11    ephemeral_key?: BufferLike;
12    alg?: BufferLike;
13    crit?: BufferLike;
14    content_type?: BufferLike;
15    ctyp?: BufferLike;
16    kid?: BufferLike;
17    IV?: BufferLike;
18    Partial_IV?: BufferLike;
19    counter_signature?: BufferLike;
20}
21
22export interface Headers {
23    u?: HeaderParameters;
24    p?: HeaderParameters;
25}
26
27export interface Key {
28    crv?: string;
29    k?: string;
30    x?: BufferLike;
31    y?: BufferLike;
32    d?: BufferLike;
33    kty?: string;
34}
35
36export namespace encrypt {
37    interface Signer {
38        key: Buffer;
39    }
40
41    interface CreateOptions {
42        externalAAD?: Buffer;
43        randomSource?(bytes: number): Buffer;
44        contextIv?: Buffer;
45        encodep?: "empty";
46        excludetag?: boolean;
47    }
48
49    function create(
50        headers: Headers,
51        payload: string,
52        recipient: Signer | Signer[],
53        options?: CreateOptions,
54    ): Promise<Buffer>;
55
56    function read(COSEMessage: Buffer, key: Buffer): Promise<Buffer>;
57}
58
59export namespace mac {
60    interface Signer {
61        key: Buffer;
62    }
63
64    function create(headers: Headers, plaintext: string, signer: Signer): Promise<Buffer>;
65
66    function read(COSEMessage: Buffer, key: Buffer): Promise<Buffer>;
67}
68
69export namespace sign {
70    interface Signer {
71        key: Key;
72        externalAAD?: Buffer;
73    }
74
75    interface VerifyOptions {
76        defaultType?: number;
77    }
78
79    interface CreateOptions {
80        encodep?: "empty";
81        excludetag?: boolean;
82    }
83
84    /** throws an error if verification fails */
85    function verify(payload: BufferLike, verifier: Signer, options?: VerifyOptions): Promise<Buffer>;
86
87    /** throws an error if verification fails */
88    function verifySync(payload: BufferLike, verifier: Signer, options?: VerifyOptions): Buffer;
89
90    function create(
91        headers: Headers,
92        payload: BufferLike,
93        signers: Signer | Signer[],
94        options?: CreateOptions,
95    ): Promise<Buffer>;
96}
97

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/node

Credits

These definitions were written by Kyle Hensel.