mirror of
https://github.com/falk-werner/webfuse
synced 2024-10-27 20:34:10 +00:00
31 lines
1.0 KiB
Markdown
31 lines
1.0 KiB
Markdown
|
# Authentication
|
||
|
|
|
||
|
|
Webfuse supports token-based authentication using HTTP headers. To activate authentication, two command line option needs to be given:
|
||
|
|
|
||
|
|
- `--wf-authenticator PATH`
|
||
|
|
allows to specify an executable used for authentication
|
||
|
|
- `--wf-auth-header HEADER`
|
||
|
|
allows to specify the HTTP header used for authentication
|
||
|
|
|
||
|
|
## Authenticator
|
||
|
|
|
||
|
|
An authenticator is an executable or script used for token-based
|
||
|
|
authentication. During HTTP handshake, webfuse will scan for the
|
||
|
|
configured HTTP header and invoke the authenticator.
|
||
|
|
|
||
|
|
authenticator TOKEN
|
||
|
|
|
||
|
|
The provided `token` contains the contents of the HTTP header.
|
||
|
|
|
||
|
|
## Header restrictions
|
||
|
|
|
||
|
|
Note that not any HTTP header can be specified using `--wf-auth-header`
|
||
|
|
option. The following headers are supported:
|
||
|
|
|
||
|
|
- `X-Auth-Token`
|
||
|
|
- `Authorization`
|
||
|
|
|
||
|
|
In addition to that, any non-standard header can be specified.
|
||
|
|
|
||
|
|
Due to implementation limitation, most standard headers can not be used by now. Please let us know, when you intend to use a header that is not supported yet. Please create an issue in that case.
|