website logo
WebsiteTry DashboardContact Sales
⌘K
πŸ‘‹Welcome to mintBlue!
❓Why Use mintBlue?
🧧mintBlue Products
⛓️Enterprise Bitcoin
πŸš€Introduction
πŸ‘‰mintBlue Quick Start Guide
πŸ”—Setting up Zapier & mintBlue
πŸŽ‡mintBlue SDK
πŸ‘‰SDK Quick Start Guide
πŸ—οΈSDK Encryption
πŸ“©Envelopes
πŸ–₯️SDK Server
πŸ“SDK Scripts
πŸ“–mintBlue API
⏹️Blockchain API
πŸ“‘Token API
πŸ–₯️mintBlue Console
πŸ‘‚Event Listeners
πŸ†Examples of Building with mintBlue
πŸ”‘password manager
πŸ“ƒNotary Express App
Docs powered byΒ archbeeΒ 
5min

Peppol v1

The Peppol envelope follows the General JWE Serialization Syntax of the JSON Web Encryption standard (JWE) specified in RFC 7516ο»Ώ

JWE is chosen because

  • support for multiple recipients
  • support for multiple encryption algorithms
  • support for additional authenticated data

ο»Ώ

High Level Overview

High level overview of the Peppol v1 format. Dashed lines denote optional features
High level overview of the Peppol v1 format. Dashed lines denote optional features
ο»Ώ

Creating a Peppol V1 Envelope with createTransaction

Argument

Type

Description

version

number

1

value

Buffer

raw file contents

pubKey

string | JWK

ES256 Public key of the receiver, either as JWK or as uncompressed hex string

options

Object

ο»Ώ

options.extra

Buffer

Extra data to include in the encrypted payload

signingKey

JWK

Optional key to sign the envelope

General JWE Serialization Syntax

Field

Description

Use in Peppol v1

protected

integrity protected header

declares algorithm A256GCM

unprotected

header without integrity protection

ο»Ώ

iv

initialization vector

used by A256GCM

aad

additional authenticated data

unused currently

ciphertext

encrypted payload

encrypted content. contains compressed file and extra data

ο»Ώ

encrypt(lzma(cbor([file, extraData]))

tag

authentication tag

ο»Ώ

recipients

array containing information about a single recipient

contains information for the receiver to be able to decrypt the ciphertext

ο»Ώ

OP_RETURN Format

For more information about OP_RETURN see hereο»Ώ

The OP_RETURN arguments are structured as follows

Index

Description

Value

0

Protocol ID

"mB:peppol"

1

Peppol Envelope

Serialized JWE/JWS

2

Receiver pubkey

Public key of the receiver, intented for quick indexing

ο»Ώ

Updated 08 Feb 2023
Did this page help you?
Yes
No
UP NEXT
SDK Server
Docs powered byΒ archbeeΒ 
TABLE OF CONTENTS
High Level Overview
Creating a Peppol V1 Envelope with createTransaction
General JWE Serialization Syntax