You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,12 +15,21 @@
15
15
16
16
## How to Install?
17
17
+ You can download it from the Releases section
18
-
+ After downloading, make sure to set the location of the exe file and add the path of that configured location to your PATH file. The database will be automatically created in the documents or users file.
18
+
+ After downloading, make sure to set the location of the exe file and add the path of that configured location to your PATH file. The database will be automatically created in `C:\Users\<username>\gosecDB` PATH.
19
19
+ Note: Please be cautious while manipulating the PATH environment variable, as it directly affects how your operating system finds and executes files.
20
20
+ When downloading an executable (exe) file, you might receive a virus warning, but this can be misleading. If you'd like, you can examine the code from the source to verify.
21
21
+ If the virus threat warning doesn't go away, you can download the source code and create the exe file by writing the code below.
22
22
+`go build main.go` After writing this, the exe file will be created inside the current folder.
23
23
24
+
## First Open
25
+
+ When you open it for the first time, gosec will ask you for a master key.
26
+
+ This is an extra security. It is useful not to forget this master key.
27
+
+ Even if you forget, you can check it in settings.json.
28
+
+ You might ask, "Why expose the master key openly in the source code?"
29
+
+ Well, imagine someone developing a program based on this source code. Let's say they are building an API and they want to decrypt their own passwords, hosting a site locally for easy access. To achieve this, they would need access to the master key. However, if the master key is embedded within the binary, it could create complications.
30
+
+ Therefore, I have incorporated this approach to address such a scenario.
31
+
32
+
24
33
## Modes
25
34
+ The application comprises five primary modes: Register, Config, Key, DeleteUser and Password.
26
35
+ All modes feature a single global option, namely -P. This argument will prompt for the password you entered during registration. It will be requested in both the password and config modes, including their sub-modes. This mechanism can be likened to an authentication check, helping us discern which user is performing the operation.
0 commit comments