[CS2103T-F11-3] SecureIT #62

hooncp · 2019-09-19T13:17:29Z

stevenwjy · 2019-10-04T04:55:28Z

docs/DeveloperGuide.adoc

 * is reasonably comfortable using CLI apps

-*Value proposition*: manage contacts faster than a typical mouse/GUI driven app
+
+*Value proposition*: Remember only one password, and save the hassle of remembering all other confidential documents (account details, credit card details, secret files, secret notes). Have a safe and secure way to store all confidential documents locally, without the use of the online/ third party / cloud-reliant vaults.

 [appendix]
 == User Stories


Our team has read through your user stories and we notice that some important ones might be missing.

Must have:

List passwords

Find passwords associated with some accounts

List credit card info

Add new file to encryption system

Nice to have:

Two-factor authentication

stevenwjy · 2019-10-04T04:56:56Z

docs/DeveloperGuide.adoc

@@ -295,56 +301,479 @@ Priorities: High (must have) - `* * \*`, Medium (nice to have) - `* \*`, Low (un
 [width="59%",cols="22%,<23%,<25%,<30%",options="header",]
 |=======================================================================
 |Priority |As a ... |I want to ... |So that I can...


Some of your user stories are in the wrong format, e.g. I can be sure ....

stevenwjy · 2019-10-04T04:59:59Z

docs/DeveloperGuide.adoc

+
+Reliability
+
+* The app shall throw appropriate exceptions when any user input is invalid or any user action fails to execute completely.


Maybe it would be better if you could paraphrase this into the system has to be robust to errors, because an NFR should not be too detail.

stevenwjy · 2019-10-04T05:01:37Z

docs/DeveloperGuide.adoc

+
+Data Integrity
+
+* Should be able to check for the data integrity as to verify that no one has modified the files within secureIT in an unauthorised fashion.


This sounds too functional, maybe it would be better to rephrase the sentence into this program should consider data integrity of files.

e0031374 · 2019-10-04T04:53:18Z

docs/DeveloperGuide.adoc

+---
+
+[discrete]
+=== UC21 - Encrypt a file


Could be missing extension, 1a where file to encrypt is missing

e0031374 · 2019-10-04T04:55:19Z

docs/DeveloperGuide.adoc

+* 2a. Details entered are invalid
+
+[none]
+** 2a1. FileSys shows an error message


Could be an unnecessary UI detail mentioned might want to try: "notify user" instead of "shows error message" which might be a bit specific

e0031374 · 2019-10-04T04:59:01Z

docs/DeveloperGuide.adoc

+
+---
+[discrete]
+=== UC11 - Add a password


Might be missing a guarantee: "password is added"

shiweing · 2019-10-25T04:24:20Z

docs/DeveloperGuide.adoc

@@ -98,9 +93,9 @@ image::LogicClassDiagram.png[]
 *API* :


The text in the diagrams seems too small, perhaps the arrows could be shorter so the diagram can be more zoomed in?

shiweing · 2019-10-25T04:28:02Z

docs/DeveloperGuide.adoc

@@ -109,7 +104,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
 .Interactions Inside the Logic Component for the `delete 1` Command
 image::DeleteSequenceDiagram.png[]

-NOTE: The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+NOTE: The lifeline for `DeleteNoteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.

 [[Design-Model]]
 === Model component


The text in the diagram seems to be too small as well and the diagram appears a bit cluttered. Perhaps the Model class diagram could be split into sub components for Card, Notes etc.

shiweing · 2019-10-25T04:37:05Z

docs/DeveloperGuide.adoc


-[NOTE]
-If the `currentStatePointer` is at index 0, pointing to the initial address book state, then there are no previous address book states to restore. The `undo` command uses `Model#canUndoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the undo.
+image::AnalysePasswordSequenceDiagram.png[]


The activation bar for DictionaryAnalyser self-called method getAllMatches() seems to be missing a return arrow. Also, the DictionaryMatch return arrow would require the return arrow head to be pointing within the activation bar instead of at the end of the bar.

shiweing · 2019-10-25T04:47:09Z

docs/DeveloperGuide.adoc

-The undo/redo mechanism is facilitated by `VersionedAddressBook`.
-It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`.
-Additionally, it implements the following operations:
+image::AnalyserClassDiagram.png[]


A figure caption seems to be missing for a few diagrams.

Nanosync

Some changes might help to improve the document.

Nanosync · 2019-10-25T05:23:05Z

docs/DeveloperGuide.adoc

@@ -98,9 +93,9 @@ image::LogicClassDiagram.png[]
 *API* :
 link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`]


Diagram can be broken down into smaller parts

Nanosync · 2019-10-25T05:26:12Z

docs/DeveloperGuide.adoc

@@ -109,7 +104,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
 .Interactions Inside the Logic Component for the `delete 1` Command
 image::DeleteSequenceDiagram.png[]

-NOTE: The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+NOTE: The lifeline for `DeleteNoteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.

 [[Design-Model]]
 === Model component


The diagram shows a good overview of all the components, however it is a bit too small. Maybe it could be broken into smaller components.

Nanosync · 2019-10-25T05:26:32Z

docs/DeveloperGuide.adoc

@@ -14,7 +14,7 @@ ifdef::env-github[]
 endif::[]
 :repoURL: https://github.com/se-edu/addressbook-level3/tree/master

-By: `Team SE-EDU`      Since: `Jun 2016`      Licence: `MIT`
+By: `SecureIT`      Since: `Jun 2016`      Licence: `MIT`


The date appears incorrect.

Nanosync · 2019-10-25T05:30:12Z

docs/DeveloperGuide.adoc

@@ -109,7 +104,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
 .Interactions Inside the Logic Component for the `delete 1` Command
 image::DeleteSequenceDiagram.png[]


The diagram shows AddressBookParser. Also, since there are multiple directories, the context of delete is not explicitly mentioned in the preface. There is also no description to describe the diagram.

Nanosync · 2019-10-25T05:36:45Z

docs/DeveloperGuide.adoc

-The undo/redo mechanism is facilitated by `VersionedAddressBook`.
-It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`.
-Additionally, it implements the following operations:
+image::AnalyserClassDiagram.png[]


The diagram can be resized.
It appears too verbose.
Each component could be described individually.
Missing figure caption.

Nanosync · 2019-10-25T05:43:01Z

docs/DeveloperGuide.adoc

-The undo/redo mechanism is facilitated by `VersionedAddressBook`.
-It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`.
-Additionally, it implements the following operations:
+image::AnalyserClassDiagram.png[]


The Match direction seems incorrect, did you mean Match implements BaseMatch and DictionaryMatch extends BaseMatch?

Nanosync · 2019-10-25T05:49:26Z

docs/DeveloperGuide.adoc

-* **Alternative 2:** Individual command knows how to undo/redo by itself.
-** Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
-** Cons: We must ensure that the implementation of each individual command are correct.
+image::InitPasswordSequenceDiagram.png[]


There are missing activation bars for Storage, Model, Logic and Ui after they are constructed.

Nanosync · 2019-10-25T05:52:43Z

docs/DeveloperGuide.adoc

-* **Alternative 2:** Individual command knows how to undo/redo by itself.
-** Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
-** Cons: We must ensure that the implementation of each individual command are correct.
+image::InitPasswordSequenceDiagram.png[]



We think it would be helpful to have an activity diagram to summarise the feature.

Fix password branch

…yption

Fix file duplication when file is being opened before encryption

…rd-2 Fix analyse password 2

Merge branch 'update-ug' of https://github.com/AY1920S1-CS2103T-F11-3/main into update-ug

Fix notes bugs

…ension Change the rename file command to retain file extension

…-util Add explanation of encryption method in the developer guide

Add new line to one command

… into add-notes-test

…1-3/main into update-UG-DG

Update ug dg

Add notes test

Fix DG minor

Do final edit on the user guide

Card tests

Final tweaks to PPP

Change version number to v1.4

Rename img file

nus-se-pr-bot added team.3 tutor.kylase-learning tutorial.CS2103T-F11 labels Sep 19, 2019

hooncp changed the title ~~[CS2103T-F11-3] Onepass~~ [CS2103T-F11-3] SecureIT Oct 3, 2019

stevenwjy reviewed Oct 4, 2019

View reviewed changes

e0031374 reviewed Oct 4, 2019

View reviewed changes

shiweing reviewed Oct 25, 2019

View reviewed changes

Nanosync reviewed Oct 25, 2019

View reviewed changes

niqiukun and others added 22 commits October 31, 2019 21:32

Update file section of the user guide

6e16708

Fix multiple fields and limit to tag

ccb9718

Merge pull request #93 from AY1920S1-CS2103T-F11-3/fix-password-branch

a8a646b

Fix password branch

Fix file duplication when file is being opened in Windows before encr…

0e1db92

…yption

Update command format tool tip

2bf8cdf

Merge pull request #95 from AY1920S1-CS2103T-F11-3/fix-windows-file

afd8a2a

Fix file duplication when file is being opened before encryption

added font

6eeae53

minor fix

6f6941e

remove unneeded import

bc58fde

Merge pull request #96 from AY1920S1-CS2103T-F11-3/fix-analyse-passwo…

d521ee1

…rd-2 Fix analyse password 2

fixed bugs on sort and edit issue

a2b56ff

updated some notes commands

880be06

printf("%p", &iArray[0]);

5822342

Merge branch 'update-ug' of https://github.com/AY1920S1-CS2103T-F11-3/main into update-ug

Change the rename command to retain file extension

7079342

added tip and warning logo to notes section of ug

05b487e

Merge pull request #97 from AY1920S1-CS2103T-F11-3/fix-notes-bugs

40073c1

Fix notes bugs

Change the user guide of rename file command

3b40e86

Merge pull request #98 from AY1920S1-CS2103T-F11-3/rename-without-ext…

9fb1501

…ension Change the rename file command to retain file extension

Merge pull request #66 from AY1920S1-CS2103T-F11-3/explain-encryption…

85a6e7d

…-util Add explanation of encryption method in the developer guide

Change default view to password

e844210

Update Ui.png

b4aee7f

Update version number for prepare for release of v1.3

03b5883

eejian97 and others added 30 commits November 11, 2019 22:40

rename PPP

6c717cf

renamed PPP

06e7c84

Merge pull request #202 from AY1920S1-CS2103T-F11-3/minor-fix

688db80

Add new line to one command

resolve conflict

7aaab27

Merge branch 'master' of https://github.com/AY1920S1-CS2103T-F11-3/main…

cc556dd

… into add-notes-test

resolved conflicts

625a937

Complete DG for cards

b96f1ee

Complete PPP

10b1aaa

fixed travis issue

f45475c

fix travis

ed66aa7

Merge branch 'update-UG-DG' of https://github.com/AY1920S1-CS2103T-F1…

373d7a3

…1-3/main into update-UG-DG

solve travis build

f1e7d2a

Merge pull request #203 from AY1920S1-CS2103T-F11-3/update-UG-DG

03475cd

Update ug dg

manually undo some conflicts

2509458

Final tweaks to PPP

79dfaa1

Merge branch 'master' into add-notes-test

aeaa69d

Merge pull request #200 from AY1920S1-CS2103T-F11-3/add-notes-test

23b79b1

Add notes test

Add tests for cards

811ecaf

Fix DG minor

cccd974

Do final edit on UG

3766d2f

Add tests for cards

b05e48d

Merge pull request #205 from AY1920S1-CS2103T-F11-3/hothothot-fix

683cad0

Fix DG minor

Merge pull request #206 from AY1920S1-CS2103T-F11-3/final-edit-on-ug

62fc5bb

Do final edit on the user guide

Merge pull request #207 from AY1920S1-CS2103T-F11-3/card-tests

ad423b1

Card tests

Merge pull request #204 from AY1920S1-CS2103T-F11-3/update-UG-DG

c651e54

Final tweaks to PPP

Change version number to v1.4

447bec5

Merge pull request #208 from AY1920S1-CS2103T-F11-3/change-version-1.4

9201f9f

Change version number to v1.4

Rename leowjityong.adoc to jityong.adoc

e90066a

Rename img file

83b0c14

Merge pull request #209 from AY1920S1-CS2103T-F11-3/rename-img-file

b77c6d7

Rename img file

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2103T-F11-3] SecureIT #62

[CS2103T-F11-3] SecureIT #62

hooncp commented Sep 19, 2019 •

edited

stevenwjy Oct 4, 2019

stevenwjy Oct 4, 2019

stevenwjy Oct 4, 2019 •

edited

stevenwjy Oct 4, 2019

e0031374 Oct 4, 2019

e0031374 Oct 4, 2019

e0031374 Oct 4, 2019

shiweing Oct 25, 2019

shiweing Oct 25, 2019

shiweing Oct 25, 2019

shiweing Oct 25, 2019

Nanosync left a comment

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019

Nanosync Oct 25, 2019


		Reliability

		* The app shall throw appropriate exceptions when any user input is invalid or any user action fails to execute completely.


		Data Integrity

		* Should be able to check for the data integrity as to verify that no one has modified the files within secureIT in an unauthorised fashion.

		@@ -98,9 +93,9 @@ image::LogicClassDiagram.png[]
		API :
		link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`]

		@@ -109,7 +104,7 @@ Given below is the Sequence Diagram for interactions within the `Logic` componen
		.Interactions Inside the Logic Component for the `delete 1` Command
		image::DeleteSequenceDiagram.png[]

[CS2103T-F11-3] SecureIT #62

Are you sure you want to change the base?

[CS2103T-F11-3] SecureIT #62

Conversation

hooncp commented Sep 19, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stevenwjy Oct 4, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nanosync left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hooncp commented Sep 19, 2019 •

edited

stevenwjy Oct 4, 2019 •

edited