"dirsp" is a short form for Diskuv Implementations of Research Security Protocols.
The first protocol we've included is "KBB2017" which is what the authors (security researchers) call a variant of
Signal Protocol v3.
We love it because it has been formally verified using two complementary proof checking tools. With the programming language OCaml
and dirsp-exchange you could write secure code like:
module P = Dirsp_proscript_mirage.Make()
module ED25519 = P.Crypto.ED25519
module K = Dirsp_exchange_kbb2017.Make(P)
module U = K.UTIL
(* Alice sends a message to Bob *)
let aliceSessionWithBob = T.newSession (* ... supply some keys you create with ED25519 and U ... *) ;;
let aliceToBobSendOutput = T.send
aliceIdentityKey
aliceSessionWithBob
(P.of_string "Hi Bob!")
(* Now you can send the output "aliceToBobSendOutput" from Alice to Bob.
Let's switch to Bob's computer. He gets notified of a new message using a notification library of your choosing, and then does ... *)
let bobSessionWithAlice = T.newSession (* ... supply some keys ... *);;
let bobFromAliceReceiveOutput = T.recv
bobIdentityKey
bobSignedPreKey
bobSessionWithAlice
theEncryptedMessageBobReceivedFromAlice
assert (bobFromAliceReceiveOutput.output.valid)
Format.printf "Bob just received a new message: %s\n"
(bobFromAliceReceiveOutput.plaintext |> P.to_bytes |> Bytes.to_string)Bindings to other languages and implementations of other security algorithms may follow later.
Looking for other implementations? Skip down to Comparison to Other Libraries
The intent of the [dirsp] libraries is to provide software engineers with auditable source code that has some level of safety assurance (typically proofs) from security researchers. By "auditable" we mean the ability to justify every line of source code when undergoing an audit by a competent security engineer. No third-party vetting of the source code has been conducted (unless noted explicitly), and the original authors at Diskuv did not have security researchers or engineers on staff when the libraries were originally written. Contact [email protected] to report any security issues, and feel free to publicly shame the Twitter handle @diskuv if Diskuv is not being responsive.
The implementations in this library are licensed permissively to broaden use and scrutiny. Sometimes that means writing an implementation from scratch based only on an academic paper. In contrast, placing security primitives like KBB2017 under restrictive licenses (ex. GPL and especially AGPL) discourages scrutiny because many security engineers work for companies which discourage or prohibit restrictive licenses. Note this lessened scrutiny is particular to low level security libraries that are restrictively licensed; even the original author of these libraries will use copy-left licenses for other types of libraries and applications.
TLDR: We don't expect you to run your code in OCaml. Embed it in your host language instead.
Most of the [dirsp] libraries are based in the programming language OCaml. Among other things OCaml is commonly used to write domain-specific languages for proof analysis. Coq is one example of a well-known DSL for developing proofs.
ProScript is another DSL. It is a restricted JavaScript language meant to be easily accessible to software engineers,
executed in production yet formally verifiable. The design fits well with the software engineering intent
of [dirsp]. The only soft spot is that the ProScript execution model is JavaScript which (at least for the authors of
[dirsp]) is not an ideal production language! So we built a tool dirsp-ps2ocaml to translate algorithms written
in ProScript into OCaml.
Let's be clear ... we don't think OCaml is an ideal production language for many people either; we suspect many teams will find the OCaml ecosystem to be too small. But we think there is a navigable path compared to JavaScript for OCaml to be embedded in several host languages (Java, Objective-C, JavaScript, etc.) and able to run logic (security and privacy algorithms) on many different host platforms (desktop, server, mobile, etc.).
This repository contains:
- dirsp-exchange-kbb2017 - The KBB2017 protocol for securing a two-party conversation. Similar to Signal Protocol v3 [1] [2] and Olm [3]
- dirsp-proscript - The ProScript Cryptographic Library (PSCL) API interface
- dirsp-proscript-mirage - A PSCL implementation based on
mirage-cryptoand related libraries - dirsp-ps2ocaml - A ProScript to OCaml translator with documentation available.
dirsp-exchange-kbb2017 has a build process that generates its own OCaml code
using dirsp-ps2ocaml on formally verified ProScript source code.
The online documentation is at:
Make sure you have opam installed. If you don't have OCaml and opam, it is probably
best to follow the Real World OCaml Installation Instructions.
You'll install the executables (currently only dirsp-ps2ocaml) as follows:
opam update
opam install dirsp-ps2ocaml
eval $(opam env)
dirsp-ps2ocaml --helpThe libraries are also available on Opam:
opam update
opam install dirsp-exchange-kbb2017 dirsp-proscript-mirageNote: Installing with esy likely works as well, but hasn't been tested.
| Library | Lineage | Language. Bindings | License | Papers | Usage |
|---|---|---|---|---|---|
| dirsp-exchange-kbb2017 | Cryptocat | OCaml | Apache v2 | Automated Verification for Secure Messaging Protocols and Their Implementations: A Symbolic and Computational Approach | Original code formally verified. [dirsp] has not been audited |
| libsignal-client (modern), libsignal-protocol-java (inactive) | Signal | Rust. Java, Swift, and TypeScript | AGPLv3 (modern). GPLv3 (inactive) | Signal Specifications | Well-known cryptographers. "Use outside of Signal is unsupported." |
| libolm | Matrix | C++ 11. JavaScript, Python, Android Java, Objective-C. | Apache v2 | Olm: A Cryptographic Ratchet | Audited in 2016. Actively being re-analysed |
Our recommendation for secure 1-on-1 messaging?
- Prefer [libolm] over [dirsp-exchange-kbb2017] unless you need to go beyond what [libolm] offers. In other words, use [dirsp-exchange-kbb2017] if you need to extend an algorithm in ProScript or need to adopt new published research (please contribute it here if you do!)
- Don't use [libsignal-client] because its owners actively discourage you from using it today. But since we suspect their stance is based on a lack of engineering resources rather than their donation-based mission of developing open source privacy technology, you may want to directly ask them.
- Announcements will be on Twitter: @diskuv. Q&A is fine!
- Use GitHub to "Watch" this repository (the top right corner of your browser)
- Disclose security vulnerabilities at [email protected]
- Report bugs at dirsp-exchange Issues
Engineers: We are actively looking for a) bindings to other languages and b) implementations of other security algorithms and c) multiple pairs of eyes vetting the code base. Please contribute if any of those interest you, or if you have other ideas!
Researchers: Looking for a test subject for an upcoming paper? If you use [dirsp] you have a reasonable opportunity for your research to impact production systems and apps.
See Contributing.
Thanks for your interest!
Jonah Beckford. Maintainer and Diskuv, Inc. Founder