diff options
| author | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-01-27 21:31:15 +0400 |
|---|---|---|
| committer | Artyom Poptsov <poptsov.artyom@gmail.com> | 2014-01-27 21:31:15 +0400 |
| commit | c09968b89dfdfb1b50904523a0458a1f61ea91d4 (patch) | |
| tree | 8aeb49a5a8f406dc9047afc0084e52169b184ab0 /doc/api-auth.texi | |
| parent | src/server-type.c (guile_ssh_server_close_x): Remove. (diff) | |
| download | guile-ssh-c09968b89dfdfb1b50904523a0458a1f61ea91d4.tar.gz | |
Add documentation in Texinfo format.
* configure.ac: Add `doc/Makefile' to `AC_CONFIG_FILES'.
* Makefile.am (SUBDIRS): Add `doc' directory.
* doc/Makefile.am: New file.
* doc/api-auth.texi, doc/api-channels.texi, doc/api-keys.texi,
doc/api-messages.texi, doc/api-servers.texi,
doc/api-sessions.texi, doc/api-version.texi, doc/fdl.texi,
doc/guile-ssh.texi, doc/indices.texi, doc/version.texi: New file.
Diffstat (limited to 'doc/api-auth.texi')
| -rw-r--r-- | doc/api-auth.texi | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/doc/api-auth.texi b/doc/api-auth.texi new file mode 100644 index 0000000..30093ba --- /dev/null +++ b/doc/api-auth.texi @@ -0,0 +1,73 @@ +@c -*-texinfo-*- +@c This file is part of Guile-SSH Reference Manual. +@c Copyright (C) 2014 Artyom V. Poptsov +@c See the file guile-ssh.texi for copying conditions. + +@node Auth +@section Auth + +@cindex authentication + +@deffn {Scheme Procedure} userauth-pubkey! session username publickey privatekey +Try to authenticate with a public key @var{publickey}. + +@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 +Try to automatically authenticate with @code{none} method first and +then with public keys. The procedure will try to get a cached private +key from a 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. + +Return one of the following symbols: + +@table @samp +@item success +@item partial +@item denied +@item error +@end table + +@end deffn + +@deffn {Scheme Procedure} userauth-password! session username password +Try to authenticate by password. +@end deffn + +@deffn {Scheme Procedure} userauth-none! session +Try to authenticate through the @code{none} method. + +Return one of the following symbols: + +@table @samp +@item success +@item partial +@item again +@item denied +@item error +@end table + +@end deffn + +@deffn {Scheme Procedure} userauth-get-list session +Get available authentication methods for a @var{session}. Return list +of available methods. + +Possible methods: + +@table @samp +@item password +@item public-key +@item host-based +@item interactive +@end table + +@end deffn + +@c Local Variables: +@c TeX-master: "guile-ssh.texi" +@c End: |
