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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
use core::fmt::Formatter;
use core::fmt::{Debug, Display};
use core::mem;
#[cfg(feature = "log")]
use log::debug;
use crate::get_ntp_timestamp;
use crate::net;
/// SNTP mode value bit mask
pub(crate) const MODE_MASK: u8 = 0b0000_0111;
/// SNTP mode bit mask shift value
pub(crate) const MODE_SHIFT: u8 = 0;
/// SNTP version value bit mask
pub(crate) const VERSION_MASK: u8 = 0b0011_1000;
/// SNTP mode bit mask shift value
pub(crate) const VERSION_SHIFT: u8 = 3;
/// SNTP LI (leap indicator) bit mask value
pub(crate) const LI_MASK: u8 = 0b1100_0000;
/// SNTP LI bit mask shift value
pub(crate) const LI_SHIFT: u8 = 6;
/// SNTP picoseconds in second constant
pub(crate) const PSEC_IN_SEC: u64 = 1_000_000_000_000;
/// SNTP nanoseconds in second constant
pub(crate) const NSEC_IN_SEC: u32 = 1_000_000_000;
/// SNTP microseconds in second constant
pub(crate) const USEC_IN_SEC: u32 = 1_000_000;
/// SNTP milliseconds in second constant
pub(crate) const MSEC_IN_SEC: u32 = 1_000;
/// SNTP seconds mask
pub(crate) const SECONDS_MASK: u64 = 0xffff_ffff_0000_0000;
/// SNTP seconds fraction mask
pub(crate) const SECONDS_FRAC_MASK: u64 = 0xffff_ffff;
/// SNTP library result type
pub type Result<T> = core::result::Result<T, Error>;
#[derive(Debug)]
pub(crate) struct NtpPacket {
pub(crate) li_vn_mode: u8,
pub(crate) stratum: u8,
pub(crate) poll: i8,
pub(crate) precision: i8,
pub(crate) root_delay: u32,
pub(crate) root_dispersion: u32,
pub(crate) ref_id: u32,
pub(crate) ref_timestamp: u64,
pub(crate) origin_timestamp: u64,
pub(crate) recv_timestamp: u64,
pub(crate) tx_timestamp: u64,
}
#[derive(Debug, Copy, Clone)]
pub(crate) struct NtpTimestamp {
pub(crate) seconds: i64,
pub(crate) seconds_fraction: i64,
}
impl From<u64> for NtpTimestamp {
fn from(v: u64) -> Self {
let seconds = (((v & SECONDS_MASK) >> 32)
- NtpPacket::NTP_TIMESTAMP_DELTA as u64)
as i64;
let microseconds = (v & SECONDS_FRAC_MASK) as i64;
NtpTimestamp {
seconds,
seconds_fraction: microseconds,
}
}
}
/// Helper enum for specification delay units
#[allow(dead_code)]
#[derive(Copy, Clone, Debug)]
pub(crate) enum Units {
Milliseconds,
Microseconds,
}
impl Display for Units {
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
let unit = match self {
Units::Microseconds => "us",
Units::Milliseconds => "ms",
};
write!(f, "{}", unit)
}
}
/// The error type for SNTP client
/// Errors originate on network layer or during processing response from a NTP server
#[derive(Debug, PartialEq, Copy, Clone)]
#[non_exhaustive]
pub enum Error {
/// Origin timestamp value in a NTP response differs from the value
/// that has been sent in the NTP request
IncorrectOriginTimestamp,
/// Incorrect mode value in a NTP response
IncorrectMode,
/// Incorrect Leap Indicator (LI) value in a NTP response
IncorrectLeapIndicator,
/// Incorrect version in a NTP response. Currently SNTPv4 is supported
IncorrectResponseVersion,
/// Incorrect stratum headers in a NTP response
IncorrectStratumHeaders,
/// Payload size of a NTP response does not meet SNTPv4 specification
IncorrectPayload,
/// Network error occurred.
Network,
/// A NTP server address can not be resolved
AddressResolve,
/// A NTP server address response has been received from does not match
/// to the address the request was sent to
ResponseAddressMismatch,
}
/// SNTP request result representation
#[derive(Debug)]
pub struct NtpResult {
/// NTP server seconds value
pub seconds: u32,
/// NTP server seconds fraction value
pub seconds_fraction: u32,
/// Request roundtrip time in microseconds
pub roundtrip: u64,
/// Estimated difference between the NTP reference and the system time in microseconds
pub offset: i64,
/// Clock stratum of NTP server
pub stratum: u8,
/// Precision of NTP server as log2(seconds) - this should usually be negative
pub precision: i8,
}
impl NtpResult {
/// Create new NTP result
/// Args:
/// * `seconds` - number of seconds
/// * `seconds_fraction` - number of seconds fraction
/// * `roundtrip` - calculated roundtrip in microseconds
/// * `offset` - calculated system clock offset in microseconds
/// * `stratum` - integer indicating the stratum (level of server's hierarchy to stratum 0 - "reference clock")
/// * `precision` - an exponent of two, where the resulting value is the precision of the system clock in seconds
pub fn new(
seconds: u32,
seconds_fraction: u32,
roundtrip: u64,
offset: i64,
stratum: u8,
precision: i8,
) -> Self {
let seconds = seconds + seconds_fraction / u32::MAX;
let seconds_fraction = seconds_fraction % u32::MAX;
NtpResult {
seconds,
seconds_fraction,
roundtrip,
offset,
stratum,
precision,
}
}
/// Returns number of seconds reported by an NTP server
pub fn sec(&self) -> u32 {
self.seconds
}
/// Returns number of seconds fraction reported by an NTP server
pub fn sec_fraction(&self) -> u32 {
self.seconds_fraction
}
/// Returns request's roundtrip time (client -> server -> client) in microseconds
pub fn roundtrip(&self) -> u64 {
self.roundtrip
}
/// Returns system clock offset value in microseconds
pub fn offset(&self) -> i64 {
self.offset
}
/// Returns reported stratum value (level of server's hierarchy to stratum 0 - "reference clock")
pub fn stratum(&self) -> u8 {
self.stratum
}
/// Returns reported precision value (an exponent of two, which results in the precision of server's system clock in seconds)
pub fn precision(&self) -> i8 {
self.precision
}
}
impl NtpPacket {
// First day UNIX era offset https://www.rfc-editor.org/rfc/rfc5905
pub(crate) const NTP_TIMESTAMP_DELTA: u32 = 2_208_988_800u32;
const SNTP_CLIENT_MODE: u8 = 3;
const SNTP_VERSION: u8 = 4 << 3;
pub fn new<T: NtpTimestampGenerator>(mut timestamp_gen: T) -> NtpPacket {
timestamp_gen.init();
let tx_timestamp = get_ntp_timestamp(timestamp_gen);
#[cfg(feature = "log")]
debug!(target: "NtpPacket::new", "{}", tx_timestamp);
NtpPacket {
li_vn_mode: NtpPacket::SNTP_CLIENT_MODE | NtpPacket::SNTP_VERSION,
stratum: 0,
poll: 0,
precision: 0,
root_delay: 0,
root_dispersion: 0,
ref_id: 0,
ref_timestamp: 0,
origin_timestamp: 0,
recv_timestamp: 0,
tx_timestamp,
}
}
}
/// A trait encapsulating timestamp generator's operations
///
/// Since under `no_std` environment `time::now()` implementations may be not available,
/// you can implement that trait on an object you want and provide proper system
/// timestamps for the SNTP client. According to specs, all timestamps calculated from
/// UNIX EPOCH "_1970-01-01 00:00:00 UTC_"
pub trait NtpTimestampGenerator {
/// Initialize timestamp generator state with `now` system time since UNIX EPOCH.
/// Expected to be called every time before `timestamp_sec` and
/// `timestamp_subsec_micros` usage. Basic flow would be the following:
///
/// ```text
/// # Timestamp A required
/// init()
/// timestamp_sec()
/// timestamp_subsec_micros()
/// // ...
/// # Timestamp B required
/// init()
/// timestamp_sec()
/// timestamp_subsec_micros()
/// // ... so on
/// ```
fn init(&mut self);
/// Returns timestamp in seconds since UNIX EPOCH for the initialized generator
fn timestamp_sec(&self) -> u64;
/// Returns the fractional part of the timestamp in whole micro seconds.
/// That method **should not** return microseconds since UNIX EPOCH
fn timestamp_subsec_micros(&self) -> u32;
}
#[cfg(feature = "std")]
/// Supplementary module to implement some `sntpc` boilerplate that environments with
/// `std` enable have to re-implement.
mod sup {
use std::time::{self, Duration};
use crate::NtpTimestampGenerator;
/// Standard library timestamp generator wrapper type
/// that relies on `std::time` to provide timestamps during SNTP client operations
#[derive(Copy, Clone, Default)]
pub struct StdTimestampGen {
duration: Duration,
}
impl NtpTimestampGenerator for StdTimestampGen {
fn init(&mut self) {
self.duration = time::SystemTime::now()
.duration_since(time::SystemTime::UNIX_EPOCH)
.unwrap();
}
fn timestamp_sec(&self) -> u64 {
self.duration.as_secs()
}
fn timestamp_subsec_micros(&self) -> u32 {
self.duration.subsec_micros()
}
}
}
#[cfg(feature = "std")]
pub use sup::*;
/// A trait encapsulating UDP socket interface required for SNTP client operations
pub trait NtpUdpSocket {
/// Send the given buffer to an address provided. On success, returns the number
/// of bytes written.
///
/// Since multiple SocketAddr objects can hide behind the type (domain name can be
/// resolved to multiple addresses), the method should send data to a single address
/// available in `addr`
fn send_to<T: net::ToSocketAddrs>(
&self,
buf: &[u8],
addr: T,
) -> Result<usize>;
/// Receives a single datagram message on the socket. On success, returns the number
/// of bytes read and the origin.
///
/// The function will be called with valid byte array `buf` of sufficient size to
/// hold the message bytes
fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, net::SocketAddr)>;
}
#[cfg(feature = "std")]
impl NtpUdpSocket for net::UdpSocket {
fn send_to<T: net::ToSocketAddrs>(
&self,
buf: &[u8],
addr: T,
) -> core::result::Result<usize, Error> {
match self.send_to(buf, addr) {
Ok(usize) => Ok(usize),
Err(_) => Err(Error::Network),
}
}
fn recv_from(
&self,
buf: &mut [u8],
) -> core::result::Result<(usize, net::SocketAddr), Error> {
match self.recv_from(buf) {
Ok((size, addr)) => Ok((size, addr)),
Err(_) => Err(Error::Network),
}
}
}
/// SNTP client context that contains of objects that may be required for client's
/// operation
#[derive(Copy, Clone)]
pub struct NtpContext<T: NtpTimestampGenerator> {
pub timestamp_gen: T,
}
impl<T: NtpTimestampGenerator + Copy> NtpContext<T> {
/// Create SNTP client context with the given timestamp generator
pub fn new(timestamp_gen: T) -> Self {
NtpContext { timestamp_gen }
}
}
/// Preserve SNTP request sending operation result required during receiving and processing
/// state
#[derive(Copy, Clone, Debug)]
pub struct SendRequestResult {
pub(crate) originate_timestamp: u64,
pub(crate) version: u8,
}
impl From<NtpPacket> for SendRequestResult {
fn from(ntp_packet: NtpPacket) -> Self {
SendRequestResult {
originate_timestamp: ntp_packet.tx_timestamp,
version: ntp_packet.li_vn_mode,
}
}
}
impl From<&NtpPacket> for SendRequestResult {
fn from(ntp_packet: &NtpPacket) -> Self {
SendRequestResult {
originate_timestamp: ntp_packet.tx_timestamp,
version: ntp_packet.li_vn_mode,
}
}
}
pub(crate) trait NtpNum {
type Type;
fn ntohl(&self) -> Self::Type;
}
impl NtpNum for u32 {
type Type = u32;
fn ntohl(&self) -> Self::Type {
self.to_be()
}
}
impl NtpNum for u64 {
type Type = u64;
fn ntohl(&self) -> Self::Type {
self.to_be()
}
}
pub(crate) struct RawNtpPacket(pub(crate) [u8; mem::size_of::<NtpPacket>()]);
impl Default for RawNtpPacket {
fn default() -> Self {
RawNtpPacket([0u8; mem::size_of::<NtpPacket>()])
}
}
impl From<RawNtpPacket> for NtpPacket {
fn from(val: RawNtpPacket) -> Self {
// left it here for a while, maybe in future Rust releases there
// will be a way to use such a generic function with compile-time
// size determination
// const fn to_array<T: Sized>(x: &[u8]) -> [u8; mem::size_of::<T>()] {
// let mut temp_buf = [0u8; mem::size_of::<T>()];
//
// temp_buf.copy_from_slice(x);
// temp_buf
// }
let to_array_u32 = |x: &[u8]| {
let mut temp_buf = [0u8; mem::size_of::<u32>()];
temp_buf.copy_from_slice(x);
temp_buf
};
let to_array_u64 = |x: &[u8]| {
let mut temp_buf = [0u8; mem::size_of::<u64>()];
temp_buf.copy_from_slice(x);
temp_buf
};
NtpPacket {
li_vn_mode: val.0[0],
stratum: val.0[1],
poll: val.0[2] as i8,
precision: val.0[3] as i8,
root_delay: u32::from_le_bytes(to_array_u32(&val.0[4..8])),
root_dispersion: u32::from_le_bytes(to_array_u32(&val.0[8..12])),
ref_id: u32::from_le_bytes(to_array_u32(&val.0[12..16])),
ref_timestamp: u64::from_le_bytes(to_array_u64(&val.0[16..24])),
origin_timestamp: u64::from_le_bytes(to_array_u64(&val.0[24..32])),
recv_timestamp: u64::from_le_bytes(to_array_u64(&val.0[32..40])),
tx_timestamp: u64::from_le_bytes(to_array_u64(&val.0[40..48])),
}
}
}
impl From<&NtpPacket> for RawNtpPacket {
fn from(val: &NtpPacket) -> Self {
let mut tmp_buf = [0u8; mem::size_of::<NtpPacket>()];
tmp_buf[0] = val.li_vn_mode;
tmp_buf[1] = val.stratum;
tmp_buf[2] = val.poll as u8;
tmp_buf[3] = val.precision as u8;
tmp_buf[4..8].copy_from_slice(&val.root_delay.to_be_bytes());
tmp_buf[8..12].copy_from_slice(&val.root_dispersion.to_be_bytes());
tmp_buf[12..16].copy_from_slice(&val.ref_id.to_be_bytes());
tmp_buf[16..24].copy_from_slice(&val.ref_timestamp.to_be_bytes());
tmp_buf[24..32].copy_from_slice(&val.origin_timestamp.to_be_bytes());
tmp_buf[32..40].copy_from_slice(&val.recv_timestamp.to_be_bytes());
tmp_buf[40..48].copy_from_slice(&val.tx_timestamp.to_be_bytes());
RawNtpPacket(tmp_buf)
}
}