Skip to content

WhiteflagProtocol/whiteflag-standard

Repository files navigation

The Whiteflag Protocol

Protocol Specification

The purpose of Whiteflag is to provide an open and decentralised communications protocol to create a trusted messaging network for disaster & conflict zones, without the requirement for a trusted third party or any specific software or system.

This GitHub repository contains the official, configuration controlled versions of the Whiteflag Protocol specification, which are published on https://standard.whiteflagprotocol.org/.

The Whiteflag Protocol is an open standard for a blockchain-based communications protocol that is trusted and accessible by all parties involved armed conflicts, in addition to any currently existing but limited or unsecure communication methods such as telephone, e-mail, messaging, physical signs, registers etc.

The standard is released in the public domain. Please read the license for more detailed information.

Protocol Version and Publication

The current baselined version of the protocol is: Version 1 Draft 7 or in short: v1-draft.7, which can be found in multiple formats at https://standard.whiteflagprotocol.org/.

Repository Structure

The main source document with the protocol specification is wf-specification.md.

This is a markdown document. Markdown is a plain text formatting syntax; see RFC 7763 or Wikipedia for more information on this media type. Using Markdown allows the standard to be easily maintained and to be published in other formats, such as html or pdf.

Documents in these formats are generated from the markdown source document with pandoc and published in the docs/ directory. The pandoc configuration and scripts can be found in the pandoc/ directory.

The docs/ directory is published on https://standard.whiteflagprotocol.org/ using GitHub pages. All baselined versions can be found there.

Along with the standard, a JSON schema of the Whiteflag message structure, message syntax and message codes is available as wf-message.schema.json. This artefact describes parts of the specification in a structured language, i.e. the JSON format. This allows for fast and interoperable implementation of the standard.

Configuration Management

The Whiteflag Foundation maintains, promotes and supports adoption of the Whiteflag Protocol. Issues may be raised and discussed in this project repository.