Documentation and Help File for SecureData 1.4

6 March 2010

This is free software, and you are welcome to redistribute it under the conditions of the GNU General Public Licence.

Contents

Introduction

SecureData provides a simple means of securely storing small items of personal data such as passwords and PINs (personal identification numbers).

The data is protected by a single pass phrase and stored in an XML file. The structure of the XML file is plainly visible but the contents of elements and attribute values are encrypted using the password-based encryption methods provided in the Java Standard Edition.

SecureData provides a straightforward mechanism for organizing, storing and retrieving the increasing number pieces of information that secure on-line (and other) systems require their users to specify, remember and recall.

The price of this simplicity is that should the pass phrase for a particular data file be forgotten then all the data in that file becomes unavailable and is effectively lost forever. However, it is possible to attach a plain text reminder which may serve to help in the recall of a forgotten pass phrase.

Once an easy to recall but not easily guessable pass phrase has been chosen then all other data which needs to be kept secure can be stored and hidden from the eyes of others. The hidden secure data need not in itself be memorable allowing the use of passwords and the like which are not linked in any way to our identity or our past lives.

You may feel it is wise to store their data in more than one file each protected by a different pass phrase.

Data Structure

The data as stored by SecureData is organised into named groups. Each group can hold as many entries as required. Each entry has a name and a value.

An example of a group with three entries

This would appear on screen when displayed by SecureData like this:

SecureData window

In addition each group may have notes attached. These notes are also encrypted when saved.

The encrypted XML file

The XML file is a valid XML file which can be read with any software designed for that purpose. The file must conform to the DTD provided in the file securedata.dtd. All significant content in the file (the text content of XML elements and the values for attributes) is encrypted. Only the tag and attribute names, the header elements and the reminder are in plain text.

An encrypted XML file containing the data consisting only of the example group given earlier might (depending on the pass phrase used) look like this when opened with an XML reader.

Example XML

Using SecureData

When opened SecureData displays the information about itself and is set up with no database loaded. The user has two options at this point:

There is an option to force SecureData to start by opening the XML file which was in use when the software was last closed.

When data has been loaded or created there will be a list of groups down the left hand side. To switch to another group (either to read or change the data) merely click the name of the group in the list.

Context information is given in the main panel immediately below the menu bar. On opening SecureData you will see the message 'No database loaded". Normally it will tell you which group is currently selected.

Although errors and warnings are given through dialogue boxes, the content of both error and success messages are displayed in the area at the bottom of the window.

The Menus

These are the menus and their options:

File Menu

Open

Selecting Open brings up a file browser window. The folder displayed will be the one in which the most recently opened or saved file is located

Once the file has been selected for opening you will be asked for the pass phrase for the file. If the pass phrase matches the file then the data in it will be decoded and displayed. Loading data replaces all data currently held by SecureData. If this data has not been saved then you will be warned.

The name of the file from which the data was loaded is shown in the title bar of the SecureData window.

Load previous data

This option is only available when a file has been saved after the Load previous data on opening option has been selected. It allows you to load the previous data at another time other than when SecureData is opened.

You will always be asked to provide the pass phrase before the previous data is loaded and displayed.

Save

Choosing this option saves the current data in the current file (normally the one from which it was loaded or saved to earlier).

If the data was not loaded from a file and has never been saved then you will be required first to specify a file in which to save it. You may choose any file name that is valid. However, if the file name does not contain a dot then .xml will be appended to the file name. [This is fine for Windows and Unix.] The name of the file in which the data was saved is shown in the title bar of the SecureData window.

If you have not specified a pass phrase then you will be asked to do so before giving the name of the file in which to store the encrypted data.

Clear

This clears all the data loaded, added or modified. If there is unsaved data then you will be warned.

Save as

Choosing this option saves the current data in a file with a name that you choose.

You may choose any file name that is valid. However, if the file name does not contain a dot then .xml will be appended to the file name. [This is fine for Windows and Unix.] The name of the file in which the data was saved is shown in the title bar of the SecureData window.

The data will be encrypted with the pass phrase curently set. This may be either the pass phrase given when data was being loaded or previously saved, or it may be a pass phrase that you have set. If you are not sure what the current pass phrase is then you may show the reminder which may help.

Set pass phrase

At any time you may use this option to set the current pass phrase with an optional reminder. If you load data you will be asked to supply the pass phrase for decrypting. This pass phrase will then become the current pass phrase.

Typically Set pass phrase is used just before saving data in a different file from which it was loaded and you want to use a different pass phrase.

Show reminder

You may use this to show the reminder associated with the current pass phrase. However, it serves its real purpose should data not be loaded from an encrypted file because of an incorrect pass phrase. If Show reminder is slected immediately following such a failure then the reminder associated with the pass phrase for the file which failed to be decrypted will be displayed.

Immdiately after using Set pass phrase you may not be able to view the new reminder until the current data has been saved.

Print

This option prints out the unencrypted data.

The circumstances in which it is reasonable to print sensitive data are few. Printing is essentially insecure. However, there may be a need to communicate the data without the aid of a computing system, and printing on paper may be the only practical means.

When data is printed with SecureData, the first set of pages contains only the group names and the left values of the entries. This is immediately followed by an equal number of pages containing the right hand values of the entries. No group names are printed on these 'right pages'.

To read any of the data, it is necessary to have a 'left page' and the corresponding 'right page'. The two pages must be aligned correctly and then the complete entry can be read. Horizontal rules are provide to aid alignment.

Some security can be maintained by keeping the left pages separate from the right pages, only bringing them together to ascertain the the value for a particular entry. For example, the two sets of pages could be sent through the mail in separate packages.

When printed data has served its purpose then the pages should be shredded.

Exit

Closes SecureData. You will be warned if the current data has not been saved.

Group Menu

Add new

This adds a new group to the data. It is also used to create a new database when SecureData is opened or the Clear function has been used. The new group becomes the selected group. To select a different group click the list of groups on the left.

Groups that have no entries are not saved. When an empty group is ignored you will be notified.

Rename

Allows you to change the name of a group.

Remove

Removes the currently selected (the currently displayed) group from the database.

Add entry

Adds a new entry to the currently selected (the currently displayed) group in the database.

The entry is given the name ** NEW **. This may be edited to change the name of the entry (the left-hand column) or to set or change the value of the entry (the right-hand column).

You may freely edit both names and values of entries. However, at certain points in the processing of the data, checks are made on the data in a group. If a group contains an entry for which the name is empty then it will be ignored and (in effect) be deleted. If a group contains entries with identical names then one of the names will be modified by appending asterisks to the end of it until it is unique within the group. You will be notified when either of these events occurs.

Option Menu

Load previous data on opening

If the box for this option is ticked (checked) then when SecureData is closed the name of the file in which the current data is stored is remembered and on next opening SecureData will immediately ask for a pass phrase (that is the pass phrase for the remembered file) and if the correct one is provided will immedialtely load and display the data.

SecureData will continue to operate like this until the check box is cancelled or an incorrect pass phrase is given on opening.

If during a session you wish to reload the data from the remembered file then use the Load previous data option on the File menu.

Set maximum idle time

If there is no interaction with SecureData for a period of time the the data will be cleared (thus hiding it from other eyes) and a dialogue box will inform you that the maximum idle time has been exceeded. Securedata will close down when you click OK and any changes to the data since the last save will be LOST.

About Menu

SecureData

Displays the version number of the software and briefly describes the licensing conditions. Buttons provide access to more detailed information. This detailed information is available directly from the other options on this menu.

No warranty

Emphasises the fact that this software is supplied without any kind of warranty express or implied.

Conditions

Displays the General Public Licence which sets out the conditions under which this software may be distributed or modified.

Help

SecureData

Allows you to view this help file using your default Internet browser.

GNU General Public Licence

GNU GENERAL PUBLIC LICENSE

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

END OF TERMS AND CONDITIONS