Feature/multiple profiles (#12)

Author: Juliya Smith

CHANGELOG.md

@@ -8,7 +8,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 The intended audience of this file is for py42 consumers -- as such, changes that don't affect
 how a consumer would use the library (e.g. adding unit tests, updating documentation, etc) are not captured here.
 
-## Unreleased
+## 0.4.0 - 2020-03-12
+
+### Added
+
+- Support for multiple profiles:
+    - Optional `--profile` flag for:
+        - `securitydata write-to`, `print`, and `send-to`,
+        - `profile show`, `set`, and `reset-pw`.
+    - `code42 profile use` command for changing the default profile.
+    - `code42 profile list` command for listing all the available profiles.
+- The following search args can now take multiple values:
+    - `--c42username`,
+    - `--actor`,
+    - `--md5`,
+    - `--sha256`,
+    - `--filename`,
+    - `--filepath`,
+    - `--processOwner`,
+    - `--tabURL`
 
 ### Fixed
 
@@ -18,6 +36,7 @@ how a consumer would use the library (e.g. adding unit tests, updating documenta
 
 - Begin dates are no longer required for subsequent interactive `securitydata` commands.
 - When provided, begin dates are now ignored on subsequent interactive `securitydata` commands.
+- `--profile` arg is now required the first time setting up a profile.
 
 ## 0.3.0 - 2020-03-04
 

README.md

@@ -21,16 +21,20 @@ $ python setup.py install
 
 First, set your profile:
 ```bash
-code42 profile set -s https://example.authority.com -u [email protected]
+code42 profile set --profile MY_FIRST_PROFILE -s https://example.authority.com -u [email protected]
 ```
+The `--profile` flag is required the first time and it takes a name.
+On subsequent uses of `set`, not specifying the profile will set the default profile.
+
 Your profile contains the necessary properties for logging into Code42 servers.
-After running this `code42 profile set`, you will be prompted about storing a password.
-If you agree, you will be securely prompted to input your password.
-Your password is not stored in plain-text, and is not shown when you do `code42 profile show`.
-However, `code42 profile show` will confirm that there is a password set for your profile.
+After running `code42 profile set`, the program prompts you about storing a password.
+If you agree, you are then prompted to input your password.
+
+Your password is not stored in plain-text and is not shown when you do `code42 profile show`.
+However, `code42 profile show` will confirm that a password exists for your profile.
 If you do not set a password, you will be securely prompted to enter a password each time you run a command.
 
-To ignore SSL errors, do:
+For development purposes, you may need to ignore ssl errors. If you need to do this, do:
 ```bash
 code42 profile set --disable-ssl-errors
 ```
@@ -40,7 +44,19 @@ To re-enable SSL errors, do:
 code42 profile set --enable-ssl-errors
 ```
 
-Next, you can query for events and send them to three possible destination types
+You can add multiple profiles with different names and the change the default profile with the `use` command:
+```bash
+code42 profile use MY_SECOND_PROFILE
+```
+When the `--profile` flag is available on other commands, such as those in `securitydata`,
+it will use that profile instead of the default one.
+
+To see all your profiles, do:
+```bash
+code42 profile list
+```
+
+Using the CLI, you can query for events and send them to three possible destination types:
 * stdout
 * A file
 * A server, such as SysLog
@@ -58,6 +74,12 @@ code42 securitydata print -b 2020-02-02 12:51
 ```
 Begin date will be ignored if provided on subsequent queries using `-i`.
 
+Use different format with `-f`:
+```bash
+code42 securitydata print -b 2020-02-02 -f CEF
+```
+The available formats are CEF, JSON, and RAW-JSON.
+
 To write events to a file, do:
 ```bash
 code42 securitydata write-to filename.txt -b 2020-02-02
@@ -74,6 +96,16 @@ code42 securitydata send-to syslog.company.com -i
 ```
 This is only guaranteed if you did not change your query.
 
+To send events to a server using a specific profile, do:
+```bash
+code42 securitydata send-to --profile PROFILE_FOR_RECURRING_JOB syslog.company.com -b 2020-02-02 -f CEF -i
+```
+
+You can also use wildcard for queries, but note, if they are not in quotes, you may get unexpected behavior.
+```bash
+code42 securitydata print --actor "*"
+```
+
 
 Each destination-type subcommand shares query parameters
 * `-t` (exposure types)
@@ -92,7 +124,7 @@ Each destination-type subcommand shares query parameters
 * `--advanced-query` (raw JSON query)
 
 You cannot use other query parameters if you use `--advanced-query`.
-To learn more about acceptable arguments, add the `-h` flag to `code42` or and of the destination-type subcommands.
+To learn more about acceptable arguments, add the `-h` flag to `code42` or any of the destination-type subcommands.
 
 
 # Known Issues

src/code42cli/__version__.py

@@ -1 +1 @@
-__version__ = "0.3.0"
+__version__ = "0.4.0"

src/code42cli/arguments.py

@@ -0,0 +1,25 @@
+PROFILE_NAME_KEY = u"profile_name"
+PROFILE_HELP_MESSAGE = (
+    u"The name of the profile containing your Code42 username and authority host address."
+)
+
+
+def add_arguments_to_parser(parser):
+    add_debug_arg(parser)
+    add_profile_name_arg(parser)
+
+
+def add_debug_arg(parser):
+    parser.add_argument(
+        u"-d",
+        u"--debug",
+        dest=u"is_debug_mode",
+        action=u"store_true",
+        help=u"Turn on Debug logging.",
+    )
+
+
+def add_profile_name_arg(parser):
+    parser.add_argument(
+        u"--profile", action=u"store", dest=PROFILE_NAME_KEY, help=PROFILE_HELP_MESSAGE
+    )

src/code42cli/compat.py

@@ -15,7 +15,11 @@
     from urlparse import urljoin, urlparse
 
     str = unicode
+
+    import repr as reprlib
 else:
     from urllib.parse import urljoin, urlparse
 
     str = str
+
+    import reprlib

src/code42cli/main.py

@@ -34,3 +34,7 @@ def _run(parser):
             parser.print_help()
             return
         raise ex
+
+
+if __name__ == "__main__":
+    main()