Roughenough is a Roughtime secure time synchronization client and server implementation in Rust.
Roughenough's server and client are functionally complete and at feature parity with the reference C++ and Golang implementations.
Requires latest stable Rust to compile. Contributions welcome, see CONTRIBUTING for instructions and limitations for areas that could use attention.
Requires the latest stable Rust to build.
```bash
$ cargo build --release ```
The client binary is target/release/client. After building you can copy the
binary and run on its own (no cargo needed) if you wish.
bash
$ cp target/release/server /usr/local/bin
bash
$ target/release/client roughtime.int08h.com 2002
Requesting time from: "roughtime.int08h.com":2002
Received time from server: midpoint="Jul 28 2018 15:21:31", radius=1000000 (merkle_index=0, verified=false)
Use the -p flag with the client to validate the server's response with its public key.
```bash
$ host -t TXT roughtime.int08h.com roughtime.int08h.com descriptive text "016e6e0284d24c37c6e4d7d8d5b4e1d3c1949ceaa545bf875616c9dce0c9bec1"
$ target/release/client roughtime.int08h.com 2002 -p 016e6e0284d24c37c6e4d7d8d5b4e1d3c1949ceaa545bf875616c9dce0c9bec1 Requesting time from: "roughtime.int08h.com":2002 Received time from server: midpoint="Jul 28 2018 15:26:54", radius=1000000 (merkle_index=0, verified=true) ```
The verified=true in the output confirms that the server's response had a valid signature.
There are two (mutually exclusive) ways to configure the Roughenough server:
The server accepts the following configuration parameters:
YAML Key | Environment Variable | Necessity | Description
--- | --- | --- | ---
interface | ROUGHENOUGH_INTERFACE | Required | IP address or interface name for listening to client requests
port | ROUGHENOUGH_PORT | Required | UDP port to listen for requests
seed | ROUGHENOUGH_SEED | Required | A 32-byte hexadecimal value used to generate the server's long-term key pair. This is a secret value and must be un-guessable, treat it with care.
batch_size | ROUGHENOUGH_BATCH_SIZE | Optional | The maximum number of requests to process in one batch. All nonces in a batch are used to build a Merkle tree, the root of which is signed. Default is 64 requests per batch.
status_interval | ROUGHENOUGH_STATUS_INTERVAL | Optional | Number of seconds between each logged status update. Default is 600 seconds (10 minutes).
The table above lists the YAML keys available in the config file. An example:
yaml
interface: 127.0.0.1
port: 8686
seed: f61075c988feb9cb700a4a6a3291bfbc9cab11b9c9eca8c802468eb38a43d7d3
Provide the config file as the single command-line argument to the Roughenough server binary:
bash
$ /path/to/server /path/to/config.yaml
Roughenough can be configured via the ROUGHENOUGH_* environment variables
listed in the table above. Start the server with a single ENV argument to have Roughenough configure itself
from the environment. Example:
bash
$ export ROUGHENOUGH_INTERFACE=127.0.0.1
$ export ROUGHENOUGH_PORT=8686
$ export ROUGHENOUGH_SEED=f61075c988feb9cb700a4a6a3291bfbc9cab11b9c9eca8c802468eb38a43d7d3
$ /path/to/server ENV
```bash $ cargo build --release
$ target/release/server example.cfg 2018-07-25 00:05:09 INFO [server] Roughenough server v1.0.5 starting 2018-07-25 00:05:09 INFO [server] Long-term public key: d0756ee69ff5fe96cbcf9273208fec53124b1dd3a24d3910e07c7c54e2473012 2018-07-25 00:05:09 INFO [server] Ephemeral public key: 25fd5dc31ceee241aed3e643534e95ed0609e9a20982a45ac0312a5f55e2cc66 2018-07-25 00:05:09 INFO [server] Server listening on 127.0.0.1:8686
$ export ROUGHENOUGHINTERFACE=127.0.0.1 $ export ROUGHENOUGHPORT=8686 $ export ROUGHENOUGH_SEED=f61075c988feb9cb700a4a6a3291bfbc9cab11b9c9eca8c802468eb38a43d7d3 $ target/release/server ENV 2018-07-25 00:05:09 INFO [server] Roughenough server v1.0.5 starting 2018-07-25 00:05:09 INFO [server] Long-term public key: d0756ee69ff5fe96cbcf9273208fec53124b1dd3a24d3910e07c7c54e2473012 2018-07-25 00:05:09 INFO [server] Ephemeral public key: 25fd5dc31ceee241aed3e643534e95ed0609e9a20982a45ac0312a5f55e2cc66 2018-07-25 00:05:09 INFO [server] Server listening on 127.0.0.1:8686 ```
The resulting binary is target/release/server. After building you can copy the
binary and run on its own (no cargo needed):
bash
$ cp target/release/server /usr/local/bin
Use Ctrl-C or kill the process.
Roughtime features not implemented by the server:
pool.ntp.org likely will not.Other notes:
Vec's could be replaced by
lifetime scoped slices.Roughtime is a protocol that aims to achieve rough time synchronisation in a secure way that doesn't depend on any particular time server, and in such a way that, if a time server does misbehave, clients end up with cryptographic proof of it. It was created by Adam Langley and Robert Obryk.
Roughenough is copyright (c) 2017-2018 int08h LLC. All rights reserved.
int08h LLC licenses Roughenough (the "Software") to you under the Apache License, version 2.0 (the "License"); you may not use this Software except in compliance with the License. You may obtain a copy of the License from the LICENSE file included with the Software or at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.