<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>MyPasswordSafe Manual</title> <style type="text/css"> H1 { border-bottom: solid 2px #0080ff; } .title { text-align: center; } .title H1 { font-size: 32pt; border: none; } .contents { } #header ul, #header ul li { display: inline; list-style: none; } </style> </head> <body> <div id="header"> Translations: <ul> <li><a href="manual.html">English</a></li> <li><a href="manual.fr.html">Française</a></li> </ul> </div> <div class="title"> <h1><a name="top">MyPasswordSafe</a></h1> © 2004 <a href="http://www.semanticgap.com/">Semantic Gap<sup>TM</sup> Solutions</a> </div> <div class="contents"> <h1>Contents</h1> <ul> <li><a href="#intro">Introduction</a></li> <li><a href="#changes">Changes</a></li> <li><a href="#legal">Legal</a> <ul> <li><a href="#copyright">Copyright and Trademark</a></li> <li><a href="#license">License</a></li> </ul> </li> <li><a href="#install">Installing</a> <ul> <li><a href="#frombin">...from Binaries</a></li> <li><a href="#fromsrc">...from Source</a></li> </ul></li> <li><a href="#usage">Usage</a> <ul> <li><a href="#starting">Starting MyPasswordSafe</a></li> <li><a href="#mainwindow">The Main Window</a></li> <li><a href="#passwords">Managing passwords</a></li> <li><a href="#editpword">Edit Password Dialog</a></li> <li><a href="#safes">Opening and saving safes</a></li> <li><a href="#prefs">Preferences</a></li> </ul></li> <li><a href="#faq">FAQ</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#credits">Credits</a></li> </ul> </div> <h1><a name="intro">Introduction</a></h1> <p> MyPasswordSafe is a straight-forward, easy-to-use password manager that maintains compatibility with <a href="http://passwordsafe.sourceforge.net/">Password Safe</a> files. MyPasswordSafe has the following features: <ul> <li>Safes are encrypted when they are stored to disk.</li> <li>Passwords never have to be seen, because they are copied to the clipboard</li> <li>Random passwords can be generated.</li> <li>Window size, position, and column widths are remembered.</li> <li>Passwords remain encrypted until they need to be decrypted at the dialog and file levels.</li> <li>A safe can be made active so it will always be opened when MyPasswordSafe starts.</li> <li>Supports <a href="http://www.unicode.org/">Unicode</a> in the safes</li> <li>Languages supported: English and French</li> </ul> </p> <p>The download page is <a href="http://www.semanticgap.com/myps/release/">http://www.semanticgap.com/myps/release/</a>, in case you want to skip the rest of this. </p> <a href="#top">Back to top</a> <h1><a name="changes">Changes</a></h1> <h2>February 4th, 2004</h2> <ul> <li>May have fixed the endian detection by using endian.h</li> <li>Moved src/util.?pp to src/myutil.?pp </ul> <h2>January 23rd, 2004</h2> <ul> <li>Changed the AboutDlg around some. It now displays the version and information about when and who compiled it.</li> <li>Added a few more compile-time config definitions</li> <li>Fixed a bug with m_safe getting set to NULL whenever the pass-phrase dialog's cancel button was clicked.</li> <li>File->SaveAs is now enabled when a safe is opened</li> <li>Thanks go out again to Emmanuael Adeline for translating the manual!</li> <li>A backup is made when a safe is saved.</li> </ul> <h2>January 22nd, 2004</h2> <ul> <li>Changed the way Safe::empty does the emptying because it wasn't emptying the correctly</li> <li>No longer crashes when no password is entered into the Pass-phrase dialog and the Ok button is clicked</li> </ul> <h2>January 19th, 2004</h2> <ul> <li>Fixed the multilined note display problem</li> <li>Created a release Makefile</li> <li>Added a PREFIX compile time option to the Makefile</li> <li>Locale files are searched for in PREFIX/share/MyPasswordSafe/locale</li> <li>Thanks to Emmanuel Adeline for the French translation</li> </ul> <h2>January 18th, 2004</h2> <ul> <li>Fixed a bug with EncryptedString segfaulting when it was created with an empty string</li> <li>More than just phoenetic characters are now allowed in a password's entry; Unicode is supported!</li> <li>Reviewed all and fixed most of the FIXMEs</li> <li>Serializers now get the default username, so MyPasswordSafe supports Password Safe's default user option</li> </ul> <h2>January 12th, 2004</h2> Just some minor updates. Thanks for all the positive responses I've been getting. <ul> <li>Created EncryptedString</li> <li>Refactored the loading and saving code to use EncryptedString</li> <li>EncryptedString is now used every where except where the password needs to be decrypted.</li> </ul> <a href="#top">Back to top</a> <h1><a name="legal">Legal</a></h1> <h2><a name="copyright">Copyright and Trademark</a></h2> MyPasswordSafe and this manual are Copyright © 2004 Semantic Gap Solutions, and is covered by the same license as the software. Semantic Gap and the double spiral are trademarks of Nolan Eakins. <h2><a name="license">License</a></h2> Copyright © 2004, Semantic Gap<sup>TM</sup> Solutions<br/> All rights reserved. <p> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: <ul> <li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li> <li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li> <li>Neither the name of Semantic Gap<sup>TM</sup> Solutions nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</li> </ul> </p> <p> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </p> <a href="#top">Back to top</a> <h1><a name="install">Installing</a></h1> <p>If you're reading this then you're either warm or hot. MyPasswordSafe comes in two distributions: a binary distribution and the source distribution. MyPasswordSafe requires <a href="http://www.trolltech.com/download/index.html">Qt 3</a> and <a href="http://www.boost.org/">Boost</a>, so make sure you have those. Boost is only required to compile MyPasswordSafe, but Qt needs to be installed to run the binaries. <h2><a name="frombin">...From Binaries</a></h2> <p>The binary distribution is precompiled. It can be downloaded from MyPasswordSafe's <a href="http://www.semanticgap.com/myps/release/">download page</a>. Once that's downloaded, just untar it: </p> <pre>tar xvfz MyPasswordSafe-bin.tgz</pre> <p>That should create a directory with the MyPasswordSafe binary, this file, and some other documentation. Running "make install" inside the MyPasswordSafe directory will install everything under <i>/usr/local</i>. It should work in other locations, but the language files won't be found if they're not in <i>/usr/local/share/MyPasswordSafe/locale</i>. That should be all assuming it works. If it didn't keep reading. <h2><a name="fromsrc">...From Source</a></h2> <p>So you want to compile it for yourself. Make sure Qt 3 is installed, and download <a href="http://www.boost.org/">Boost</a>. Boost doesn't need to be compiled, just untarred.<a href="http://www.semanticgap.com/myps/release/">Download the sources</a> and then untar MyPasswordSafe: <pre>tar xvfz MyPasswordSafe.src.tgz</pre> <p>You can untar Boost into MyPasswordSafe's directory. The project file (MyPasswordSafe.pro) expects "boost-1.30.2" to be in the directory. If it's not, a simple link made from your boost directory will work. You can change the project file by hand if your boost path is different. The Makefile also contains a PREFIX variable which sets the location where MyPasswordSafe will install it and its associated files. Change it if <i>/usr/local</i> isn't where you want it to install itself. Finally you can run make: </p> <pre>cd MyPasswordSafe make make install</pre> <p>Now if that was successful you can start using MyPasswordSafe. If not, send me an email describing your situation. If for any reason you want to uninstall MyPasswordSafe, the Makefile has an uninstall directive. Running "make uninstall" will remove the files it installed. </p> <a href="#top">Back to top</a> <h1><a name="usage">Usage</a></h1> <p> MyPasswordSafe is straight-forward to use. Nearly all of the commands can be accessed from the menu, toolbar, context menu, or by keyboard. Before we delve into actual usage, let's cover how MyPasswordSafe can be started. </p> <h2><a name="starting">Starting MyPasswordSafe</a></h2> <p>Starting MyPasswordSafe is just like any other program, you just need to run it. If you copied the binary into your PATH, all you need to is type <i>MyPasswordSafe</i>. Otherwise you need to either change to the directory where the binary is or include that in the command line. Adding an icon to your favorite launcher may also be desired. </p> <p>When MyPasswordSafe starts for the first time, an empty safe is created. As you'll learn later, MyPasswordSafe has a thing called the active safe. The active safe gets opened when MyPasswordSafe starts saving you from having to always find it over and over. </p> <h2><a name="mainwindow">The Main Window</a></h2> <p>The main window isn't to complex. There's a list box, tool-bar, and menu. The tool-bar and menu duplicate each other quite a bit. Most of the action happens in the list box. </p> <center><img src="sshots/mainwindow.jpg" alt="Screenshot of MyPasswordSafe's main window"/></center> <p>The list box contains the passwords from the current safe. Double clicking on a password in the list box fetches the password for that item, and right clicking convienently pops up the edit menu next to the pointer. So what do those commands do? </p> <a href="#top">Back to top</a> <h2><a name="passwords">Managing Passwords</a></h2> <p> The edit menu contains the commands used to manage passwords. Each command's name is descriptive of what it does. For example, <i>Add Password</i> really does add a new password. <i>Delete Password</i> deletes the password selected password. And <i>Edit Password</i> opens up a dialog to edit the selected password. </p> <p> The last two commands may need some explanation. They are <i>Fetch User</i> and <i>Fetch Password</i>. Both copy information to the clipboard. One copies the user, and the other copies the password field. </p> <a href="#top">Back to top</a> <h2><a name="editpword">Edit Password Dialog</a></h2> <center><img src="sshots/editdialog.jpg" alt="Screenshot of the edit password dialog"/></center> <p> Both <i>Add Password</i> and <i>Edit Password</i> make use of the same dialog to edit a password's data. Passwords have four fields of information: name, user, password, and notes. All but the password field is displayed in the main window. The dialog also has three buttons that affect the password field. <ul> <li>Show: turns off the password masking making the password visible</li> <li>Fetch: copies the password to the clipboard</li> <li>Generate: fills in the password field with a random password</li> </ul> </p> <a href="#top">Back to top</a> <h2><a name="safes">Opening and saving safes</a></h2> <p>Safes can be created, opened, and saved from the file menu. The commands work like any other application except when a pass-phrase is needed. MyPasswordSafe does support multiple file formats. Currently MyPasswordSafe only two file formats are supported, Password Safe safes and text files. </p> <p>Password Safe is a similiar to MyPasswordSafe, but runs only on Windows. Files created by Password Safe can be opened by MyPasswordSafe and vice-versa. The files are encrypted using the Blowfish algorithm, and are presumed to be secure. Use <i>dat</i> for the extension. </p> <p>Text files should <b><font color="red">NEVER</font></b> be used. All information is stored unencrypted. If you find them useful, go ahead and use them. </p> <a href="#top">Back to top</a> <h2><a name="prefs">Preferences</a></h2> <center><img src="sshots/prefsdialog.jpg" alt="Screenshot of the Preferences Dialog"/></center> <p>MyPasswordSafe isn't the most configurable, but it does have some options. <ul> <li>Active safe: this is the safe that MyPasswordSafe opens when it starts up; this can also be set using the <i>Make Active</i> item in the File menu</li> <li>Default user name: this is the username used for new passwords</li> <li>Clear clipboard on exit?: if this is checked, the clipboard is cleared when MyPasswordSafe closes</li> <li>Generated password length: sets the length of the passwords generated by pressing the Generate button in the Edit Password dialog</li> <li>Number of guesses: this is the number of times MyPasswordSafe will attempt to get the correct pass-phrase from you before it gives up.</li> </ul></p> <p>MyPasswordSafe also stores the position and size of the window as well as the column widths. These are set by changing them, and are not available in the Preferences dialog. </p> <a href="#top">Back to top</a> <h1><a name="faq">FAQ</a></h1> <h2>How secure is MyPasswordSafe?</h2> <p>It beats me. The safes should be secure unless the Blowfish algorithm gets cracked. It's when the program is running that I'm unsure of the security. I'm sure some pesky program could find your passwords in memory. </p> <p>If you know anything about how to make this program bullet proof, send me an email or a patch. </p> <h2>Where is the Windows version?</h2> <p>I really wish there was a Windows version, but I can't afford a Qt license. If you need a password manager for Windows, get <a href="http://passwordsafe.sourceforge.net/">Password Safe</a>. Versions < 2 create files that MyPasswordSafe can load and save. [ Note to developers: if you have Qt for Windows, could you compile and package it for me? ]</p> <a href="#top">Back to top</a> <h1><a name="contact">Contact</a></h1> Semantic Gap<sup>TM</sup> Solutions can be contacted using the following: <ul> <li>Web: <a href="http://www.semanticgap.com/">http://www.semanticgap.com/</a></li> <li>Email: <a href="mailto:support@semanticgap.com">support@semanticgap.com</a></li> <li>Mail:<br/> Semantic Gap Solutions<br/> 527 Park Dr.<br/> Greenwood, IN 46143<br/> USA </li> </ul> <h1><a name="credits">Credits</a></h1> Programming and design:<br/> Nolan Eakins<br/> <br/> <p>Peter Palfrader contributed bug fixes for 64 bit cleanliness, and character encoding problems. He also reported some other bugs and issues.</p> <p>Some of the file loading and saving code is from <a href="http://passwordsafe.sourceforge.net/">Password Safe</a>.</p> <p>And most of the icons came from <a href="http://www.kde.org/">KDE</a></p> <p>The French translation was done by Emmanuel Adeline.</p> </body> </html>