Skip to content

docs(auth): document X-Tinyauth-Authorization header for Basic-auth apps #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manysuq wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(auth): document X-Tinyauth-Authorization header for Basic-auth apps #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/content/docs/docs/reference/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ flowchart BR

Tinyauth by default allows for authentication using the `Authorization` header with the Basic scheme. This means that clients can send credentials in the format of `username:password` encoded in Base64, which Tinyauth will decode and verify against the stored user configuration.

Some apps use the `Authorization` header with the Basic scheme for their own authentication, which conflicts with Tinyauth's Basic authentication. For these apps, send the credentials in the `X-Tinyauth-Authorization` header instead, using the same `Basic base64(username:password)` format:

```http
X-Tinyauth-Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
```

When this header is present, Tinyauth authenticates with it and ignores the `Authorization` header, so the upstream app receives the original `Authorization` value untouched. If the header is present but malformed, Tinyauth responds with `401 Unauthorized` instead of falling back to `Authorization`.

:::caution
When using Basic Authentication, accounts that use TOTP will not be able to authenticate, as the TOTP code cannot be provided in the `Authorization` header. For accounts with TOTP enabled, consider using cookie-based authentication.
:::
Expand Down