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

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:

• user_Security.xml (modified) (1 diff)
• user_VBoxManage.xml (modified) (2 diffs)

trunk/doc/manual/en_US/user_Security.xml

@@ -277 +277 @@
         <listitem>
           <para>When using remote iSCSI storage and the storage server
-          requires authentication, a password can optionally be supplied with
-          the <computeroutput>VBoxManage storageattach</computeroutput>
-          command. Note however that this is stored <emphasis
-          role="bold">unencrypted</emphasis> in the machine configuration and
-          is therefore potentially readable on the host. See <xref
+          requires authentication, an initiator secret can optionally be supplied
+          with the <computeroutput>VBoxManage storageattach</computeroutput>
+          command. As long as no settings password is provided (command line
+          option <screen>--settingspwfile</screen>, this secret is
+          stored <emphasis role="bold">unencrypted</emphasis> in the machine
+          configuration and is therefore potentially readable on the host.
+          See <xref
           linkend="storage-iscsi" /> and <xref
           linkend="vboxmanage-storageattach" />.</para>

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -148 +148 @@
     invoked in one single call. The following sections provide detailed
     reference information on the different commands.</para>
+  </sect1>
+
+  <sect1 id="vboxmanage-general">
+    <title>General options</title>
+    <para>
+      <itemizedlist>
+        <listitem>
+          <para><computeroutput>--version</computeroutput>: show the version of
+            this tool and exit.</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--nologo</computeroutput>: suppress the output
+            of the logo information (useful for scripts)</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--settingspw</computeroutput>: specifiy a settings
+            password</para>
+        </listitem>
+        <listitem>
+          <para><computeroutput>--settingspwfile</computeroutput>: specify a file
+            containing the settings password.</para>
+        </listitem>
+      </itemizedlist>
+      The settings password is used for certain settings which need to be
+      stored encrypted for security reasons. At the moment, the only encrypted
+      setting is the iSCSI initiator secret (see
+      <xref linkend="vboxmanage-storageattach" /> for details). As long as no
+      settings password is specified, this information is stored in
+      <emphasis role="bold">plain text</emphasis>. After using the
+      <computeroutput>--settingspw|--settingspwfile</computeroutput> option
+      once, it must be always used, otherwise the encrypted setting cannot
+      be unencrypted.
+    </para>
   </sect1>
 
@@ -1840 +1873 @@
 
           <glossdef>
-            <para>Username and password for target authentication, if required
-            (optional).<note>
-                <para>Currently, username and password are stored without
+            <para>Username and password (initiator secret) for target
+                authentication, if required (optional).<note>
+                <para>Username and password are stored without
                 encryption (i.e. in clear text) in the XML machine
-                configuration file.</para>
+                configuration file if no settings password is provided.
+                When a settings password was specified the first time,
+                the password is stored encrypted.</para>
               </note></para>
           </glossdef>