diff options
| author | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-03-22 11:22:53 +0400 |
|---|---|---|
| committer | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-03-22 11:22:53 +0400 |
| commit | 20836b5a3d6704b28b2e123683848e44b59c5093 (patch) | |
| tree | d97242ab0062b41b3291734781eb68dacdfaa605 /doc/api-auth.texi | |
| parent | Thank Ludovic. (diff) | |
| download | guile-ssh-20836b5a3d6704b28b2e123683848e44b59c5093.tar.gz | |
ssh/auth.c: Remove username form parameter list of functions.
* ssh/auth.c (guile_ssh_userauth_pubkey): Don't take a username as
an parameter. All callers updated.
(guile_ssh_userauth_password): Likewise.
* examples/ssshd.scm.in (handle-req-auth): Update.
* examples/echo/client.scm.in (main): Update.
* tests/client-server.scm ("userauth-password!, success")
("userauth-password!, denied", "userauth-password!, partial")
("userauth-pubkey!, success"): Update TCs.
* doc/api-auth.texi (Auth): Update documentation for
`userauth-pubkey!' and `userauth-password!'. Add a general note
about setting of a username.
* doc/version.texi: Update.
Diffstat (limited to 'doc/api-auth.texi')
| -rw-r--r-- | doc/api-auth.texi | 46 |
1 files changed, 39 insertions, 7 deletions
diff --git a/doc/api-auth.texi b/doc/api-auth.texi index e19d672..459543e 100644 --- a/doc/api-auth.texi +++ b/doc/api-auth.texi @@ -11,12 +11,27 @@ The @code{(ssh auth)} module provides authentication procedures for a Guile-SSH client. -@deffn {Scheme Procedure} userauth-pubkey! session username publickey privatekey -Try to authenticate with a public key @var{publickey}. +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. + +@deffn {Scheme Procedure} userauth-pubkey! session public-key private-key +Try to authenticate with a @var{public-key}. + +Return one of the following symbols: + +@table @samp +@item success +Authentication success. +@item partial +You've been partially authenticated, you still have to use another +method. +@item denied +Authentication failed: use another method. +@item error +A serious error happened. +@end table -@var{username} can be either string or @code{#f}, If @var{username} is -@code{#f} it's assumed that the @var{username} was set though -@code{option-set!} call. @end deffn @deffn {Scheme Procedure} userauth-autopubkey! session @@ -43,8 +58,25 @@ A serious error happened. @end deffn -@deffn {Scheme Procedure} userauth-password! session username password -Try to authenticate by password. +@deffn {Scheme Procedure} userauth-password! session password +Try to authenticate by @var{password}. + +Return one of the following symbols: + +@table @samp +@item success +Authentication success. +@item partial +You've been partially authenticated, you still have to use another +method. +@item denied +Authentication failed: use another method. +@item error +A serious error happened. +@item again +In nonblocking mode, you've got to call this again later. +@end table + @end deffn @deffn {Scheme Procedure} userauth-none! session |
