usr.sbin/uefisign/uefisign.8

   1 .\" Copyright (c) 2014 The FreeBSD Foundation
   2 .\"
   3 .\" This software was developed by Edward Tomasz Napierala under sponsorship
   4 .\" from the FreeBSD Foundation.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd July 11, 2015
  30 .Dt UEFISIGN 8
  31 .Os
  32 .Sh NAME
  33 .Nm uefisign
  34 .Nd UEFI Secure Boot signing utility
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Fl k Ar key
  38 .Fl c Ar certificate
  39 .Fl o Ar output
  40 .Op Fl v
  41 .Ar file
  42 .Nm
  43 .Fl V
  44 .Op Fl v
  45 .Ar file
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility signs PE binary files using Authenticode scheme, as required by
  50 UEFI Secure Boot specification.
  51 Alternatively, it can be used to view and verify existing signatures.
  52 These options are available:
  53 .Bl -tag -width ".Fl l"
  54 .It Fl V
  55 Determine whether the file is signed.
  56 Note that this does not verify the correctness of the signature;
  57 only that the file contains a signature.
  58 .It Fl k
  59 Name of file containing the private key used to sign the binary.
  60 .It Fl c
  61 Name of file containing the certificate used to sign the binary.
  62 .It Fl o
  63 Name of file to write the signed binary to.
  64 .It Fl v
  65 Be verbose.
  66 .El
  67 .Sh EXIT STATUS
  68 The
  69 .Nm
  70 utility exits 0 on success, and >0 if an error occurs.
  71 .Sh EXAMPLES
  72 Generate self-signed certificate and use it to sign a binary:
  73 .Dl /usr/share/examples/uefisign/uefikeys testcert
  74 .Dl uefisign -c testcert.pem -k testcert.key -o signed-binary binary
  75 .Pp
  76 View signature:
  77 .Dl uefisign -Vv binary
  78 .Sh SEE ALSO
  79 .Xr openssl 1 ,
  80 .Xr loader 8 ,
  81 .Xr uefi 8
  82 .Sh HISTORY
  83 The
  84 .Nm
  85 command appeared in
  86 .Fx 10.2 .
  87 .Sh AUTHORS
  88 The
  89 .Nm
  90 utility was developed by
  91 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
  92 under sponsorship from the FreeBSD Foundation.