ssi-jwt 0.6.0

Implementation of JWT for the ssi library.
Documentation
use std::str::FromStr;

use chrono::{prelude::*, Duration, LocalResult};
use ordered_float::NotNan;
use serde::{Deserialize, Serialize, Serializer};

/// JSON numeric value representing the number of seconds from
/// 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap
/// seconds.
///
/// See: <https://datatracker.ietf.org/doc/html/rfc7519#section-2>
#[derive(Debug, Serialize, Deserialize, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NumericDate(#[serde(serialize_with = "interop_serialize")] NotNan<f64>);

/// As many JWT libraries only accept integers, this serializer aims for a
/// middle ground by serializing a date as an integer if it does not have
/// fractional seconds. Otherwise a trailing `.0` is always present.
fn interop_serialize<S>(x: &f64, s: S) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    if x.fract() != 0.0 {
        s.serialize_f64(*x)
    } else {
        s.serialize_i64(*x as i64)
    }
}

#[derive(thiserror::Error, Debug)]
pub enum NumericDateConversionError {
    #[error("Not a number")]
    Nan,

    #[error("Invalid float literal")]
    InvalidFloatLiteral,
}

impl From<ordered_float::FloatIsNan> for NumericDateConversionError {
    fn from(_: ordered_float::FloatIsNan) -> Self {
        Self::Nan
    }
}

impl NumericDate {
    /// Return the f64-valued number of seconds represented by this NumericDate.
    pub fn as_seconds(self) -> f64 {
        *self.0
    }

    /// Try to create NumericDate from a f64 value, returning error upon out-of-range.
    pub fn try_from_seconds(seconds: f64) -> Result<Self, NumericDateConversionError> {
        let seconds = NotNan::new(seconds)?;
        Ok(NumericDate(seconds))
    }

    /// Decompose NumericDate for use in Utc.timestamp and Utc.timestamp_opt
    fn into_whole_seconds_and_fractional_nanoseconds(self) -> (i64, u32) {
        let whole_seconds = self.0.floor() as i64;
        let fractional_nanoseconds = ((self.0 - self.0.floor()) * 1_000_000_000.0).floor() as u32;
        assert!(fractional_nanoseconds < 1_000_000_000);
        (whole_seconds, fractional_nanoseconds)
    }
}

/// Note that this will panic if the addition goes out-of-range.
impl std::ops::Add<Duration> for NumericDate {
    type Output = NumericDate;
    fn add(self, rhs: Duration) -> Self::Output {
        let self_dtu: DateTime<Utc> = self.into();
        Self::Output::from(self_dtu + rhs)
    }
}

/// Note that this will panic if the addition goes out-of-range.
impl std::ops::Sub<NumericDate> for NumericDate {
    type Output = Duration;
    fn sub(self, rhs: NumericDate) -> Self::Output {
        let self_dtu: DateTime<Utc> = self.into();
        let rhs_dtu: DateTime<Utc> = rhs.into();
        self_dtu - rhs_dtu
    }
}

/// Note that this will panic if the addition goes out-of-range.
impl std::ops::Sub<Duration> for NumericDate {
    type Output = NumericDate;
    fn sub(self, rhs: Duration) -> Self::Output {
        let self_dtu: DateTime<Utc> = self.into();
        Self::Output::from(self_dtu - rhs)
    }
}

impl From<i32> for NumericDate {
    fn from(value: i32) -> Self {
        Self(NotNan::new(value as f64).unwrap())
    }
}

impl TryFrom<i64> for NumericDate {
    type Error = NumericDateConversionError;

    fn try_from(value: i64) -> Result<Self, Self::Error> {
        Self::try_from_seconds(value as f64)
    }
}

impl TryFrom<f64> for NumericDate {
    type Error = NumericDateConversionError;

    fn try_from(value: f64) -> Result<Self, Self::Error> {
        Self::try_from_seconds(value)
    }
}

impl From<DateTime<Utc>> for NumericDate {
    fn from(dtu: DateTime<Utc>) -> Self {
        // Have to take seconds and nanoseconds separately in order to get the full allowable
        // range of microsecond-precision values as described above.
        let whole_seconds = dtu.timestamp() as f64;
        let fractional_seconds = match dtu.timestamp_nanos_opt() {
            Some(nanos) => nanos.rem_euclid(1_000_000_000) as f64 * 1.0e-9,
            None => dtu.timestamp_micros().rem_euclid(1_000_000) as f64 * 1.0e-6,
        };

        Self::try_from_seconds(whole_seconds + fractional_seconds)
            // UNWRAP SAFETY: input value can't be NaN nor infinite.
            .unwrap()
    }
}

impl From<DateTime<FixedOffset>> for NumericDate {
    fn from(dtfo: DateTime<FixedOffset>) -> Self {
        DateTime::<Utc>::from(dtfo).into()
    }
}

impl From<NumericDate> for DateTime<Utc> {
    fn from(nd: NumericDate) -> Self {
        let (whole_seconds, fractional_nanoseconds) =
            nd.into_whole_seconds_and_fractional_nanoseconds();
        // `timestamp` (deprecated) was already doing an unwrap
        Utc.timestamp_opt(whole_seconds, fractional_nanoseconds)
            .unwrap()
    }
}

impl From<NumericDate> for LocalResult<DateTime<Utc>> {
    fn from(nd: NumericDate) -> Self {
        let (whole_seconds, fractional_nanoseconds) =
            nd.into_whole_seconds_and_fractional_nanoseconds();
        Utc.timestamp_opt(whole_seconds, fractional_nanoseconds)
    }
}

impl FromStr for NumericDate {
    type Err = NumericDateConversionError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let f: NotNan<f64> = s
            .parse()
            .map_err(|_| NumericDateConversionError::InvalidFloatLiteral)?;
        Ok(Self(f))
    }
}