README.md

   1 Hippotat - asinine IP over HTTP
   2 ===============================
   3
   4 Hippotat is a system to allow you to use your normal VPN,
   5 ssh, and other applications, even in broken network environments
   6 that are only ever tested with "web stuff".
   7
   8 Packets are parcelled up into HTTP POST requests, resembling
   9 form submissions (or JavaScript XMLHttpRequest traffic),
  10 and the returned packets arrive via the HTTP response bodies.
  11
  12 Scenario
  13 --------
  14
  15 You're in a cafe or a hotel, trying to use the provided wifi.
  16 But it's not working.  You discover that port 80 and port 443
  17 are open, but the wifi forbids all other traffic.
  18
  19 Never mind, start up your hippotat client.  Now you have connectivity.
  20 Your VPN and SSH and so on run over Hippotat.
  21 The result is not very efficient, but it does work.
  22
  23 The design goal is that if the your barista's phone works OK,
  24 or the hotel concierge can see Google on their computer,
  25 you can use the internet properly, despite
  26 whatever breakage and nonsense.
  27
  28 So Hippotat is an alternative to the futile strategy of
  29 trying to report technical bugs, or stupid portblocks,
  30 in terrible wifi systems.
  31
  32 Of course it can't always help.
  33 If the wifi is bad enough that one's hosts'
  34 devices don't work reliably either,
  35 hopefully you can probably get them to reboot the magic box,
  36 or maybe get some money off, if wifi was supposed to be included.
  37
  38 Non-goals
  39 ---------
  40
  41 **Hippotat does not provide meaningful encryption**.
  42 You should use protocols over the top of it
  43 that you would be happy to run over the public internet:
  44 encrypted ones, like a VPN or SSH.
  45
  46 Use of Hippotat is not intended to be undetectable,
  47 or even particularly hard to distinguish from other uses of HTTP,
  48 should someone want to go to the effort.
  49 Rather, it is intended to be deployed against idiocy, ignorance,
  50 and incompetence.
  51
  52 Protection against interference is limited to
  53 trying to defend against off-path attackers, and
  54 arranging that formerly-on-path attackers'
  55 ability to do harm will expire reasonably soon.
  56
  57 Hippotat is not designed to allow you to "leech" internet access
  58 from "closed" Wifi.
  59 It won't work if "normal web access" doesn't.
  60 You might try IP-over-DNS systems for that.