VirtualBox

Changeset 42448 in vbox for trunk/doc/manual/en_US


Ignore:
Timestamp:
Jul 30, 2012 1:53:08 PM (13 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
79579
Message:

doc/manual: explain the settings password options

Location:
trunk/doc/manual/en_US
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/user_Security.xml

    r41988 r42448  
    277277        <listitem>
    278278          <para>When using remote iSCSI storage and the storage server
    279           requires authentication, a password can optionally be supplied with
    280           the <computeroutput>VBoxManage storageattach</computeroutput>
    281           command. Note however that this is stored <emphasis
    282           role="bold">unencrypted</emphasis> in the machine configuration and
    283           is therefore potentially readable on the host. See <xref
     279          requires authentication, an initiator secret can optionally be supplied
     280          with the <computeroutput>VBoxManage storageattach</computeroutput>
     281          command. As long as no settings password is provided (command line
     282          option <screen>--settingspwfile</screen>, this secret is
     283          stored <emphasis role="bold">unencrypted</emphasis> in the machine
     284          configuration and is therefore potentially readable on the host.
     285          See <xref
    284286          linkend="storage-iscsi" /> and <xref
    285287          linkend="vboxmanage-storageattach" />.</para>
  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r42445 r42448  
    148148    invoked in one single call. The following sections provide detailed
    149149    reference information on the different commands.</para>
     150  </sect1>
     151
     152  <sect1 id="vboxmanage-general">
     153    <title>General options</title>
     154    <para>
     155      <itemizedlist>
     156        <listitem>
     157          <para><computeroutput>--version</computeroutput>: show the version of
     158            this tool and exit.</para>
     159        </listitem>
     160        <listitem>
     161          <para><computeroutput>--nologo</computeroutput>: suppress the output
     162            of the logo information (useful for scripts)</para>
     163        </listitem>
     164        <listitem>
     165          <para><computeroutput>--settingspw</computeroutput>: specifiy a settings
     166            password</para>
     167        </listitem>
     168        <listitem>
     169          <para><computeroutput>--settingspwfile</computeroutput>: specify a file
     170            containing the settings password.</para>
     171        </listitem>
     172      </itemizedlist>
     173      The settings password is used for certain settings which need to be
     174      stored encrypted for security reasons. At the moment, the only encrypted
     175      setting is the iSCSI initiator secret (see
     176      <xref linkend="vboxmanage-storageattach" /> for details). As long as no
     177      settings password is specified, this information is stored in
     178      <emphasis role="bold">plain text</emphasis>. After using the
     179      <computeroutput>--settingspw|--settingspwfile</computeroutput> option
     180      once, it must be always used, otherwise the encrypted setting cannot
     181      be unencrypted.
     182    </para>
    150183  </sect1>
    151184
     
    18401873
    18411874          <glossdef>
    1842             <para>Username and password for target authentication, if required
    1843             (optional).<note>
    1844                 <para>Currently, username and password are stored without
     1875            <para>Username and password (initiator secret) for target
     1876                authentication, if required (optional).<note>
     1877                <para>Username and password are stored without
    18451878                encryption (i.e. in clear text) in the XML machine
    1846                 configuration file.</para>
     1879                configuration file if no settings password is provided.
     1880                When a settings password was specified the first time,
     1881                the password is stored encrypted.</para>
    18471882              </note></para>
    18481883          </glossdef>
Note: See TracChangeset for help on using the changeset viewer.

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