github-mirror/rclone
github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-02-22 04:42:10 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: restore lost auth proxy logs

Browse Source 
These came from f2a789ea98b14bc7 which unfortunately added the docs to
the auto generated files.
This commit is contained in:
Nick Craig-Wood 2020-02-10 14:31:59 +00:00
parent dfb710eab7
commit de93852512
5 changed files with 85 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
cmd/serve/proxy/proxy.go
View File

@ -29,6 +29,10 @@ rclone will use that program to generate backends on the fly which
then are used to authenticate incoming requests. This uses a simple then are used to authenticate incoming requests. This uses a simple
JSON based protocl with input on STDIN and output on STDOUT. JSON based protocl with input on STDIN and output on STDOUT.
**PLEASE NOTE:** |--auth-proxy| and |--authorized-keys| cannot be used
together, if |--auth-proxy| is set the authorized keys option will be
ignored.
There is an example program There is an example program
[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py)
in the rclone source code. in the rclone source code.
@ -46,7 +50,8 @@ This config generated must have this extra parameter
And it may have this parameter And it may have this parameter
- |_obscure| - comma separated strings for parameters to obscure - |_obscure| - comma separated strings for parameters to obscure
For example the program might take this on STDIN If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:
||| |||
{ {
@ -55,7 +60,17 @@ For example the program might take this on STDIN
} }
||| |||
And return this on STDOUT If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:
|||
{
"user": "me",
"public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf"
}
|||
And as an example return this on STDOUT
||| |||
{ {
@ -69,7 +84,7 @@ And return this on STDOUT
||| |||
This would mean that an SFTP backend would be created on the fly for This would mean that an SFTP backend would be created on the fly for
the |user| and |pass| returned in the output to the host given. Note the |user| and |pass|/|public_key| returned in the output to the host given. Note
that since |_obscure| is set to |pass|, rclone will obscure the |pass| that since |_obscure| is set to |pass|, rclone will obscure the |pass|
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
@ -81,8 +96,8 @@ in the output and the user to |user|. For security you'd probably want
to restrict the |host| to a limited list. to restrict the |host| to a limited list.
Note that an internal cache is keyed on |user| so only use that for Note that an internal cache is keyed on |user| so only use that for
configuration, don't use |pass|. This also means that if a user's configuration, don't use |pass| or |public_key|. This also means that if a user's
password is changed the cache will need to expire (which takes 5 mins) password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect. before it takes effect.
This can be used to build general purpose proxies to any kind of This can be used to build general purpose proxies to any kind of

2
cmd/serve/sftp/sftp.go
View File

@ -71,7 +71,7 @@ control the stats printing.
You must provide some means of authentication, either with --user/--pass, You must provide some means of authentication, either with --user/--pass,
an authorized keys file (specify location with --authorized-keys - the an authorized keys file (specify location with --authorized-keys - the
default is the same as ssh) or set the --no-auth flag for no default is the same as ssh), an --auth-proxy, or set the --no-auth flag for no
authentication when logging in. authentication when logging in.
Note that this also implements a small number of shell commands so Note that this also implements a small number of shell commands so

27
docs/content/commands/rclone_serve_ftp.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-02-10T12:28:36Z date: 2020-02-10T14:24:31Z
title: "rclone serve ftp" title: "rclone serve ftp"
slug: rclone_serve_ftp slug: rclone_serve_ftp
url: /commands/rclone_serve_ftp/ url: /commands/rclone_serve_ftp/
@ -173,6 +173,10 @@ rclone will use that program to generate backends on the fly which
then are used to authenticate incoming requests. This uses a simple then are used to authenticate incoming requests. This uses a simple
JSON based protocl with input on STDIN and output on STDOUT. JSON based protocl with input on STDIN and output on STDOUT.
**PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used
together, if `--auth-proxy` is set the authorized keys option will be
ignored.
There is an example program There is an example program
[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py)
in the rclone source code. in the rclone source code.
@ -190,7 +194,8 @@ This config generated must have this extra parameter
And it may have this parameter And it may have this parameter
- `_obscure` - comma separated strings for parameters to obscure - `_obscure` - comma separated strings for parameters to obscure
For example the program might take this on STDIN If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:
``` ```
{ {
@ -199,7 +204,17 @@ For example the program might take this on STDIN
} }
``` ```
And return this on STDOUT If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:
```
{
"user": "me",
"public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf"
}
```
And as an example return this on STDOUT
``` ```
{ {
@ -213,7 +228,7 @@ And return this on STDOUT
``` ```
This would mean that an SFTP backend would be created on the fly for This would mean that an SFTP backend would be created on the fly for
the `user` and `pass` returned in the output to the host given. Note the `user` and `pass`/`public_key` returned in the output to the host given. Note
that since `_obscure` is set to `pass`, rclone will obscure the `pass` that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
@ -225,8 +240,8 @@ in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list. to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass`. This also means that if a user's configuration, don't use `pass` or `public_key`. This also means that if a user's
password is changed the cache will need to expire (which takes 5 mins) password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect. before it takes effect.
This can be used to build general purpose proxies to any kind of This can be used to build general purpose proxies to any kind of

29
docs/content/commands/rclone_serve_sftp.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-02-10T12:28:36Z date: 2020-02-10T14:24:31Z
title: "rclone serve sftp" title: "rclone serve sftp"
slug: rclone_serve_sftp slug: rclone_serve_sftp
url: /commands/rclone_serve_sftp/ url: /commands/rclone_serve_sftp/
@ -25,7 +25,7 @@ control the stats printing.
You must provide some means of authentication, either with --user/--pass, You must provide some means of authentication, either with --user/--pass,
an authorized keys file (specify location with --authorized-keys - the an authorized keys file (specify location with --authorized-keys - the
default is the same as ssh) or set the --no-auth flag for no default is the same as ssh), an --auth-proxy, or set the --no-auth flag for no
authentication when logging in. authentication when logging in.
Note that this also implements a small number of shell commands so Note that this also implements a small number of shell commands so
@ -184,6 +184,10 @@ rclone will use that program to generate backends on the fly which
then are used to authenticate incoming requests. This uses a simple then are used to authenticate incoming requests. This uses a simple
JSON based protocl with input on STDIN and output on STDOUT. JSON based protocl with input on STDIN and output on STDOUT.
**PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used
together, if `--auth-proxy` is set the authorized keys option will be
ignored.
There is an example program There is an example program
[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py)
in the rclone source code. in the rclone source code.
@ -201,7 +205,8 @@ This config generated must have this extra parameter
And it may have this parameter And it may have this parameter
- `_obscure` - comma separated strings for parameters to obscure - `_obscure` - comma separated strings for parameters to obscure
For example the program might take this on STDIN If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:
``` ```
{ {
@ -210,7 +215,17 @@ For example the program might take this on STDIN
} }
``` ```
And return this on STDOUT If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:
```
{
"user": "me",
"public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf"
}
```
And as an example return this on STDOUT
``` ```
{ {
@ -224,7 +239,7 @@ And return this on STDOUT
``` ```
This would mean that an SFTP backend would be created on the fly for This would mean that an SFTP backend would be created on the fly for
the `user` and `pass` returned in the output to the host given. Note the `user` and `pass`/`public_key` returned in the output to the host given. Note
that since `_obscure` is set to `pass`, rclone will obscure the `pass` that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
@ -236,8 +251,8 @@ in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list. to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass`. This also means that if a user's configuration, don't use `pass` or `public_key`. This also means that if a user's
password is changed the cache will need to expire (which takes 5 mins) password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect. before it takes effect.
This can be used to build general purpose proxies to any kind of This can be used to build general purpose proxies to any kind of

27
docs/content/commands/rclone_serve_webdav.md
View File

@ -1,5 +1,5 @@
--- ---
date: 2020-02-10T12:28:36Z date: 2020-02-10T14:24:31Z
title: "rclone serve webdav" title: "rclone serve webdav"
slug: rclone_serve_webdav slug: rclone_serve_webdav
url: /commands/rclone_serve_webdav/ url: /commands/rclone_serve_webdav/
@ -230,6 +230,10 @@ rclone will use that program to generate backends on the fly which
then are used to authenticate incoming requests. This uses a simple then are used to authenticate incoming requests. This uses a simple
JSON based protocl with input on STDIN and output on STDOUT. JSON based protocl with input on STDIN and output on STDOUT.
**PLEASE NOTE:** `--auth-proxy` and `--authorized-keys` cannot be used
together, if `--auth-proxy` is set the authorized keys option will be
ignored.
There is an example program There is an example program
[bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py) [bin/test_proxy.py](https://github.com/rclone/rclone/blob/master/test_proxy.py)
in the rclone source code. in the rclone source code.
@ -247,7 +251,8 @@ This config generated must have this extra parameter
And it may have this parameter And it may have this parameter
- `_obscure` - comma separated strings for parameters to obscure - `_obscure` - comma separated strings for parameters to obscure
For example the program might take this on STDIN If password authentication was used by the client, input to the proxy
process (on STDIN) would look similar to this:
``` ```
{ {
@ -256,7 +261,17 @@ For example the program might take this on STDIN
} }
``` ```
And return this on STDOUT If public-key authentication was used by the client, input to the
proxy process (on STDIN) would look similar to this:
```
{
"user": "me",
"public_key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDuwESFdAe14hVS6omeyX7edc...JQdf"
}
```
And as an example return this on STDOUT
``` ```
{ {
@ -270,7 +285,7 @@ And return this on STDOUT
``` ```
This would mean that an SFTP backend would be created on the fly for This would mean that an SFTP backend would be created on the fly for
the `user` and `pass` returned in the output to the host given. Note the `user` and `pass`/`public_key` returned in the output to the host given. Note
that since `_obscure` is set to `pass`, rclone will obscure the `pass` that since `_obscure` is set to `pass`, rclone will obscure the `pass`
parameter before creating the backend (which is required for sftp parameter before creating the backend (which is required for sftp
backends). backends).
@ -282,8 +297,8 @@ in the output and the user to `user`. For security you'd probably want
to restrict the `host` to a limited list. to restrict the `host` to a limited list.
Note that an internal cache is keyed on `user` so only use that for Note that an internal cache is keyed on `user` so only use that for
configuration, don't use `pass`. This also means that if a user's configuration, don't use `pass` or `public_key`. This also means that if a user's
password is changed the cache will need to expire (which takes 5 mins) password or public-key is changed the cache will need to expire (which takes 5 mins)
before it takes effect. before it takes effect.
This can be used to build general purpose proxies to any kind of This can be used to build general purpose proxies to any kind of