Debian Codegraph @

NEWS

raw
1 #+TITLE: Guile-SSH News -- history of user-visible changes.
2 #+STARTUP: content hidestars
3
4 Copyright (C) Artyom V. Poptsov <[email protected]>
5 Copyright (C) Nicolas Graves <[email protected]>
6
7 Copying and distribution of this file, with or without modification,
8 are permitted in any medium without royalty provided the copyright
9 notice and this notice are preserved.
10
11 * Changes in version 1.0.0 (2026-03-25)
12 ** modules/ssh/key.scm: =make-keypair= length is now optional :API_CHANGE:
13 =libssh='s =ssh_pki_generate= uses a default size when it's set to 0. Make the
14 =length= argument of =make-keypair= optional and rely on this default when
15 unset.
16 ** modules/ssh/session.scm: Now loads (ssh key) :BUGFIX:
17 Without loading =(ssh key)= module, Guile-SSH would always fail with
18 "Segmentation fault" when working with keys (e.g. when trying to print a key
19 acquired from =get-server-public-key= procedure.)
20
21 Reported by graywolf in
22 <https://github.com/artyom-poptsov/guile-ssh/issues/41>
23 ** Add tests for =ed25519= keys
24 Tests were not run for the =ed25519= key despite its widespread use, now they
25 do.
26
27 ** Introduce =sign= and =verify= functions
28 Based on a functionality introduced in libssh@12, these functions allow to
29 sign and verify a string from a OpenSSH key, and consequently to reproduce git
30 signing with SSH using guile-ssh. This functionality also required the
31 addition of the =get-public-key-fingerprint= procedure, along with tests and
32 documentation.
33
34 #+begin_src scheme
35 (use-modules (ssh key)
36 (srfi srfi-26)
37 (ice-9 textual-ports))
38
39 (define (public-keys-equal? pub1 pub2)
40 (string=? (public-key->string pub1)
41 (public-key->string pub2)))
42
43 (define rsakey (private-key-from-file "tests/keys/rsakey"))
44 (define test-string "Test input\0string")
45
46 (call-with-output-file "/tmp/message.sig"
47 (cut format <> (sign test-string rsakey)))
48
49 (and=>
50 (verify
51 "Test input\0string"
52 ;; "not a signature"
53 (call-with-input-file "/tmp/message.sig" get-string-all))
54 (cut public-keys-equal? rsakey <>))
55 #+end_src
56
57 ** Drop support for libssh versions older than 0.8.3
58 libssh 0.8.3 was released in sept. 2018 and versions lower were deprecated and
59 did not properly compile and test on the Github CI.
60
61 ** CI/guix: Complete revamp.
62 To adapt to the numerous upstream package changes, and the aforementioned
63 drop, the =guix.scm= file has been completely rewritten.
64
65 Then it has been moved to =.guix/modules/guile-ssh-packages.scm= as a proper
66 module with package definition to allow a refactor of =guix.yml= CI file.
67
68 The CI on Github now does not run =guix pull= after the last tarball, but it's
69 most likely fine since most of our package definitions are our own, and Guix
70 made the =1.5.0= release since. This cuts CI time spent on Guix from 30 to 3
71 minutes.
72
73 * Changes in version 0.18.0 (2024-11-10)
74 ** Change =(ssh popen)= procedures behavior :API_CHANGE:
75 Now the following procedures handle the program arguments the same way as
76 =open-pipe*= procedure. This also makes the their behavior match the
77 description from the Guile-SSH documentation.
78
79 This change affects the following procedures from =(ssh popen)=:
80 - =open-remote-pipe*=
81 - =open-remote-input-pipe*=
82 - =open-remote-output-pipe*=
83
84 Reported by graywolf in
85 <https://github.com/artyom-poptsov/guile-ssh/issues/39>
86 ** =make-session= now handles =#:config= set to =#f= properly
87 Now =make-session= disables reading the default SSH configuration files when
88 =#:config= is set to =#f= (as per Guile-SSH documentation.) Note that =#f=
89 value is handled through the "process-config?" option that was added in libssh
90 0.9; when an older version of libssh is used, Guile-SSH falls back to setting
91 the configuration file to =/dev/null= (which in turn prevents libssh from using
92 the default configuration files.)
93
94 When =#:config= is set to =#t= then the default SSH configuration files are
95 read. This is by default to keep the backward compatibility.
96
97 Reported by graywolf in
98 <https://github.com/artyom-poptsov/guile-ssh/issues/38>
99
100 ** session-func.c: Fix compile error caused by bool identifier :BUGFIX:
101 Fix a compilation error caused by the confusion of a variable name with
102 boolean type name.
103
104 Reported and fixed by Peter Tillemans <[email protected]> in
105 <https://github.com/artyom-poptsov/guile-ssh/pull/43>
106 ** session-func.c: Fix compilation with libssh < 0.8.3 :BUGFIX:
107 Guile-SSH don't try to handle missing SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES in
108 libssh older than 0.8.3 because it leads to compilation errors. Instead now
109 it issues a compilation warning.
110 ** session-func.c: Add compilation warnings for missing options
111 Now Guile-SSH issues compilation warnings for missing libssh session options.
112 ** Drop support for libssh versions older than 0.8.0 :API_CHANGE:
113 libssh 0.7.4 was released in 2017 and libssh 0.8.0 was released back in 2018
114 so it is quite old already. Since then some CVE were fixed, namely:
115 - 0.8.4: CVE-2018-10933: libssh authentication bypass
116 - 0.9.3: CVE-2019-14889: SCP: Unsanitized location leads to command execution
117 - 0.9.4: CVE-2020-1730: Possible DoS in client and server when handling
118 - 0.9.5: CVE-2020-16135: Avoid null pointer dereference in sftpserver (T232)
119 - 0.9.6: CVE-2021-3634: Fix possible heap-buffer overflow when rekeying with
120 different key exchange mechanism.
121
122 Also libssh introduced some new features since 0.8.0 so Guile-SSH will not
123 probably work with libssh 0.7 anyway. Guile-SSH with libssh 0.8 should work
124 fine (according to tests) although some new Guile-SSH API will not be
125 available (e.g. some types of private keys are not compatible with old
126 versions of libssh.)
127
128 Support for libssh version 0.8.0, 0.8.1 and 0.8.2 will be dropped in the next
129 Guile-SSH releases.
130 ** Documentation
131 *** doc/api-popen.texi: Improve description; update examples
132 *** doc/api-dist.texi: Fix the description of "make-node"
133 *** doc/api-sessions.texi: Update and improve
134 ** Tests
135 *** tests/session.scm: Bugfix :BUGFIX:
136 Set "host" to "example" so the default configuration from the test config will
137 be read.
138 *** tests/server.scm ("make-server", "server-get"): Bugfix :BUGFIX:
139 Don't try to use DSA key when it is disabled.
140 *** tests/common.scm: Don't use DSA keys when DSA is not supported :BUGFIX:
141 *** tests/session: Expand "#:config" test suite
142 *** tests/client-server: Fix logging :BUGFIX:
143 In test case "data transferring, remote side abruptly closed": Don't log
144 errors into stderr, use libssh log instead. Remove "error" word from the log
145 string as surprisingly it tricks the test framework to think that some test
146 error has happened.
147 *** tests/client-server: Don't use ECDSA key with older versions of libssh :BUGFIX:
148 Now test "userauth-public-key!, success") is skipped when libssh has version
149 older than 0.8.3.
150
151 Instead "userauth-public-key!, success (RSA)" test case is used for older
152 versions of libssh.
153 *** tests/sssh-ssshd: Don't use ECDSA keys with older versions of libssh :BUGFIX:
154 ** Examples
155 *** examples/ssshd.scm.in (main): Bugfix: Handle deprecation of DSA :BUGFIX:
156 *** tests/key.scm: Bugfix: Handle DSA deprecation properly :BUGFIX:
157 ** New simplified version of the project logo
158 Thanks to Darya Sev. <[email protected]> for very helpful design advices for the
159 new simplified version of the project logo.
160 ** New =CODE_OF_CONDUCT.org= file
161 The document is a copy of
162 <https://www.contributor-covenant.org/version/2/1/code_of_conduct/> converted
163 into org-mode format.
164
165 * Changes in version 0.17.0 (2024-05-01)
166 ** =make-session= now loads config file before setting options
167 =make-session= would always overwrite the explicitly set options passed by
168 keywords with the values from the SSH configuration file. That lead to
169 unexpected behavior.
170
171 This patch fixes this error.
172
173 Reported by graywolf in
174 <https://github.com/artyom-poptsov/guile-ssh/issues/38>
175 ** =session-set!= now allows to set =rsa-min-size=
176 Only available if Guile-SSH is compiled with libssh 0.10.
177 ** Add new tests.
178 ** Update the documentation.
179
180 * Changes in version 0.16.4 (2023-12-17)
181 ** =private-key-from-file= now allows to read encrypted keys
182 The procedure =private-key-from-file= from =(ssh key)= now has optional
183 =#:auth-callback= and =#:user-data= keys that allow to specify a callback
184 procedure to read the password for an encrypted key, and optionally pass to
185 the callback procedure some user data.
186
187 The Texinfo documentation for =private-key-from-file= is updated with an usage
188 example.
189
190 New tests were added for the new functionality.
191 ** Add GNU Guix workflows for GitHub CI
192 Now Guile-SSH has GNU Guix workflows for GitHub CI.
193
194 Platforms:
195 - x86_64-linux-gnu
196 - aarch64-linux-gnu
197
198 Thanks to Sharlatan Hellseher <[email protected]>
199 ** Fix typos in the documentation
200 Some typos in =doc/api-popen.texi= are fixed, thanks to
201 Maxim Cournoyer <[email protected]>
202
203 * Changes in version 0.16.3 (2023-01-29)
204 ** Fix Guile-SSH/libssh channel leak
205 Guile-SSH channel would always "leak" the libssh channels when the remote side
206 issued the closing request. Now this bug is fixed by freeing libssh channel
207 when the remote side is closed.
208
209 Reported by Andrew Tropin <[email protected]> in
210 <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=58290>
211
212 The test for reproducing the problem was provided by Ludovic Courtès
213 <[email protected]>.
214
215 * Changes in version 0.16.2 (2023-01-02)
216 ** Bugfix in test "string->public-key, ECDSA"
217 The test used to explicitly compare libssh version with "9" so it would always
218 fail on platforms with libssh 0.10. Now the test does numerical comparison
219 and uses "ecdsa-p256" on platforms that have libssh 0.9 or later version.
220
221 Reported by Vagrant Cascadian, here:
222 <https://github.com/artyom-poptsov/guile-ssh/issues/34>
223
224 * Changes in version 0.16.1 (2022-12-31)
225 ** Disable the tests that require DSA algorithm by default
226 When DSA support is disabled in libssh (which is the default state since
227 libssh 0.10) all DSA-related Guile-SSH procedures will fail. Now Guile-SSH
228 disables by default all the tests that are require the DSA algorithm support
229 by default.
230
231 Although those changes do not affect the Guile-SSH API directly, users should
232 be aware that DSA support will be removed altogether in the next major libssh
233 release.
234
235 Reported by Vagrant Cascadian, here:
236 <https://github.com/artyom-poptsov/guile-ssh/issues/34>
237 ** Add '--enable-dsa' Autoconf option
238 'configure.ac' now has '--enable-dsa' option that allows to enable DSA public
239 key algorithm support in Guile-SSH.
240 ** (ssh version): 'dsa-support?': New procedure
241 ** guix.scm: Use libssh 0.10.0
242 The development GNU Guix environment now uses libssh 0.10.0.
243
244 * Changes in version 0.16.0 (2022-09-13)
245 ** Fix Guile snarfer environment
246 Fix a bug introduced in Guile-SSH 0.15.0 that breaks the cross-compilation.
247
248 Reported by Ludovic Courtes <[email protected]> here:
249 <https://github.com/artyom-poptsov/guile-ssh/issues/30>
250 ** New API: SFTP Directory
251 Guile-SSH now allows directory traversal by means of the new procedures in the
252 (ssh sftp) module.
253 ** Update the documentation.
254
255 * Changes in version 0.15.1 (2022-02-28)
256 ** Fix session garbage collecting errors
257 When a session is being destroyed by the Guile GC, the session garbage
258 collector procedures try to close all the session channels. There was a
259 bug that lead to accessing elements that are over the border of a channels
260 list.
261
262 Now the bug should be fixed.
263
264 Reported by Ludovic Courtès <[email protected]> in an email, here:
265 <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=52975>
266 ** Fix segfaults that occur on session closing
267 When a remote side closing a channel Guile-SSH would fail as the libssh
268 callback that marks the Guile-SSH channel as closed tried to convert a
269 Guile channel object to the channel data and fails to do it.
270
271 Now the problem should be fixed.
272
273 Reported by Ludovic Courtès <[email protected]> in an email, here:
274 <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=52975>
275 ** Add GNU Guix package definition to the repository
276 Add =guix.scm= to the repository. The file contains GNU Guix package
277 definition that allows to build Guile-SSH from Git.
278
279 * Changes in version 0.15.0 (2022-01-03)
280 ** Bump library version to "14:0:0" according to libtool rules
281 In the 0.14.0 release of Guile-SSH the libtool library version wasn't
282 properly changed. This could lead to compatibility problems.
283
284 Now the version is bumped to "14:0:0".
285 ** Remove requirement for 'whereis' command
286 Guile-SSH required 'whereis' from 'util-linux' package to find
287 'guile-snarf' command. Now this dependency is removed.
288 * Changes in version 0.14.0 (2021-12-20)
289 ** API change: OpenSSH agent procedures are now in (ssh agent)
290 Move agent procedures to (ssh agent) module from (ssh auth).
291
292 The procedures are renamed and improved too. The current set of procedures
293 provided by (ssh agent) is as follows:
294 - ssh-agent-sock-get
295 - ssh-agent-sock-set!
296 - ssh-agent-start
297 - ssh-agent-info
298
299 The documentation is updated accordingly.
300 ** API change: Remove 'sftp-init' from (ssh sftp)
301 This procedure was not present in the module anyway, so this is more like a
302 bugfix though.
303
304 If you need to call SFTP init, you can use low-level '%sftp-init' procedure
305 (although this is discouraged.)
306 ** Guile-SSH channels are now explicitly blocking by default
307 ** Fix snarfing errors on Fedora GNU/Linux
308 Guile-SSH would fail to find 'guile-snarf' script on Fedora GNU/Linux when
309 GNU Guile 2.2 installed because the snarfer installed as 'guile-snarf2.2'.
310 Now the problem is fixed.
311 ** Fix random segfaults due to libssh logging
312 The library would sometimes get segfaults due to libssh logging.
313
314 Guile-SSH used to pass Guile objects to a libssh logging procedure as a
315 opaque pointers, and some Guile objects didn't make it to the point when an
316 actual Scheme callback procedure called, GC'ted on the way. So when a
317 Scheme logging callback tried to use its parameters, the parameters was
318 freed already.
319
320 Now Guile-SSH bypasses libssh logging altogether, calling a Scheme logging
321 callback right away -- that provides more control over Scheme objects and
322 allows to keep them from GC'ing.
323 ** Fix "random" errors and segfaults in channels
324 Guile-SSH would sometimes fail with segmentation faults and other errors
325 when a remote side is abruptly closed the connection and the client side
326 still tries to read data.
327
328 Now in that situation reading a Guile-SSH channel results in EOF.
329 ** Fix test failures due to 'primitive-fork' calls
330 SRFI-64 doesn't really like tests that spawn new processes and try to do
331 stuff after 'primitive-fork' without calling 'execle' (or similar)
332 procedure: sometimes a test would fail even when all its test cases where
333 successful.
334
335 Now that should be fixed.
336
337 ** Fix the tests for Guile 3.0.7
338 There are differences in REPL welcome message between Guile 3.0.7 and older
339 versions. Now this difference is handled properly.
340
341 Reported by Ludovic Courtès in
342 <https://github.com/artyom-poptsov/guile-ssh/issues/28>
343
344 ** Fix the tests for Guile 3.0.5
345 The test-runner object is now reset to #f when calling the 'test-end'
346 procedure. See the commit de5d1a7f99b8e952b115237ebc29633062f99bb9 in Guile
347 (srfi-64: Reset test-runner-current if done) which introduced this change.
348
349 ** The Guile-SSH building process now less verbose
350
351 ** Update documentation
352
353 * Changes in version 0.13.1 (2020-08-19)
354 ** Fix segfaults on GC'ing
355 The library would always fail with segmentation fault when the GC tried to
356 free Guile-SSH session when Guile-SSH channels related to this sessions
357 were in use.
358
359 Now live channels prevent the keep Guile-SSH session from freeing.
360 ** Channels procedures now check if the parent session is alive
361 Channels procedures now check if the parent session is alive and
362 connected. If this is not the case, an guile-ssh-error is issued.
363
364 * Changes in version 0.13.0 (2020-07-18)
365 ** API change: 'call-with-ssh-forward' does not start a thread
366 The procedure does not start a thread because multi-threading with libssh
367 sometimes leads to random segfaults.
368
369 Now 'call-with-ssh-forward' calls the provided procedure with a channel as
370 an argument instead.
371
372 If you wish to have a socket that forwards all the data to the remote side
373 through an SSH channel, you should implement a separate process that
374 forwards the data. There is an example in the directory 'examples/rpc' that
375 shows how to implement such a forwarding.
376 ** API change: add 'nodelay' option for Guile-SSH sessions
377 Thanks to Lars-Dominik Braun.
378 ** Fix some random segfaults in the channel and session code
379 ** Add support for macOS
380 Now Guile-SSH can be installed on macOS through a Homebrew Tap:
381 https://github.com/aconchillo/homebrew-guile
382
383 Thanks to Aleix Conchillo Flaqué!
384 ** Disable libguile-ssh static library
385 This change is a part of poring Guile-SSH to macOS.
386 ** Don't use deprecated libssh procedures
387 Add additional checks that replace deprecated procedures with the new ones
388 when newer libssh library is present.
389 ** Changes in documentation
390 Fix Texinfo warnings.
391
392 * Changes in version 0.12.0 (2020-01-05)
393 ** API change: Implement new version of the RREPL API
394 As proposed by Ludovic Courtès, this Guile-SSH version includes an
395 implementation of a new stateless RREPL.
396 ** New module: (ssh agent)
397 The module contains procedures for interaction with running SSH agent
398 instances.
399 ** Prepare for Guile 2.9/3.0
400 Allow to build Guile-SSH with Guile versions 2.0, 2.2, 3.0.
401
402 Pull request has been made by Ludovic Courtès in
403 <https://github.com/artyom-poptsov/guile-ssh/pull/14>
404 ** Remove bundled SRFI-64
405 This test framework is included in Guile since version 2.0.12.
406
407 This request has been made by Ludovic Courtès in
408 <https://github.com/artyom-poptsov/guile-ssh/pull/14>
409 ** Cross-compilation support
410 Now Guile-SSH should allow cross-compilation.
411
412 Pull request has been made by Mathieu Othacehe in
413 <https://github.com/artyom-poptsov/guile-ssh/pull/16>
414 ** Changes in (ssh auth):
415 *** New procedure 'userauth-gssapi!'
416 The procedure allows to authenticate through GSSAPI (Generic Security
417 Services Application Program Interface.)
418
419 Pull request has been made by Lars-Dominik Braun in
420 <https://github.com/artyom-poptsov/guile-ssh/pull/15>
421 ** Generic compilation fixes
422 Fix some warnings that surface during compilation and linking.
423 ** Bugfixes
424 *** Fix a segfault in 'libguile-ssh'
425 The library would always fail with segmentation fault error when an
426 application tried to free a closed channel. Now it should be fixed.
427
428 Reported by Michael Bowcutt <[email protected]> in
429 <https://github.com/artyom-poptsov/guile-ssh/issues/8>
430 and Njagi Mwaniki in a personal email.
431 *** Fix building with libssh 0.8
432 The 'libguile-ssh' library would fail to build due to missing
433 'libssh_threads' library that was removed libssh 0.8. Now 'libguile-ssh'
434 builds without 'libssh_threads' when using libssh 0.8+.
435
436 Reported by lantw44 in
437 <https://github.com/artyom-poptsov/guile-ssh/issues/9>
438 *** Fix failing tests
439 Tests would fail from time to time due to problems with an implementation
440 of the Guile-SSH testing framework. Now Guile-SSH uses updated (and
441 hopefully better) version of tests; that should fix most of the failures.
442
443 Reported by Pilifer, Carl Dong and Vagrant Cascadian in
444 <https://github.com/artyom-poptsov/guile-ssh/issues/12>
445
446 * Changes in version 0.11.3 (2018-03-27)
447 ** Bugfixes
448 *** 'node-run-server' now checks for errors
449 When 'node-run-server' fails to start the server it would go down an
450 infinite loop. The procedure now checks if the RREPL server started
451 correctly and throws 'node-error' if it's not.
452
453 Reported by Marius Bakke and Ludovic Courtès, in
454 <https://bugs.gnu.org/30522>
455
456 * Changes in version 0.11.2 (2017-06-18)
457 ** Bugfixes
458 *** Always reset the channel and sftp streams when closing ports
459 In Guile 2.2 objects (and thus Guile-SSH channels) are finalized in a
460 separate finalizer thread, but libssh does not work properly in such a
461 multi-threaded fashion -- which leads to segfaults in Guile-SSH.
462
463 To address that problem the following changes are made:
464 - In (ssh dist node) REPL channels opened in 'node-eval' are closed
465 explicitly.
466 - Channels and SFTP streams are always reset when closing ports.
467
468 Thanks to Ludovic Courtès for the patches!
469
470 Reported by Ludovic Courtès and Mark H Weaver, in
471 <https://bugs.gnu.org/26976>
472 *** In (ssh dist node)
473 **** 'node-guile-version' now does not fail
474 The procedure would always fail to get Guile version. Now that should be
475 fixed.
476
477 Reported by Mark H Weaver and Ludovic Courtès, in
478 <https://bugs.gnu.org/26976>
479 *** In (ssh session)
480 **** 'session-set!' now throws an option with its value on an error
481 *** In (ssh channel)
482 **** Printing a channel now works with Guile 2.2
483 **** 'channel-get-exit-status' handle freed channels properly
484 'channel-get-exit-status' now handles freed channels properly by throwing
485 'wrong-type-arg' error.
486 **** Printing a freed channel doesn't lead to SIGSEGV anymore
487 Guile-SSH would always crash with SIGSEGV errors when tried to print a
488 freed channel object (e.g. after calling 'close' on a channel). This bug
489 is fixed now by introducing new checks.
490
491 Now a freed channel will be printed like this:
492 #<unknown channel (freed) 9412f0>
493 ** Update unit tests
494 *** Add test cases for fixed bugs
495 ** Misc
496 *** Improve logging
497
498 * Changes in version 0.11.1 (2017-05-09)
499 ** Bugfixes
500 *** Fix building scripts
501 The building process would always fail on fresh source tree because
502 'configure' tried to make a symlink or a copy of files that were not
503 present yet. This should be fixed by now.
504
505 Reported by Ludovic Courtès, on #guix IRC channel.
506
507 * Changes in version 0.11.0 (2017-05-09)
508 ** Add support of Guile 2.2
509 Tested with GNU Guile version 2.0.14 (on Gentoo GNU/Linux) and
510 2.2.2.3-0c102 (on Debian GNU/Linux.)
511
512 Many thanks to Ludovic Courtès for patches!
513 ** New module (ssh shell)
514 The module provides some procedures build upon (ssh popen) module for
515 working with remote shell.
516 ** Bugfixes
517 *** In (ssh tunnel)
518 **** 'main-loop' now handles "interrupted system call" errors
519 that sometimes occur on 'select' call.
520 *** In (ssh dist node)
521 ***** 'rrepl-get-result' now handles compilation errors
522 The procedure would always fail to read compilation errors properly
523 because it considered the message as "undefined" result. Now this bug
524 should be fixed.
525
526 An example of an error that now should be handled is "no code for module"
527 due to using a non-existing module in 'with-ssh' expression.
528
529 Reported by Mathieu, in
530 <https://github.com/artyom-poptsov/guile-ssh/issues/3>
531 ***** 'rrepl-get-result' now handles "unbound variable" errors
532 The procedure would always fail to read "unbound variable" errors
533 properly, returning wrong result with only two values (current module
534 name and current language name). Now this bug should be fixed.
535
536 Reported by Mathieu, in
537 <https://github.com/artyom-poptsov/guile-ssh/issues/3>
538 ***** 'rrepl-get-result' now handles unknown # objects
539 The procedure would always fail to read unknown objects (e.g. instances
540 of Guile-SSH session) properly, raising an obscure errors like
541 "Unknown # object: #\<". Now the procedure raises 'node-repl-error'
542 with full evaluation result gotten from RREPL.
543
544 Reported by Mathieu, in
545 <https://github.com/artyom-poptsov/guile-ssh/issues/3>
546 ** Changes in (ssh dist node)
547 *** 'node-eval' now can work without procps
548 The procedure now checks if procps package is present on a node and uses
549 fallback Guile-SSH implementation of 'pgrep' and 'pkill' if it is not.
550 The fallback implementation of 'pgrep' is built upon pure bash, and
551 'pkill' in addition requires Guile itself on the remote side.
552 *** New procedure 'node-loadavg'
553 The procedure can be used to get average load of a node.
554 ** Changes in (ssh dist)
555 Procedures in the module now are capable of checking presence of procps
556 package on a remote side and switching to fallback implementation of some
557 of the procps tools when the package is not present -- thanks to updated
558 'node-eval' procedure (see above.)
559
560 At the end of the day it means that now the code can start/stop Guile REPL
561 server on a remote side even without procps installed.
562 ** Update unit tests
563 *** Add test cases for (ssh shell) module
564 ** Update documentation
565 *** Add documentation for (ssh shell) module
566 *** Describe project goals in "Introduction" section
567
568 * Changes in version 0.10.2 (2016-11-25)
569 ** New procedures
570 *** New procedure 'channel-send-eof' in (ssh channel)
571 The procedure allows to send end-of-file (EOF) on a channel. This action
572 doesn't close the channel; you may still read from it but not write.
573 'channel-send-eof!' is handy when we deal with a remote command that reads
574 data until EOF (such as 'wc'.)
575 ** Documentation
576 *** Add procedure index
577 ** Misc
578 *** Fixed several compilation warnings
579
580 * Changes in version 0.10.1 (2016-10-09)
581 ** Bugfixes
582 *** Fix SMOB freeing callbacks
583 Callbacks for many Guile-SSH objects would always fail to free allocated
584 resources due to wrong check added in 0.10.0. The problem should be fixed
585 now.
586 ** Change default 'guilesitedir' to 'PREFIX/share/guile/site/X.Y'
587 from 'PREFIX/share/guile-ssh/ssh/'
588
589 * Changes in version 0.10.0 (2016-08-20)
590 ** Add support of Guile 2.0.12
591 Guile-SSH now builds (and works quite well, as far as I can see) with Guile
592 2.0.9 and 2.0.12. Unit tests are passing too.
593
594 Tested on:
595 - Gentoo GNU/Linux, Guile 2.0.12-r1, libssh 0.7.3
596 - Gentoo GNU/Linux, Guile 2.0.9-r1, libssh 0.7.3
597 ** Add support of libssh 0.7.3
598 Guile-SSH now supports libssh 0.7.3 and (probably) newer versions; haven't
599 tested.
600
601 Note that [[https://www.libssh.org/2016/02/23/libssh-0-7-3-security-and-bugfix-release/][CVE-2016-0739 was found in previous libssh versions]]; though you
602 may still use 0.6.4, you really should stick with 0.7.3+ for aforementioned
603 reason. 0.7.3 is already should be in your distro's repository, so that
604 won't be a big deal I guess.
605 ** Bugfixes
606 *** (ssh dist node)
607 **** 'node-server-running?' now checks the default port
608 The procedure now checks for Guile server running on the default port
609 (that is, with '--listen' option without an argument), if that port was
610 specified for the node.
611 *** Fix include errors and misspecified inline procedures in C code
612 These errors lead to build failures (reported on Arch GNU/Linux, see
613 <https://github.com/artyom-poptsov/guile-ssh/issues/1>.)
614 *** Don't merge stderr with stdout in remote pipes
615 See <https://github.com/artyom-poptsov/guile-ssh/issues/2>.
616 ** Examples
617 *** Add 'uptop' example
618 ** Update documentation
619 ** Unit tests
620 Expand test suite, improve existing tests. Namely tests now don't always
621 fail when '-j' option is used with 'make check', with value greater than 1
622 (e.g. '-j4'; tested on Gentoo GNU/Linux, 4-core Intel Atom CPU)
623
624 Though sometimes tests fail, so there's still a room for improvement.
625
626 Another improvement is that SRFI-64 module and Guile-SSH common test module
627 are now compiled before use, that should speed up the tests.
628
629
630 * Changes in version 0.9.0 (2015-12-24)
631 ** Bugfixes
632 *** Fix a bug in distributed forms in handling of REPL errors
633 Distributed procedures now throw an 'node-repl-error' on an evaluation
634 error instead of returning of an unspecified value.
635 *** Fix a bug in handling of strings in distributed forms
636 The 'rrepl-eval' was always failing to send sexps that contain strings in
637 the proper way because the procedure uses the human-readable printing to
638 transmit the data. As the result an RREPL fails to evaluate it and
639 reports an error. The bug is fixed by switching to the machine-readable
640 data printing.
641 *** 'dist-map' and 'distribute' now raise an error if an evaluation failed
642 instead of silently return an empty list.
643 *** 'channel-listen-forward' now returns a correct port number
644 'channel-listen-forward' would always return garbage as the 2nd argument
645 when called with port > 0. Now when the port is explicitly specified then
646 the procedure returns the specified port as the 2nd argument.
647 *** Add missing export of 'node-tunnel' from (ssh dist node) module
648 ** Changes in API
649 *** Distributed forms now return the number of evaluation as a number
650 instead of string.
651 *** 'with-ssh' is now capable of handling of multiple values
652 'with-ssh' now returns a vector of values if an expression was evaluated to
653 multiple values. 'distribute' and 'dist-map' only take the 1st value if
654 multiple values were returned by an expression.
655 *** Nodes are now capable of starting and stopping a remote REPL (RREPL)
656 The new behaviour is controlled by 'start-repl-server?' and
657 'stop-repl-server?' keyed options of 'make-node'. Stopping of a RREPL
658 server is disabled by default.
659 *** Channels now can be created as input, output or bi-drectional ports
660 The direction of a channel is controlled by the 2nd argument to
661 'make-channel' procedure.
662 *** 'make-session' now takes 'config' option
663 that allows to specify whether the SSH config should be parsed or not, and
664 optionally the path to the config.
665 ** New procedures
666 *** New procedure 'node-server-running?' in (ssh dist node)
667 *** New procedure 'node-run-server' in (ssh dist node)
668 *** New procedure 'node-stop-server' in (ssh dist node)
669 *** New procedure 'node-guile-version' in (ssh dist node)
670 *** New procedure 'session-parse-config!' in (ssh session)
671 ** New modules
672 *** (ssh popen)
673 Remote popen interface to interact with remote processes.
674 *** (ssh sftp)
675 SFTP interface that allows to operate on remote files.
676 ** Documentation
677 *** Move description of tunnels into a separate section
678 *** Add description of the new procedures
679 *** Update existing documentation
680 ** Unit tests
681 *** Expand the test suite for distributed forms
682 *** Expand the test suite for tunnels
683 ** Add the project logo
684
685 * Changes in version 0.8.0 (2015-08-04)
686 ** Implement port forwarding
687 ** Add distributed forms
688 ** Require libssh 0.6.4 or 0.6.5
689 ** New module: (ssh tunnel)
690 The module provides hi-level procedures for SSH tunneling.
691 ** New module: (ssh dist)
692 The module provides distributed forms of 'map' and 'eval', as well as
693 remote REPL (RREPL) implementation.
694 ** New module: (ssh dist job)
695 Low-level API for distributed jobs.
696 ** New module: (ssh dist node)
697 Low-level API for distributed nodes.
698 ** New procedure 'channel-accept-forward' in (ssh channel)
699 ** New procedure 'channel-listen-forward' in (ssh channel)
700 ** Remove 'channel-open-forward/reverse' procedure from (ssh channel)
701 ** Examples
702 *** Add an RPC client example
703 Add an example program that does an RPC call over a secure channel using
704 a Guile-SSH tunnel. See 'examples/rpc' directory.
705 *** Add a RREPL example
706 Add a demo program that connects to a remote REPL (RREPL).
707 ** Update documentation
708
709 * Changes in version 0.7.2 (2015-02-24)
710 ** Remove dependency on libgcrypt added by a mistake
711 ** Fix "double free or corruption" error on GC'ing of keys
712 Fix "double free or corruption" error that occures in case when a key was
713 derived from an authentication message by means of `message-get-req'. When
714 such a key is GC'ed then GC'ing of its parent message leads to error, or
715 vice versa.
716 ** Fix a bug in the channel implementation
717 The bug could occasionally manifest itself on channel reading as the
718 following error:
719 #+BEGIN_EXAMPLE
720 guile: ports.c:1476: scm_i_fill_input: Assertion `pt->read_pos == pt->read_end' failed.
721 #+END_EXAMPLE
722 ** New `server-get' procedure in (ssh server)
723 The procedure can be used to retrieve server options.
724 ** New `channel-get-exit-status' procedure in (ssh channel)
725 The procedure allows to get exit status of an executed command from a
726 channel.
727 ** New `channel-request-send-exit-status' procedure in (ssh channel)
728 The procedure can be used to send the exit status to a client.
729 ** Improve printing of Guile-SSH server objects
730 Print the bind address of a server object and its bind port. Example:
731 #+BEGIN_EXAMPLE
732 #<server 127.0.0.1:12345 9b70ff0>
733 #+END_EXAMPLE
734 ** Update examples
735 *** sssh
736 - Check exit status of an executed command.
737 *** ssshd
738 - Send exit status to the client according to the result of command
739 execution.
740 *** echo server and client
741 - Some cosmetic changes aimed to make the code cleaner.
742 ** Update documentation
743 - Add description of the new procedures.
744 - Update examples.
745
746 * Changes in version 0.7.1 (2014-10-11)
747 ** New `%get-libssh-version' procedure in (ssh version)
748 The procedure can be used to get libssh version in the "raw" format such
749 as: "0.6.3/openssl/zlib".
750 ** New `get-crypto-library' procedure in (ssh version)
751 The procedure returns name of a cryptographic library with which libssh was
752 compiled.
753 ** New `zlib-support?' procedure in (ssh version)
754 The procedure checks if zlib support is enabled in libssh.
755 ** New `set-log-verbosity!' procedure in (ssh log)
756 The procedure sets global libssh log verbosity.
757 ** New `get-log-verbosity' procedure in (ssh log)
758 The procedure gets global libssh log verbosity.
759 ** New `make-keypair' procedure in (ssh key)
760 The procedure can be used to generate a new keypair with the specified
761 parameters.
762 ** New `private-key-to-file' procedure in (ssh key)
763 The procedure can be used to export a private key to a file (doesn't work
764 if libssh 0.6.3 is compiled with GCrypt).
765 ** Changes in tests
766 *** Fix "end of file" errors in tests
767 Fix the following kind of errors in tests:
768 #+BEGIN_EXAMPLE
769 ERROR: In procedure scm_i_lreadparen: /path/to/guile-ssh/sources/tests/./client-server.scm:272:34: end of file
770 #+END_EXAMPLE
771 Thanks to Ludovic Courtès for reporting the issue and for a good advice how
772 to fix that.
773 *** Don't perform ECDSA key tests if libssh is compiled with GCrypt
774 libssh 0.6.3 does not support ECDSA keys if compiled with GCrypt instead
775 of OpenSSL. Thus, ECDSA key tests used to fail. Now there is a check
776 that prevents these tests from execution in case when libssh 0.6.3 is
777 compiled with GCrypt.
778 ** Update documentation
779 - Add description of the new procedures.
780 - Add note about ECDSA keys support with GCrypt library.
781
782 * Changes in version 0.7.0 (2014-08-31)
783 ** Require GNU Guile 2.0
784 ** Require libssh 0.6.3
785 ** Change `get-public-key-hash'
786 *** Move the procedure to (ssh key)
787 *** Return the hash as a bytevector
788 *** Accept a public key as the first argument
789 *** Accept a hash type as the second argument
790 Possible types are: 'md5, 'sha1
791 ** (ssh auth) procedures now throw an exception if the session is not connected
792 ** (ssh channel) procedures now handle closed and freed channels
793 - `channel-open?' returns `#f' if the channel has been closed freed.
794 - `channel-open-session' and `channel-eof?' throw to `guile-ssh-error' if
795 the channel has been closed and freed.
796 - `channel-request-env', `channel-request-exec', `channel-request-pty',
797 `channel-request-shell', `channel-set-pty-size!', `channel-set-stream!',
798 `channel-get-stream' now throw `wrong-type-arg` if the channel is closed.
799 ** Some (ssh session) procedures now throw an exception if the session is not connected
800 These procedures are:
801 - `get-protocol-version'
802 - `authenticate-server'
803 - `get-server-public-key'
804 - `write-known-host!'
805 ** Change `userauth-pubkey!'
806 *** Rename it to `userauth-public-key!'
807 *** Change arguments
808 ** `blocking-flush!' now returns `error' symbol on error
809 instead of throwing of an exception
810 ** `connect!' now returns `error' symbol on error
811 instead of throwing of an exception
812 ** `authenticate-server' now returns `error' symbol on error
813 instead of throwing of an exception
814 ** `private-key-from-file' now takes only a file name
815 ** New (ssh log) module
816 ** Rename `userauth-pubkey-auto!' to `userauth-public-key/auto!'
817 ** New `userauth-public-key/try' procedure in (ssh auth)
818 ** New `bytevector->hex-string' procedure in (ssh key)
819 ** New `channel-open-forward' procedure in (ssh channel)
820 ** New `channel-open-forward/reverse' procedure in (ssh channel)
821 ** New `session-get' procedure in (ssh session)
822 ** New `channel-get-session' procedure in (ssh channel)
823 ** New `message-get-session' procedure in (ssh message)
824 ** Improve printing of Guile-SSH objects
825 *** Print more detailed information about `session' object
826 Print user name, host name and current state of a `session' object.
827 *** Print object address for `channel' object
828 *** Print object address for `message' object
829 *** Print object address for `key' object
830 ** Changes in tests
831 *** Add tests for Guile-SSH keys
832 *** Add tests for `authenticate-server' procedure
833 ** Bug fixes
834 *** Fix a GC issue
835 Keep a reference to the parent session in channels and messages to prevent
836 the session from premature GC'ing. Without that GC could free a session
837 even if there are live channels and by that break the channels.
838 *** `public-key?' and `private-key?' now produce correct result
839 Functions now return `#f' if the given argument is not a Guile-SSH
840 key object.
841 ** Documentation update
842 *** Fix old URLs to Guile-SSH repository in the `Installation' chapter
843 *** Add an overview of programming with Guile-SSH to the "Examples" chapter
844
845 * Changes in version 0.6.0 (2014-03-23)
846 ** Remove username from parameter list of auth procedures
847 `userauth-password!' and `userauth-pubkey!' don't take a username
848 as a parameter anymore. Rationale: According to libssh 0.6 docs,
849 most server implementations do not permit changing the username
850 during authentication. Moreover, the parameter was deprecated in
851 libssh 0.5.3.
852
853 Elimination of the username makes Guile-SSH Auth API clearer and
854 simpler. Username can be set either on creation of a session or by
855 calling of `session-set!' procedure.
856 ** `server-accept' now throws `guile-ssh-error' on error
857 ** Improve reads from channels
858 Return EOF immediately if the channel is closed instead of polling
859 it for data (which causes notable latency on the first read).
860 Thanks Ludovic Courtès for the patch.
861 ** Compile Guile modules
862 Compile Guile modules and install compiled files if GNU Guile 2.0.x
863 is available.
864 ** Update Texinfo documentation
865 *** Update Auth API description
866 *** Update Server API description
867 *** Update Acknowledgments
868 ** Update examples
869 *** Use actual path to Guile interpreter in the shebang
870 Executables will be produced during building of the Guile-SSH.
871 *** Handle `guile-ssh-error' on `server-accept'
872 *** Catch `guile-ssh-error' on reading from a port
873 *** ssshd
874 **** Add `--port', `--ssh-debug' and `--pid-file' option
875 **** Store the PID in a file
876 instead of printing it to stdout.
877 **** Handle password authentication correctly
878 *** sssh
879 **** Add `--ssh-debug' option
880 ** Improve automated tests
881 *** Prevent sssh-ssshd from asking of a SSH agent for keys
882 *** Make parallel tests work
883
884 * Changes in version 0.5.0 (2014-02-05)
885 ** Implement Guile-SSH channels as GNU Guile ports.
886 Now channels can be used with regular procedures such as `display',
887 `write' and `read-line'.
888 ** `session-set!' and `server-set!' now take log-verbosity as a symbol
889 Use symbols to represent log levels instead of numbers.
890 ** Remove duplicates of some session options
891 Remove duplicates that are existed for some Guile-SSH session
892 options: `port-str' (duplicates `port', differs only in expected
893 type of value), `log-verbosity-str' (duplicates `log-verbosity',
894 differs only in expected type of value), `add-identity' (duplicates
895 `identity', no differences).
896 ** New `userauth-autopubkey!' procedure.
897 The procedure can be used for public key authentication with a SSH
898 agent.
899 ** New procedures.
900 `channel-set-stream!', `channel-get-stream', `session?', `server?',
901 `message?'.
902 ** Remove procedures.
903 These procedures are removed due to changes in Guile-SSH channel
904 API: `close-channel!', `channel-poll' `free-channel!',
905 `channel-read`, `channel-write'.
906 ** Add documentation in Texinfo format
907 The Guile-SSH reference manual in Info format will be installed on
908 `make install' into `${prefix}/share/info' directory.
909 ** Update sssh/ssshd example.
910 *** `examples/sssh.scm' and `examples/ssshd.scm' are updated
911 to use the new Guile-SSH channel API.
912 *** `sssh.scm` now uses `userauth-autopubkey!'
913 *** `ssshd.scm' now parses command-line options
914 See `ssshd.scm --help'.
915 ** Add echo server/client example.
916 See `examples/echo' directory.
917 ** Add automated tests.
918 See `tests/' directory.
919
920 * Changes in version 0.4.0 (2013-11-26)
921 ** Port the library to GNU Guile version 2.0
922 Now the library works with GNU Guile version 2.0 as well as 1.8.
923 ** Remove "ssh:" prefix from procedures names.
924 If it is needed, an user's prefix can be added by setting a renamer
925 for a module on loading. See the documentation for the GNU Guile
926 module system.
927 ** Implement basic SSH server API.
928 ** Fix a memory corruption in `channel-read'
929 The problem was seen on reading of an output from "lsb_release -a"
930 command.
931 ** Fix a memory corruption during GC'ing of SSH keys.
932 ** Fix a bug in `session-set!'
933 Fix the bug that leads to an error if the user tried to set a
934 correct boolean option.
935 ** New `channel-write' procedure.
936 ** New `channel-request-pty' procedure.
937 ** New `channel-request-shell' procedure.
938 ** New `channel-set-pty-size!' procedure.
939 ** Fix the name of `write-known-host!'
940 The procedure was called `authenticate-server' by mistake. Rename
941 it to `write-known-host!'.
942 ** Change error handling in some procedures.
943 Now `write-known-host!', `channel-open-session',
944 `channel-request-exec', `channel-request-env', `close-channel!',
945 throw an exception on error. The return value of these procedures
946 now is undefined.
947 ** `authenticate-server' now throws guile-ssh-error exception on error.
948 Don't return the 'error symbol, throw an exception instead.
949 ** `server-set!' now throws guile-ssh-error exception on error.
950 The return value now is undefined.
951 ** Rename `make-session' to `%make-session'.
952 See `make-session' below.
953 ** New `make-session' procedure.
954 This is a convenient wrapper for `%make-session' which allows to
955 set session options by passing them as keywords.
956 ** Rename `connect' to `connect!'.
957 ** Fix a typo in an option symbol
958 'strcthostkeycheck -> 'stricthostkeycheck
959 ** Fix an infinite loop in `public-key->string'.
960 The problem was observed on Ubuntu GNU/Linux 10.04 LTS.
961 ** Add examples to the repository.
962 See the "examples/" directory.
963 ** Improve printing of SSH keys, channels and messages.
964 Examples: #<public rsa key>, #<open ssh channel>
965
966 * Changes in version 0.3.1 (2013-07-14)
967 ** Use a simpler method to GC'ing of SSH channels.
968 The idea is that we don't have to free resources allocated by a
969 channel during its GC'ing, because these resources will be freed
970 anyway when the related SSH session is GC'ed. However, to be able
971 to control allocating of resources more precisely, introduce new
972 procedure ssh:free-channel! that can be used for freeing resources
973 allocated by a channel.
974 ** ssh:free-channel!
975 New procedure.
976 ** Make the library thread-safe.
977
978 * Changes in version 0.3 (2013-07-13)
979 ** Improve working with public keys.
980 Because some libssh functions are working with public keys
981 represented as a ssh_string instead of a ssh_public_key, we try to
982 hide this peculiarity so all kinds of keys are look like a <key>
983 class from the Scheme perspective.
984 ** Fix segmentation faults on GC'ing of SSH objects.
985 The program doesn't crashes anymore during GC'ing of SSH objecs.
986 ** ssh:public-key-from-file
987 Make it work. Return newly created <key> instance or #f on error.
988 ** ssh:public-key->string
989 Take a key as a <key> instance.
990 ** ssh:private-key-from-file
991 Fix call to an undefined procedure. Return #f on error.
992 ** ssh:get-key-type
993 New procedure. The procedure returns type for a passed <key>
994 instance. Possible types are: 'dss, 'rsa, 'rsa1, 'unknown
995 ** ssh:userauth-get-list
996 New procedure. The procedure returns a list of available
997 authentication methods for a given SSH session
998 ** ssh:channel-read
999 Fix call to an undefined procedure. Throw guile-ssh-error
1000 exception on error.
1001 ** ssh:close-channel!
1002 Fix return value: return #t if channel is closed successfully, #f
1003 otherwise.
1004 ** ssh:blocking-flush!
1005 Return 'error by default.
1006 ** ssh:session-set!
1007 Fix a bug with uint32 options setting.
1008 ** SSH objects now comparable.
1009
1010 * Changes in version 0.2 (2013-05-25)
1011 ** Release of the first stable version of Guile-SSH.
1012
1013 Local Variables:
1014 mode: org
1015 End: