The Mercure Protocol
draft-dunglas-mercure-07

Document Type Active Internet-Draft (individual)
Last updated 2020-07-08
Stream (None)
Intended RFC status (None)
Formats plain text html xml pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                         K. Dunglas
Internet-Draft                                         Les-Tilleuls.coop
Intended status: Standards Track                             8 July 2020
Expires: 9 January 2021

                          The Mercure Protocol
                        draft-dunglas-mercure-07

Abstract

   Mercure is a protocol enabling the pushing of data updates to web
   browsers and other HTTP clients in a fast, reliable and battery-
   efficient way.  It is especially useful for publishing real-time
   updates of resources served through web APIs to web and mobile apps.

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on 9 January 2021.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.  Code Components
   extracted from this document must include Simplified BSD License text
   as described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Simplified BSD License.

Dunglas                  Expires 9 January 2021                 [Page 1]
Internet-Draft            The Mercure Protocol                 July 2020

Table of Contents

   1.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Discovery . . . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.1.  Content Negotiation . . . . . . . . . . . . . . . . . . .   5
   3.  Topic Selectors . . . . . . . . . . . . . . . . . . . . . . .   6
   4.  Subscription  . . . . . . . . . . . . . . . . . . . . . . . .   7
   5.  Publication . . . . . . . . . . . . . . . . . . . . . . . . .   8
   6.  Authorization . . . . . . . . . . . . . . . . . . . . . . . .  10
     6.1.  Publishers  . . . . . . . . . . . . . . . . . . . . . . .  11
     6.2.  Subscribers . . . . . . . . . . . . . . . . . . . . . . .  12
     6.3.  Payload . . . . . . . . . . . . . . . . . . . . . . . . .  13
   7.  Reconnection, State Reconciliation and Event Sourcing . . . .  13
   8.  Active Subscriptions  . . . . . . . . . . . . . . . . . . . .  14
     8.1.  Subscription Events . . . . . . . . . . . . . . . . . . .  15
     8.2.  Subscription API  . . . . . . . . . . . . . . . . . . . .  16
   9.  JSON-LD Context . . . . . . . . . . . . . . . . . . . . . . .  20
   10. Encryption  . . . . . . . . . . . . . . . . . . . . . . . . .  20
   11. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  21
     11.1.  Well-Known URIs Registry . . . . . . . . . . . . . . . .  21
     11.2.  Link Relation Types Registry . . . . . . . . . . . . . .  21
     11.3.  JSON Web Token (JWT) Registry  . . . . . . . . . . . . .  21
   12. Security Considerations . . . . . . . . . . . . . . . . . . .  22
   13. Implementation Status . . . . . . . . . . . . . . . . . . . .  23
     13.1.  Mercure.rocks Hub  . . . . . . . . . . . . . . . . . . .  23
     13.2.  Ilshidur/node-mercure  . . . . . . . . . . . . . . . . .  24
     13.3.  Symfony  . . . . . . . . . . . . . . . . . . . . . . . .  25
     13.4.  API Platform . . . . . . . . . . . . . . . . . . . . . .  26
     13.5.  Laravel Mercure Broadcaster  . . . . . . . . . . . . . .  26
     13.6.  dart_mercure . . . . . . . . . . . . . . . . . . . . . .  27
     13.7.  pymercure  . . . . . . . . . . . . . . . . . . . . . . .  28
     13.8.  Amphp Mercure Publisher  . . . . . . . . . . . . . . . .  29
     13.9.  Java Library for Mercure . . . . . . . . . . . . . . . .  30
     13.10. Yii 2 Mercure behavior . . . . . . . . . . . . . . . . .  31
     13.11. GitHub Action for Mercure  . . . . . . . . . . . . . . .  31
     13.12. Other Implementations  . . . . . . . . . . . . . . . . .  32
   14. Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  32
   15. Normative References  . . . . . . . . . . . . . . . . . . . .  32
   16. Informative References  . . . . . . . . . . . . . . . . . . .  33
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  35

1.  Terminology
Show full document text