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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
// Copyright (c) 2020 Xu Shaohua <shaohua@biofan.org>. All rights reserved.
// Use of this source is governed by General Public License that can be found
// in the LICENSE file.

#![no_std]

extern crate alloc;
extern crate core;
use alloc::vec::Vec;
use byteorder::{BigEndian, WriteBytesExt};
use core::convert::TryInto;
use core::default::Default;

/// Number of bytes of binary representation of struct.
pub trait BinLen {
    const LEN: usize;
}

#[derive(Debug)]
pub enum Error {
    InvalidPacket,
}

pub trait ToNetPacket {
    fn to_net(&self, v: &mut Vec<u8>);
}

/// 2-bits indicator to check leap second.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum LeapIndicator {
    NoWarning = 0,
    AddOne = 1,
    SubOne = 2,
    Unknown = 3,
}

impl Default for LeapIndicator {
    fn default() -> Self {
        LeapIndicator::NoWarning
    }
}

/// 3-bits version number of NTP protocol.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Version {
    V1 = 0,
    V2 = 1,
    V3 = 3,
    V4 = 4,
    V5 = 5,
}

impl Default for Version {
    fn default() -> Self {
        Version::V4
    }
}

/// 3-bits mode type of NTP packet.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Mode {
    Reserved = 0,
    SymmetricActive = 1,
    SymmetricPassive = 2,
    Client = 3,
    Server = 4,
    Broadcast = 5,
    ControlMessage = 6,
    ReservedForPrivateUse = 7,
}

impl Default for Mode {
    fn default() -> Self {
        Mode::Client
    }
}

/// 8-bit stratum type.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct Stratum(u8);

/// NTP packet header.
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct Header {
    /// Flags(the first byte) are constructed with leap_id, version and mode.
    pub leap_id: LeapIndicator,
    pub version: Version,
    pub mode: Mode,

    pub stratum: Stratum,
    pub poll: i8,
    pub precision: i8,
}

impl BinLen for Header {
    const LEN: usize = 4;
}

impl ToNetPacket for Header {
    fn to_net(&self, v: &mut Vec<u8>) {
        let flags = ((self.leap_id as u8) & 0b11000000)
            + ((self.version as u8) << 3)
            + ((self.mode as u8) & 0b00000111);
        log::info!("flags: {:x}", flags);
        v.push(flags);
        v.push(self.stratum.0);
        // TODO(Shaohua): Check interger sign
        v.push(self.poll as u8);
        v.push(self.precision as u8);
    }
}

/// Short format of timestamp.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct ShortTimestamp {
    pub seconds: u16,
    pub fraction: u16,
}

impl BinLen for ShortTimestamp {
    const LEN: usize = 4;
}

impl ToNetPacket for ShortTimestamp {
    fn to_net(&self, v: &mut Vec<u8>) {
        v.write_u16::<BigEndian>(self.seconds);
        v.write_u16::<BigEndian>(self.fraction);
    }
}

/// Reference identifier.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct RefIdentifier {
    pub ref_id: [u8; 4],
}

impl BinLen for RefIdentifier {
    const LEN: usize = 4;
}

impl ToNetPacket for RefIdentifier {
    fn to_net(&self, v: &mut Vec<u8>) {
        v.push(self.ref_id[0]);
        v.push(self.ref_id[1]);
        v.push(self.ref_id[2]);
        v.push(self.ref_id[3]);
    }
}

/// 64-bits timestamp.
#[repr(C)]
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct Timestamp {
    pub seconds: u32,
    pub fraction: u32,
}

impl BinLen for Timestamp {
    const LEN: usize = 8;
}

impl ToNetPacket for Timestamp {
    fn to_net(&self, v: &mut Vec<u8>) {
        v.write_u32::<BigEndian>(self.seconds);
        v.write_u32::<BigEndian>(self.fraction);
    }
}

impl Timestamp {
    pub fn now() -> Timestamp {
        let mut now = nc::timeval_t::default();
        let mut tz = nc::timezone_t::default();
        let _ = nc::gettimeofday(&mut now, &mut tz);
        const DELTA: u64 = 2_208_988_800;
        let seconds = (now.tv_sec as u64 + DELTA).try_into().unwrap();
        let fraction = (now.tv_usec as u64).try_into().unwrap();
        Timestamp { seconds, fraction }
    }
}

/// ## Ntp package format:
/// ```memory
///  0                   1                   2                   3
///  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
/// +--------------+---------------+---------------+----------------+
/// |LI | VN  |Mode |    Stratum     |     Poll      |  Precision   |
/// +--------------+---------------+---------------+----------------+
/// |                          Root Delay                           |
/// +--------------+---------------+---------------+----------------+
/// |                        Root Dispersion                        |
/// +--------------+---------------+---------------+----------------+
/// |                         Reference ID                          |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// +                   Reference Timestamp (64)                    +
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// +                     Origin Timestamp (64)                     +
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// +                    Receive Timestamp (64)                     +
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// +                    Transmit Timestamp (64)                    +
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// .                                                               .
/// .                    Extension Field 1 (variable)               .
/// .                                                               .
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// .                                                               .
/// .                    Extension Field 2 (variable)               .
/// .                                                               .
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// |                        Key Identifier                         |
/// +--------------+---------------+---------------+----------------+
/// |                                                               |
/// |                          dgst (128)                           |
/// |                                                               |
/// +--------------+---------------+---------------+----------------+
/// ```
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct NtpPacket {
    pub header: Header,
    pub root_delay: ShortTimestamp,
    pub root_dispersion: ShortTimestamp,
    pub ref_id: RefIdentifier,
    pub ref_timestamp: Timestamp,
    pub origin_timestamp: Timestamp,
    pub receive_timestamp: Timestamp,
    pub transmit_timestamp: Timestamp,
}

impl BinLen for NtpPacket {
    const LEN: usize = Header::LEN
        + ShortTimestamp::LEN
        + ShortTimestamp::LEN
        + RefIdentifier::LEN
        + Timestamp::LEN
        + Timestamp::LEN
        + Timestamp::LEN
        + Timestamp::LEN;
}

impl ToNetPacket for NtpPacket {
    fn to_net(&self, v: &mut Vec<u8>) {
        self.header.to_net(v);
        self.root_delay.to_net(v);
        self.root_dispersion.to_net(v);
        self.ref_id.to_net(v);
        self.ref_timestamp.to_net(v);
        self.origin_timestamp.to_net(v);
        self.receive_timestamp.to_net(v);
        self.transmit_timestamp.to_net(v);
    }
}

impl NtpPacket {
    pub fn new() -> NtpPacket {
        NtpPacket {
            transmit_timestamp: Timestamp::now(),
            ..NtpPacket::default()
        }
    }
}