Author: ab226828
Date: 2011-03-14 11:33:55 +0100 (Mon, 14 Mar 2011)
New Revision: 25368
Log:
Added details of vault implementation. Doc bug 58869, 11765864.
Modified:
trunk/workbench/manage-db-connections.xml
Modified: trunk/workbench/manage-db-connections.xml
===================================================================
--- trunk/workbench/manage-db-connections.xml 2011-03-14 09:15:54 UTC (rev 25367)
+++ trunk/workbench/manage-db-connections.xml 2011-03-14 10:33:55 UTC (rev 25368)
Changed blocks: 1, Lines Added: 52, Lines Deleted: 0; 2475 bytes
@@ -95,6 +95,58 @@
<guibutton>Duplicate</guibutton> button.
</para>
+ <para>
+ <emphasis role="bold">Vault</emphasis>
+ </para>
+
+ <para>
+ The vault provides a convenient secure storage for passwords used to
+ access MySQL servers. Using the vault ensures that you do not need
+ to enter credentials every time &workbench; attempts to connect to a
+ server. The vault is implemented differently on each platform:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Windows</emphasis> - The vault is an
+ encrypted file in the &workbench; <filename>data</filename>
+ directory. This is where <filename>connections.xml</filename>
+ and related files are located. The file is encrypted using a
+ Windows API which performs the encryption based on the current
+ user, so only the current user can decrypt it. As a result it is
+ not possible to decrypt the file on any other computer. It is
+ possible to delete the file, in which case all stored passwords
+ are lost, but &workbench; will otherwise perform as expected.
+ You will then need to re-enter passwords as required.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Mac OS X</emphasis> - The vault is
+ implemented using the OS X Secure Keychain. The keychain
+ contents can be viewed using the <filename>Keychain
+ Access.app</filename> utility.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis role="bold">Linux</emphasis> - The vault works by
+ storing passwords using the <literal>gnome-keyring</literal>
+ daemon. That daemon must be running for password persistency to
+ work. The daemon is automatically started in GNOME desktops, but
+ normally is not in KDE and others. On non-GNOME platforms the
+ <literal>gnome-keyring</literal> daemon will need to be started
+ manually before being able to use the vault for password storage
+ in &workbench;.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
<section id="wb-manage-db-connections-standard">
<title>Standard TCP/IP Connection</title>
| Thread |
|---|
| • svn commit - mysqldoc@oter02: r25368 - trunk/workbench | tony.bedford | 14 Mar |