Skip to content

Latest commit

 

History

History
650 lines (427 loc) · 18.8 KB

UserGuide.adoc

File metadata and controls

650 lines (427 loc) · 18.8 KB
Raw

SecureIT - User Guide

By: SecureIT Since: August 2019 Licence: MIT

1. Introduction

Welcome to SecureIT!

Tired of having to keep track of all your confidential information? Look no further! SecureIT is specifically designed to help manage your confidential information all in one application. More importantly, it stores your information locally, and does not use any form of online storage!

SecureIT is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). For those of you who are type fast, SecureIT can get can manage your confidential information faster than traditional GUI apps.

Interested? Jump to the Section 3, “Quick Start” to get started. Enjoy!

2. Basic Information

This following guide will teach you how you can use SecureIT to keep track of your confidential information so you will never have to worry about your information ever again.

Confused? You refer to Section 3, “Quick Start” for a simple set-up.

If you are overwhelmed by all the instructions and don’t know which one to use, our Section 5, “CheatSheet of commands” is here to help you.

The following list of icons below will assist you to understand our material:

Icon

Meaning
tip

Some tips for you to familiarise with the commands
warning

Warning! Danger zone. Make sure you know what you are doing

3. Quick Start

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest SecureIT.jar here.

  3. Copy the file to the folder you want to use as the home folder for your SecureIT.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

  5. Since this is the first time that you are using SecureIT, you will be asked to create a new master password. Type your preferred master password in the command box and hit the Enter key.

  6. With that, you have created your very own SecureIT account. You can now enter commands in the command box and press Enter to execute it.

    Ui

  7. Here are some example commands that you can try out:

    • add d/Gmail u/randomGuy p/qwerty123 : adds a password with username 'randomGuy' and password 'qwerty123'

    • analyse : briefly analyses all your passwords and produces a security report

    • analyse strong/1 : analyses your first password and produces a detailed security report

    • generate : generates a random strong password for you

    • encrypt <filepath> : encrypts the file in the specified filepath

  8. You may refer to Section 4, “Features” for more details of all our available commands.

4. Features

tip

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by you e.g. in add u/USERNAME, USERNAME is a parameter which can be used as add u/User Doe.

  • Items in square brackets are optional e.g u/USERNAME [t/TAG] can be used as u/User Doe t/work or as n/User Doe.

  • Items with …​ after them can be used multiple times until a limit including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/Work, t/SocialMedia t/Personal etc.

  • Parameters can be in any order e.g. if the command specifies u/USERNAME p/PASSWORD, p/PASSWORD u/USERNAME is also acceptable.

  • All index specified must be a positive number 1,2,3…​

4.1. Password

You can access the password directory using this command : goto password

4.1.1. Adding a password : add

Too many passwords to remember? You can add a password to the application.

Format: add d/DESCRIPTION u/USERNAME p/PASSWORD [w/WEBSITE] [t/TAG]…​

Example: add d/Gmail u/user1 p/password1 w/www.gmail.com/signin t/work

4.1.2. Accessing a password : read

You can open and view the password for the specified index.

Format: read INDEX

Example: read 1

4.1.3. Copying a field in a password : copy

tip

Tip

  • You can type cp for copy, p for password, u for username and w for website.

  • You can only copy one field at a time

You can copy the password value, website or username for the specific index.

Format: copy password INDEX

Example: copy password 1

Example: cp p 1

Example: cp username 2

Example: cp w 2

4.1.4. Updating a password : edit

tip

Tip

  • You do not need not type all the fields of the password again.

  • You can just type the fields that you want to change.

Added a wrong password? No worries, you can edit the password.

Format: edit INDEX [d/DESCRIPTION] [u/USERNAME] [p/PASSWORD] [w/WEBSITE] [t/TAG]

Example: edit 1 u/NewUsername

Example: edit 1 p/password123

Example: edit 1 u/NewUsername p/password123

4.1.5. Deleting a password: delete

warning

Warning

  • Deleted passwords are not recoverable

No longer use the user account? You can delete the password as specified by the user.

Format: delete INDEX

Example: delete 2

4.1.6. Finding a password: find

tip

Tip

  • The search is case insensitive. e.g gmail will match Gmail

  • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans

  • Only the description is searched.

  • Incomplete-words will be matched e.g. Han will match Hans

Too many passwords? You can find the password description as specified by the user.

Format: find DESCRIPTION

Example: find Gmail

4.1.7. Generating a new password: generate

Lazy to think of a strong password? Simply enter generate into the command box to get one.

tip

Try it out!

  • You can add custom preferences and configure the following:

    • Length of password

    • Inclusion of upper / lower alphabets

    • Inclusion of numbers

    • Inclusion of special characters

  • All passwords are automatically copied onto your clipboard.

Format: generate [length/LENGTH] [lower/TRUE] [upper/TRUE] [num/TRUE] [special/TRUE]

  • The various fields are set to TRUE by default.

  • To disable these fields, set to FALSE.

Example: generate

Example generate length/10

Example: generate lower/true upper/true num/true special/false

4.1.8. Analysing passwords : analyse

Curious how secure your passwords really are? Type analyse into the command box to find out.

tip

Try it out!

  • You can opt to view:

    • A general, summary security report for all passwords, or

    • A detailed security report for a specific password.

  • To view the detailed analysis of a particular password, simply add in the strong prefix.

Format: analyse [strong/INDEX]

Example: analyse

Example: analyse strong/8

4.2. Card

Too many credit cards to carry around? With SecureIT, you can easily manage your card information.

To access your cards, simply enter goto card in the command box.

4.2.1. Creating a card : add

You can easily adds cards to the application.

Format: add d/DESCRIPTION c/CARDNUMBER v/CVC e/EXPIRY [t/TAG]

Example: add d/VisaPOSB c/5203123458392748 v/456 e/12/25 t/groceries

4.2.2. Reading a card : read

You can also obtain the details of a card easily, just by its description.

Format: read d/DESCRIPTION v/CVC

Example: read d/VisaPOSB v/456

4.2.3. Deleting a card: delete

If your card has expired, you can easily remove it from the application, by its description.

Format: delete DESCRIPTION

Example: delete VisaPOSB

4.3. File

SecureIT has a file manager which helps you keep secret files that you do not wish others to see. Using your master password, SecureIT convert your files into encrypted code which other apps cannot understand.

To access the file manager, simply enter goto file in the command box.

4.3.1. Encrypting a file : encrypt

Encrypts a local file as specified by its file path. The file’s content is converted into encrypted code which other apps cannot understand. Encrypted files have the prefix [LOCKED] in their file names.

As you encrypt the file, you may tag the file at the same time for easy reference later on.

Format: encrypt FILEPATH [t/TAG]…​

Example: encrypt ~/Desktop/Secret File.png t/Image

tip

Tip

  • Instead of typing the file path, you can drag the file into the input field to easily append the file path. This also applies to other commands (e.g. add).

  • The app may freeze for some time if the file to be encrypted is large. Please do not force exit the app during encryption.

  • The app does not support encryption of files larger than 2GB.

warning

Warning

  • The encrypt command only alters the file content but does not set up additional access rights. In other words, it keeps your information secret but does not keep your files safe from malicious alteration or deletion.

  • If you wish to prevent alternation or deletion of files, please set up additional access rights using your operating system. SecureIT is not responsible for any data loss resulting from lack of access right settings.

  • If you are using Windows, please close the file before encryption.

4.3.2. Decrypting a file : decrypt

Decrypts a local file as specified by the displayed index number.

Format: decrypt INDEX

Example: decrypt 1 (This command decrypts the first file in the displayed file list.)

tip

Tip

  • If you notice that the file decryption fails, it may be because you have renamed the file or moved the file to another location without using SecureIT (for example, using your operating system directly).

  • In that case, use remove command to remove the file from the list first, and then use add command to add the renamed/moved file. Please refer to the remove and add command sections for detailed instructions.

4.3.3. Adding an encrypted file : add

Adds an encrypted file as specified by its file path. The file must be encrypted by SecureIT previously.

As you add the file, you may tag the file at the same time for easy reference later on.

Format: add FILENAME [t/TAG]…​

Example: add ~/Desktop/[LOCKED] Secret File.png t/Image

tip

Tip

  • The file name does not have to contain the prefix [LOCKED]. SecureIT can recognise the file and automatically prepend the prefix.

4.3.4. Removing a file : remove

Removes an encrypted file record as specified by the displayed index number.

Please note that only the file record within SecureIT is removed. The actual file is not deleted from the file system.

Format: remove INDEX

Example: remove 1

warning

Warning

  • The "encrypted at" and "last edited at" timestamps are stored within SecureIT and will be discarded if you remove the record from SecureIT. They are not recoverable even if you add the file back using add command.

4.3.5. Renaming an encrypted file : rename

Renames an encrypted file as specified by its index number. The prefix [LOCKED] is retained.

Format: rename INDEX TARGET_FILENAME

Example: rename 1 Secret File.txt

tip

Tip

  • The file extension of the file is retained using rename command. If you give a file extension in the target file name, it will be ignored.

4.3.6. Moving an encrypted file : move

Moves an encrypted file as specified by its index number.

Format: move INDEX TARGET_DIRECTORY

Example: move 1 ~/Documents/Secret File.png

tip

Tip

  • It is recommended to rename and move files using SecureIT to better manage your files.

  • If you have renamed or moved your files without using SecureIT (for example, using the operating system directly), you have to use remove command to remove the file from the list first, and then use add command to add the renamed/moved file.

4.3.7. Finding encrypted files : find

Finds matching encrypted files as specified by the search keywords.

To return from search results, use list command.

Format: find KEYWORDS…​

Examples: find Secret File

tip

Tip

  • The search is case insensitive. e.g secret file will match Secret File.

  • Both the file name and the file path are searched. Hence, you can look for files with certain types (e.g. find .png .jpg) or files inside certain directories (e.g. find /Desktop).

4.3.8. Listing all files : list

Lists all encrypted files managed by SecureIT.

Format: list

4.3.9. Viewing an encrypted file : preview [coming soon]

Previews an encrypted file as specified by its index number. You can only preview .txt, .jpg and .png files.

Format: preview INDEX

Example: preview 1

4.4. Note

Accessing note directory : goto note

4.4.1. Creating a note : add

Adds a note to the app.

Format: `add ti/TITLE d/DESCRIPTION t/TAG c/CONTENT `

Example: add ti/Diary d/documentation of 2020 t/Personal c/day1 documentation

warning

Warning

  • You are not allowed to add notes with the same title.

  • Title, description and tag fields must not be empty.

4.4.2. Accessing a note : open

Opens the note corresponding to the index in the app.

Format: open INDEX

Example: open 1

tip

Tip

  • Opens a new panel on the right that allows you to read and edit easily.

  • Click on save button after editing to save changes made to the content of the note.

4.4.3. Deleting a note: delete

Deletes a note as specified by the user.

Format: delete INDEX

Example: delete 1

4.4.4. Editing a note: edit

Edits a note specified by the user.

Format: edit INDEX [ti/TITLE] [d/DESCRIPTION] [t/TAG c/CONTENT]

Example: edit 1 ti/NewTitle d/NewDescription t/NewTag c/NewContent Example: edit 1 ti/NewTitle

warning

Warning

  • INDEX and at least one optional field is compulsory to successfully edit the note.

  • You are not allowed to edit notes to have the same title.

4.4.5. Finding a note: find

Finds a note as specified by the user.

Format: find TEXT

Example:`find Personal_diary`

tip

Tip

  • Your input TEXT for search is case insensitive. e.g Personal_diary will match personal_diary

  • Searches title, description and content of all notes and returns those that contains the TEXT.

4.4.6. Sorting notes: sort

Sorts notes in ways specified by the user.

Format: sort by/SORTBYCONDITION

Example: sort by/DateModified

warning

Warning

  • SORTBYCONDITION must be either "DateModified", "DateCreated" and "NumOfAccess".

  • SORTBYCONDITION is not case-sensitive.

4.4.7. Undo notes action: undo

Undo last action on notes.

Format: undo

Example: undo

tip

Tip

  • You can only perform undo on undo-able commands. Undoable commands are: add, edit, delete, clear and sort

  • You can undo as many commands as you wish until there are no more commands that can be undone.

4.4.8. Redo notes action: redo

Redo last undone action on notes.

Format: redo

Example: redo

tip

Tip

  • You can redo as many commands as you wish until there are no more commands that can be redone.

  • If you perform a new undo-able command, all existing redo-able commands will be cleared.

4.5. Clearing all entries : clear

Clears all entries from the current book user is on.
Format: clear

4.6. Exiting the program : exit

Exits the program.
Format: exit

4.7. Saving the data

SecureIT data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

5. CheatSheet of commands

Password

Accessing Password directory: goto password

  • add d/DESCRIPTION u/USERNAME p/PASSWORD [w/WEBSITE] [t/TAG]…​ : Adds a password to the app.

  • read INDEX: Shows the username and password for the specified index provided by you.

  • edit INDEX [d/DESCRIPTION] [u/USERNAME] [p/PASSWORD] [w/WEBSITE] [t/TAG]: Edits a password as specified by you.

  • copy password INDEX: Copies the password value, website or username for the specific index

  • delete INDEX: Deletes a password as specified by the user.

  • find DESCRIPTION: Finds a password description as specified by the user.

  • generate [length/LENGTH] [lower/TRUE] [upper/TRUE] [num/TRUE] [special/TRUE]: Generates a new random password based on user preference input and copies generated password into user clipboard.

  • analyse: Analyses all passwords currently stored and produces a security summary report.

  • analyse [strong/INDEX]: Analyses in detail a specified password based on the user specified index.

Card

Accessing Card directory: goto card

  • add d/DESCRIPTION c/CARDNUMBER e/EXPIRY v/CVC: Adds a credit/debit card to the app.

  • delete DESCRIPTION: Deletes a card as specified by the user.

File

Accessing File directory: goto file

  • encrypt FILEPATH [t/TAG]…​: Encrypts a local file as specified by its file path.

  • decrypt INDEX: Decrypts a local file as specified by the displayed index number.

  • add FILENAME [t/TAG]…​: Adds an encrypted file as specified by its file path.

  • remove INDEX: Removes an encrypted file record as specified by the displayed index number.

  • rename INDEX TARGET_FILENAME: Renames an encrypted file as specified by its index number.

  • move INDEX TARGET_DIRECTORY: Moves an encrypted file as specified by its index number.

  • find KEYWORDS…​: Finds matching encrypted files as specified by the search keywords.

  • list: Lists all encrypted files managed by SecureIT.

Note

Accessing Note directory: goto note

  • open INDEX: Opens the note corresponding to the index.

  • delete INDEX: Deletes a note as specified by you.

  • edit INDEX ti/TITLE d/DESCRIPTION t/TAG c/CONTENT: Edits a note specified by you.

  • find TEXT: Finds notes containing the text specified by the user.

  • sort by/SORTBYCONDITION: Sorts notes by the condition specified by you.

  • undo: Undo last action on notes.

  • redo: Redo last undone action on notes.

Others

Other commands

  • clear: Clears all entries from the current book user is on.

  • exit: Exits the program.

6. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and copy store.tmp files from the application’s directory to the new computer.