1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
;;; session.scm -- SSH session management.
;; Copyright (C) 2013-2024 Artyom V. Poptsov <poptsov.artyom@gmail.com>
;;
;; This file is a part of Guile-SSH.
;;
;; Guile-SSH is free software: you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.
;;
;; Guile-SSH is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;; General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with Guile-SSH. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This module contains API that is used for SSH session management.
;;
;; These methods are exported:
;;
;; session?
;; %make-session
;; make-session
;; session-parse-config!
;; blocking-flush!
;; session-set!
;; session-get
;; get-protocol-version
;; connect!
;; disconnect!
;; connected?
;; authenticate-server
;; get-public-key-hash
;; write-known-host!
;; get-error
;;; Code:
(define-module (ssh session)
#:use-module (ice-9 optargs)
#:use-module (ssh log)
#:use-module (ssh version)
#:export (session
session?
%make-session
make-session
session-parse-config!
blocking-flush!
session-set!
session-get
get-protocol-version
connect!
disconnect!
connected?
authenticate-server
get-server-public-key
write-known-host!
get-error))
;; Set a SSH option if it is specified by the user
(define-macro (session-set-if-specified! option)
`(if ,option (session-set! session (quote ,option) ,option)))
(define (get-libssh-minor-version)
(string->number (cadr (string-split (get-libssh-version)
#\.))))
;; This procedure is more convenient than primitive `%make-session',
;; but on other hand it should be a bit slower because of additional
;; checks. I think we can put up with this. -avp
(define* (make-session #:key host port user ssh-dir identity add-identity
knownhosts timeout timeout-usec ssh1 ssh2 log-verbosity
ciphers-c-s ciphers-s-c compression-c-s compression-s-c
proxycommand stricthostkeycheck compression
compression-level nodelay callbacks (config #t)
public-key-accepted-types)
"Make a new SSH session with specified configuration.\n
Return a new SSH session."
(let ((session (%make-session)))
(session-set-if-specified! host)
(if config
(begin
(or host
(throw 'guile-ssh-error
"'config' is specified, but 'host' option is missed."))
(cond
((string? config)
(%gssh-session-parse-config! session config))
((boolean? config)
(%gssh-session-parse-config! session #f))
(else
(throw 'guile-ssh-error "Wrong 'config' value" config))))
(let ((libssh-minor-version (get-libssh-minor-version)))
(if (>= libssh-minor-version 9)
(session-set! session 'process-config? #f)
(begin
(format-log 'rare
'make-session
(string-append
"process-config? option is not available"
" (using libssh 0.~a.)"
" Falling back to setting the config to"
" '/dev/null' to prevent reading the default"
" configuration files."
" See <https://github.com/artyom-poptsov/guile-ssh/issues/38>.")
libssh-minor-version)
(%gssh-session-parse-config! session "/dev/null")))))
(session-set-if-specified! port)
(session-set-if-specified! user)
(session-set-if-specified! ssh-dir)
(session-set-if-specified! identity)
(session-set-if-specified! add-identity)
(session-set-if-specified! knownhosts)
(session-set-if-specified! timeout)
(session-set-if-specified! timeout-usec)
(session-set-if-specified! ssh1)
(session-set-if-specified! ssh2)
(session-set-if-specified! log-verbosity)
(session-set-if-specified! ciphers-c-s)
(session-set-if-specified! ciphers-s-c)
(session-set-if-specified! compression-c-s)
(session-set-if-specified! compression-s-c)
(session-set-if-specified! proxycommand)
(session-set-if-specified! stricthostkeycheck)
(session-set-if-specified! compression)
(session-set-if-specified! compression-level)
(session-set-if-specified! nodelay)
(session-set-if-specified! callbacks)
session))
(define* (session-parse-config! session #:optional file-name)
"Parse an SSH config FILE-NAME and set SESSION options. If FILE-NAME is not
set, the default SSH '~/.ssh/config' is used. Throw 'guile-ssh-error' on an
error. Return value is undefined."
(%gssh-session-parse-config! session file-name))
(unless (getenv "GUILE_SSH_CROSS_COMPILING")
(load-extension "libguile-ssh" "init_session"))
;;; session.scm ends here
|
