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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
| | ;;; erc-scenarios-sasl.el --- SASL tests for ERC -*- lexical-binding: t -*-
;; Copyright (C) 2022 Free Software Foundation, Inc.
;;
;; This file is part of GNU Emacs.
;;
;; This program 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.
;;
;; This program 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 this program. If not, see
;; <https://www.gnu.org/licenses/>.
;;; Code:
(require 'ert-x)
(eval-and-compile
(let ((load-path (cons (ert-resource-directory) load-path)))
(require 'erc-scenarios-common)))
(declare-function sasl-client-name "sasl" (client))
(require 'erc-scenarios-common)
(require 'erc-sasl)
(ert-deftest erc-scenarios-sasl--plain ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "sasl")
(erc-d-linger-secs 0.5)
(erc-server-flood-penalty 0.1)
(dumb-server (erc-d-run "localhost" t 'plain))
(port (process-contact dumb-server :service))
(erc-modules (cons 'sasl erc-modules))
(erc-sasl-mechanism 'plain)
(erc-sasl-password "password123")
(erc-sasl--session-options nil)
(inhibit-message noninteractive)
(expect (erc-d-t-make-expecter)))
(ert-info ("Connect")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:user "tester"
:full-name "tester")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(erc-d-t-wait-for 10 "server buffer ready" (get-buffer "ExampleOrg"))
(ert-info ("Notices received")
(with-current-buffer "ExampleOrg"
(funcall expect 10 "This server is in debug mode")
;; Regression "\0\0\0\0 ..." caused by (fillarray passphrase 0)
(should (string= erc-sasl-password "password123"))))))
;; This is meant to assert `erc-update-modules' and local-module
;; behavior generally. It only exists here for convenience because as
;; of ERC 5.5, `sasl' is the only local module.
(ert-deftest erc-scenarios-sasl--local-modules-reconnect ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "sasl")
(erc-server-flood-penalty 0.1)
(dumb-server (erc-d-run "localhost" t 'plain 'plain))
(port (process-contact dumb-server :service))
(erc-sasl--session-options nil)
(inhibit-message noninteractive)
(expect (erc-d-t-make-expecter)))
(ert-info ("Connect with options let-bound")
(with-current-buffer
;; This won't work unless the library is already loaded
(let ((erc-modules (cons 'sasl erc-modules))
(erc-sasl-mechanism 'plain)
(erc-sasl-password "password123"))
(erc :server "127.0.0.1"
:port port
:nick "tester"
:user "tester"
:full-name "tester"))
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(with-current-buffer (erc-d-t-wait-for 10 (get-buffer "ExampleOrg"))
(ert-info ("First connection succeeds")
(funcall expect 10 "This server is in debug mode")
(erc-cmd-QUIT "")
(funcall expect 10 "finished"))
(should-not erc-sasl-password) ; obviously
(should-not (memq 'sasl erc-modules))
(erc-d-t-wait-for 10 (not (erc-server-process-alive)))
(erc-cmd-RECONNECT)
(ert-info ("Second connection succeeds")
(funcall expect 10 "This server is in debug mode")
(erc-cmd-QUIT "")
(funcall expect 10 "finished")))))
(ert-deftest erc-scenarios-sasl--external ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "sasl")
(erc-d-linger-secs 0.5)
(erc-server-flood-penalty 0.1)
(dumb-server (erc-d-run "localhost" t 'external))
(port (process-contact dumb-server :service))
(erc-modules (cons 'sasl erc-modules))
(erc-sasl-mechanism 'external)
(erc-sasl--session-options nil)
(inhibit-message noninteractive)
(expect (erc-d-t-make-expecter)))
(ert-info ("Connect")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:user "tester"
:full-name "tester")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(erc-d-t-wait-for 10 "server buffer ready" (get-buffer "ExampleOrg"))
(ert-info ("Notices received")
(with-current-buffer "ExampleOrg"
(funcall expect 10 "903 * Authentication successful")
(funcall expect 10 "This server is in debug mode")))))
(ert-deftest erc-scenarios-sasl--plain-fail ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "sasl")
(erc-d-linger-secs 0.5)
(erc-server-flood-penalty 0.1)
(dumb-server (erc-d-run "localhost" t 'plain-failed))
(port (process-contact dumb-server :service))
(erc-modules (cons 'sasl erc-modules))
(erc-sasl-password "wrong")
(erc-sasl-mechanism 'plain)
(erc-sasl--session-options nil)
(inhibit-message noninteractive)
(expect (erc-d-t-make-expecter))
(buf nil))
(ert-info ("Connect")
(setq buf (erc :server "127.0.0.1"
:port port
:nick "tester"
:user "tester"
:full-name "tester"))
(let ((err (should-error
(with-current-buffer buf
(funcall expect 20 "Connection failed!")))))
(should (string-search "please review" (cadr err)))
(with-current-buffer buf
(funcall expect 10 "Opening connection")
(funcall expect 20 "SASL authentication failed")
(should-not (erc-server-process-alive)))))))
(defun erc-scenarios--common--sasl (mech)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "sasl")
(erc-d-linger-secs 0.5)
(erc-server-flood-penalty 0.1)
(dumb-server (erc-d-run "localhost" t mech))
(port (process-contact dumb-server :service))
(erc-modules (cons 'sasl erc-modules))
(erc-sasl-password "sesame")
(erc-sasl-mechanism mech)
(erc-sasl--session-options nil)
(mock-rvs (list "c5RqLCZy0L4fGkKAZ0hujFBs" ""))
(sasl-unique-id-function (lambda () (pop mock-rvs)))
(inhibit-message noninteractive)
(expect (erc-d-t-make-expecter)))
(ert-info ("Connect")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "jilles"
:full-name "jilles")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(erc-d-t-wait-for 10 "server buffer ready" (get-buffer "jaguar"))
(ert-info ("Notices received")
(with-current-buffer "jaguar"
(funcall expect 10 "Found your hostname")
(funcall expect 20 "marked as being away")))))
(ert-deftest erc-scenarios-sasl--scram-sha-1 ()
:tags '(:expensive-test)
(let ((erc-sasl-authzid "jilles"))
(erc-scenarios--common--sasl 'scram-sha-1)))
(ert-deftest erc-scenarios-sasl--scram-sha-256 ()
:tags '(:expensive-test)
(unless (featurep 'sasl-scram-sha256)
(ert-skip "Emacs lacks sasl-scram-sha256"))
(erc-scenarios--common--sasl 'scram-sha-256))
;;; erc-scenarios-sasl.el ends here
|