prelude-cli-beta 1396__tar.gz

prelude_cli_beta-1396/LICENSE

@@ -0,0 +1,9 @@
+MIT LICENSE
+
+Copyright 2022, Prelude Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

prelude_cli_beta-1396/MANIFEST.in

@@ -0,0 +1 @@
+include prelude_cli/templates/*

prelude_cli_beta-1396/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: prelude-cli-beta
+Version: 1396
+Summary: For interacting with the Prelude SDK
+Home-page: https://github.com/preludeorg
+Author: Prelude Research
+Author-email: support@preludesecurity.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prelude-sdk==2.6.13a1396
+Requires-Dist: click>8
+Requires-Dist: rich
+Requires-Dist: python-dateutil
+Requires-Dist: pyyaml
+Dynamic: license-file
+
+# Prelude CLI
+
+Interact with the full range of features in Prelude Detect, organized by:
+
+- IAM: manage your account 
+- Build: write and maintain your collection of security tests
+- Detect: schedule security tests for your endpoints
+
+## Quick start
+```bash
+pip install prelude-cli
+prelude --help
+prelude --interactive
+```
+
+## Documentation
+
+https://docs.preludesecurity.com/docs/prelude-cli

prelude_cli_beta-1396/README.md

@@ -0,0 +1,18 @@
+# Prelude CLI
+
+Interact with the full range of features in Prelude Detect, organized by:
+
+- IAM: manage your account 
+- Build: write and maintain your collection of security tests
+- Detect: schedule security tests for your endpoints
+
+## Quick start
+```bash
+pip install prelude-cli
+prelude --help
+prelude --interactive
+```
+
+## Documentation
+
+https://docs.preludesecurity.com/docs/prelude-cli

prelude_cli_beta-1396/prelude_cli/cli.py

@@ -0,0 +1,47 @@
+import click
+
+from prelude_cli.views.auth import auth
+from prelude_cli.views.build import build
+from prelude_cli.views.configure import configure
+from prelude_cli.views.detect import detect
+from prelude_cli.views.generate import generate
+from prelude_cli.views.iam import iam
+from prelude_cli.views.jobs import jobs
+from prelude_cli.views.partner import partner
+from prelude_cli.views.scm import scm
+from prelude_sdk.models.account import Account, Keychain
+
+
+def complete_profile(ctx, param, incomplete):
+    return [x for x in Keychain().read_keychain() if x.startswith(incomplete)]
+
+
+@click.group(invoke_without_command=True)
+@click.version_option()
+@click.pass_context
+@click.option(
+    "--profile",
+    default="default",
+    help="The prelude keychain profile to use",
+    show_default=True,
+    shell_complete=complete_profile,
+)
+def cli(ctx, profile):
+    ctx.obj = Account.from_keychain(profile=profile)
+    if ctx.invoked_subcommand is None:
+        click.echo(ctx.get_help())
+
+
+cli.add_command(auth)
+cli.add_command(build)
+cli.add_command(configure)
+cli.add_command(detect)
+cli.add_command(generate)
+cli.add_command(iam)
+cli.add_command(jobs)
+cli.add_command(partner)
+cli.add_command(scm)
+
+
+if __name__ == "__main__":
+    cli()

prelude_cli_beta-1396/prelude_cli/templates/README.md

@@ -0,0 +1,28 @@
+# $NAME
+
+This section should describe the test, provide some background information (such as historical in-the-wild usage by threat actors or APTs), and briefly illustrate the test's intention, objective, and techniques utilized to achieve them. This section should NOT be too technical or overly long; a small paragraph should be sufficient.
+
+## How
+
+ > Safety: This section should contain an advisory statement that positively declares that the VST does not negatively affect the tested system in any way.
+
+Steps:
+
+ 1. This section enumerates the individual, atomic steps by which ...
+ 2. ... the probe attempts to achieve the intended effect of the test ...
+ 3. ... and thereby perform evaluation of any resident security solutions.
+
+ Example Output:
+ ```bash
+ [$ID] Starting test at: $TIME
+ [$ID] Host is vulnerable, continuing with technique execution
+ [$ID] Completed with code: 101
+ [$ID] Ending test at: $TIME
+ ```
+
+## Resolution
+
+ If this test fails:
+
+* Bulleted list of recommendations that the testing organization SHOULD consider ...
+* ... based upon the nature of the test, as well as the point of failure.

prelude_cli_beta-1396/prelude_cli/templates/template.go

@@ -0,0 +1,24 @@
+/*
+ID: $ID
+NAME: $NAME
+TECHNIQUE: $TECHNIQUE
+UNIT: $UNIT
+CREATED: $TIME
+*/
+package main
+
+import (
+	Endpoint "github.com/preludeorg/libraries/go/tests/endpoint"
+)
+
+func test() {
+	Endpoint.Stop(Endpoint.TestCompletedNormally)
+}
+
+func clean() {
+	Endpoint.Say("Cleaning up")
+}
+
+func main() {
+	Endpoint.Start(test, clean)
+}

prelude_cli_beta-1396/prelude_cli/views/auth.py

@@ -0,0 +1,56 @@
+import click
+import webbrowser
+
+from prelude_cli.views.shared import Spinner, pretty_print
+
+
+@click.group()
+@click.pass_context
+def auth(ctx):
+    """Authentication"""
+    pass
+
+
+@auth.command("login")
+@click.option("-p", "--password", type=str, help="password for login")
+@click.option(
+    "-t",
+    "--temp_password",
+    type=str,
+    help="temporary password for login (if set, `password` will become your new password)",
+)
+@click.pass_obj
+@pretty_print
+def login(account, password, temp_password):
+    """Login using password or SSO"""
+    if not account.oidc:
+        password = password or click.prompt("Password", type=str, hide_input=True)
+        with Spinner(description="Logging in and saving tokens"):
+            new_password = password if temp_password else None
+            password = temp_password or password
+            return (
+                account.password_login(password, new_password),
+                "Login with password successful",
+            )
+
+    url = f"{account.hq.replace('api', 'platform')}/cli-auth?handle={account.handle}&provider={account.oidc}"
+    if account.oidc == "custom":
+        slug = account.slug or click.prompt("Please enter your account slug")
+        url += f"&slug={slug}"
+    webbrowser.open(url)
+    code = click.prompt(
+        f"Launching browser for authentication:\n\n{url}\n\nPlease enter your authorization code here"
+    )
+    verifier, authorization_code = code.split("/")
+    with Spinner(description="Logging in and saving tokens"):
+        tokens = account.exchange_authorization_code(authorization_code, verifier)
+    return tokens, "Login with SSO successful"
+
+
+@auth.command("refresh")
+@click.pass_obj
+@pretty_print
+def refresh(account):
+    """Refresh your tokens"""
+    with Spinner(description="Refreshing tokens"):
+        return account.refresh_tokens(), "New access tokens saved"