message-signing/Header.ts
Header overview
COSE header structures (RFC 8152).
Added in v2.0.0
Table of contents
- Constructors
- Conversion
- Model
- HeaderMap (class)
- toJSON (method)
- toString (method)
- [Inspectable.NodeInspectSymbol] (method)
- [Equal.symbol] (method)
- [Hash.symbol] (method)
- setAlgorithmId (method)
- algorithmId (method)
- setCriticality (method)
- criticality (method)
- setKeyId (method)
- keyId (method)
- setContentType (method)
- contentType (method)
- setInitVector (method)
- initVector (method)
- setPartialInitVector (method)
- partialInitVector (method)
- setHeader (method)
- header (method)
- keys (method)
- Headers (class)
- HeaderMap (class)
- Schemas
Constructors
headerMapNew
Create an empty HeaderMap.
Signature
export declare const headerMapNew: () => HeaderMapAdded in v2.0.0
headersNew
Create Headers with protected and unprotected maps.
Signature
export declare const headersNew: (protectedHeaders: HeaderMap, unprotectedHeaders: HeaderMap) => HeadersAdded in v2.0.0
Conversion
headerMapFromCBORBytes
Decode HeaderMap from CBOR bytes.
Signature
export declare const headerMapFromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => HeaderMapAdded in v2.0.0
headerMapFromCBORHex
Decode HeaderMap from CBOR hex.
Signature
export declare const headerMapFromCBORHex: (hex: string, options?: CBOR.CodecOptions) => HeaderMapAdded in v2.0.0
headerMapToCBORBytes
Encode HeaderMap to CBOR bytes.
Signature
export declare const headerMapToCBORBytes: (headerMap: HeaderMap, options?: CBOR.CodecOptions) => Uint8ArrayAdded in v2.0.0
headerMapToCBORHex
Encode HeaderMap to CBOR hex.
Signature
export declare const headerMapToCBORHex: (headerMap: HeaderMap, options?: CBOR.CodecOptions) => stringAdded in v2.0.0
Model
HeaderMap (class)
Map of COSE header labels to values (RFC 8152).
Signature
export declare class HeaderMapAdded in v2.0.0
toJSON (method)
Signature
toJSON()toString (method)
Signature
toString(): string[Inspectable.NodeInspectSymbol] (method)
Signature
[Inspectable.NodeInspectSymbol](): unknown[Equal.symbol] (method)
Signature
[Equal.symbol](that: unknown): boolean[Hash.symbol] (method)
Signature
[Hash.symbol](): numbersetAlgorithmId (method)
Set algorithm identifier header.
Signature
setAlgorithmId(alg: AlgorithmId): thisAdded in v2.0.0
algorithmId (method)
Get algorithm identifier header.
Signature
algorithmId(): AlgorithmId | undefinedAdded in v2.0.0
setCriticality (method)
Set criticality header (label 2) - array of critical header labels.
Signature
setCriticality(labels: ReadonlyArray<Label>): thisAdded in v2.0.0
criticality (method)
Get criticality header (label 2) - array of critical header labels.
Signature
criticality(): ReadonlyArray<Label> | undefinedAdded in v2.0.0
setKeyId (method)
Set key ID header.
Signature
setKeyId(kid: Uint8Array): thisAdded in v2.0.0
keyId (method)
Get key ID header.
Signature
keyId(): Uint8Array | undefinedAdded in v2.0.0
setContentType (method)
Set content type header (label 3).
Signature
setContentType(contentType: Label): thisAdded in v2.0.0
contentType (method)
Get content type header (label 3).
Signature
contentType(): Label | undefinedAdded in v2.0.0
setInitVector (method)
Set initialization vector header (label 5).
Signature
setInitVector(iv: Uint8Array): thisAdded in v2.0.0
initVector (method)
Get initialization vector header (label 5).
Signature
initVector(): Uint8Array | undefinedAdded in v2.0.0
setPartialInitVector (method)
Set partial initialization vector header (label 6).
Signature
setPartialInitVector(piv: Uint8Array): thisAdded in v2.0.0
partialInitVector (method)
Get partial initialization vector header (label 6).
Signature
partialInitVector(): Uint8Array | undefinedAdded in v2.0.0
setHeader (method)
Set custom header.
Signature
setHeader(label: Label, value: CBOR.CBOR): thisAdded in v2.0.0
header (method)
Get custom header.
Signature
header(label: Label): CBOR.CBOR | undefinedAdded in v2.0.0
keys (method)
Get all header label keys.
Signature
keys(): ReadonlyArray<Label>Added in v2.0.0
Headers (class)
COSE protected and unprotected headers (RFC 8152).
Signature
export declare class HeadersAdded in v2.0.0
toJSON (method)
Signature
toJSON()toString (method)
Signature
toString(): string[Inspectable.NodeInspectSymbol] (method)
Signature
[Inspectable.NodeInspectSymbol](): unknown[Equal.symbol] (method)
Signature
[Equal.symbol](that: unknown): boolean[Hash.symbol] (method)
Signature
[Hash.symbol](): numberSchemas
HeaderMapFromCBORBytes
CBOR bytes transformation schema for HeaderMap.
Signature
export declare const HeaderMapFromCBORBytes: (
options?: CBOR.CodecOptions
) => Schema.transformOrFail<
Schema.transformOrFail<
typeof Schema.Uint8ArrayFromSelf,
Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
never
>,
Schema.SchemaClass<HeaderMap, HeaderMap, never>,
never
>Added in v2.0.0
HeaderMapFromCBORHex
CBOR hex transformation schema for HeaderMap.
Signature
export declare const HeaderMapFromCBORHex: (
options?: CBOR.CodecOptions
) => Schema.transform<
Schema.Schema<Uint8Array, string, never>,
Schema.transformOrFail<
Schema.transformOrFail<
typeof Schema.Uint8ArrayFromSelf,
Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
never
>,
Schema.SchemaClass<HeaderMap, HeaderMap, never>,
never
>
>Added in v2.0.0