jaiden
/
chibiauth
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
chibiauth/README.md

33 lines
831 B
Markdown
Raw Normal View History

initial commit
2022-02-08 10:36:22 +00:00
# ChibiAuth
Naive OpenID Provider.
## Documentation
Relevant info for development is inside the `doc` folder.
For administration and usage, a reference handbook will be provided in the future.
cargo, doc, server: see commit details - cargo/deps: update dependencies - cargo/audit: remove unused advisory ignore - cargo/profile: add now-stable strip to release/smaller builds - cargo/feature: make SQLite bundling a feature - doc: document various design choices and plans - server/config: remove configuration file as 2 flags are enough - server/tracing: initial setup - server/db: initial schema draft design
2022-02-26 15:27:16 +00:00
## Usage
```sh
main: draft layout for subcommands & identity I think that API key generation and revocation should be done by calling the binary. Also, nuking all keys should be accessible. Public identity regeneration can use `init` again for now. I am thinking about seperating between confidential and public clients in the structure that keeps track of them. The map keeping track of the confidential should use the client base url as well. Expecting to overhaul how its done after checking RFC 8725 and other JOSE damage reduction strategies more throughly. (ugh)
2022-05-27 07:48:32 +00:00
chibiauth run --database=/path/to/database/of/chibiauth.db --port 9909 --base-url 'https://example.com'
cargo, doc, server: see commit details - cargo/deps: update dependencies - cargo/audit: remove unused advisory ignore - cargo/profile: add now-stable strip to release/smaller builds - cargo/feature: make SQLite bundling a feature - doc: document various design choices and plans - server/config: remove configuration file as 2 flags are enough - server/tracing: initial setup - server/db: initial schema draft design
2022-02-26 15:27:16 +00:00
```
* ChibiAuth will bind to localhost, bring your own TLS terminator.
* The database is just a SQLite file, feel free to use something like litestream.
git: add gitsigners and document about it
2022-05-31 09:08:25 +00:00
## Development
We prefer commit signing via SSH. The allowed signers are listed in `.gitsigners`.
To verify an entry such as following might be needed in `./.git/config`:
```ini
[gpg.ssh]
allowedSignersFile = .gitsigners
```
initial commit
2022-02-08 10:36:22 +00:00
## License
This repository is licensed under the EUPL-1.2. An English copy of the license text is available under `LICENSE`.