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
//! # rsntp //! //! An [RFC 4330](https://tools.ietf.org/html/rfc4330) compliant Simple Network Time Protocol (SNTP) client //! library for Rust. //! //! `rsntp` provides an API to synchronize time with SNTPv4 time servers with the following features: //! //! * Provides both a synchronous (blocking) and an (optional) asynchronous API based `tokio` //! * Time and date handling based on the `chrono` crate //! * IPv6 support //! //! ## Usage //! //! Add this to your `Cargo.toml`: //! //! ```toml //! [dependencies] //! rsntp = "2.0.0" //! ``` //! //! Obtain the current local time with the blocking API: //! //! ```no_run //! use rsntp::SntpClient; //! use chrono::{DateTime, Local}; //! //! let client = SntpClient::new(); //! let result = client.synchronize("pool.ntp.org").unwrap(); //! //! let local_time: DateTime<Local> = DateTime::from(result.datetime()); //! //! println!("Current time is: {}", local_time); //! ``` //! #![cfg_attr( feature = "async", doc = r##" A function which uses the asynchronous API to obtain local time: ```no_run use rsntp::AsyncSntpClient; use chrono::{DateTime, Local}; async fn local_time() -> DateTime<Local> { let client = AsyncSntpClient::new(); let result = client.synchronize("pool.ntp.org").await.unwrap(); DateTime::from(result.datetime()) } ``` ## Disabling asynchronous API The asynchronous API is enabled by default but you can optionally disable it. This removes dependency to `tokio` which reduces crate dependencies significantly. ```toml [dependencies] rsntp = { version = "2.0.0", default-features = false } ``` "## )] //! ## IPv6 support //! //! `rsntp` supports IPv6, but by default (for compatilibty reasons) it binds its UDP socket to an //! IPv4 address (0.0.0.0) which might prevent synchronization with IPv6 servers. //! //! To use IPv6, you need to set an IPv6 bind address: //! //! ```no_run //! use chrono::{DateTime, Local}; //! use rsntp::SntpClient; //! use std::net::Ipv6Addr; //! //! let mut client = SntpClient::new(); //! client.set_bind_address((Ipv6Addr::UNSPECIFIED, 0).into()); //! //! let result = client.synchronize("2.pool.ntp.org").unwrap(); //! //! let local_time: DateTime<Local> = DateTime::from(result.datetime()); //! ``` //! mod core_logic; mod error; mod packet; mod to_server_addrs; pub use core_logic::SynchronizationResult; pub use error::{KissCode, ProtocolError, SynchroniztationError}; pub use packet::{LeapIndicator, ReferenceIdentifier}; pub use to_server_addrs::ToServerAddrs; use core_logic::{Reply, Request}; use packet::Packet; use std::net::{IpAddr, Ipv4Addr, SocketAddr}; use std::time::Duration; #[cfg(feature = "async")] use tokio::time::timeout; const SNTP_PORT: u16 = 123; /// Blocking client instance /// /// This is the main entry point of the blocking API. #[derive(Clone, Debug, Hash)] pub struct SntpClient { bind_address: SocketAddr, timeout: Duration, } impl SntpClient { /// Creates a new instance with default parameters /// /// # Example /// /// ```no_run /// use rsntp::SntpClient; /// /// let client = SntpClient::new(); /// ``` pub fn new() -> SntpClient { SntpClient { bind_address: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 0), timeout: Duration::from_secs(3), } } /// Synchronize with the server /// /// Sends a request to the server, waits for the reply and processes it. This is a blocking call /// and can block for quite long time. After sending the request it waits for a timeout and if no /// reply is received then an error is returned. /// /// If the supplied server address resolves to multiple addresses then only the first one is used. /// /// # Example /// /// ```no_run /// use rsntp::SntpClient; /// /// let client = SntpClient::new(); /// let result = client.synchronize("pool.ntp.org"); /// ``` pub fn synchronize<A: ToServerAddrs>( &self, server_address: A, ) -> Result<SynchronizationResult, SynchroniztationError> { let socket = std::net::UdpSocket::bind(self.bind_address)?; socket.set_read_timeout(Some(self.timeout))?; socket.connect(server_address.to_server_addrs(SNTP_PORT))?; let request = Request::new(); let mut receive_buffer = [0; Packet::ENCODED_LEN]; socket.send(&request.as_bytes())?; let (bytes_received, server_address) = socket.recv_from(&mut receive_buffer)?; let reply = Reply::new( request, Packet::from_bytes(&receive_buffer[..bytes_received], server_address)?, ); reply.process() } /// Sets synchronization timeout /// /// This sets the amount of time which the client waits for reply after the request has been sent. /// Default is 3 seconds. /// /// # Example /// /// ```no_run /// use rsntp::SntpClient; /// use std::time::Duration; /// /// let mut client = SntpClient::new(); /// client.set_timeout(Duration::from_secs(10)); /// ``` pub fn set_timeout(&mut self, timeout: Duration) { self.timeout = timeout; } /// Set UDP bind address /// /// Sets the local address which is used to send/receive UDP packets. By default it is /// "0.0.0.0:0" which means that an IPv4 address and a port is chosen automatically. /// /// To synchronize with IPv6 servers, you might need to set it to an IPv6 address. /// /// # Example /// /// ```no_run /// use rsntp::SntpClient; /// /// let mut client = SntpClient::new(); /// client.set_bind_address("192.168.0.1:0".parse().unwrap()); /// ``` pub fn set_bind_address(&mut self, address: SocketAddr) { self.bind_address = address; } } impl Default for SntpClient { fn default() -> Self { SntpClient::new() } } /// Asynchronous client instance /// /// Only available when async feature is enabled (which is the default) /// /// This is the main entry point of the asynchronous API. #[cfg(feature = "async")] pub struct AsyncSntpClient { bind_address: SocketAddr, timeout: Duration, } #[cfg(feature = "async")] impl AsyncSntpClient { /// Creates a new instance with default parameters /// /// Only available when async feature is enabled (which is the default) /// /// # Example /// /// ```no_run /// use rsntp::AsyncSntpClient; /// /// let client = AsyncSntpClient::new(); /// ``` pub fn new() -> AsyncSntpClient { AsyncSntpClient { bind_address: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)), 0), timeout: Duration::from_secs(3), } } /// Synchronize with the server /// /// Only available when async feature is enabled (which is the default) /// /// Sends a request to the server and processes the reply. If no reply is received within timeout /// then an error is returned. If the supplied server address resolves to multiple addresses then /// only the first one is used. /// /// # Example /// /// ```no_run /// use rsntp::{AsyncSntpClient, SynchronizationResult, SynchroniztationError}; /// use chrono::{DateTime, Local}; /// /// async fn local_time() -> Result<SynchronizationResult, SynchroniztationError> { /// let client = AsyncSntpClient::new(); /// /// client.synchronize("pool.ntp.org").await /// } /// ``` pub async fn synchronize<A: ToServerAddrs>( &self, server_address: A, ) -> Result<SynchronizationResult, SynchroniztationError> { let mut receive_buffer = [0; Packet::ENCODED_LEN]; let socket = tokio::net::UdpSocket::bind(self.bind_address).await?; socket .connect(server_address.to_server_addrs(SNTP_PORT)) .await?; let request = Request::new(); socket.send(&request.as_bytes()).await?; let result_future = timeout(self.timeout, socket.recv_from(&mut receive_buffer)); let (bytes_received, server_address) = result_future.await.map_err(|_| { std::io::Error::new( std::io::ErrorKind::TimedOut, "Timeout while waiting for server reply", ) })??; let reply = Reply::new( request, Packet::from_bytes(&receive_buffer[..bytes_received], server_address)?, ); reply.process() } /// Sets synchronization timeout /// /// Sets the amount of time which the client waits for reply after the request has been sent. /// Default is 3 seconds. /// /// # Example /// /// ```no_run /// use rsntp::AsyncSntpClient; /// use std::time::Duration; /// /// let mut client = AsyncSntpClient::new(); /// client.set_timeout(Duration::from_secs(10)); /// ``` pub fn set_timeout(&mut self, timeout: Duration) { self.timeout = timeout; } /// Set UDP bind address /// /// Sets the local address which is used to send/receive UDP packets. By default it is /// "0.0.0.0:0" which means that an IPv4 address and a port is chosen automatically. /// /// To synchronize with IPv6 servers, you might need to set it to an IPv6 address. /// /// # Example /// /// ```no_run /// use rsntp::AsyncSntpClient; /// /// let mut client = AsyncSntpClient::new(); /// client.set_bind_address("192.168.0.1:0".parse().unwrap()); /// ``` pub fn set_bind_address(&mut self, address: SocketAddr) { self.bind_address = address; } } #[cfg(feature = "async")] impl Default for AsyncSntpClient { fn default() -> Self { AsyncSntpClient::new() } }