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
|
#!/usr/bin/env python
## Copyright 2018 Stian Soiland-Reyes, The University of Manchester, UK
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## http://www.apache.org/licenses/LICENSE-2.0
##
## Unless required by applicable law or agreed to in writing, software
## distributed under the License is distributed on an "AS IS" BASIS,
## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
## See the License for the specific language governing permissions and
## limitations under the License.
import unittest
from uuid import UUID, RFC_4122, NAMESPACE_OID
import re
from arcp import generate
from hashlib import sha256, md5
# Some test data
TEST_UUID_v1 = UUID("dbc0802a-0682-11e8-9895-b8ca3ad10ac0")
TEST_UUID_v4 = UUID("8c36d39a-18be-4aa8-b1ce-fef330b00a28")
OID = "1.3.6.1.4.1.13661"
uuid_re = re.compile(r"^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$")
class UUIDTest(unittest.TestCase):
"""Test arcp_uuid()"""
def testUUID(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/",
generate.arcp_uuid(TEST_UUID_v1))
# UUID version should not matter
self.assertEqual("arcp://uuid,8c36d39a-18be-4aa8-b1ce-fef330b00a28/",
generate.arcp_uuid(TEST_UUID_v4))
def testUUIDPath(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/folder/file.txt",
generate.arcp_uuid(TEST_UUID_v1, "/folder/file.txt"))
def testUUIDPathQuery(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/folder/file.txt?q=s",
generate.arcp_uuid(TEST_UUID_v1, "/folder/file.txt", "q=s"))
def testUUIDPathQueryFrag(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/folder/file.txt?q=s#frag",
generate.arcp_uuid(TEST_UUID_v1, "/folder/file.txt", "q=s", "frag"))
def testUUIDQuery(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/?a=b&c=d",
generate.arcp_uuid(TEST_UUID_v1, query="a=b&c=d"))
def testUUIDFrag(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/#frag",
generate.arcp_uuid(TEST_UUID_v1, fragment="frag"))
def testUUIDstr(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/",
generate.arcp_uuid("dbc0802a-0682-11e8-9895-b8ca3ad10ac0"))
def testUUIDstrFromUpperCase(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/",
generate.arcp_uuid("dbc0802a-0682-11e8-9895-b8ca3ad10ac0"))
def testUUIDstrPathQueryFrag(self):
self.assertEqual("arcp://uuid,dbc0802a-0682-11e8-9895-b8ca3ad10ac0/folder/file.txt?q=s#frag",
generate.arcp_uuid("dbc0802a-0682-11e8-9895-b8ca3ad10ac0",
"/folder/file.txt", "q=s", "frag"))
def testUUIDstrInvalidUUID(self):
with self.assertRaises(Exception):
# Too short
generate.arcp_uuid("5da78af6")
with self.assertRaises(Exception):
# empty
generate.arcp_uuid("")
class RandomTest(unittest.TestCase):
"""Test arcp_random(), with implicit or explicit UUID"""
def testRandom(self):
u = generate.arcp_random()
u2 = generate.arcp_random()
# always fresh
self.assertNotEqual(u, u2)
self.assertTrue(u.startswith("arcp://uuid,"))
self.assertTrue(u.endswith("/"))
def testRandomValidUUID(self):
u = generate.arcp_random()
# Extract UUID to ensure it is v4
uuidStr = u.replace("arcp://uuid,", "").strip("/")
# Ensure RFC4122 compliance
self.assertIsNotNone(uuid_re.match(uuidStr))
# ensure lower-case in output
self.assertEqual(uuidStr, uuidStr.lower())
# must be valid UUID
uuid = UUID(uuidStr)
# must be RFC_4122 variant, version 4 (random)
self.assertEqual(RFC_4122, uuid.variant)
self.assertEqual(4, uuid.version)
def testRandomPath(self):
u = generate.arcp_random("/folder/file.txt")
self.assertTrue(u.startswith("arcp://uuid,"))
self.assertTrue(u.endswith("/folder/file.txt"))
self.assertEqual(
# initial / in path is optional
len(generate.arcp_random("file.txt")),
len(generate.arcp_random("/file.txt")))
def testRandomQuery(self):
u = generate.arcp_random(query="q=a")
self.assertTrue(u.startswith("arcp://uuid,"))
self.assertTrue(u.endswith("/?q=a"))
def testRandomFrag(self):
u = generate.arcp_random(fragment="frag")
self.assertTrue(u.startswith("arcp://uuid,"))
self.assertTrue(u.endswith("/#frag"))
def testRandomPathQueryFrag(self):
u = generate.arcp_random("/folder/file.txt", "a=b&c=d", "frag")
self.assertTrue(u.startswith("arcp://uuid,"))
self.assertTrue(u.endswith("/folder/file.txt?a=b&c=d#frag"))
# Now test providing a fixed UUID
def testUUID(self):
self.assertEqual("arcp://uuid,8c36d39a-18be-4aa8-b1ce-fef330b00a28/",
generate.arcp_random(uuid=TEST_UUID_v4))
# UUID version must be 4
with self.assertRaises(Exception):
generate.arcp_random(uuid=TEST_UUID_v1)
def testUUIDPath(self):
self.assertEqual("arcp://uuid,8c36d39a-18be-4aa8-b1ce-fef330b00a28/folder/file.txt",
generate.arcp_random("/folder/file.txt", uuid=TEST_UUID_v4))
def testUUIDstr(self):
self.assertEqual("arcp://uuid,8c36d39a-18be-4aa8-b1ce-fef330b00a28/",
generate.arcp_random(uuid="8c36d39a-18be-4aa8-b1ce-fef330b00a28"))
with self.assertRaises(Exception):
# UUID version must be 4
generate.arcp_random(uuid="dbc0802a-0682-11e8-9895-b8ca3ad10ac0")
def testUUIDstrPathQueryFrag(self):
self.assertEqual("arcp://uuid,8c36d39a-18be-4aa8-b1ce-fef330b00a28/folder/file.txt?q=s#frag",
generate.arcp_random("/folder/file.txt", "q=s", "frag",
uuid="8c36d39a-18be-4aa8-b1ce-fef330b00a28"))
def testUUIDstrInvalidUUID(self):
with self.assertRaises(Exception):
# Too short
generate.arcp_random(uuid="5da78af6")
with self.assertRaises(Exception):
# empty
generate.arcp_random(uuid="")
class LocationTest(unittest.TestCase):
"""Test arcp_location()"""
def testExampleZip(self):
# URL and expected UUID as in
# https://tools.ietf.org/id/draft-soilandreyes-arcp-03.html#rfc.appendix.A.2
self.assertEqual("arcp://uuid,b7749d0b-0e47-5fc4-999d-f154abe68065/",
generate.arcp_location("http://example.com/data.zip"))
self.assertEqual("arcp://uuid,b7749d0b-0e47-5fc4-999d-f154abe68065/pics/",
generate.arcp_location("http://example.com/data.zip", "/pics/"))
self.assertEqual("arcp://uuid,b7749d0b-0e47-5fc4-999d-f154abe68065/pics/flower.jpeg",
generate.arcp_location("http://example.com/data.zip", "/pics/flower.jpeg"))
def testExampleZipUUIDValid(self):
u = generate.arcp_location("http://example.com/")
# Extract UUID to ensure it is v4
uuidStr = u.replace("arcp://uuid,", "").strip("/")
# Ensure RFC4122 compliance
self.assertIsNotNone(re.match(uuid_re, uuidStr))
# ensure lower-case in output
self.assertEqual(uuidStr, uuidStr.lower())
# must be valid UUID
uuid = UUID(uuidStr)
# must be RFC_4122 variant, version 5 (name sha1)
self.assertEqual(RFC_4122, uuid.variant)
self.assertEqual(5, uuid.version)
def testLocationOtherNamespace(self):
u = generate.arcp_location(OID, namespace=NAMESPACE_OID, path="/example")
self.assertEqual("arcp://uuid,215aa48f-233f-507f-8484-3eb5d6e23e9d/example", u)
def testLocationNamespaceUUIDstrPathQueryFrag(self):
self.assertEqual("arcp://uuid,215aa48f-233f-507f-8484-3eb5d6e23e9d/folder/file.txt?q=s#frag",
generate.arcp_location(OID, "/folder/file.txt", "q=s", "frag",
namespace=NAMESPACE_OID))
class NameTest(unittest.TestCase):
"""Test arcp_name()"""
def testExampleName(self):
# Adapted from
# https://tools.ietf.org/id/draft-soilandreyes-arcp-02.html#rfc.appendix.A.7
self.assertEqual("arcp://name,gallery.example.org/",
generate.arcp_name("gallery.example.org"))
new_photos = generate.arcp_name("gallery.example.org", "/photos/", "New")
self.assertEqual("arcp://name,gallery.example.org/photos/?New",
new_photos)
photo = generate.arcp_name("gallery.example.org", "/photos/137")
self.assertEqual("arcp://name,gallery.example.org/photos/137", photo)
template = "arcp://name,messaging.example.com/share;{*uri};{*redirect}"
u = template.replace("{*uri}", photo).replace("{*redirect}", new_photos)
# TODO: Should arcp_name support
path = "/share;%s;%s" % (photo, new_photos)
self.assertEqual(u,
generate.arcp_name("messaging.example.com", path))
def testNamePath(self):
self.assertEqual("arcp://name,app.example.org/msgs/1",
generate.arcp_name("app.example.org", "/msgs/1"))
def testNameQuery(self):
self.assertEqual("arcp://name,app.example.org/?q=a",
generate.arcp_name("app.example.org", query="q=a"))
def testNameHash(self):
self.assertEqual("arcp://name,app.example.org/#frag",
generate.arcp_name("app.example.org", fragment="frag"))
def testNamePathQueryHash(self):
self.assertEqual("arcp://name,app.example.org/msgs/1?a=b&c=d#frag",
generate.arcp_name("app.example.org", "/msgs/1", "a=b&c=d", "frag"))
def testInvalidName(self):
with self.assertRaises(Exception):
generate.arcp_name("example com")
def testEmptyName(self):
# empty name is valid by the spec (TODO: should it be?)
self.assertEqual("arcp://name,/",
generate.arcp_name(""))
# Example from https://tools.ietf.org/html/rfc6920#section-8.1
BYTES = "Hello World!".encode("ASCII")
# echo -n "Hello World!" | sha256sum
HASH = "7f83b1657ff1fc53b92dc18148a1d65dfc2d4b1fa3d677284addd200126d9069"
NI = "ni:///sha-256;f4OxZX_x_FO5LcGBSKHWXfwtSx-j1ncoSt3SABJtkGk"
ARCP = "arcp://ni,sha-256;f4OxZX_x_FO5LcGBSKHWXfwtSx-j1ncoSt3SABJtkGk/"
class HashTest(unittest.TestCase):
"""Test arcp_hash()"""
def testHash(self):
# Using "Hello World!" example
# instead of a real archive file
self.assertEqual(ARCP, generate.arcp_hash(BYTES))
def testHashPath(self):
self.assertEqual(ARCP + "bin/evil",
generate.arcp_hash(BYTES, "/bin/evil"))
def testHashQuery(self):
self.assertEqual(ARCP + "?q=a",
generate.arcp_hash(BYTES, query="q=a"))
def testHashFragment(self):
self.assertEqual(ARCP + "#frag",
generate.arcp_hash(BYTES, fragment="frag"))
def testHashPathQueryFragment(self):
self.assertEqual(ARCP + "bin/evil?a=b&c=d#frag",
generate.arcp_hash(BYTES, "/bin/evil", "a=b&c=d", "frag"))
def testHashHash(self):
h = sha256(BYTES)
self.assertEqual(ARCP, generate.arcp_hash(hash=h))
def testHashPathEmptyHash(self):
h = sha256()
self.assertEqual(ARCP + "bin/evil",
generate.arcp_hash(BYTES, "bin/evil", hash=h))
def testHashPathPremadeHash(self):
h = sha256(BYTES)
self.assertEqual(ARCP + "bin/evil",
generate.arcp_hash(path="bin/evil", hash=h))
def testHashWrongHash(self):
h = md5(BYTES)
with self.assertRaises(Exception):
generate.arcp_hash(hash=h)
|
