summaryrefslogtreecommitdiff
path: root/doc/api-keys.texi
diff options
context:
space:
mode:
authorArtyom V. Poptsov <poptsov.artyom@gmail.com>2014-10-11 07:19:46 +0400
committerArtyom V. Poptsov <poptsov.artyom@gmail.com>2014-10-11 07:19:46 +0400
commitc4ca0177bdd6734501934ddfc088fe0d3b555b81 (patch)
treefe882e7696936fcbc39017207b85b529adf8baac /doc/api-keys.texi
parentssh/log.scm (set-log-verbosity!, get-log-verbosity): New procedures (diff)
downloadguile-ssh-c4ca0177bdd6734501934ddfc088fe0d3b555b81.tar.gz
ssh/key.scm (make-keypair): New procedure
* ssh/key-type.c (_scm_from_ssh_key, guile_ssh_make_keypair): New procedures. * ssh/key-type.h: Update. * ssh/key.scm (make-keypair): Export. * doc/api-keys.texi (Keys): Add description of `make-keypair'. * tests/key.scm ("make-keypair"): New TC. * NEWS: Update.
Diffstat (limited to 'doc/api-keys.texi')
-rw-r--r--doc/api-keys.texi9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api-keys.texi b/doc/api-keys.texi
index 24243fc..a787fd8 100644
--- a/doc/api-keys.texi
+++ b/doc/api-keys.texi
@@ -16,6 +16,15 @@ Guile-SSH keys.
@strong{Note} that Guile-SSH does not support ECDSA keys if libssh 0.6.3 is
compiled with GCrypt instead of OpenSSL.
+@deffn {Scheme Procedure} make-keypair type length
+Generate a keypair of specified @var{type} and @var{length} (in bits). This
+may take some time.
+
+Possible key types are: @code{dss}, @code{rsa}, @code{rsa1}, @code{ecdsa}.
+
+Return newly generated private key. Throw @code{guile-ssh-error} on error.
+@end deffn
+
@deffn {Scheme Procedure} key? x
Return @code{#t} if @var{x} is a Guile-SSH key, @code{#f} otherwise.
@end deffn