Skip to content

Latest commit

 

History

History
245 lines (198 loc) · 9.97 KB

README.md

File metadata and controls

245 lines (198 loc) · 9.97 KB
Raw

Library for interacting with Synack API

This is a library and set of scripts that make SRT life a little easier when interacting with the platform from an LP+ linux commandline.

  • Connect to platform
    • Stay connected to the platform
  • Register available targets
  • Connect to targets
  • Download targets' scope
  • Retrieve analytics from Web Application and Host targets
  • Download hydra findings
  • Retrieve target specific information:
    • Client names
    • Codenames
    • Slugs
    • Target types
  • Manage notifications

Acknowledgements

Thank you Malcolm, Nicolas, and pmnh for making this better!

Configuration requirements

Operating System

This has been developed on LP+ (Linux). I have no idea if it will work on Windows. It might, but your mileage may vary. I do not use windows. If you do, and you want to test, please do.

Configuration Directories

The required directory is ~/.synack.

synack.conf

This is a required config file, and is expected to be in the directory ~/.synack/

[DEFAULT]
login_wait = 15
login_url = https://login.synack.com
email = [email protected]
password = your.synack.password
authy_secret = ABCDEFGHIJKLMNOPQRSTUVWXYZ======
webhook_url = https://hooks.slack.com/services/...
  • login_wait
    • Number of seconds to wait for the platform's website to be loaded before attempting to log in. Can take a while.
  • login_url
    • This should stay as is, unless Synack changes something
  • email
    • The email address you use to log into the platform
  • password
    • The password you use to log into the platform
  • authy_secret
    • base32 secret for generating Authy tokens
    • Guillaume Boudreau provide a nice walk through for getting this secret
      • Follow the above to get Authy into debug mode, then use THIS CODE to get your valid TOTP SECRET!
  • gecko true/false (default true) - if false, the requests module will be used for the login flow, instead of the geckodriver (works well on Windows)
  • proxy true/false (default false) - if true, route requests through a local proxy for debugging
  • proxyport (default 8080) - local proxy port used for debugging
  • session_token_path (default /tmp/synacktoken) - location to store synack token
  • notification_token_path (default /tmp/notificationtoken) - location to store notification token

Installing as a python module

This can be installed as a python module named synack for easy integration with other python code. To install, you can enter the SynackAPI directory and run the following:

pip3 install -e .

requirements.txt

Your best bet to have all required python3 modules is to run pip3 install -r requirements.txt. I cannot help troubleshoot any other modules.

geckodriver

You must install geckodriver and it must be in your $PATH (note, this is currently true even if you have gecko set to False in the config file)

Synack API python3 module

This python3 module provides a class to create objects for interacting with the Synack LP/LP+ platform.
Basic use:

from synack import synack

s1 = synack()
s1.getSessionToken()
s1.getAllTargets()

Console command

Once installed as a python module, you can use synack as a console command, specifying the name of a script in the tools directory. For example, to find the current target, you can run synack currentTarget. A CLI is available which wraps around most of the synack class functions, if you run synack cli.

synack()

This method creates an object that can be used to interact with the LP/LP+ platform.

connectToPlatform()

This method is used to connect to the Synack platform and writes the session token to disk using requests or Gecko.

connectToPlatformrequests()

This method

connectToPlatformGecko()

SSL Certificates

This method will create the directory ~/.synack/selenium.profile. The first time connecting to the SRT Platform, you will be asked to install the cacert.crt file. This allows the cert to be permanently stored and used with geckodriver.

getSessionToken()

This method reads a file disk location of synack.tokenPath and stores the file contents into the synack.token variable. If the file does not contain a valid Synack platform authentication token, the rest of this library will not work.

getAllTargets()

This method pulls down a descriptive JSON on all targets. Most other methods rely on this JSON and should normally be the second function method called.

getAssessments()

This method returns a list of all Synack assessments that have been completed.

getCodenames(category, mission_only=False)

This method takes two parameters and returns a list of codenames.

parameters:

  • category STRING defines the type of target you're looking for and must be one of the following:
    • "web application"
    • "host"
    • "mobile"
    • "source code"
    • "reverse engineering"
    • "hardware"
  • mission_only BOOLEAN
    • True: returns targets that only allow SV2M missions
    • False: returns targets that are NOT SV2M only.

clientName(codename)

This method takes the target codename and returns the client's true name.

connectToTarget(codename)

This method takes a target codename and connects to it.

getCategory(codename)

This method takes a target codename and returns what type of assessment the target requires.

getTargetID(codename)

This method takes a target codename and returns the project slug. This method is generally not used by end users, but rather supports other function methods.

getCodenameFromSlug(slug)

This method takes a project slug and returns the target codename. This method is generally not used by end users, but rather supports other function methods.

getCurrentTargetSlug()

This method returns the slug of whatever target you are connected to. If not connected to a target, this will return None.

getScope(codename)

This method takes a codename and returns its scope as two lists of dictionaries.

The first list of dictionaries is the in-scope items, and the second list of dictionaries is the out of scope items.

  • Host targets return the CIDR notation ranges
  • Web Application targets return the expanded list of rules:
    • scheme: (http || https)
    • netloc: the "domain" part of the url
    • path: the path of the url
    • wildcard: if the subdomain of the url is a wildcard, not the path
https://www.example.com/*
*.example.com/path/*

[
  {
    'scheme': 'https',
    'netloc': 'www.example.com',
    'path': '/*',
    'wildcard': False
  },
  {
    'scheme': '',
    'netloc': 'example.com',
    'path': '/path/*',
    'wildcard': True
  }
]

So for example, if you wanted to retrieve a list of in-scope items, and only include those which were wildcards, only grab the domain, and ensure they are unique, you could do something like this:

scope = s1.getScope(codename)[0]
current_set = set()
for s in scope:
     wildcard = s['wildcard']
     if wildcard == True:
         host = s['netloc']
         if host not in current_set:
             current_set.add(host)
target_list = list(current_set)

registerAll()

This method registers all unregistered targets
Thanks Ozgur for most of the leg work :)

getAnalytics(codename, status)

This method takes a codename and status accepted | rejected | in_queue | all and returns a list of all endpoints reported in that target's Analytics tab.

getHydra(codename)

This method takes a codename and returns a json of all hydra reported in that target's Hydra tab.

getRoes(slug):

This method takes a target slug and returns any additional rules of engagement as a list.

getNotificationToken()

This method is used to obtain the bearer token used to authenticate to the notifications.synack.com API.

markNotificationsRead()

This method marks all notifications as read.

pollNotifications()

This method retrieves all unread notifications and returns a list of dicts with the following fields:

{
  "id": INT,                  # ID of the notifications
  "user_id": INT,             # Your synack ID (integer)
  "subject": "STRING",        # Codename, dollar amount of transfer, etc..
  "subject_type": "STRING",   # What is this? listing update, cashout, etc..
  "action": "STRING",         # What is the action: outage_starts, scope, etc..
  "url": "STRING",            # Relevant URL path
  "created_at": "DATETIME",
  "read": BOOL,               # true/false
  "meta": {
                              # All sorts of other stuff
  }
}

getVulns(status="accepted")

This method takes either zero or single parameter (status) and returns a list of all vulns you've submitted. The status parameter could be either

  • accepted (default)
  • rejected

getVuln(identifier)

This method takes a vulnerability identifier, e.g. CODENAME-###, as a parameter and returns a dict with all details of the vulnerability.

getDrafts()

This method returns a list of dictionaries containing data for each draft vulnerability.

deleteDraft(id)

This method takes a draft vulnerability identifier (integer value) as a parameter and deletes the draft vulnerability.

getTransactions()

This method returns all cashout transactions as list.

Docker setup

There are few ways to run the module under docker, the fastest way will be to obtain it directly and run it using
docker run -d --name synackapi --dns 8.8.8.8 --rm -v ~/.synack:/root/.synack krasn/synackapi
The above will run the docker directly under the name synackapi and will use your synack.conf as it's configured per above instructions. The default mode of the docker will be to stay on the background and poll for new targets every hour which will accept.

  • Notes ** If would like to build the docker from scratch instructions are on Dockerfile, you will additionally need to modify synack.conf file and set self.headless = True
  • To simply pull the docker image and do nothing you can always use docker pull krasn/synackapi