summaryrefslogtreecommitdiff
path: root/doc/design/external_special_remote_protocol.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-12-27 16:01:43 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-12-27 16:01:43 -0400
commitc1cc4d23de10e5669a42164b9145acea732be60d (patch)
treeda75e73f9a0523428233d0e5f644826bae07c379 /doc/design/external_special_remote_protocol.mdwn
parentc1d48d64b4d93c0a684ef68262b9e14b1b63005d (diff)
add credential storage support for external special remotes & update example
Diffstat (limited to 'doc/design/external_special_remote_protocol.mdwn')
-rw-r--r--doc/design/external_special_remote_protocol.mdwn17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn
index e93ead8d6..8fef581a0 100644
--- a/doc/design/external_special_remote_protocol.mdwn
+++ b/doc/design/external_special_remote_protocol.mdwn
@@ -189,6 +189,23 @@ in control.
can have been set by a previous SETCONFIG. Can be run at any time.
(git-annex replies with VALUE followed by the value. If the setting is
not set, the value will be empty.)
+* `SETCREDS Setting User Password`
+ When some form of user and password is needed to access a special remote,
+ this can be used to securely store them for later use.
+ (Like SETCONFIG, this is normally sent only during INITREMOTE.)
+ The Setting indicates which value in a remote's configuration can be
+ used to store the creds.
+ Note that creds are normally only stored in the remote's configuration
+ when it's surely safe to do so; when gpg encryption is used, in which
+ case the creds will be encrypted using it. If creds are not stored in
+ the configuration, they'll only be stored in a local file.
+ (embedcreds can be set to yes by the user or by SETCONFIG to force
+ the creds to be stored in the remote's configuration).
+* `GETCREDS Setting`
+ Gets any creds that were previously stored in the remote's configuration
+ or a file.
+ (git-annex replies with "CREDS User Password". If no creds are found,
+ User and Password are both empty.)
## general messages