diff options
| author | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-07-07 00:05:43 +0400 |
|---|---|---|
| committer | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-07-07 00:05:43 +0400 |
| commit | fa5cb61adee1fd4e896e8f81c947ef09bf1ff851 (patch) | |
| tree | 833fe946c9328a6d610579f63188e056384a486e /doc | |
| parent | ssh/auth.c: Handle disconnected sessions (diff) | |
| download | guile-ssh-fa5cb61adee1fd4e896e8f81c947ef09bf1ff851.tar.gz | |
ssh/auth.c: Throw `wrong-type-arg' instead of `guile-ssh-error'
* ssh/auth.c: Throw `wrong-type-arg' instead of `guile-ssh-error' if a
disconnected session is passed as an argument to procedures in the
module.
* ssh/session-type.h (GSSH_VALIDATE_CONNECTED_SESSION): New macro.
* doc/api-auth.texi (Auth): Update.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api-auth.texi | 17 |
1 files changed, 3 insertions, 14 deletions
diff --git a/doc/api-auth.texi b/doc/api-auth.texi index b2c5a76..b2975d2 100644 --- a/doc/api-auth.texi +++ b/doc/api-auth.texi @@ -15,11 +15,12 @@ Please note that you must specify a username either on creation of a session or by @code{session-set!} call (@pxref{Sessions}) before calling of procedures from this section. +Also @strong{note} that the session must be connected before calling to these +procedures, otherwise the @code{wrong-type-arg} exception will be thrown. + @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 @@ -44,8 +45,6 @@ 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 @@ -65,8 +64,6 @@ 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. @@ -91,8 +88,6 @@ 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 @@ -112,8 +107,6 @@ 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 @@ -135,8 +128,6 @@ 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 @@ -158,8 +149,6 @@ 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!}. |