summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArtyom Poptsov <poptsov.artyom@gmail.com>2014-06-01 01:02:47 +0400
committerArtyom Poptsov <poptsov.artyom@gmail.com>2014-06-01 01:02:47 +0400
commit3add773c07d58238834d07b2b266bda56eac193d (patch)
tree480245d60ca8e0f5b2cf53ef127abef16b275dd6 /doc
parentssh/key-type.c (_scm_to_ssh_key_type): Fix return type (diff)
downloadguile-ssh-3add773c07d58238834d07b2b266bda56eac193d.tar.gz
ssh/key.scm (string->public-key): New procedure
* ssh/key.scm (string->public-key): New procedure. * ssh/key-func.c (guile_ssh_string_to_public_key): New procedure. * ssh/key-func.h: Likewise. * doc/api-keys.texi (Keys): Add description of `string->public-key'.
Diffstat (limited to 'doc')
-rw-r--r--doc/api-keys.texi8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/api-keys.texi b/doc/api-keys.texi
index c3e1580..99ba8a8 100644
--- a/doc/api-keys.texi
+++ b/doc/api-keys.texi
@@ -31,6 +31,14 @@ otherwise.
Convert @var{public-key} to a string.
@end deffn
+@deffn {Scheme Procedure} string->public-key string type
+Convert a public key of @var{type} represented as Base64 @var{string}
+to a Guile-SSH key. Throw @code{guile-ssh-error} on error.
+
+The @var{type} must be one of the following symbols: @code{dss},
+@code{rsa}, @code{rsa1}, @code{ecdsa}
+@end deffn
+
@deffn {Scheme Procedure} private-key-from-file session file
Read private key from a @var{file}. If the the key is encrypted the
user will be asked for passphrase to decrypt the key.