OpenYOLO Specification

This repository contains the draft OpenYOLO Specification, which standardizes the protocol and platform specifics of direct communication between services (apps and sites) and credential providers.

This specification is currently a draft and rapidly changing - please do not rely upon any aspect of it for your own services. If you wish to ask questions about the specification or collaborate on its definition, please join the Account Chooser and OpenYOLO Working Group and post to its mailing list.

Contributions

All contributors to this specification must sign the OpenID Intellectual Property and Contribution Agreements. Spec changes should typically be discussed on the Account Chooser and OpenYOLO working group before specification change pull requests are produced.

Producing a finalized document

The following tools are required:

• mmark, which translates the Markdown source to XML2RFC v2 and v3 XML.

• xml2rfc v2, which produces the standard RFC ASCII text output.

• A Java runtime, and Saxon 9 HE, which produces the HTML output version of the document.

• Make, to drive the above tools.

To produce all output, just run make. See the Makefile for the more specific targets.

Installing mmark

On Mac OS, mmark can be installed using homebrew: brew install mmark. Otherwise, on all platforms the tool can be built from source.

Installing xml2rfc v2

On all platforms, xml2rfc can be installed using pip: pip install xml2rfc.

Installing Saxon

Download Saxon 9 HE, and unzip the files into a "saxon" subfolder of your checkout (this is ignored by git). In particular, saxon/saxon9he.jar must exist.