Fix typos and serve with `static` (#12)

Co-authored-by: Lysander Trischler <software@lyse.isobeef.org>
Reviewed-on: #12
Reviewed-by: James Mills <james@mills.io>
Co-authored-by: lyse <lyse@noreply@mills.io>
Co-committed-by: lyse <lyse@noreply@mills.io>
pull/13/head
lyse 4 months ago committed by James Mills
parent 813e889b58
commit f58cffe3a5
  1. 2
      .zs/layout.html
  2. 6
      Makefile
  3. 17
      spec.md

@ -16,7 +16,7 @@
<small>
Last modified <time datetime="{{ date +%Y-%m-%dT%H:%M:%SZ%:z }}">{{ date }}</time> ·
Copyright © 2022-present All Rights Reserved James Mills ·
Built with <a href="https://git.mills.io/prologic/zs">zs
Built with <a href="https://git.mills.io/prologic/zs">zs</a>
</small>
</footer>
</body>

@ -11,7 +11,11 @@ deps:
dev : DEBUG=1
dev : build
@zs watch
@bash -c 'trap "jobs -p | xargs kill" EXIT; \
zs watch & \
static -r .pub & \
echo http://localhost:8000/; \
wait'
build:
@zs build

@ -110,7 +110,8 @@ It is encouraged (*but optional*) that appropriate Cross-Origin-Resource-Sharing
```
# GET requests must respond with:
# Access-Control-Allow-Headers: * # Access-Control-Allow-Origin: *
# Access-Control-Allow-Headers: *
# Access-Control-Allow-Origin: *
$ curl -v -X GET "https://domain.tld/.well-known/salty/xxx.json"
...
< access-control-expose-headers: *
@ -118,7 +119,8 @@ $ curl -v -X GET "https://domain.tld/.well-known/salty/xxx.json"
< access-control-allow-origin: *
# OPTIONS reqeusts must respond with:
# Access-Control-Allow-Headers: * # Access-Control-Allow-Origin: *
# Access-Control-Allow-Headers: *
# Access-Control-Allow-Origin: *
$ curl -v -X OPTIONS "https://domain.tld/.well-known/salty/xxx.json"
...
< access-control-expose-headers: *
@ -136,7 +138,7 @@ It is recommended that Directory Listing be disabled for serving the
Well-Known URI resource(s) to prevent crawlers and bad actors from harvesting
Salty addresses.
### Discovery Document
### Discovery Document
The contents of a User's Well-Known Configuration file contains the following
JSON document:
@ -150,7 +152,7 @@ JSON document:
Example: `prologic@mills.io` has the following Well-Known URI:
https://mills.io/.well-known/salty/d3d52221e8da5a8ae012f4e2db0631c181f4156f0edcde5cffa25b347c7ceda8.json and contains
https://mills.io/.well-known/salty/d3d52221e8da5a8ae012f4e2db0631c181f4156f0edcde5cffa25b347c7ceda8.json
This contains the following JSON document:
@ -190,11 +192,12 @@ The format is each message contains:
- An RFC3339 time-stamp in UTC to the second
- The Identity of the sender
- The contents of the actual message
- Newlines in Message(s) are encoded as unicode LINE SEPARATOR (\u2028)
- Newlines in Message(s) are encoded as unicode LINE SEPARATOR (`\u2028`)
**NOTE:**
> It is important that the time-stamp be in UTC so that Messages have a
> Consistent time and it is the responsibility of Clients to represent the time-stamp appropriately (for example in local time).
> consistent time and it is the responsibility of Clients to represent the time-stamp appropriately (for example in local time).
The Identity of the sender is simply the Sender's `user@domain.tld` used as part of the Discovery process and bares no meaning to the User's actual identity or in any way carries any personal identifiable information about the user (other than they are `nick` at `domain.tld`).
@ -219,7 +222,7 @@ The support Events are currently:
## Delivery
Once a Message has been Signed and Encrypted to all intended recipients, those recipients are looked up using the Discovery process. Then reach message is sent to the recipient's Endpoint(s).
Once a Message has been Signed and Encrypted to all intended recipients, those recipients are looked up using the Discovery process. Then each message is sent to the recipient's Endpoint(s).
At this point the exact serialisation of the Signed and Encrypted Message is not important, however it is recommended to use the Saltpack Armour encoding.

Loading…
Cancel
Save