/beagle-codeship-script

Beagle codeship integration script

Primary LanguageShell

Beagle Security Plugin for CODESHIP

This plugin can be used to trigger beagle penetration testing from Codeship

Prerequisites

  • Obtain Application Token and User Token from Beagle Dashboard
  • Add the Environment variables "USER_TOKEN" and "APPLICATION_TOKEN" to Codeship.

Generate your User Token From Beagle User Settings:

Settings -> Access token -> Generate your new personal access token

Generate user token

Generate your Application Token From Beagle

Home -> Applications -> Select your application -> Settings -> Application token

Get application token

What is Beagle?

Beagle is an intelligent and holistic platform to make your applications hack-proof. The platform provides continuous and automated Penetration Testing (under human supervision) for organizations, so that they can always stay on top of the cyber threats.

In short, Beagle finds out how deep your system can be penetrated. Know it before the hackers do!

Deployment

Following steps will help you to configure beagle penetration testing in your project

Creating Environment Variables

In-order to trigger beagle penetration testing you need to create two environment variables.

  1. Login to CODESHIP
  2. Select your project
  3. Go to project settings Project Settings
  4. Navigate to Environment Environment
  5. Add tokens, make sure you use environment variable names as follows:
    • For user token -> user_token
    • For application token -> application_token
    • Final View Step 3
    • Save Configuration

Setup Deployment Script

In-order to trigger beagle penetration testing you need to setup deploy script.

  1. Go to project settings Project Settings

  2. Navigate to Deploy

  3. Select your branch to deploy Deploy Home

  4. After selecting branch scroll down to Add Deployment and select Script Add Deployment

  5. Add the following snippet to Deployment Commands

    curl --silent -L https://git.io/fjXpj | bash -s
    

    Set Custom Command

    • click on Create Deployment
  6. Build the project!

Authors

  • Beagle Security

License

This project is licensed under the MIT License - see the LICENSE.md file for details