src/utils.rs

   1 // Copyright 2021-2022 Ian Jackson and contributors to Hippotat
   2 // SPDX-License-Identifier: GPL-3.0-or-later
   3 // There is NO WARRANTY.
   4
   5 use crate::prelude::*;
   6
   7 #[ext(pub)]
   8 impl<T> T where T: Debug {
   9   fn to_debug(&self) -> String { format!("{:?}", self) }
  10 }
  11
  12 #[ext(pub)]
  13 impl<T,E> Result<T,E> where AE: From<E> {
  14   fn dcontext<D:Debug>(self, d: D) -> anyhow::Result<T> {
  15     self.map_err(|e| AE::from(e)).with_context(|| d.to_debug())
  16   }
  17 }
  18
  19 #[derive(Error,Debug)]
  20 pub enum ReadLimitedError {
  21   #[error("maximum size {limit} exceeded")]
  22   Truncated { sofar: Box<[u8]>, limit: usize },
  23
  24   #[error("HTTP error {0}")]
  25   Hyper(#[from] hyper::Error),
  26 }
  27
  28 impl ReadLimitedError {
  29   pub fn discard_data(&mut self) { match self {
  30     ReadLimitedError::Truncated { sofar,.. } => { mem::take(sofar); },
  31     _ => { },
  32   } }
  33 }
  34 #[ext(pub)]
  35 impl<T> Result<T,ReadLimitedError> {
  36   fn discard_data(self) -> Self {
  37     self.map_err(|mut e| { e.discard_data(); e })
  38   }
  39 }
  40
  41 // Works around the lack of ErrorKind::IsADirectory
  42 // #![feature(io_error_more)]
  43 // https://github.com/rust-lang/rust/issues/86442
  44 #[ext(pub)]
  45 impl io::Error {
  46   fn is_is_a_directory(&self) -> bool {
  47     self.raw_os_error()
  48       .unwrap_or_else(|| panic!(
  49  "trying to tell whether Kind is IsADirectory for non-OS error io::Error {}",
  50         self))
  51       == libc::EISDIR
  52   }
  53 }
  54
  55 #[throws(ReadLimitedError)]
  56 pub async fn read_limited_bytes<S>(limit: usize, initial: Box<[u8]>,
  57                                    capacity: usize,
  58                                    stream: &mut S) -> Box<[u8]>
  59 where S: futures::Stream<Item=Result<hyper::body::Bytes,hyper::Error>>
  60          + Debug + Unpin,
  61       // we also require that the Stream is cancellation-safe
  62 {
  63   let mut accum = initial.into_vec();
  64   let capacity = min(limit, capacity);
  65   if capacity > accum.len() { accum.reserve(capacity - accum.len()); }
  66   while let Some(item) = stream.next().await {
  67     let b = item?;
  68     accum.extend(b);
  69     if accum.len() > limit {
  70       throw!(ReadLimitedError::Truncated { limit, sofar: accum.into() })
  71     }
  72   }
  73   accum.into()
  74 }
  75
  76 pub fn time_t_now() -> u64 {
  77   SystemTime::now()
  78     .duration_since(UNIX_EPOCH)
  79     .unwrap_or_else(|_| Duration::default()) // clock is being weird
  80     .as_secs()
  81 }
  82
  83 use sha2::Digest as _;
  84
  85 pub type HmacH = sha2::Sha256;
  86 pub const HMAC_B: usize = 64;
  87 pub const HMAC_L: usize = 32;
  88
  89 pub fn token_hmac(key: &[u8], message: &[u8]) -> [u8; HMAC_L] {
  90   let key = {
  91     let mut padded = [0; HMAC_B];
  92     if key.len() > padded.len() {
  93       let digest: [u8; HMAC_L] = HmacH::digest(key).into();
  94       padded[0..HMAC_L].copy_from_slice(&digest);
  95     } else {
  96       padded[0.. key.len()].copy_from_slice(key);
  97     }
  98     padded
  99   };
 100   let mut ikey = key;  for k in &mut ikey { *k ^= 0x36; }
 101   let mut okey = key;  for k in &mut okey { *k ^= 0x5C; }
 102
 103   //dbg!(DumpHex(&key), DumpHex(message), DumpHex(&ikey), DumpHex(&okey));
 104
 105   let h1 = HmacH::new()
 106     .chain(&ikey)
 107     .chain(message)
 108     .finalize();
 109   let h2 = HmacH::new()
 110     .chain(&okey)
 111     .chain(h1)
 112     .finalize();
 113   h2.into()
 114 }
 115
 116 #[test]
 117 fn hmac_test_vectors(){
 118   // C&P from RFC 4231
 119   let vectors = r#"
 120    Key =          0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b
 121                   0b0b0b0b                          (20 bytes)
 122    Data =         4869205468657265                  ("Hi There")
 123
 124    HMAC-SHA-256 = b0344c61d8db38535ca8afceaf0bf12b
 125                   881dc200c9833da726e9376c2e32cff7
 126
 127
 128    Key =          4a656665                          ("Jefe")
 129    Data =         7768617420646f2079612077616e7420  ("what do ya want ")
 130                   666f72206e6f7468696e673f          ("for nothing?")
 131
 132    HMAC-SHA-256 = 5bdcc146bf60754e6a042426089575c7
 133                   5a003f089d2739839dec58b964ec3843
 134
 135
 136    Key =          aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 137                   aaaaaaaa                          (20 bytes)
 138    Data =         dddddddddddddddddddddddddddddddd
 139                   dddddddddddddddddddddddddddddddd
 140                   dddddddddddddddddddddddddddddddd
 141                   dddd                              (50 bytes)
 142
 143    HMAC-SHA-256 = 773ea91e36800e46854db8ebd09181a7
 144                   2959098b3ef8c122d9635514ced565fe
 145
 146
 147    Key =          0102030405060708090a0b0c0d0e0f10
 148                   111213141516171819                (25 bytes)
 149    Data =         cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd
 150                   cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd
 151                   cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd
 152                   cdcd                              (50 bytes)
 153
 154    HMAC-SHA-256 = 82558a389a443c0ea4cc819899f2083a
 155                   85f0faa3e578f8077a2e3ff46729665b
 156
 157
 158
 159    Key =          aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 160                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 161                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 162                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 163                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 164                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 165                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 166                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 167                   aaaaaa                            (131 bytes)
 168    Data =         54657374205573696e67204c61726765  ("Test Using Large")
 169                   72205468616e20426c6f636b2d53697a  ("r Than Block-Siz")
 170                   65204b6579202d2048617368204b6579  ("e Key - Hash Key")
 171                   204669727374                      (" First")
 172
 173    HMAC-SHA-256 = 60e431591ee0b67f0d8a26aacbf5b77f
 174                   8e0bc6213728c5140546040f0ee37f54
 175
 176    Key =          aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 177                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 178                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 179                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 180                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 181                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 182                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 183                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 184                   aaaaaa                            (131 bytes)
 185    Data =         54686973206973206120746573742075  ("This is a test u")
 186                   73696e672061206c6172676572207468  ("sing a larger th")
 187                   616e20626c6f636b2d73697a65206b65  ("an block-size ke")
 188                   7920616e642061206c61726765722074  ("y and a larger t")
 189                   68616e20626c6f636b2d73697a652064  ("han block-size d")
 190                   6174612e20546865206b6579206e6565  ("ata. The key nee")
 191                   647320746f2062652068617368656420  ("ds to be hashed ")
 192                   6265666f7265206265696e6720757365  ("before being use")
 193                   642062792074686520484d414320616c  ("d by the HMAC al")
 194                   676f726974686d2e                  ("gorithm.")
 195
 196    HMAC-SHA-256 = 9b09ffa71b942fcb27635fbcd5b0e944
 197                   bfdc63644f0713938a7f51535c3a35e2
 198 "#;
 199   let vectors = regex_replace_all!{
 200     r#"\(.*\)"#,
 201     vectors.trim_end(),
 202     |_| "",
 203   };
 204   let vectors = regex_replace_all!{
 205     r#" *\n                  "#,
 206     &vectors,
 207     |_| "",
 208   };
 209   let vectors = regex_replace_all!{
 210     r#"\s*\n"#,
 211     &vectors,
 212     |_| "\n",
 213   };
 214   let mut lines = vectors.split('\n');
 215   assert_eq!( lines.next().unwrap(), "" );
 216   let mut get = |prefix| {
 217     let l = lines.next()?;
 218     dbg!(l);
 219     let b = l.strip_prefix(prefix).unwrap().as_bytes().chunks(2)
 220       .map(|s| str::from_utf8(s).unwrap())
 221       .map(|s| { assert_eq!(s.len(), 2); u8::from_str_radix(s,16).unwrap() })
 222       .collect::<Vec<u8>>();
 223     Some(b)
 224   };
 225   while let Some(key) = get("   Key =          ") {
 226     let data = get("   Data =         ").unwrap();
 227     let exp = get("   HMAC-SHA-256 = ").unwrap();
 228     let got = token_hmac(&key, &data);
 229     assert_eq!(&got[..], &exp);
 230   }
 231 }