ronin-db 0.1.2-java → 0.2.0.rc1-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby.yml +3 -2
  3. data/.gitignore +1 -0
  4. data/ChangeLog.md +33 -0
  5. data/Gemfile +6 -4
  6. data/README.md +17 -5
  7. data/Rakefile +13 -35
  8. data/data/completions/ronin-db +271 -0
  9. data/gemspec.yml +17 -2
  10. data/lib/ronin/db/cli/command.rb +1 -1
  11. data/lib/ronin/db/cli/commands/add.rb +1 -1
  12. data/lib/ronin/db/cli/commands/asn.rb +12 -2
  13. data/lib/ronin/db/cli/commands/certs.rb +322 -0
  14. data/lib/ronin/db/cli/commands/completion.rb +63 -0
  15. data/lib/ronin/db/cli/commands/creds.rb +2 -1
  16. data/lib/ronin/db/cli/commands/edit.rb +1 -1
  17. data/lib/ronin/db/cli/commands/emails.rb +22 -1
  18. data/lib/ronin/db/cli/commands/hosts.rb +2 -1
  19. data/lib/ronin/db/cli/commands/ips.rb +2 -1
  20. data/lib/ronin/db/cli/commands/irb.rb +8 -4
  21. data/lib/ronin/db/cli/commands/list.rb +1 -1
  22. data/lib/ronin/db/cli/commands/migrate.rb +12 -8
  23. data/lib/ronin/db/cli/commands/open_ports.rb +102 -0
  24. data/lib/ronin/db/cli/commands/oses.rb +95 -0
  25. data/lib/ronin/db/cli/commands/passwords.rb +83 -0
  26. data/lib/ronin/db/cli/commands/people.rb +185 -0
  27. data/lib/ronin/db/cli/commands/phone_numbers.rb +136 -0
  28. data/lib/ronin/db/cli/commands/ports.rb +103 -0
  29. data/lib/ronin/db/cli/commands/remove.rb +1 -1
  30. data/lib/ronin/db/cli/commands/services.rb +102 -0
  31. data/lib/ronin/db/cli/commands/software.rb +95 -0
  32. data/lib/ronin/db/cli/commands/street_addresses.rb +129 -0
  33. data/lib/ronin/db/cli/commands/urls.rb +2 -1
  34. data/lib/ronin/db/cli/commands/web_vulns.rb +235 -0
  35. data/lib/ronin/db/cli/database_options.rb +87 -0
  36. data/lib/ronin/db/cli/deletable.rb +85 -0
  37. data/lib/ronin/db/cli/importable.rb +108 -0
  38. data/lib/ronin/db/cli/model_command.rb +8 -6
  39. data/lib/ronin/db/cli/modifiable.rb +12 -104
  40. data/lib/ronin/db/cli/printing.rb +58 -0
  41. data/lib/ronin/db/cli/ruby_shell.rb +1 -1
  42. data/lib/ronin/db/cli/uri_methods.rb +1 -1
  43. data/lib/ronin/db/cli.rb +3 -1
  44. data/lib/ronin/db/config_file.rb +13 -8
  45. data/lib/ronin/db/exceptions.rb +10 -1
  46. data/lib/ronin/db/home.rb +1 -1
  47. data/lib/ronin/db/root.rb +1 -1
  48. data/lib/ronin/db/tasks.rb +87 -0
  49. data/lib/ronin/db/version.rb +2 -2
  50. data/lib/ronin/db.rb +24 -7
  51. data/man/ronin-db-add.1 +48 -70
  52. data/man/ronin-db-add.1.md +26 -22
  53. data/man/ronin-db-asn.1 +37 -55
  54. data/man/ronin-db-asn.1.md +29 -19
  55. data/man/ronin-db-certs.1 +108 -0
  56. data/man/ronin-db-certs.1.md +106 -0
  57. data/man/ronin-db-completion.1 +76 -0
  58. data/man/ronin-db-completion.1.md +78 -0
  59. data/man/ronin-db-creds.1 +29 -47
  60. data/man/ronin-db-creds.1.md +23 -16
  61. data/man/ronin-db-edit.1 +16 -27
  62. data/man/ronin-db-edit.1.md +11 -7
  63. data/man/ronin-db-emails.1 +37 -50
  64. data/man/ronin-db-emails.1.md +30 -17
  65. data/man/ronin-db-hosts.1 +32 -52
  66. data/man/ronin-db-hosts.1.md +25 -18
  67. data/man/ronin-db-ips.1 +32 -53
  68. data/man/ronin-db-ips.1.md +26 -19
  69. data/man/ronin-db-irb.1 +23 -36
  70. data/man/ronin-db-irb.1.md +17 -10
  71. data/man/ronin-db-list.1 +17 -31
  72. data/man/ronin-db-list.1.md +13 -9
  73. data/man/ronin-db-migrate.1 +23 -36
  74. data/man/ronin-db-migrate.1.md +17 -10
  75. data/man/ronin-db-open-ports.1 +72 -0
  76. data/man/ronin-db-open-ports.1.md +70 -0
  77. data/man/ronin-db-oses.1 +72 -0
  78. data/man/ronin-db-oses.1.md +70 -0
  79. data/man/ronin-db-passwords.1 +75 -0
  80. data/man/ronin-db-passwords.1.md +73 -0
  81. data/man/ronin-db-people.1 +96 -0
  82. data/man/ronin-db-people.1.md +94 -0
  83. data/man/ronin-db-phone-numbers.1 +93 -0
  84. data/man/ronin-db-phone-numbers.1.md +91 -0
  85. data/man/ronin-db-ports.1 +87 -0
  86. data/man/ronin-db-ports.1.md +85 -0
  87. data/man/ronin-db-remove.1 +16 -29
  88. data/man/ronin-db-remove.1.md +12 -8
  89. data/man/ronin-db-services.1 +84 -0
  90. data/man/ronin-db-services.1.md +82 -0
  91. data/man/ronin-db-software.1 +72 -0
  92. data/man/ronin-db-software.1.md +70 -0
  93. data/man/ronin-db-street-addresses.1 +81 -0
  94. data/man/ronin-db-street-addresses.1.md +79 -0
  95. data/man/ronin-db-urls.1 +38 -61
  96. data/man/ronin-db-urls.1.md +28 -21
  97. data/man/ronin-db-web-vulns.1 +87 -0
  98. data/man/ronin-db-web-vulns.1.md +85 -0
  99. data/man/ronin-db.1 +118 -0
  100. data/man/ronin-db.1.md +99 -0
  101. data/scripts/setup +58 -0
  102. metadata +70 -13
  103. data/lib/ronin/db/cli/database_command.rb +0 -71
  104. data/lib/ronin/db/cli/resources_command.rb +0 -118
@@ -0,0 +1,78 @@
1
+ # ronin-db-completion 1 "2024-01-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-completion - Manages shell completion rules for `ronin-db`
6
+
7
+ ## SYNOPSIS
8
+
9
+ `ronin-db completion` [*options*]
10
+
11
+ ## DESCRIPTION
12
+
13
+ The `ronin-db completion` command can print, install, or uninstall shell
14
+ completion rules for the `ronin-db` command.
15
+
16
+ Supports installing completion rules for Bash or Zsh shells.
17
+ Completion rules for the Fish shell is currently not supported.
18
+
19
+ ### ZSH SUPPORT
20
+
21
+ Zsh users will have to add the following lines to their `~/.zshrc` file in
22
+ order to enable Zsh's Bash completion compatibility layer:
23
+
24
+ autoload -Uz +X compinit && compinit
25
+ autoload -Uz +X bashcompinit && bashcompinit
26
+
27
+ ## OPTIONS
28
+
29
+ `--print`
30
+ : Prints the shell completion file.
31
+
32
+ `--install`
33
+ : Installs the shell completion file.
34
+
35
+ `--uninstall`
36
+ : Uninstalls the shell completion file.
37
+
38
+ `-h`, `--help`
39
+ : Prints help information.
40
+
41
+ ## ENVIRONMENT
42
+
43
+ *PREFIX*
44
+ : Specifies the root prefix for the file system.
45
+
46
+ *HOME*
47
+ : Specifies the home directory of the user. Ronin will search for the
48
+ `~/.cache/ronin-db` cache directory within the home directory.
49
+
50
+ *XDG_DATA_HOME*
51
+ : Specifies the data directory to use. Defaults to `$HOME/.local/share`.
52
+
53
+ ## FILES
54
+
55
+ `~/.local/share/bash-completion/completions/`
56
+ : The user-local installation directory for Bash completion files.
57
+
58
+ `/usr/local/share/bash-completion/completions/`
59
+ : The system-wide installation directory for Bash completions files.
60
+
61
+ `/usr/local/share/zsh/site-functions/`
62
+ : The installation directory for Zsh completion files.
63
+
64
+ ## EXAMPLES
65
+
66
+ `ronin-db completion --print`
67
+ : Prints the shell completion rules instead of installing them.
68
+
69
+ `ronin-db completion --install`
70
+ : Installs the shell completion rules for `ronin-db`.
71
+
72
+ `ronin-db completion --uninstall`
73
+ : Uninstalls the shell completion rules for `ronin-db`.
74
+
75
+ ## AUTHOR
76
+
77
+ Postmodern <postmodern.mod3@gmail.com>
78
+
data/man/ronin-db-creds.1 CHANGED
@@ -1,96 +1,78 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
4
- .LP
3
+ .TH ronin-db-creds 1 "2023-01-02" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-creds \- Manages all credentials in the database
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-db creds\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-db creds\fR \[lB]\fIoptions\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Manages credentials\.
14
- .LP
15
13
  .SH OPTIONS
16
- .LP
17
14
  .TP
18
- \fB--db\fR \fINAME\fP
15
+ \fB\-\-db\fR \fINAME\fP
19
16
  The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
- .LP
21
17
  .TP
22
- \fB--db-uri\fR \fIURI\fP
18
+ \fB\-\-db\-uri\fR \fIURI\fP
23
19
  The explicit database URI to connect to\.
24
- .LP
20
+ .RS
25
21
  .RS
26
22
  .IP \(bu 2
27
- \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
23
+ \fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
28
24
  .IP \(bu 2
29
- \fBmysql\fP: \fBmysql://user:password@host/database\fR
25
+ \fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
30
26
  .IP \(bu 2
31
- \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
27
+ \fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
32
28
  .RE
33
- .LP
29
+ .RE
30
+ .TP
31
+ \fB\-\-db\-file\fR \fIPATH\fP
32
+ The sqlite3 database file to use\.
34
33
  .TP
35
- \fB-v\fR, \fB--verbose\fR
34
+ \fB\-v\fR, \fB\-\-verbose\fR
36
35
  Enable verbose output\.
37
- .LP
38
36
  .TP
39
- \fB--add\fR \fIUSER\fP:\fIPASSWORD\fP
37
+ \fB\-\-add\fR \fIUSER\fP:\fIPASSWORD\fP
40
38
  Adds the \fIUSER\fP and \fIPASSWORD\fP to the database\.
41
- .LP
42
39
  .TP
43
- \fB--import\fR \fIFILE\fP
40
+ \fB\-\-import\fR \fIFILE\fP
44
41
  Imports the credentials from the given \fIFILE\fP\.
45
- .LP
46
42
  .TP
47
- \fB--delete\fR \fIVALUE\fP
43
+ \fB\-\-delete\fR \fIVALUE\fP
48
44
  Deletes a credential value from the database\.
49
- .LP
50
45
  .TP
51
- \fB--delete-all\fR
46
+ \fB\-\-delete\-all\fR
52
47
  Deletes every credential from the database\.
53
- .LP
54
48
  .TP
55
- \fB-u\fR, \fB--for-user\fR \fIUSER\fP
49
+ \fB\-u\fR, \fB\-\-for\-user\fR \fIUSER\fP
56
50
  Searches for credentials associated with the \fIUSER\fP\.
57
- .LP
58
51
  .TP
59
- \fB-p\fR, \fB--with-password\fR \fIPASSWORD\fP
52
+ \fB\-p\fR, \fB\-\-with\-password\fR \fIPASSWORD\fP
60
53
  Searches for credentials that have the \fIPASSWORD\fP\.
61
- .LP
62
54
  .TP
63
- \fB-h\fR, \fB--help\fR
55
+ \fB\-h\fR, \fB\-\-help\fR
64
56
  Print help information\.
65
- .LP
66
57
  .SH ENVIRONMENT
67
- .LP
68
58
  .TP
69
59
  \fIHOME\fP
70
60
  Alternate location for the user\[cq]s home directory\.
71
- .LP
72
61
  .TP
73
62
  \fIXDG\[ru]CONFIG\[ru]HOME\fP
74
- Alternate location for the \fB~/.config\fR directory\.
75
- .LP
63
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
76
64
  .TP
77
65
  \fIXDG\[ru]DATA\[ru]HOME\fP
78
- Alternate location for the \fB~/.local/share\fR directory\.
79
- .LP
66
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
80
67
  .SH FILES
81
- .LP
82
68
  .TP
83
- \fB~/.local/share/ronin-db/database.sqlite3\fR
69
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
84
70
  The default sqlite3 database file\.
85
- .LP
86
71
  .TP
87
- \fB~/.config/ronin-db/database.yml\fR
72
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
88
73
  Optional database configuration\.
89
- .LP
90
74
  .SH AUTHOR
91
- .LP
92
75
  .PP
93
76
  Postmodern
94
77
  .MT postmodern\.mod3\[at]gmail\.com
95
78
  .ME
96
- .LP
@@ -1,4 +1,8 @@
1
- # ronin-db-creds 1 "2023-01-02" Ronin "User Manuals"
1
+ # ronin-db-creds 1 "2023-01-02" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-creds - Manages all credentials in the database
2
6
 
3
7
  ## SYNOPSIS
4
8
 
@@ -11,57 +15,60 @@ Manages credentials.
11
15
  ## OPTIONS
12
16
 
13
17
  `--db` *NAME*
14
- The database to connect to. Defaults to `default` if not given.
18
+ : The database to connect to. Defaults to `default` if not given.
15
19
 
16
20
  `--db-uri` *URI*
17
- The explicit database URI to connect to.
21
+ : The explicit database URI to connect to.
18
22
 
19
23
  * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
20
24
  * **mysql**: `mysql://user:password@host/database`
21
25
  * **postgres**: `postgres://user:password@host/database`
22
26
 
27
+ `--db-file` *PATH*
28
+ : The sqlite3 database file to use.
29
+
23
30
  `-v`, `--verbose`
24
- Enable verbose output.
31
+ : Enable verbose output.
25
32
 
26
33
  `--add` *USER*:*PASSWORD*
27
- Adds the *USER* and *PASSWORD* to the database.
34
+ : Adds the *USER* and *PASSWORD* to the database.
28
35
 
29
36
  `--import` *FILE*
30
- Imports the credentials from the given *FILE*.
37
+ : Imports the credentials from the given *FILE*.
31
38
 
32
39
  `--delete` *VALUE*
33
- Deletes a credential value from the database.
40
+ : Deletes a credential value from the database.
34
41
 
35
42
  `--delete-all`
36
- Deletes every credential from the database.
43
+ : Deletes every credential from the database.
37
44
 
38
45
  `-u`, `--for-user` *USER*
39
- Searches for credentials associated with the *USER*.
46
+ : Searches for credentials associated with the *USER*.
40
47
 
41
48
  `-p`, `--with-password` *PASSWORD*
42
- Searches for credentials that have the *PASSWORD*.
49
+ : Searches for credentials that have the *PASSWORD*.
43
50
 
44
51
  `-h`, `--help`
45
- Print help information.
52
+ : Print help information.
46
53
 
47
54
  ## ENVIRONMENT
48
55
 
49
56
  *HOME*
50
- Alternate location for the user's home directory.
57
+ : Alternate location for the user's home directory.
51
58
 
52
59
  *XDG_CONFIG_HOME*
53
- Alternate location for the `~/.config` directory.
60
+ : Alternate location for the `~/.config` directory.
54
61
 
55
62
  *XDG_DATA_HOME*
56
- Alternate location for the `~/.local/share` directory.
63
+ : Alternate location for the `~/.local/share` directory.
57
64
 
58
65
  ## FILES
59
66
 
60
67
  `~/.local/share/ronin-db/database.sqlite3`
61
- The default sqlite3 database file.
68
+ : The default sqlite3 database file.
62
69
 
63
70
  `~/.config/ronin-db/database.yml`
64
- Optional database configuration.
71
+ : Optional database configuration.
65
72
 
66
73
  ## AUTHOR
67
74
 
data/man/ronin-db-edit.1 CHANGED
@@ -1,55 +1,44 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
3
  .TH ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
4
- .LP
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-edit \- Manually edits the database\.yml configuration file
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-db edit\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-db edit\fR \[lB]\fIoptions\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
- Manually edits the \fB~/.config/ronin-db/database.yml\fR configuration file\.
14
- .LP
12
+ Manually edits the \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR configuration file\.
15
13
  .SH OPTIONS
16
- .LP
17
14
  .TP
18
- \fB-h\fR, \fB--help\fR
15
+ \fB\-h\fR, \fB\-\-help\fR
19
16
  Print help information\.
20
- .LP
21
17
  .SH ENVIRONMENT
22
- .LP
23
18
  .TP
24
19
  \fIHOME\fP
25
20
  Alternate location for the user\[cq]s home directory\.
26
- .LP
27
21
  .TP
28
22
  \fIXDG\[ru]CONFIG\[ru]HOME\fP
29
- Alternate location for the \fB~/.config\fR directory\.
30
- .LP
23
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
31
24
  .TP
32
25
  \fIXDG\[ru]DATA\[ru]HOME\fP
33
- Alternate location for the \fB~/.local/share\fR directory\.
34
- .LP
26
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
35
27
  .SH FILES
36
- .LP
37
28
  .TP
38
- \fB~/.local/share/ronin-db/database.sqlite3\fR
29
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
39
30
  The default sqlite3 database file\.
40
- .LP
41
31
  .TP
42
- \fB~/.config/ronin-db/database.yml\fR
32
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
43
33
  Optional database configuration\.
44
- .LP
45
34
  .SH AUTHOR
46
- .LP
47
35
  .PP
48
36
  Postmodern
49
37
  .MT postmodern\.mod3\[at]gmail\.com
50
38
  .ME
51
- .LP
52
39
  .SH SEE ALSO
53
- .LP
54
40
  .PP
55
- ronin\-db(1) ronin\-db\-add(1) ronin\-db\-list(1) ronin\-db\-remove(1)
41
+ .BR ronin\-db (1)
42
+ .BR ronin\-db\-add (1)
43
+ .BR ronin\-db\-list (1)
44
+ .BR ronin\-db\-remove (1)
@@ -1,5 +1,9 @@
1
1
  # ronin-db-edit 1 "2023-02-01" Ronin DB "User Manuals"
2
2
 
3
+ ## NAME
4
+
5
+ ronin-db-edit - Manually edits the database.yml configuration file
6
+
3
7
  ## SYNOPSIS
4
8
 
5
9
  `ronin-db edit` [*options*]
@@ -11,26 +15,26 @@ Manually edits the `~/.config/ronin-db/database.yml` configuration file.
11
15
  ## OPTIONS
12
16
 
13
17
  `-h`, `--help`
14
- Print help information.
18
+ : Print help information.
15
19
 
16
20
  ## ENVIRONMENT
17
21
 
18
22
  *HOME*
19
- Alternate location for the user's home directory.
23
+ : Alternate location for the user's home directory.
20
24
 
21
25
  *XDG_CONFIG_HOME*
22
- Alternate location for the `~/.config` directory.
26
+ : Alternate location for the `~/.config` directory.
23
27
 
24
28
  *XDG_DATA_HOME*
25
- Alternate location for the `~/.local/share` directory.
29
+ : Alternate location for the `~/.local/share` directory.
26
30
 
27
31
  ## FILES
28
32
 
29
33
  `~/.local/share/ronin-db/database.sqlite3`
30
- The default sqlite3 database file.
34
+ : The default sqlite3 database file.
31
35
 
32
36
  `~/.config/ronin-db/database.yml`
33
- Optional database configuration.
37
+ : Optional database configuration.
34
38
 
35
39
  ## AUTHOR
36
40
 
@@ -38,4 +42,4 @@ Postmodern <postmodern.mod3@gmail.com>
38
42
 
39
43
  ## SEE ALSO
40
44
 
41
- ronin-db(1) ronin-db-add(1) ronin-db-list(1) ronin-db-remove(1)
45
+ [ronin-db](ronin-db.1.md) [ronin-db-add](ronin-db-add.1.md) [ronin-db-list](ronin-db-list.1.md) [ronin-db-remove](ronin-db-remove.1.md)
@@ -1,100 +1,87 @@
1
- .\" Generated by kramdown-man 0.1.8
1
+ .\" Generated by kramdown-man 1.0.1
2
2
  .\" https://github.com/postmodern/kramdown-man#readme
3
- .TH ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
4
- .LP
3
+ .TH ronin-db-emails 1 "2023-02-01" Ronin DB "User Manuals"
4
+ .SH NAME
5
+ .PP
6
+ ronin\-db\-emails \- Manages all email addresses in the database
5
7
  .SH SYNOPSIS
6
- .LP
7
- .HP
8
- \fBronin-db emails\fR \[lB]\fIoptions\fP\[rB]
9
- .LP
8
+ .PP
9
+ \fBronin\-db emails\fR \[lB]\fIoptions\fP\[rB]
10
10
  .SH DESCRIPTION
11
- .LP
12
11
  .PP
13
12
  Manages email addresses\.
14
- .LP
15
13
  .SH OPTIONS
16
- .LP
17
14
  .TP
18
- \fB--db\fR \fINAME\fP
15
+ \fB\-\-db\fR \fINAME\fP
19
16
  The database to connect to\. Defaults to \fBdefault\fR if not given\.
20
- .LP
21
17
  .TP
22
- \fB--db-uri\fR \fIURI\fP
18
+ \fB\-\-db\-uri\fR \fIURI\fP
23
19
  The explicit database URI to connect to\.
24
- .LP
20
+ .RS
25
21
  .RS
26
22
  .IP \(bu 2
27
- \fBsqlite3\fP: \fBsqlite3:relative/path.db\fR or \fBsqlite3:///absolute/path.db\fR
23
+ \fBsqlite3\fP: \fBsqlite3:relative\[sl]path\.db\fR or \fBsqlite3:\[sl]\[sl]\[sl]absolute\[sl]path\.db\fR
28
24
  .IP \(bu 2
29
- \fBmysql\fP: \fBmysql://user:password@host/database\fR
25
+ \fBmysql\fP: \fBmysql:\[sl]\[sl]user:password\[at]host\[sl]database\fR
30
26
  .IP \(bu 2
31
- \fBpostgres\fP: \fBpostgres://user:password@host/database\fR
27
+ \fBpostgres\fP: \fBpostgres:\[sl]\[sl]user:password\[at]host\[sl]database\fR
28
+ .RE
32
29
  .RE
33
- .LP
34
30
  .TP
35
- \fB-v\fR, \fB--verbose\fR
31
+ \fB\-\-db\-file\fR \fIPATH\fP
32
+ The sqlite3 database file to use\.
33
+ .TP
34
+ \fB\-v\fR, \fB\-\-verbose\fR
36
35
  Enable verbose output\.
37
- .LP
38
36
  .TP
39
- \fB--add\fR \fIVALUE\fP
37
+ \fB\-\-add\fR \fIVALUE\fP
40
38
  Adds the email address to the database\.
41
- .LP
42
39
  .TP
43
- \fB--import\fR \fIFILE\fP
40
+ \fB\-\-import\fR \fIFILE\fP
44
41
  Imports the email addresses from the given \fIFILE\fP\.
45
- .LP
46
42
  .TP
47
- \fB--delete\fR \fIVALUE\fP
43
+ \fB\-\-delete\fR \fIVALUE\fP
48
44
  Deletes the email address from the database\.
49
- .LP
50
45
  .TP
51
- \fB--delete-all\fR
46
+ \fB\-\-delete\-all\fR
52
47
  Deletes every email address from the database\.
53
- .LP
54
48
  .TP
55
- \fB-H\fR, \fB--with-host\fR \fIHOST\fP
49
+ \fB\-H\fR, \fB\-\-with\-host\fR \fIHOST\fP
56
50
  Searches for email addresses associated with the \fIHOST\fP\.
57
- .LP
58
51
  .TP
59
- \fB-I\fR, \fB--with-ip\fR \fIIP\fP
52
+ \fB\-I\fR, \fB\-\-with\-ip\fR \fIIP\fP
60
53
  Searches for email addresses associated with the IP address\.
61
- .LP
62
- .HP
63
- \fB-u\fR, \fB--with-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
54
+ .TP
55
+ \fB\-u\fR, \fB\-\-with\-users\fR \fINAME\fP \[lB]\.\.\.\[rB]
64
56
  Searches for email addresses associated with the user NAME(s)\.
65
- .LP
66
57
  .TP
67
- \fB-h\fR, \fB--help\fR
58
+ \fB\-P\fR, \fB\-\-for\-person\fR \fIFULL\[ru]NAME\fP
59
+ Searches for email addresses associated with the person\[cq]s full name\.
60
+ .TP
61
+ \fB\-O\fR, \fB\-\-for\-organization\fR \fINAME\fP
62
+ Searches for email addresses associated with the organization\[cq]s name\.
63
+ .TP
64
+ \fB\-h\fR, \fB\-\-help\fR
68
65
  Print help information\.
69
- .LP
70
66
  .SH ENVIRONMENT
71
- .LP
72
67
  .TP
73
68
  \fIHOME\fP
74
69
  Alternate location for the user\[cq]s home directory\.
75
- .LP
76
70
  .TP
77
71
  \fIXDG\[ru]CONFIG\[ru]HOME\fP
78
- Alternate location for the \fB~/.config\fR directory\.
79
- .LP
72
+ Alternate location for the \fB\[ti]\[sl]\.config\fR directory\.
80
73
  .TP
81
74
  \fIXDG\[ru]DATA\[ru]HOME\fP
82
- Alternate location for the \fB~/.local/share\fR directory\.
83
- .LP
75
+ Alternate location for the \fB\[ti]\[sl]\.local\[sl]share\fR directory\.
84
76
  .SH FILES
85
- .LP
86
77
  .TP
87
- \fB~/.local/share/ronin-db/database.sqlite3\fR
78
+ \fB\[ti]\[sl]\.local\[sl]share\[sl]ronin\-db\[sl]database\.sqlite3\fR
88
79
  The default sqlite3 database file\.
89
- .LP
90
80
  .TP
91
- \fB~/.config/ronin-db/database.yml\fR
81
+ \fB\[ti]\[sl]\.config\[sl]ronin\-db\[sl]database\.yml\fR
92
82
  Optional database configuration\.
93
- .LP
94
83
  .SH AUTHOR
95
- .LP
96
84
  .PP
97
85
  Postmodern
98
86
  .MT postmodern\.mod3\[at]gmail\.com
99
87
  .ME
100
- .LP
@@ -1,4 +1,8 @@
1
- # ronin-db-emails 1 "2023-02-01" Ronin "User Manuals"
1
+ # ronin-db-emails 1 "2023-02-01" Ronin DB "User Manuals"
2
+
3
+ ## NAME
4
+
5
+ ronin-db-emails - Manages all email addresses in the database
2
6
 
3
7
  ## SYNOPSIS
4
8
 
@@ -11,60 +15,69 @@ Manages email addresses.
11
15
  ## OPTIONS
12
16
 
13
17
  `--db` *NAME*
14
- The database to connect to. Defaults to `default` if not given.
18
+ : The database to connect to. Defaults to `default` if not given.
15
19
 
16
20
  `--db-uri` *URI*
17
- The explicit database URI to connect to.
21
+ : The explicit database URI to connect to.
18
22
 
19
23
  * **sqlite3**: `sqlite3:relative/path.db` or `sqlite3:///absolute/path.db`
20
24
  * **mysql**: `mysql://user:password@host/database`
21
25
  * **postgres**: `postgres://user:password@host/database`
22
26
 
27
+ `--db-file` *PATH*
28
+ : The sqlite3 database file to use.
29
+
23
30
  `-v`, `--verbose`
24
- Enable verbose output.
31
+ : Enable verbose output.
25
32
 
26
33
  `--add` *VALUE*
27
- Adds the email address to the database.
34
+ : Adds the email address to the database.
28
35
 
29
36
  `--import` *FILE*
30
- Imports the email addresses from the given *FILE*.
37
+ : Imports the email addresses from the given *FILE*.
31
38
 
32
39
  `--delete` *VALUE*
33
- Deletes the email address from the database.
40
+ : Deletes the email address from the database.
34
41
 
35
42
  `--delete-all`
36
- Deletes every email address from the database.
43
+ : Deletes every email address from the database.
37
44
 
38
45
  `-H`, `--with-host` *HOST*
39
- Searches for email addresses associated with the *HOST*.
46
+ : Searches for email addresses associated with the *HOST*.
40
47
 
41
48
  `-I`, `--with-ip` *IP*
42
- Searches for email addresses associated with the IP address.
49
+ : Searches for email addresses associated with the IP address.
43
50
 
44
51
  `-u`, `--with-users` *NAME* [...]
45
- Searches for email addresses associated with the user NAME(s).
52
+ : Searches for email addresses associated with the user NAME(s).
53
+
54
+ `-P`, `--for-person` *FULL_NAME*
55
+ : Searches for email addresses associated with the person's full name.
56
+
57
+ `-O`, `--for-organization` *NAME*
58
+ : Searches for email addresses associated with the organization's name.
46
59
 
47
60
  `-h`, `--help`
48
- Print help information.
61
+ : Print help information.
49
62
 
50
63
  ## ENVIRONMENT
51
64
 
52
65
  *HOME*
53
- Alternate location for the user's home directory.
66
+ : Alternate location for the user's home directory.
54
67
 
55
68
  *XDG_CONFIG_HOME*
56
- Alternate location for the `~/.config` directory.
69
+ : Alternate location for the `~/.config` directory.
57
70
 
58
71
  *XDG_DATA_HOME*
59
- Alternate location for the `~/.local/share` directory.
72
+ : Alternate location for the `~/.local/share` directory.
60
73
 
61
74
  ## FILES
62
75
 
63
76
  `~/.local/share/ronin-db/database.sqlite3`
64
- The default sqlite3 database file.
77
+ : The default sqlite3 database file.
65
78
 
66
79
  `~/.config/ronin-db/database.yml`
67
- Optional database configuration.
80
+ : Optional database configuration.
68
81
 
69
82
  ## AUTHOR
70
83