src/utils.rs

   1 // Copyright 2021 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 { limit: usize },
  23
  24   #[error("HTTP error {0}")]
  25   Hyper(#[from] hyper::Error),
  26 }
  27
  28 #[throws(ReadLimitedError)]
  29 pub async fn read_limited_bytes<S>(limit: usize, stream: &mut S) -> Box<[u8]>
  30 where S: futures::Stream<Item=Result<hyper::body::Bytes,hyper::Error>>
  31          + Debug + Unpin,
  32       // we also require that the Stream is cancellation-safe
  33 {
  34   let mut accum = vec![];
  35   while let Some(item) = stream.next().await {
  36     let b = item?;
  37     accum.extend(b);
  38     if accum.len() > limit {
  39       throw!(ReadLimitedError::Truncated { limit })
  40     }
  41   }
  42   accum.into()
  43 }
  44
  45 use sha2::Digest as _;
  46
  47 type HmacH = sha2::Sha256;
  48 const HMAC_B: usize = 64;
  49 const HMAC_L: usize = 32;
  50
  51 pub fn token_hmac(key: &[u8], message: &[u8]) -> [u8; HMAC_L] {
  52   let key = {
  53     let mut padded = [0; HMAC_B];
  54     if key.len() > padded.len() {
  55       let digest: [u8; HMAC_L] = HmacH::digest(key).into();
  56       padded[0..HMAC_L].copy_from_slice(&digest);
  57     } else {
  58       padded[0.. key.len()].copy_from_slice(key);
  59     }
  60     padded
  61   };
  62   let mut ikey = key;  for k in &mut ikey { *k ^= 0x36; }
  63   let mut okey = key;  for k in &mut okey { *k ^= 0x5C; }
  64
  65 //dbg!(&key, &ikey, &okey);
  66
  67   let h1 = HmacH::new()
  68     .chain(&ikey)
  69     .chain(message)
  70     .finalize();
  71   let h2 = HmacH::new()
  72     .chain(&okey)
  73     .chain(h1)
  74     .finalize();
  75   h2.into()
  76 }
  77
  78 #[test]
  79 fn hmac_test_vectors(){
  80   // C&P from RFC 4231
  81   let vectors = r#"
  82    Key =          0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b
  83                   0b0b0b0b                          (20 bytes)
  84    Data =         4869205468657265                  ("Hi There")
  85
  86    HMAC-SHA-256 = b0344c61d8db38535ca8afceaf0bf12b
  87                   881dc200c9833da726e9376c2e32cff7
  88
  89
  90    Key =          4a656665                          ("Jefe")
  91    Data =         7768617420646f2079612077616e7420  ("what do ya want ")
  92                   666f72206e6f7468696e673f          ("for nothing?")
  93
  94    HMAC-SHA-256 = 5bdcc146bf60754e6a042426089575c7
  95                   5a003f089d2739839dec58b964ec3843
  96
  97
  98    Key =          aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  99                   aaaaaaaa                          (20 bytes)
 100    Data =         dddddddddddddddddddddddddddddddd
 101                   dddddddddddddddddddddddddddddddd
 102                   dddddddddddddddddddddddddddddddd
 103                   dddd                              (50 bytes)
 104
 105    HMAC-SHA-256 = 773ea91e36800e46854db8ebd09181a7
 106                   2959098b3ef8c122d9635514ced565fe
 107
 108
 109    Key =          0102030405060708090a0b0c0d0e0f10
 110                   111213141516171819                (25 bytes)
 111    Data =         cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd
 112                   cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd
 113                   cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd
 114                   cdcd                              (50 bytes)
 115
 116    HMAC-SHA-256 = 82558a389a443c0ea4cc819899f2083a
 117                   85f0faa3e578f8077a2e3ff46729665b
 118
 119
 120
 121    Key =          aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 122                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 123                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 124                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 125                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 126                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 127                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 128                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 129                   aaaaaa                            (131 bytes)
 130    Data =         54657374205573696e67204c61726765  ("Test Using Large")
 131                   72205468616e20426c6f636b2d53697a  ("r Than Block-Siz")
 132                   65204b6579202d2048617368204b6579  ("e Key - Hash Key")
 133                   204669727374                      (" First")
 134
 135    HMAC-SHA-256 = 60e431591ee0b67f0d8a26aacbf5b77f
 136                   8e0bc6213728c5140546040f0ee37f54
 137
 138    Key =          aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 139                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 140                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 141                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 142                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 143                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 144                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 145                   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 146                   aaaaaa                            (131 bytes)
 147    Data =         54686973206973206120746573742075  ("This is a test u")
 148                   73696e672061206c6172676572207468  ("sing a larger th")
 149                   616e20626c6f636b2d73697a65206b65  ("an block-size ke")
 150                   7920616e642061206c61726765722074  ("y and a larger t")
 151                   68616e20626c6f636b2d73697a652064  ("han block-size d")
 152                   6174612e20546865206b6579206e6565  ("ata. The key nee")
 153                   647320746f2062652068617368656420  ("ds to be hashed ")
 154                   6265666f7265206265696e6720757365  ("before being use")
 155                   642062792074686520484d414320616c  ("d by the HMAC al")
 156                   676f726974686d2e                  ("gorithm.")
 157
 158    HMAC-SHA-256 = 9b09ffa71b942fcb27635fbcd5b0e944
 159                   bfdc63644f0713938a7f51535c3a35e2
 160 "#;
 161   let vectors = regex_replace_all!{
 162     r#"\(.*\)"#,
 163     vectors.trim_end(),
 164     |_| "",
 165   };
 166   let vectors = regex_replace_all!{
 167     r#" *\n                  "#,
 168     &vectors,
 169     |_| "",
 170   };
 171   let vectors = regex_replace_all!{
 172     r#"\s*\n"#,
 173     &vectors,
 174     |_| "\n",
 175   };
 176   let mut lines = vectors.split('\n');
 177   assert_eq!( lines.next().unwrap(), "" );
 178   let mut get = |prefix| {
 179     let l = lines.next()?;
 180     dbg!(l);
 181     let b = l.strip_prefix(prefix).unwrap().as_bytes().chunks(2)
 182       .map(|s| str::from_utf8(s).unwrap())
 183       .map(|s| { assert_eq!(s.len(), 2); u8::from_str_radix(s,16).unwrap() })
 184       .collect::<Vec<u8>>();
 185     Some(b)
 186   };
 187   while let Some(key) = get("   Key =          ") {
 188     let data = get("   Data =         ").unwrap();
 189     let exp = get("   HMAC-SHA-256 = ").unwrap();
 190     let got = token_hmac(&key, &data);
 191     assert_eq!(&got[..], &exp);
 192   }
 193 }