Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SymbolicSoft/noiseexplorer
Online engine for reasoning about the Noise Protocol Framework.
https://github.com/SymbolicSoft/noiseexplorer
cryptographic-protocols cryptography formal-methods formal-verification protocol-analysis protocol-verification symbolic-protocol-analysis
Last synced: about 2 months ago
JSON representation
Online engine for reasoning about the Noise Protocol Framework.
- Host: GitHub
- URL: https://github.com/SymbolicSoft/noiseexplorer
- Owner: symbolicsoft
- License: gpl-3.0
- Created: 2021-04-07T08:44:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-19T11:19:42.000Z (about 1 year ago)
- Last Synced: 2024-04-16T06:46:59.669Z (6 months ago)
- Topics: cryptographic-protocols, cryptography, formal-methods, formal-verification, protocol-analysis, protocol-verification, symbolic-protocol-analysis
- Language: Rust
- Homepage: https://noiseexplorer.com
- Size: 49.7 MB
- Stars: 5
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-dot - NoiseExplorer - Rust code generator for formally verified (Noise/ cryptographic) (Libraries / Multisig Wallets)
README
# [Noise Explorer](https://noiseexplorer.com)
## Version 1.0.4, based on Noise Protocol Revision 34.
### Overview
The Noise Explorer command-line tool can parse Noise Handshake Patterns according to the original specification. It can generate cryptographic models for formal verification, including security queries, top-level processes and malicious principals, for testing against an active or passive attacker. Noise Explorer can also generate fully functional discrete implementations for any Noise Handshake Pattern, written in the [Go](https://golang.org) and [Rust](https://www.rust-lang.org) programming languages, as well as [WebAssembly](https://webassembly.org) binaries.
Noise Explorer can also render results from the ProVerif output into an elegant and easy to read HTML format: the pattern results that can be explored on [Noise Explorer](https://noiseexplorer.com) were generated using the Noise Explorer command-line tool.
### Status
| Output | Functional | Reliable | Tests |
|----------|------------|----------|------------|
| ProVerif | ✔️ | ✔️ | ✔️ |
| Go | ✔️ | ✔️ | ✔️ |
| Rust | ✔️ | ✔️ | ✔️ |
| Wasm | ✔️ | ✔️ | ✔️ |
### Usage
```
$> node noiseExplorer --help
Noise Explorer version 0.3 (specification revision 34)
Noise Explorer has three individual modes: generation, rendering and web interface.
Generation:
--generate=(json|pv|go|rs|wasm): Specify output format.
--pattern=[file]: Specify input pattern file (required).
--attacker=(active|passive): Specify ProVerif attacker type (default: active).
Rendering:
--render: Render results from ProVerif output files into HTML.
--pattern=[file]: Specify input pattern file (required).
--activeModel=[file]: Specify ProVerif active attacker model (required).
--activeResults=[file]: Specify active results file for --render (required).
--passiveResults=[file]: Specify passive results file for --render (required).
Web interface:
--web=(port): Make Noise Explorer's web interface available at http://localhost:(port) (default: 8000).
Help:
--help: View this help text.
```
### Requirements
1. [Node](https://nodejs.org) is required for running Noise Explorer locally.
2. [ProVerif](http://prosecco.gforge.inria.fr/personal/bblanche/proverif/) is required for verifying generated models.
2. [Go](https://golang.org) and [Rust](https://www.rust-lang.org) are required for running generated implementations.
3. [Google Chrome](https://chrome.google.com) is required for testing Wasm implementations.
### Preparation
1. `cd src`
2. `make dependencies`
3. `make parser`
### Usage
`node noiseExplorer --help`
### Model Generation
To quickly translate all Noise handshake patterns in the `patterns` folder to ProVerif models, simply run `make models` after completing the steps outlined in the Preparation section of this document. The models will be available in the `models` folder.
### Implementation Generation
To quickly translate all Noise handshake patterns in the `patterns` folder to Go, Rust and Wasm implementations, simply run `make implementations` after completing the steps outlined in the Preparation section of this document. The software will be available in the `implementations` folder. Note that the implementations found under `implementations/wasm` and the ones found under `implementations/rust` use different cryptographic libraries for compatibility purposes.
### WebAssembly Binaries
Wasm binaries and relevant helper files are found under `implementations/wasm/*/pkg`. To re-compile the Wasm binaries run `make wasm` after generating implementations using `make implementations`.
### Implementation Testing
Running `make tests` will verify these implementations against test vectors obtained from [Cacophony](https://github.com/centromere/cacophony), a Haskell implementation of the Noise Protocol Framework.
Testing Wasm implementations will utilize [Google Chrome](https://chrome.google.com) in headless mode.
### Implementation Documentation
To view the documentation of a generated Rust implementation, navigate to the directory of the desired pattern and run `cargo doc --open --no-deps`.
### Contributors and License
Authored by [Symbolic Software](https://symbolic.software). Released under the GNU General Public License, version 3.