5
0
Fork 0
backend-auth/README.md

19 lines
956 B
Markdown
Raw Normal View History

2019-02-17 08:38:49 +08:00
# backend-auth
2019-02-22 23:08:10 +08:00
Beep backend auth proxy. At long last, something done properly in Rust. My ancestors are smiling at me, Imperial, can you say the same?
Is basically tailored just for traefik's Forward Authentication system. It takes a `GET`, `POST`, `PUT`, `PATCH` or `DELETE` request, reads a Bearer Auth JWT token if available. Alternatively, the token can be supplied in the querystring as `token`. Tokens in the Authorization header override tokens in the querystring. If it is not available or invalid, request fails with 4XX and traefik rejects the request. Otherwise, a success response is returned with a `X-User-Claim` header containing serialised user information. `OPTIONS` requests are allowed to pass through wholesale.
2019-02-22 23:08:10 +08:00
## Contents of `X-User-Claim`
```json
{
"userid": "<userid>",
"clientid": "<clientid>"
}
```
## Errors
`auth` responses with `400` if there is no token supplied, or `401` if there is an error processing the token.