Simple Rust SNTP client

This crate provides a method for sending requests to NTP servers and process responses, extracting received timestamp.

Supported SNTP protocol versions:

SNTPv4

Documentation

Installation

This crate works with Cargo and is on crates.io. Add it to your Cargo.toml like so:

[dependencies]
sntpc = "0.3.9"

By calling the get_time() method and providing a proper NTP pool or server you should get a valid synchronization timestamp:

use std::net::UdpSocket;
use std::time::Duration;

fn main() {
    let socket =
        UdpSocket::bind("0.0.0.0:0").expect("Unable to crate UDP socket");
    socket
       .set_read_timeout(Some(Duration::from_secs(2)))
       .expect("Unable to set UDP socket read timeout");
    let result = sntpc::simple_get_time("time.google.com:123", &socket);
    match result {
       Ok(time) => {
           println!("Got time: {}.{}", time.sec(), sntpc::fraction_to_milliseconds(time.sec_fraction()));
       }
       Err(err) => println!("Err: {:?}", err),
    }
}

`no_std` support

Currently, there are basic no_std support available, thanks to no-std-net crate. There is an example available on how to use smoltcp stack and that should provide general idea on how to bootstrap no_std networking and timestamping tools for sntpc library usage

`async` support

Feature async_tokio allows to use crate together with tokio. There is an example: examples/tokio.rs.

There is also no_std support with feature async, but it requires Rust >= 1.75-nightly version. The example can be found in separate repository.

Examples

You can find several examples that shows how to use the library in details under [examples/] folder. Currently, there are examples that show:

usage of SNTP library in std environment
usage of SNTP library with smoltcp TCP/IP stack. Some std dependencies required only due to smoltcp available interfaces

Contribution

Contributions are always welcome! If you have an idea, it's best to float it by me before working on it to ensure no effort is wasted. If there's already an open issue for it, knock yourself out. See the contributing section for additional details

Thanks

Frank A. Stevenson: for implementing stricter adherence to RFC4330 verification scheme
Timothy Mertz: for fixing possible overflow in offset calculation
HannesH: for fixing a typo in the README.md
Richard Penney: for adding two indicators of the NTP server's accuracy into the NtpResult structure
Vitali Pikulik: for adding async support
tsingwong: for fixing invalid link in the README.md
Robert Bastian: for fixing the overflow issue in the calculate_offset

Really appreciate all your efforts! Please let me know if I forgot someone.

License

This project is licensed under:

The 3-Clause BSD License

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in time by you, as defined in the 3-Clause BSD license, shall be licensed as above, without any additional terms or conditions.

vpetrigo/sntpc