roughenough 1.3.0-draft13

A Roughtime secure time sync server and client written in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

// Copyright 2017-2024 int08h LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License 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.

//!
//! An implementation of the [Roughtime](https://roughtime.googlesource.com/roughtime)
//! secure time synchronization protocol.
//!
//! Roughtime aims to achieve rough time synchronization in a secure way that doesn't
//! depend on any particular timeserver, and in such a way that, if a timeserver does
//! misbehave, clients end up with cryptographic proof of it.
//!
//! # Protocol
//!
//! Roughtime messages are represented by [`RtMessage`](struct.RtMessage.html) which
//! implements the mapping of Roughtime `u32` [`tags`](enum.Tag.html) to byte-strings.
//!
//! # Keys and Signing
//!
//! Roughtime uses an [Ed25519](https://ed25519.cr.yp.to/) key pair as the server's
//! long-term identity and a second key pair (signed by the long-term key) as a
//! delegated on-line (ephemeral) key.
//!
//! [`LongTermKey`](key/struct.LongTermKey.html) and [`OnlineKey`](key/struct.OnlineKey.html)
//! implement these elements of the protocol. The [`sign`](sign/index.html) module provides
//! signing and verification operations.
//!
//! # Client
//!
//! A Roughtime client can be found in `src/bin/client.rs`. To run the client:
//!
//! ```bash
//! $ cargo run --release --bin client roughtime.int08h.com 2002
//! ```
//!
//! Consult the client's `--help` output for all runtime options.
//!
//! # Server
//!
//! The core Roughtime server implementation is in `src/server.rs` and the server's CLI can
//! be found in `src/bin/roughenough-server.rs`.
//!
//! The server has multiple ways it can be configured,
//! see [`ServerConfig`](config/trait.ServerConfig.html) for the configuration trait and
//!
//!

#[macro_use]
extern crate log;

pub use crate::error::Error;
pub use crate::message::RtMessage;
pub use crate::tag::Tag;

mod error;
mod message;
mod tag;

pub mod config;
pub mod grease;
pub mod key;
pub mod kms;
pub mod merkle;
pub mod request;
pub mod responder;
pub mod server;
pub mod sign;
pub mod stats;
pub mod version;

/// Version of Roughenough
pub const VERSION: &str = "1.3.0-draft13";

/// Roughenough version string enriched with any compile-time optional features
pub fn roughenough_version() -> String {
    let kms_str = if cfg!(feature = "awskms") {
        " (+AWS KMS)"
    } else if cfg!(feature = "gcpkms") {
        " (+GCP KMS)"
    } else {
        ""
    };

    format!("{}{}", VERSION, kms_str)
}

//  Constants and magic numbers of the Roughtime protocol

/// Minimum size (in bytes) of a client request. Any request smaller than is will be dropped.
pub const MIN_REQUEST_LENGTH: usize = 1024;

/// Maximum size (in bytes) of a client request. Any request larger than is will be dropped.
pub const MAX_REQUEST_LENGTH: usize = 1500;

/// Size (in bytes) of seeds used to derive private keys
pub const SEED_LENGTH: u32 = 32;

/// Size (in bytes) of an Ed25519 signature
pub const SIGNATURE_LENGTH: u32 = 64;

/// Value prepended to leaves prior to hashing
pub const TREE_LEAF_TWEAK: &[u8] = &[0x00];

/// Value prepended to nodes prior to hashing
pub const TREE_NODE_TWEAK: &[u8] = &[0x01];

/// RFC first field magic value
pub const REQUEST_FRAMING_BYTES: &[u8] = b"ROUGHTIM";