Feature/support new search params (#8)

Author: Juliya Smith

CHANGELOG.md

@@ -8,11 +8,33 @@ 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.3.0 - 2020-03-04
 
 ### Added
 
 - Begin and end date now support specifying time: `code42 securitydata print -b 2020-02-02 12:00:00`.
+- New search arguments for `print`, `write-to`, and `send-to`:
+    - `--c42username`
+    - `--actor`
+    - `--md5`
+    - `--sha256`
+    - `--source`
+    - `--filename`
+    - `--filepath`
+    - `--processOwner`
+    - `--tabURL`
+    - `--include-non-exposure`
+
+### Changed
+
+- It is no longer required to store your password in your profile,
+    and you will be prompted to enter your password at runtime if you don't.
+- You will be asked if you would like to set a password after using `code42cli profile set`.
+- Begin date is now required for `securitydata` `print`, `write-to`, and `send-to` commands.
+
+### Removed
+
+- Removed `--show` flag from `code42 profile set` command. Just use `code42 profile show`.
 
 ## 0.2.0 - 2020-02-25
 

README.md

@@ -1,7 +1,7 @@
 # The Code42 CLI
 
 Use the `code42` command to interact with your Code42 environment.
-`code42 securitydata` is a CLI tool for extracting AED events. 
+`code42 securitydata` is a CLI tool for extracting AED events.
 Additionally, `code42 securitydata` can record a checkpoint so that you only get events you have not previously gotten.
 
 ## Requirements
@@ -23,15 +23,11 @@ First, set your profile:
 code42 profile set -s https://example.authority.com -u [email protected]
 ```
 Your profile contains the necessary properties for logging into Code42 servers.
-You will prompted for a password if there is not one saved for your current username/authority URL combination.
-
-To explicitly set your password, use `-p`:
-```bash
-code42 profile set -p
-```
-You will be securely prompted to input your password.
+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.
+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:
 ```bash
@@ -67,6 +63,16 @@ Each destination-type subcommand shares query parameters
 * `-t` (exposure types)
 * `-b` (begin date)
 * `-e` (end date)
+* `--c42username`
+* `--actor`
+* `--md5`
+* `--sha256`
+* `--source`
+* `--filename`
+* `--filepath`
+* `--processOwner`
+* `--tabURL`
+* `--include-non-exposure` (does not work with `-t`)
 * `--advanced-query` (raw JSON query)
 
 Note that you cannot use other query parameters if you use `--advanced-query`.

setup.py

@@ -20,7 +20,7 @@
     packages=find_packages("src"),
     package_dir={"": "src"},
     python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4",
-    install_requires=["c42eventextractor==0.2.0", "keyring==18.0.1","py42==0.5.1"],
+    install_requires=["c42eventextractor==0.2.1", "keyring==18.0.1","py42==0.5.1"],
     license="MIT",
     include_package_data=True,
     zip_safe=False,

src/code42cli/__version__.py

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

src/code42cli/main.py

@@ -10,10 +10,10 @@ def main():
     subcommand_parser = code42_arg_parser.add_subparsers()
     profile.init(subcommand_parser)
     securitydata.init_subcommand(subcommand_parser)
-    _call_subcommand(code42_arg_parser)
+    _run(code42_arg_parser)
 
 
-def _call_subcommand(parser):
+def _run(parser):
     try:
         args = parser.parse_args()
         args.func(args)

src/code42cli/profile/config.py

@@ -6,6 +6,9 @@
 import code42cli.util as util
 
 
+_DEFAULT_VALUE = u"__DEFAULT__"
+
+
 class ConfigurationKeys(object):
     USER_SECTION = u"Code42"
     AUTHORITY_KEY = u"c42_authority_url"
@@ -16,33 +19,37 @@ class ConfigurationKeys(object):
 
 
 def get_config_profile():
+    """Get your config file profile."""
     parser = ConfigParser()
     if not profile_has_been_set():
-        util.print_error("Profile is not set.")
-        print("")
-        print("To set, use: ")
-        util.print_bold("\tcode42 profile set -s <authority-URL> -u <username>")
-        print("")
+        util.print_error(u"Profile has not completed setup.")
+        print(u"")
+        print(u"To set, use: ")
+        util.print_bold(u"\tcode42 profile set -s <authority-URL> -u <username>")
+        print(u"")
         exit(1)
 
     return _get_config_profile_from_parser(parser)
 
 
-def mark_as_set():
+def profile_has_been_set():
+    """Whether you have, at one point in time, set your username and authority server URL."""
     parser = ConfigParser()
     config_file_path = _get_config_file_path()
     parser.read(config_file_path)
     settings = parser[ConfigurationKeys.INTERNAL_SECTION]
-    settings[ConfigurationKeys.HAS_SET_PROFILE_KEY] = "True"
-    _save(parser, ConfigurationKeys.HAS_SET_PROFILE_KEY)
+    return settings.getboolean(ConfigurationKeys.HAS_SET_PROFILE_KEY)
 
 
-def profile_has_been_set():
+def mark_as_set_if_complete():
+    if not _profile_can_be_set():
+        return
     parser = ConfigParser()
     config_file_path = _get_config_file_path()
     parser.read(config_file_path)
     settings = parser[ConfigurationKeys.INTERNAL_SECTION]
-    return settings.getboolean(ConfigurationKeys.HAS_SET_PROFILE_KEY)
+    settings[ConfigurationKeys.HAS_SET_PROFILE_KEY] = u"True"
+    _save(parser, ConfigurationKeys.HAS_SET_PROFILE_KEY)
 
 
 def set_username(new_username):
@@ -66,22 +73,31 @@ def set_ignore_ssl_errors(new_value):
     _save(parser, ConfigurationKeys.IGNORE_SSL_ERRORS_KEY)
 
 
-def _get_config_file_path():
-    path = "{}config.cfg".format(util.get_user_project_path())
-    if not os.path.exists(path) or not _verify_config_file(path):
-        _create_new_config_file(path)
-
-    return path
+def _profile_can_be_set():
+    """Whether your current username and authority URL are set,
+        but your profile has not been marked as set.
+    """
+    parser = ConfigParser()
+    profile = _get_config_profile_from_parser(parser)
+    username = profile[ConfigurationKeys.USERNAME_KEY]
+    authority = profile[ConfigurationKeys.AUTHORITY_KEY]
+    return username != _DEFAULT_VALUE and authority != _DEFAULT_VALUE and not profile_has_been_set()
 
 
 def _get_config_profile_from_parser(parser):
     config_file_path = _get_config_file_path()
     parser.read(config_file_path)
     config = parser[ConfigurationKeys.USER_SECTION]
-    config.ignore_ssl_errors = config.getboolean(ConfigurationKeys.IGNORE_SSL_ERRORS_KEY)
     return config
 
 
+def _get_config_file_path():
+    path = u"{}config.cfg".format(util.get_user_project_path())
+    if not os.path.exists(path) or not _verify_config_file(path):
+        _create_new_config_file(path)
+    return path
+
+
 def _create_new_config_file(path):
     config_parser = ConfigParser()
     config_parser = _create_user_section(config_parser)
@@ -93,25 +109,28 @@ def _create_user_section(parser):
     keys = ConfigurationKeys
     parser.add_section(keys.USER_SECTION)
     parser[keys.USER_SECTION] = {}
-    parser[keys.USER_SECTION][keys.AUTHORITY_KEY] = "null"
-    parser[keys.USER_SECTION][keys.USERNAME_KEY] = "null"
-    parser[keys.USER_SECTION][keys.IGNORE_SSL_ERRORS_KEY] = "False"
+    parser[keys.USER_SECTION][keys.AUTHORITY_KEY] = _DEFAULT_VALUE
+    parser[keys.USER_SECTION][keys.USERNAME_KEY] = _DEFAULT_VALUE
+    parser[keys.USER_SECTION][keys.IGNORE_SSL_ERRORS_KEY] = u"False"
     return parser
 
 
 def _create_internal_section(parser):
     keys = ConfigurationKeys
     parser.add_section(keys.INTERNAL_SECTION)
     parser[keys.INTERNAL_SECTION] = {}
-    parser[keys.INTERNAL_SECTION][keys.HAS_SET_PROFILE_KEY] = "False"
+    parser[keys.INTERNAL_SECTION][keys.HAS_SET_PROFILE_KEY] = u"False"
     return parser
 
 
 def _save(parser, key=None, path=None):
     path = _get_config_file_path() if path is None else path
-    util.open_file(path, "w+", lambda f: parser.write(f))
+    util.open_file(path, u"w+", lambda f: parser.write(f))
     if key is not None:
-        print("'{}' has been successfully updated".format(key))
+        if key == ConfigurationKeys.HAS_SET_PROFILE_KEY:
+            print(u"You have completed setting up your profile!")
+        else:
+            print(u"'{}' has been successfully updated".format(key))
 
 
 def _verify_config_file(path):

src/code42cli/profile/password.py

@@ -9,32 +9,33 @@
 _ROOT_SERVICE_NAME = u"code42cli"
 
 
-def get_password(prompt_if_not_exists=True):
+def get_password():
     """Gets your currently stored password for your username / authority URL combo."""
     profile = config.get_config_profile()
     service_name = _get_service_name(profile)
     username = _get_username(profile)
     password = keyring.get_password(service_name, username)
-    if password is None and prompt_if_not_exists:
-        return set_password()
-
     return password
 
 
-def set_password():
+def set_password_from_prompt():
     """Prompts and sets your password for your username / authority URL combo."""
     password = getpass()
     profile = config.get_config_profile()
     service_name = _get_service_name(profile)
     username = _get_username(profile)
     keyring.set_password(service_name, username, password)
-    print("'Code42 Password' updated.")
+    print(u"'Code42 Password' updated.")
     return password
 
 
+def get_password_from_prompt():
+    return getpass()
+
+
 def _get_service_name(profile):
     authority_url = profile[ConfigurationKeys.AUTHORITY_KEY]
-    return "{}::{}".format(_ROOT_SERVICE_NAME, authority_url)
+    return u"{}::{}".format(_ROOT_SERVICE_NAME, authority_url)
 
 
 def _get_username(profile):