From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nikita Karetnikov Subject: Re: [PATCH] Add 'guix hash'. Date: Fri, 05 Apr 2013 18:04:31 +0400 Message-ID: <8762015b0w.fsf@karetnikov.org> References: <87li92alhe.fsf@karetnikov.org> <874nforp12.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="==-=-="; micalg=pgp-sha1; protocol="application/pgp-signature" Return-path: Received: from eggs.gnu.org ([208.118.235.92]:59406) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UO7De-0003VT-C5 for bug-guix@gnu.org; Fri, 05 Apr 2013 10:02:29 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UO7DS-0005Tf-Cb for bug-guix@gnu.org; Fri, 05 Apr 2013 10:02:18 -0400 In-Reply-To: <874nforp12.fsf@gnu.org> ("Ludovic =?utf-8?Q?Court=C3=A8s=22'?= =?utf-8?Q?s?= message of "Wed, 03 Apr 2013 10:34:17 +0200") List-Id: Bug reports for GNU Guix List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-guix-bounces+gcggb-bug-guix=m.gmane.org@gnu.org Sender: bug-guix-bounces+gcggb-bug-guix=m.gmane.org@gnu.org To: Ludovic =?utf-8?Q?Court=C3=A8s?= Cc: bug-guix@gnu.org --==-=-= Content-Type: multipart/mixed; boundary="=-=-=" --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable > Could you copy/paste the --format option found in (guix scripts > download)? I changed it a bit. (By the way, I'd like to add your copyright to the header of 'hash.scm'. What year should be used?) >> Should we capitalize error messages? > No (info "(standards) Errors"): [...] OK, I prepended 'guix hash' to all messages. I'd like to change other commands (e.g., 'guix download') accordingly. What do you think? I also want to change the output of 'guix download --help'. In particular, I'd like to specify the supported formats and remove (default: `nix-base32'). Basically, I want it to look like the output of 'guix hash --help'. >> Is it OK to output a backtrace when the specified file doesn't exist? > No, because it=E2=80=99s too scaring. :-) Done. > Also, could you add an entry in the manual (with a couple of sentences > explaining when users should care about this tool, and what it does), as > well as a line in po/POTFILES.in? Done. But what is a translatable string? Is it a string that should be i18n'd? Do you have any suggestions regarding the manual entry of 'guix hash'? The current version looks rough to me. --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: attachment; filename=0001-Add-guix-hash.patch Content-Transfer-Encoding: quoted-printable From=204e36644099b71057d01fe3299036c06204ddd326 Mon Sep 17 00:00:00 2001 From: Nikita Karetnikov Date: Fri, 5 Apr 2013 13:10:25 +0000 Subject: [PATCH] Add 'guix hash'. * guix/scripts/hash.scm: New file. * Makefile.am (MODULES): Add it. * po/POTFILES.in: Add it. * doc/guix.texi (Invoking guix hash): New node. =2D-- Makefile.am | 1 + doc/guix.texi | 37 +++++++++++++++ guix/scripts/hash.scm | 118 +++++++++++++++++++++++++++++++++++++++++++++= ++++ po/POTFILES.in | 1 + 4 files changed, 157 insertions(+), 0 deletions(-) create mode 100644 guix/scripts/hash.scm diff --git a/Makefile.am b/Makefile.am index 136c01b..eb8b80f 100644 =2D-- a/Makefile.am +++ b/Makefile.am @@ -30,6 +30,7 @@ MODULES =3D \ guix/scripts/import.scm \ guix/scripts/package.scm \ guix/scripts/gc.scm \ + guix/scripts/hash.scm \ guix/scripts/pull.scm \ guix/scripts/substitute-binary.scm \ guix/base32.scm \ diff --git a/doc/guix.texi b/doc/guix.texi index 1be172c..b24a92e 100644 =2D-- a/doc/guix.texi +++ b/doc/guix.texi @@ -1087,6 +1087,7 @@ space. =20 @menu * Invoking guix build:: Building packages from the command line. +* Invoking guix hash:: Computing the cryptographic hash of a file. @end menu =20 @node Invoking guix build @@ -1182,6 +1183,42 @@ the @code{package-derivation} procedure of the @code= {(guix packages)} module, and to the @code{build-derivations} procedure of the @code{(guix store)} module. =20 +@node Invoking guix hash +@section Invoking @command{guix hash} + +The @command{guix hash} command computes the cryptographic hash of a +file. + +The general syntax is: + +@example +guix hash @var{option} @var{file} +@end example + +@command{guix hash} has the following option: + +@table @code + +@item --format=3D@var{fmt} +@itemx -f @var{fmt} +Write the hash in the given format. + +Supported formats: @code{nix-base32}, @code{base32}, @code{base16} +(@code{hex} and @code{hexadecimal} can be used as well). + +If the @option{--format} option is not specified, @command{guix hash} +will output the hash in @code{nix-base32}. This representation is used +in the definitions of packages. + +@end table + +@command{guix hash} is a convenient tool to check the integrity of a +file. For example, it can be used to compute the hashes of bootstrap +binaries. + +There is also @code{guix download} which computes the hash of a remote +file. + @c ********************************************************************* @node GNU Distribution @chapter GNU Distribution diff --git a/guix/scripts/hash.scm b/guix/scripts/hash.scm new file mode 100644 index 0000000..424f3b9 =2D-- /dev/null +++ b/guix/scripts/hash.scm @@ -0,0 +1,118 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright =C2=A9 2013 Nikita Karetnikov +;;; +;;; This file is part of GNU Guix. +;;; +;;; GNU Guix 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. +;;; +;;; GNU Guix 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 GNU Guix. If not, see . + +(define-module (guix scripts hash) + #:use-module (guix base32) + #:use-module (guix ui) + #:use-module (guix utils) + #:use-module (rnrs io ports) + #:use-module (rnrs files) + #:use-module (ice-9 match) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-26) + #:use-module (srfi srfi-37) + #:export (guix-hash)) + + +;;; +;;; Command-line options. +;;; + +(define %default-options + ;; Alist of default option values. + `((format . ,bytevector->nix-base32-string))) + +(define (show-help) + (display (_ "Usage: guix hash [OPTION] FILE +Return the cryptographic hash of FILE. + +Supported formats: 'nix-base32' (default), 'base32', and 'base16' +('hex' and 'hexadecimal' can be used as well).\n")) + (format #t (_ " + -f, --format=3DFMT write the hash in the given format")) + (newline) + (display (_ " + -h, --help display this help and exit")) + (display (_ " + -V, --version display version information and exit")) + (newline) + (show-bug-report-information)) + +(define %options + ;; Specification of the command-line options. + (list (option '(#\f "format") #t #f + (lambda (opt name arg result) + (define fmt-proc + (match arg + ("nix-base32" + bytevector->nix-base32-string) + ("base32" + bytevector->base32-string) + ((or "base16" "hex" "hexadecimal") + bytevector->base16-string) + (x + (leave (_ "~a: unsupported hash format: ~a~%") + "guix hash" arg)))) + + (alist-cons 'format fmt-proc + (alist-delete 'format result)))) + + (option '(#\h "help") #f #f + (lambda args + (show-help) + (exit 0))) + (option '(#\V "version") #f #f + (lambda args + (show-version-and-exit "guix hash"))))) + + + +;;; +;;; Entry point. +;;; + +(define (guix-hash . args) + (define (parse-options) + ;; Return the alist of option values. + (args-fold args %options + (lambda (opt name arg result) + (leave (_ "~a: unrecognized option: ~a~%") + "guix hash" name)) + (lambda (arg result) + (alist-cons 'argument arg result)) + %default-options)) + + (let* ((opts (parse-options)) + (args (filter-map (match-lambda + (('argument . value) + value) + (_ #f)) + (reverse opts))) + (fmt (assq-ref opts 'format))) + + (match args + ((file) + (if (file-exists? file) + (format #t "~a~%" + (call-with-input-file file + (compose fmt sha256 get-bytevector-all))) + (leave (_ "~a: file '~a' does not exist~%") + "guix hash" (basename file)))) + (_ + (leave (_ "~a: wrong number of arguments~%") + "guix hash"))))) diff --git a/po/POTFILES.in b/po/POTFILES.in index bdb894d..3c712a4 100644 =2D-- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -8,5 +8,6 @@ guix/scripts/build.scm guix/scripts/download.scm guix/scripts/package.scm guix/scripts/gc.scm +guix/scripts/hash.scm guix/scripts/pull.scm guix/ui.scm =2D-=20 1.7.5.4 --=-=-=-- --==-=-= Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.10 (GNU/Linux) iQIcBAEBAgAGBQJRXtn4AAoJEM+IQzI9IQ389T4P/0GwOZJHjnnmogGq4qJ2Hp/D VeYk+nFdlKQ4HN+huV9FHmp5l6HZTLdsgwNJ3DnIVnizRD1zRNx8YONKk0unTITF HNXA88O98kCaKt4kyi52sy/in57HYbFSlRG6xb3R2rGhZCB6hRB4UmEy8lKmmPdr gjSAmMrVzEWrFQOzBFbBDzyOwlRoagfH7pBmLeQVdmEx+EmlUf1JAYvf5BgpT6Pz yd0/PMehGwb7s7hEeu8BKfTvnIq5N5rflzd/ItsAJKB0t72meW96w7yE8wKS8c23 J+BPpkZ6kZy8mV2zwJkSqHWTIXd4SuGPzgoa1lD8XDsQQgRHyjQ0pRmPJBLxB/FT 34Z1jqbDC+hhz/ap9n/UXo247Tr6b1UkkfgzbACTH/LFpCmHCFKlcXyX1kWNuKnT UagNkNotZqWYV89yUZr1V8jm6Lkwz799eVGBcwCwzkWpbp1ZO9xtTjAIXobiyJ9k F2WE5OhEZviErNTHUzGXERe5+Jkqrp4IIi5l8coDDG/EEdRLvIdcZCQhX0mxxH+A 0L3cv+sW2XYBSO+aPx2NxIhiLVUsO5LHTEwVtoEzA2Dtl+SdNwxKsjpWkc26o4bz g2D52QWdYhn4dNfy46vjhO27dHPE48XHs9WYcwPV6vbJls0TX89lTnLjpH59UlJH P/97VivOQtc0lXgU2Htm =RX1H -----END PGP SIGNATURE----- --==-=-=--