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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
package net.usebox.gemini.server
import java.nio.file.FileSystems
import scala.concurrent.duration._
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers
import akka.util.ByteString
class ServerSpec extends AnyFlatSpec with Matchers {
behavior of "validPath"
it should "return true for the emtpy path" in {
Server(TestData.conf).validPath("") shouldBe true
}
it should "return true for valid paths" in {
List("/", "/file", "/./", "/.", "/dir/", "/dir/../").foreach { p =>
Server(TestData.conf).validPath(p) shouldBe true
}
}
it should "return false for invalid paths" in {
List("/../", "/..", "/dir/../..", "/dir/../..", "/./../", "/./dir/.././../")
.foreach { p =>
Server(TestData.conf).validPath(p) shouldBe false
}
}
behavior of "guessMimeType using the internal resolver"
it should "resolve a known MIME type" in {
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("file.html"),
None
) shouldBe "text/html"
}
it should "resolve de default MIME type for unknown types" in {
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("unknow"),
None
) shouldBe TestData.conf.defaultMimeType
}
it should "resolve gemini MIME type" in {
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("file.gmi"),
None
) shouldBe "text/gemini"
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("file.gemini"),
None
) shouldBe "text/gemini"
}
it should "resolve gemini MIME type, including parameters" in {
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("file.gmi"),
Some("param")
) shouldBe "text/gemini; param"
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("file.gemini"),
Some("param")
) shouldBe "text/gemini; param"
}
it should "gemini MIME type parameters are sanitized" in {
Server(TestData.conf)
.guessMimeType(
FileSystems.getDefault().getPath("file.gmi"),
Some(" ; param")
) shouldBe "text/gemini; param"
}
behavior of "guessMimeType using the configured types"
it should "resolve a known MIME type" in {
Server(TestData.conf.copy(mimeTypes = TestData.mimeTypes))
.guessMimeType(
FileSystems.getDefault().getPath("file.gmi"),
None
) shouldBe "config"
}
it should "include parameters for text/gemini MIME types" in {
Server(
TestData.conf.copy(mimeTypes = Some(Map("text/gemini" -> List(".gmi"))))
).guessMimeType(
FileSystems.getDefault().getPath("file.gmi"),
Some("param")
) shouldBe "text/gemini; param"
}
it should "resolve de default MIME type for unknown types" in {
Server(TestData.conf.copy(mimeTypes = TestData.mimeTypes))
.guessMimeType(
FileSystems.getDefault().getPath("unknow"),
None
) shouldBe TestData.conf.defaultMimeType
}
behavior of "decodeUTF8"
it should "return right on valid UTF-8 codes" in {
Server(TestData.conf)
.decodeUTF8(ByteString("válid UTF-8")) shouldBe Symbol(
"right"
)
}
it should "return left on invalid UTF-8 codes" in {
Server(TestData.conf)
.decodeUTF8(ByteString(Array(0xc3.toByte, 0x28.toByte))) shouldBe Symbol(
"left"
)
}
behavior of "handleReq"
it should "return bad request on URLs with no scheme" in {
Server(TestData.conf).handleReq("//localhost/") should matchPattern {
case _: BadRequest =>
}
}
it should "return proxy request refused on port mismatch" in {
Server(TestData.conf)
.handleReq("gemini://localhost:8080/") should matchPattern {
case _: ProxyRequestRefused =>
}
}
it should "return proxy request refused when port not provided and configured port is not default" in {
Server(TestData.conf.copy(port = 8080))
.handleReq("gemini://localhost/") should matchPattern {
case _: ProxyRequestRefused =>
}
}
it should "return success when port is provided and matches configured port (not default)" in {
Server(TestData.conf.copy(port = 8080))
.handleReq("gemini://localhost:8080/") should matchPattern {
case _: Success =>
}
}
it should "return proxy request refused when the vhost is not found" in {
Server(TestData.conf)
.handleReq("gemini://otherhost/") should matchPattern {
case _: ProxyRequestRefused =>
}
}
it should "return bad request when user info is present" in {
Server(TestData.conf)
.handleReq("gemini://user@localhost/") should matchPattern {
case _: BadRequest =>
}
}
it should "return bad request when the path is out of root dir" in {
Server(TestData.conf)
.handleReq("gemini://localhost/../../") should matchPattern {
case _: BadRequest =>
}
}
it should "return bad request for invalid URLs" in {
Server(TestData.conf)
.handleReq("gemini://localhost/ invalid") should matchPattern {
case _: BadRequest =>
}
}
it should "redirect to normalize the URL" in {
Server(TestData.conf)
.handleReq("gemini://localhost/./") should matchPattern {
case _: PermanentRedirect =>
}
}
it should "return not found if the path doesn't exist" in {
Server(TestData.conf)
.handleReq("gemini://localhost/doesnotexist") should matchPattern {
case _: NotFound =>
}
}
it should "return not found if a dot file" in {
Server(TestData.conf)
.handleReq("gemini://localhost/.dotfile") should matchPattern {
case _: NotFound =>
}
}
it should "return success on reading file" in {
Server(TestData.conf)
.handleReq("gemini://localhost/index.gmi") should matchPattern {
case Success(_, "text/gemini", Some(_), 25L) =>
}
}
it should "redirect and normalize request on a directory" in {
Server(TestData.conf)
.handleReq("gemini://localhost/dir") should matchPattern {
case _: PermanentRedirect =>
}
}
it should "return an existing index file when requesting a directory" in {
Server(TestData.conf)
.handleReq("gemini://localhost/") should matchPattern {
case Success(_, "text/gemini", Some(_), 25L) =>
}
}
it should "return a directory listing if is enabled and no index" in {
Server(TestData.conf)
.handleReq("gemini://localhost/dir/") should matchPattern {
case _: DirListing =>
}
}
it should "return not found if directory listing is nt enabled and no index" in {
Server(
TestData.conf.copy(virtualHosts =
List(TestData.conf.virtualHosts(0).copy(directoryListing = false))
)
).handleReq("gemini://localhost/dir/") should matchPattern {
case _: NotFound =>
}
}
it should "return proxy request refused for non gemini schemes" in {
Server(TestData.conf)
.handleReq("https://localhost/") should matchPattern {
case _: ProxyRequestRefused =>
}
}
it should "include gemini params for gemini MIME type" in {
Server(
TestData.conf.copy(virtualHosts =
List(TestData.conf.virtualHosts(0).copy(geminiParams = Some("test")))
)
).handleReq("gemini://localhost/index.gmi") should matchPattern {
case Success(_, "text/gemini; test", Some(_), 25L) =>
}
}
object TestData {
val conf = ServiceConf(
address = "127.0.0.1",
port = 1965,
defaultMimeType = "text/plain",
idleTimeout = 10.seconds,
virtualHosts = List(
VirtualHost(
host = "localhost",
root = getClass.getResource("/").getPath()
)
),
genCertValidFor = 1.day,
enabledProtocols = Nil,
enabledCipherSuites = Nil
)
val mimeTypes = Some(
Map(
"config" -> List(".gmi", ".gemini")
)
)
}
}
|
