summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 1470ba72db0c9a8818a90f0a53ce2284154a914c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# identicons-web

VFace identity generator and verifier for the Virebent web service.

The project contains:

- `index.php`, the PHP verifier and identity page generator;
- `identicons-cli.go`, a dependency-free Go CLI implementing the
  Ch1ffr3punk identicon rendering used by VFace and Aegis.

## Build the CLI

```sh
go build -buildvcs=false -o identicons-cli .
```

The PHP application expects the compiled `identicons-cli` beside `index.php`
and requires PHP sodium support. Deploy the directory behind a PHP-capable web
server. Do not make uploaded files executable or writable by the web process.

## VFace input

The deterministic identity input is `username|email|canonical-ed25519-public-key`.
The service publishes verification data and PNG hashes, but private keys must
remain on the user's device and must never be uploaded or committed.