Skip to content
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

Jump to bottom

Update api-authentication.md #2

Closed
wants to merge 2 commits into from
Closed

Update api-authentication.md #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f22a1c
Update api-authentication.md
mro Jun 15, 2016
a025ca3
Update api-authentication.md
mro Jun 15, 2016
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
15 changes: 15 additions & 0 deletions api-authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# Shaarli API Authentication

## Assumptions and preconditions

1. there is a webserver,
2. there is a shaarli instance,
3. it should be **KISS** – both on server and client side,
4. it should be **as secure as shaarli** itself (ban after fails),
5. there is only **one user**, so there's no finer authorisation

## Approaches

1. Webserver does the auth or
2. get a token from the shaarli webinterface or
3. do a full cycle auth with uid+pwd and e.g. HTTP Digest, OAuth2 or Kerberos.

I'd propose 2., salt the token and send it in a custom HTTP Request Header, e.g. `SHAARLI_SALTED_AUTH_TOKEN`. It's simple on server and client but a little ugly to set up for testing (no api call to get the token).