shttpd/README

.. SPDX-License-Identifier: GPL-2.0 or GPL-3.0
.. Copyright © 2018-2019 Ariadne Devos

# s^2 Web Stuff

s^2 is -- so far -- a personal project to write secure and sandboxed software
for doing things on the web. E.g. a web server and mail server and client.
In contrast to seemingly wide-held opinion, except perhaps by Intel,
it doesn't view speculative execution as an evil (*).

(*)
  Except Meltdown and perhaps some others ... The model of Spectre I
  address is: all branches may temporarily be ignored or falsily taken and all
  indirect branch must be retpolined. Checking the page bits may be speculated.

  s^2 should be safe against Speculative Store Bypass, Bounds Check Bypass,
  Branch Target Injection. Foreshadow is not relevant. Lazy FP State Restore
  is a bug of the kernel.

As an extension to what nginx supports, s^2 will allow migration to
different versions and machines. The source code is intended to be readable.

There is some architecture-specific code for Spectre mitigation.
Linux is supported, and the BSDs will be. W32 might be possible.

Do `autoreconf` && `./configure` && `make` to compile.
A CFLAGS argument of "$(sed '/^[*/#]/d' CFLAGS |tr '\n' ' ')"
is recommended, although compiler support may vary.

## Stuff

- [ ] apps/website.md: for static web sites, may be extended
- [ ] apps/torrent.md (TODO: bittorrent, webtorrent, Dat, IPFS, gnunet?)
- [ ] apps/mail.md: e-mail client and server, encrypted, signed, image support)
- [ ] apps/blog.md (TODO)
- [ ] apps/git.md (TODO)
- [ ] apps/ci.md (TODO)

## Some design details

OO is used, except that inheritance isn't really used. Nothing is overridden.
Generics may be used sparely. SMP may be used for efficiency (power-efficiency
according to Intel?), but is not mandatory. Tasks of the same type are batched
to reduce cache pressure and branch misprediction.

## Contact

Do NOT send a mail to Ariadne Devos <m-m@mailoo.org>, as I can't login anymore.
Instead, open a bug at <https://notabug.org/ariadne/shttpd>. Patches, ideas and
general discussion are welcome.

## Licensing

The license is GPL-2.0 and GPL-3.0, see `doc/people/license-copyright.rst`
for details. The texts are respectively in `doc/people/gpl-2.rst` and
`doc/people/gpl-3.rst`.