gnu: Add emacs-exec-path-from-shell.
[jackhill/guix/guix.git] / tests / substitute.scm
CommitLineData
e9c6c584
NK
1;;; GNU Guix --- Functional package management for GNU
2;;; Copyright © 2014 Nikita Karetnikov <nikita@karetnikov.org>
a9468b42 3;;; Copyright © 2014, 2015, 2017 Ludovic Courtès <ludo@gnu.org>
e9c6c584
NK
4;;;
5;;; This file is part of GNU Guix.
6;;;
7;;; GNU Guix is free software; you can redistribute it and/or modify it
8;;; under the terms of the GNU General Public License as published by
9;;; the Free Software Foundation; either version 3 of the License, or (at
10;;; your option) any later version.
11;;;
12;;; GNU Guix is distributed in the hope that it will be useful, but
13;;; WITHOUT ANY WARRANTY; without even the implied warranty of
14;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15;;; GNU General Public License for more details.
16;;;
17;;; You should have received a copy of the GNU General Public License
18;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
19
2c74fde0
LC
20(define-module (test-substitute)
21 #:use-module (guix scripts substitute)
e9c6c584
NK
22 #:use-module (guix base64)
23 #:use-module (guix hash)
0363991a 24 #:use-module (guix serialization)
e9c6c584
NK
25 #:use-module (guix pk-crypto)
26 #:use-module (guix pki)
cdea30e0 27 #:use-module (guix config)
e903b7c1 28 #:use-module (guix base32)
cdea30e0 29 #:use-module ((guix store) #:select (%store-prefix))
f84f8590 30 #:use-module ((guix ui) #:select (guix-warning-port))
a9468b42
LC
31 #:use-module ((guix build utils)
32 #:select (mkdir-p delete-file-recursively))
33 #:use-module (guix tests http)
e9c6c584 34 #:use-module (rnrs bytevectors)
cdea30e0
LC
35 #:use-module (rnrs io ports)
36 #:use-module (web uri)
52f80dfc 37 #:use-module (ice-9 regex)
cdea30e0 38 #:use-module (srfi srfi-26)
e9c6c584 39 #:use-module (srfi srfi-34)
52f80dfc 40 #:use-module (srfi srfi-35)
e9c6c584
NK
41 #:use-module ((srfi srfi-64) #:hide (test-error)))
42
f84f8590
LC
43(define-syntax-rule (test-quit name error-rx exp)
44 "Emit a test that passes when EXP throws to 'quit' with value 1, and when
45it writes to GUIX-WARNING-PORT a messages that matches ERROR-RX."
cdea30e0 46 (test-equal name
f84f8590
LC
47 '(1 #t)
48 (let ((error-output (open-output-string)))
49 (parameterize ((guix-warning-port error-output))
50 (catch 'quit
51 (lambda ()
52 exp
53 #f)
54 (lambda (key value)
55 (list value
56 (let ((message (get-output-string error-output)))
57 (->bool (string-match error-rx message))))))))))
e9c6c584
NK
58
59(define %public-key
cdea30e0
LC
60 ;; This key is known to be in the ACL by default.
61 (call-with-input-file (string-append %config-directory "/signing-key.pub")
62 (compose string->canonical-sexp get-string-all)))
e9c6c584
NK
63
64(define %private-key
cdea30e0
LC
65 (call-with-input-file (string-append %config-directory "/signing-key.sec")
66 (compose string->canonical-sexp get-string-all)))
e9c6c584 67
52f80dfc
LC
68(define* (signature-body bv #:key (public-key %public-key))
69 "Return the signature of BV as the base64-encoded body of a narinfo's
cdea30e0 70'Signature' field."
e9c6c584
NK
71 (base64-encode
72 (string->utf8
73 (canonical-sexp->string
52f80dfc 74 (signature-sexp (bytevector->hash-data (sha256 bv)
e9c6c584
NK
75 #:key-type 'rsa)
76 %private-key
cdea30e0 77 public-key)))))
e9c6c584 78
e9c6c584
NK
79(define %wrong-public-key
80 (string->canonical-sexp "(public-key
81 (rsa
82 (n #00E05873AC2B168760343145918E954EE9AB73C026355693B192E01EE835261AA689E9EF46642E895BCD65C648524059FC450E4BA77A68F4C52D0E39EF0CC9359709AB6AAB153B63782201871325B0FDA19CB401CD99FD0C31A91CA9000AA90A77E82B89E036FB63BC1D3961207469B3B12468977148D376F8012BB12A4B11A8F1#)
83 (e #010001#)
84 )
85 )"))
86
52f80dfc
LC
87(define* (signature-field bv-or-str
88 #:key (version "1") (public-key %public-key))
89 "Return the 'Signature' field value of bytevector/string BV-OR-STR, using
90PUBLIC-KEY as the signature's principal, and using VERSION as the signature
91version identifier.."
92 (string-append version ";example.gnu.org;"
93 (signature-body (if (string? bv-or-str)
94 (string->utf8 bv-or-str)
95 bv-or-str)
96 #:public-key public-key)))
97
e9c6c584 98
cdea30e0 99\f
2c74fde0 100(test-begin "substitute")
e9c6c584 101
f84f8590
LC
102(test-quit "not a number"
103 "signature version"
52f80dfc
LC
104 (narinfo-signature->canonical-sexp
105 (signature-field "foo" #:version "not a number")))
e9c6c584 106
f84f8590
LC
107(test-quit "wrong version number"
108 "unsupported.*version"
52f80dfc
LC
109 (narinfo-signature->canonical-sexp
110 (signature-field "foo" #:version "2")))
e9c6c584
NK
111
112(test-assert "valid narinfo-signature->canonical-sexp"
52f80dfc 113 (canonical-sexp? (narinfo-signature->canonical-sexp (signature-field "foo"))))
e9c6c584 114
e9c6c584 115
cdea30e0 116\f
a9468b42
LC
117(define %main-substitute-directory
118 ;; The place where 'call-with-narinfo' stores its data by default.
119 (uri-path (string->uri (getenv "GUIX_BINARY_SUBSTITUTE_URL"))))
120
121(define %alternate-substitute-directory
122 ;; Another place.
123 (string-append (dirname %main-substitute-directory)
124 "/substituter-alt-data"))
125
e9c6c584 126(define %narinfo
52f80dfc 127 ;; Skeleton of the narinfo used below.
cdea30e0
LC
128 (string-append "StorePath: " (%store-prefix)
129 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo
e903b7c1
LC
130URL: example.nar
131Compression: none
132NarHash: sha256:" (bytevector->nix-base32-string
133 (sha256 (string->utf8 "Substitutable data."))) "
e9c6c584
NK
134NarSize: 42
135References: bar baz
cdea30e0
LC
136Deriver: " (%store-prefix) "/foo.drv
137System: mips64el-linux\n"))
e9c6c584 138
a9468b42
LC
139(define* (call-with-narinfo narinfo thunk
140 #:optional
141 (narinfo-directory %main-substitute-directory))
142 "Call THUNK in a context where the directory at URL is populated with
cdea30e0 143a file for NARINFO."
a9468b42
LC
144 (mkdir-p narinfo-directory)
145 (let ((cache-directory (string-append (getenv "XDG_CACHE_HOME")
146 "/guix/substitute/")))
cdea30e0
LC
147 (dynamic-wind
148 (lambda ()
149 (when (file-exists? cache-directory)
150 (delete-file-recursively cache-directory))
151 (call-with-output-file (string-append narinfo-directory
152 "/nix-cache-info")
153 (lambda (port)
154 (format port "StoreDir: ~a\nWantMassQuery: 0\n"
155 (%store-prefix))))
156 (call-with-output-file (string-append narinfo-directory "/"
157 "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
158 ".narinfo")
159 (cut display narinfo <>))
160
e903b7c1
LC
161 ;; Prepare the nar.
162 (call-with-output-file
163 (string-append narinfo-directory "/example.out")
164 (cut display "Substitutable data." <>))
165 (call-with-output-file
166 (string-append narinfo-directory "/example.nar")
167 (cute write-file
168 (string-append narinfo-directory "/example.out") <>))
169
2c74fde0 170 (set! (@@ (guix scripts substitute)
cdea30e0
LC
171 %allow-unauthenticated-substitutes?)
172 #f))
173 thunk
174 (lambda ()
a9468b42
LC
175 (when (file-exists? cache-directory)
176 (delete-file-recursively cache-directory))))))
cdea30e0
LC
177
178(define-syntax-rule (with-narinfo narinfo body ...)
179 (call-with-narinfo narinfo (lambda () body ...)))
180
a9468b42
LC
181(define-syntax-rule (with-narinfo* narinfo directory body ...)
182 (call-with-narinfo narinfo (lambda () body ...) directory))
183
2c74fde0 184;; Transmit these options to 'guix substitute'.
218f6ecc 185(substitute-urls (list (getenv "GUIX_BINARY_SUBSTITUTE_URL")))
cdea30e0 186
e903b7c1
LC
187(test-equal "query narinfo without signature"
188 "" ; not substitutable
189
190 (with-narinfo %narinfo
191 (string-trim-both
192 (with-output-to-string
193 (lambda ()
194 (with-input-from-string (string-append "have " (%store-prefix)
195 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
196 (lambda ()
2c74fde0 197 (guix-substitute "--query"))))))))
e903b7c1 198
cdea30e0 199(test-equal "query narinfo with invalid hash"
52f80dfc 200 ;; The hash in the signature differs from the hash of %NARINFO.
cdea30e0
LC
201 ""
202
52f80dfc
LC
203 (with-narinfo (string-append %narinfo "Signature: "
204 (signature-field "different body")
205 "\n")
cdea30e0
LC
206 (string-trim-both
207 (with-output-to-string
208 (lambda ()
209 (with-input-from-string (string-append "have " (%store-prefix)
210 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
211 (lambda ()
2c74fde0 212 (guix-substitute "--query"))))))))
cdea30e0
LC
213
214(test-equal "query narinfo signed with authorized key"
215 (string-append (%store-prefix) "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
216
52f80dfc
LC
217 (with-narinfo (string-append %narinfo "Signature: "
218 (signature-field %narinfo)
219 "\n")
cdea30e0
LC
220 (string-trim-both
221 (with-output-to-string
222 (lambda ()
223 (with-input-from-string (string-append "have " (%store-prefix)
224 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
225 (lambda ()
2c74fde0 226 (guix-substitute "--query"))))))))
cdea30e0
LC
227
228(test-equal "query narinfo signed with unauthorized key"
229 "" ; not substitutable
230
52f80dfc
LC
231 (with-narinfo (string-append %narinfo "Signature: "
232 (signature-field
233 %narinfo
234 #:public-key %wrong-public-key)
235 "\n")
cdea30e0
LC
236 (string-trim-both
237 (with-output-to-string
238 (lambda ()
239 (with-input-from-string (string-append "have " (%store-prefix)
240 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
241 (lambda ()
2c74fde0 242 (guix-substitute "--query"))))))))
cdea30e0 243
f84f8590 244(test-quit "substitute, no signature"
a9468b42 245 "no valid substitute"
e903b7c1 246 (with-narinfo %narinfo
2c74fde0
LC
247 (guix-substitute "--substitute"
248 (string-append (%store-prefix)
249 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
250 "foo")))
e903b7c1 251
f84f8590 252(test-quit "substitute, invalid hash"
a9468b42 253 "no valid substitute"
52f80dfc
LC
254 ;; The hash in the signature differs from the hash of %NARINFO.
255 (with-narinfo (string-append %narinfo "Signature: "
256 (signature-field "different body")
257 "\n")
2c74fde0
LC
258 (guix-substitute "--substitute"
259 (string-append (%store-prefix)
260 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
261 "foo")))
cdea30e0 262
f84f8590 263(test-quit "substitute, unauthorized key"
a9468b42 264 "no valid substitute"
52f80dfc
LC
265 (with-narinfo (string-append %narinfo "Signature: "
266 (signature-field
267 %narinfo
268 #:public-key %wrong-public-key)
269 "\n")
2c74fde0
LC
270 (guix-substitute "--substitute"
271 (string-append (%store-prefix)
272 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
273 "foo")))
e9c6c584 274
e903b7c1
LC
275(test-equal "substitute, authorized key"
276 "Substitutable data."
277 (with-narinfo (string-append %narinfo "Signature: "
278 (signature-field %narinfo))
279 (dynamic-wind
280 (const #t)
281 (lambda ()
2c74fde0
LC
282 (guix-substitute "--substitute"
283 (string-append (%store-prefix)
284 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
285 "substitute-retrieved")
e903b7c1
LC
286 (call-with-input-file "substitute-retrieved" get-string-all))
287 (lambda ()
288 (false-if-exception (delete-file "substitute-retrieved"))))))
289
a9468b42
LC
290(test-equal "substitute, unauthorized narinfo comes first"
291 "Substitutable data."
292 (with-narinfo*
293 (string-append %narinfo "Signature: "
294 (signature-field
295 %narinfo
296 #:public-key %wrong-public-key))
297 %alternate-substitute-directory
298
299 (with-narinfo* (string-append %narinfo "Signature: "
300 (signature-field %narinfo))
301 %main-substitute-directory
302
303 (dynamic-wind
304 (const #t)
305 (lambda ()
306 ;; Remove this file so that the substitute can only be retrieved
307 ;; from %ALTERNATE-SUBSTITUTE-DIRECTORY.
308 (delete-file (string-append %main-substitute-directory
309 "/example.nar"))
310
311 (parameterize ((substitute-urls
312 (map (cut string-append "file://" <>)
313 (list %alternate-substitute-directory
314 %main-substitute-directory))))
315 (guix-substitute "--substitute"
316 (string-append (%store-prefix)
317 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
318 "substitute-retrieved"))
319 (call-with-input-file "substitute-retrieved" get-string-all))
320 (lambda ()
321 (false-if-exception (delete-file "substitute-retrieved")))))))
322
323(test-equal "substitute, unsigned narinfo comes first"
324 "Substitutable data."
325 (with-narinfo* %narinfo ;not signed!
326 %alternate-substitute-directory
327
328 (with-narinfo* (string-append %narinfo "Signature: "
329 (signature-field %narinfo))
330 %main-substitute-directory
331
332 (dynamic-wind
333 (const #t)
334 (lambda ()
335 ;; Remove this file so that the substitute can only be retrieved
336 ;; from %ALTERNATE-SUBSTITUTE-DIRECTORY.
337 (delete-file (string-append %main-substitute-directory
338 "/example.nar"))
339
340 (parameterize ((substitute-urls
341 (map (cut string-append "file://" <>)
342 (list %alternate-substitute-directory
343 %main-substitute-directory))))
344 (guix-substitute "--substitute"
345 (string-append (%store-prefix)
346 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
347 "substitute-retrieved"))
348 (call-with-input-file "substitute-retrieved" get-string-all))
349 (lambda ()
350 (false-if-exception (delete-file "substitute-retrieved")))))))
351
352(test-equal "substitute, first narinfo is unsigned and has wrong hash"
353 "Substitutable data."
354 (with-narinfo* (regexp-substitute #f
355 (string-match "NarHash: [[:graph:]]+"
356 %narinfo)
357 'pre
358 "NarHash: sha256:"
359 (bytevector->nix-base32-string
360 (make-bytevector 32))
361 'post)
362 %alternate-substitute-directory
363
364 (with-narinfo* (string-append %narinfo "Signature: "
365 (signature-field %narinfo))
366 %main-substitute-directory
367
368 (dynamic-wind
369 (const #t)
370 (lambda ()
371 ;; This time remove the file so that the substitute can only be
372 ;; retrieved from %MAIN-SUBSTITUTE-DIRECTORY.
373 (delete-file (string-append %alternate-substitute-directory
374 "/example.nar"))
375
376 (parameterize ((substitute-urls
377 (map (cut string-append "file://" <>)
378 (list %alternate-substitute-directory
379 %main-substitute-directory))))
380 (guix-substitute "--substitute"
381 (string-append (%store-prefix)
382 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
383 "substitute-retrieved"))
384 (call-with-input-file "substitute-retrieved" get-string-all))
385 (lambda ()
386 (false-if-exception (delete-file "substitute-retrieved")))))))
387
388(test-equal "substitute, first narinfo is unsigned and has wrong refs"
389 "Substitutable data."
390 (with-narinfo* (regexp-substitute #f
391 (string-match "References: ([^\n]+)\n"
392 %narinfo)
393 'pre "References: " 1
394 " wrong set of references\n"
395 'post)
396 %alternate-substitute-directory
397
398 (with-narinfo* (string-append %narinfo "Signature: "
399 (signature-field %narinfo))
400 %main-substitute-directory
401
402 (dynamic-wind
403 (const #t)
404 (lambda ()
405 ;; This time remove the file so that the substitute can only be
406 ;; retrieved from %MAIN-SUBSTITUTE-DIRECTORY.
407 (delete-file (string-append %alternate-substitute-directory
408 "/example.nar"))
409
410 (parameterize ((substitute-urls
411 (map (cut string-append "file://" <>)
412 (list %alternate-substitute-directory
413 %main-substitute-directory))))
414 (guix-substitute "--substitute"
415 (string-append (%store-prefix)
416 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
417 "substitute-retrieved"))
418 (call-with-input-file "substitute-retrieved" get-string-all))
419 (lambda ()
420 (false-if-exception (delete-file "substitute-retrieved")))))))
421
422(test-quit "substitute, two invalid narinfos"
423 "no valid substitute"
424 (with-narinfo* %narinfo ;not signed
425 %alternate-substitute-directory
426
427 (with-narinfo* (string-append %narinfo "Signature: " ;unauthorized
428 (signature-field
429 %narinfo
430 #:public-key %wrong-public-key))
431 %main-substitute-directory
432
433 (guix-substitute "--substitute"
434 (string-append (%store-prefix)
435 "/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-foo")
436 "substitute-retrieved"))))
437
2c74fde0 438(test-end "substitute")
e9c6c584 439
cdea30e0
LC
440;;; Local Variables:
441;;; eval: (put 'with-narinfo 'scheme-indent-function 1)
a9468b42 442;;; eval: (put 'with-narinfo* 'scheme-indent-function 2)
f84f8590 443;;; eval: (put 'test-quit 'scheme-indent-function 2)
cdea30e0 444;;; End: