VirtualBox

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-signova.xml@ 103131

Last change on this file since 103131 was 99513, checked in by vboxsync, 20 months ago

manual,VBoxManage,isomaker/viso: Require all refsect1 and refsect2 elements to have @id attributes in manpages (refentry) to make these predictable and the split up topic files easier to handle for the docs team. Also requires these @id values to start with the refentry @id + '-'. Corrected a few bogus ones. Because 'controlvm' has too many sub-commands, HELP_SCOPE_ IDs will not be generated for 'See Also' and 'Examples' sections. bugref:10302

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 manpage, user manual, usage: VBoxManage signova
4-->
5<!--
6 Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
8 This file is part of VirtualBox base platform packages, as
9 available from https://www.virtualbox.org.
10
11 This program is free software; you can redistribute it and/or
12 modify it under the terms of the GNU General Public License
13 as published by the Free Software Foundation, in version 3 of the
14 License.
15
16 This program is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, see <https://www.gnu.org/licenses>.
23
24 SPDX-License-Identifier: GPL-3.0-only
25-->
26<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
27 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
28<!ENTITY % all.entities SYSTEM "all-entities.ent">
29%all.entities;
30]>
31<refentry id="vboxmanage-signova" lang="en">
32 <refentryinfo>
33 <pubdate>$Date: 2023-04-21 21:59:02 +0000 (Fri, 21 Apr 2023) $</pubdate>
34 <title>VBoxManage signova</title>
35 </refentryinfo>
36
37 <refmeta>
38 <refentrytitle>VBoxManage-signova</refentrytitle>
39 <manvolnum>1</manvolnum>
40 </refmeta>
41
42 <refnamediv>
43 <refname>VBoxManage-signova</refname>
44 <refpurpose>Digitally sign an OVA</refpurpose>
45 <refclass>&product-name;</refclass>
46 </refnamediv>
47
48 <refsynopsisdiv>
49 <cmdsynopsis id="synopsis-vboxmanage-signova">
50<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51 <command>VBoxManage signova</command>
52 <arg choice="req"><replaceable>ova</replaceable></arg>
53 <arg choice="req">--certificate=<replaceable>file</replaceable></arg>
54 <arg choice="req">--private-key=<replaceable>file</replaceable></arg>
55 <group>
56 <arg choice="plain">--private-key-password-file=<replaceable>password-file</replaceable></arg>
57 <arg choice="plain">--private-key-password=<replaceable>password</replaceable></arg>
58 </group>
59 <arg>--digest-type=<replaceable>type</replaceable></arg>
60 <group>
61 <arg choice="plain">--pkcs7</arg>
62 <arg choice="plain">--no-pkcs7</arg>
63 </group>
64 <arg>--intermediate-cert=<replaceable>file</replaceable></arg>
65 <arg>--force</arg>
66 <arg>--verbose</arg>
67 <arg>--quiet</arg>
68 <arg>--dry-run</arg>
69 </cmdsynopsis>
70 </refsynopsisdiv>
71
72 <refsect1 id="vboxmanage-signova-description">
73 <title>Description</title>
74 <para>
75 The <command>VBoxManage signova</command> command adds a digital
76 signature to an OVA file.
77 </para>
78 <!-- Add more description here -->
79 <variablelist>
80 <varlistentry>
81 <term><replaceable>ova</replaceable></term>
82 <listitem><para>The OVA file to sign.</para></listitem>
83 </varlistentry>
84 <varlistentry>
85 <term><option>--certificate=<replaceable>file</replaceable></option></term>
86 <listitem><para>File containing the certificate that the OVA should be
87 signed with. This can either be in PEM format (base64) or DER (binary),
88 the command will detect which.</para></listitem>
89 </varlistentry>
90 <varlistentry>
91 <term><option>--private-key=<replaceable>file</replaceable></option></term>
92 <listitem><para>The file containing the private key. This can either be
93 in PEM (base64) or DER (binary) format, the command will detect
94 which.</para></listitem>
95 </varlistentry>
96 <varlistentry>
97 <term><option>--private-key-password-file=<replaceable>password-file</replaceable></option></term>
98 <listitem><para>File containing the private key password.</para></listitem>
99 </varlistentry>
100 <varlistentry>
101 <term><option>--private-key-password=<replaceable>password</replaceable></option></term>
102 <listitem><para>The private key password. <!-- add warning about visibility --> </para></listitem>
103 </varlistentry>
104 <varlistentry>
105 <term><option>--digest-type=<replaceable>type</replaceable></option></term>
106 <listitem>
107 <para>Select the cryptographic digest algorithm to use in the
108 signing. Possible values: SHA-256 (default), SHA-512 and SHA-1.</para>
109 <para>Some older versions of OVFTool and other VMware produces may
110 require <option>--digest-type=sha-1</option> to accept the OVA.</para>
111 </listitem>
112 </varlistentry>
113 <varlistentry>
114 <term><option>--pkcs7</option>, <option>--no-pkcs7</option></term>
115 <listitem><para>Enables or disables the creation of an additional
116 PKCS#7/CMS signature. This is enabled by default.</para></listitem>
117 </varlistentry>
118 <varlistentry>
119 <term><option>--intermediate-cert=<replaceable>file</replaceable></option></term>
120 <listitem><para>File containing an intermediary certificate that should be
121 included in the optional PKCS#7/CMS signature. Like the others, the file can
122 either be in PEM or DER format. This option can be repeated to add
123 multiple intermediate certificates. This option implies the
124 <option>--pkcs7</option> option.</para></listitem>
125 </varlistentry>
126 <varlistentry>
127 <term><option>--force</option></term>
128 <listitem><para>Overwrite existing signature if present. The default
129 behaviour is to fail if the OVA is already signed.</para></listitem>
130 </varlistentry>
131 <varlistentry>
132 <term><option>--dry-run</option></term>
133 <listitem><para>Do not actually modify the OVA, just test-run the signing operation.</para></listitem>
134 </varlistentry>
135 <varlistentry>
136 <term><option>-v</option>, <option>--verbose</option>, <option>-q</option>, <option>--quiet</option></term>
137 <listitem><para>Controls the verbositity of the command execution. The
138 <option>--verbose</option> option can be used multiple times to get more output.
139 </para></listitem>
140 </varlistentry>
141 </variablelist>
142 </refsect1>
143</refentry>
144
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette