diff options
| author | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-07-06 10:31:36 +0400 |
|---|---|---|
| committer | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-07-06 10:31:36 +0400 |
| commit | b58de6852f1a16f46b3163db275ffb81b0265c42 (patch) | |
| tree | 47f36ace46477ea6609d4a7e9b4d0586edda95a8 /doc/api-auth.texi | |
| parent | ssh/*.c: Improve the docstrings format (diff) | |
| download | guile-ssh-b58de6852f1a16f46b3163db275ffb81b0265c42.tar.gz | |
ssh/auth.c: Handle disconnected sessions
* ssh/auth.c (guile_ssh_userauth_public_key_x)
(guile_ssh_userauth_public_key_auto_x)
(guile_ssh_userauth_public_key_try, guile_ssh_userauth_agent_x)
(guile_ssh_userauth_password_x, guile_ssh_userauth_none_x)
(guile_ssh_userauth_get_list): Throw `guile-ssh-error' if the session
is not connected.
* doc/api-auth.texi (Auth): Update.
* NEWS: Update.
Diffstat (limited to 'doc/api-auth.texi')
| -rw-r--r-- | doc/api-auth.texi | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api-auth.texi b/doc/api-auth.texi index 9ad8f24..b2c5a76 100644 --- a/doc/api-auth.texi +++ b/doc/api-auth.texi @@ -18,6 +18,8 @@ calling of procedures from this section. @deffn {Scheme Procedure} userauth-public-key! session private-key Try to authenticate with a public/private key. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + Return one of the following symbols: @table @samp @@ -42,6 +44,8 @@ key from a @acronym{SSH} agent and if it fails it will try to read a key from a file. If the key is encrypted the user will be asked for a passphrase. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + Return one of the following symbols: @table @samp @@ -61,6 +65,8 @@ A serious error happened. @deffn {Scheme Procedure} userauth-public-key/try session public-key Try to authenticate with the given @var{public-key}. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + To avoid unnecessary processing and user interaction, the following method is provided for querying whether authentication using the @var{public-key} would be possible. @@ -85,6 +91,8 @@ A serious error happened. @deffn {Scheme Procedure} userauth-agent! session Try to do public key authentication with ssh agent. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + Return one of the following symbols: @table @samp @@ -104,6 +112,8 @@ A serious error happened. @deffn {Scheme Procedure} userauth-password! session password Try to authenticate by @var{password}. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + Return one of the following symbols: @table @samp @@ -125,6 +135,8 @@ In nonblocking mode, you've got to call this again later. @deffn {Scheme Procedure} userauth-none! session Try to authenticate through the @code{none} method. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + Return one of the following symbols: @table @samp @@ -146,6 +158,8 @@ A serious error happened. Get available authentication methods for a @var{session}. Return list of available methods. +Throw @code{guile-ssh-error} if the @var{session} is not connected. + This call will block, even in nonblocking mode, if run for the first time before a (complete) call to @code{userauth-none!}. |