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 .Dd July 11, 2015
  28 .Dt UEFISIGN 8
  29 .Os
  30 .Sh NAME
  31 .Nm uefisign
  32 .Nd UEFI Secure Boot signing utility
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Fl k Ar key
  36 .Fl c Ar certificate
  37 .Fl o Ar output
  38 .Op Fl v
  39 .Ar file
  40 .Nm
  41 .Fl V
  42 .Op Fl v
  43 .Ar file
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility signs PE binary files using Authenticode scheme, as required by
  48 UEFI Secure Boot specification.
  49 Alternatively, it can be used to view and verify existing signatures.
  50 These options are available:
  51 .Bl -tag -width ".Fl l"
  52 .It Fl V
  53 Determine whether the file is signed.
  54 Note that this does not verify the correctness of the signature;
  55 only that the file contains a signature.
  56 .It Fl k
  57 Name of file containing the private key used to sign the binary.
  58 .It Fl c
  59 Name of file containing the certificate used to sign the binary.
  60 .It Fl o
  61 Name of file to write the signed binary to.
  62 .It Fl v
  63 Be verbose.
  64 .El
  65 .Sh EXIT STATUS
  66 The
  67 .Nm
  68 utility exits 0 on success, and >0 if an error occurs.
  69 .Sh EXAMPLES
  70 Generate self-signed certificate and use it to sign a binary:
  71 .Dl /usr/share/examples/uefisign/uefikeys testcert
  72 .Dl uefisign -c testcert.pem -k testcert.key -o signed-binary binary
  73 .Pp
  74 View signature:
  75 .Dl uefisign -Vv binary
  76 .Sh SEE ALSO
  77 .Xr openssl 1 ,
  78 .Xr loader 8 ,
  79 .Xr uefi 8
  80 .Sh HISTORY
  81 The
  82 .Nm
  83 command appeared in
  84 .Fx 10.2 .
  85 .Sh AUTHORS
  86 The
  87 .Nm
  88 utility was developed by
  89 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
  90 under sponsorship from the FreeBSD Foundation.