GithubHelp home page GithubHelp logo

tacklebox's Introduction

Code Climate Test Coverage Build Status

tacklebox

Description

A phishing toolkit for generating and sending phishing emails.

Features

  • Provides a Liquid + Markdown email template system.
  • Provides built-in liquid tags for customized emails:
    • {TackleBox::Email::Template::Tags::Attachment attachment}
    • {TackleBox::Email::Template::Tags::Date date}
    • {TackleBox::Email::Template::Tags::Day day}
    • {TackleBox::Email::Template::Tags::Link link}
    • {TackleBox::Email::Template::Tags::RandomDate random_date}
    • {TackleBox::Email::Template::Tags::RandomDay random_day}
    • {TackleBox::Email::Template::Tags::RandomGreeting random_greeting}
    • {TackleBox::Email::Template::Tags::RandomWeekDay random_week_day}
    • {TackleBox::Email::Template::Tags::WeekDay week_day}
    • {TackleBox::Email::Template::Tags::Year year}
  • Renders dynamic emails based on the recipient.
  • Supports targeting specific sub-groups of people within an organization.
  • Supports embedding links and/or attachments into emails.
  • Supports custom 1x1 tracking pixel URLs.

API

  • {TackleBox::Attachment}
  • {TackleBox::Link}
  • {TackleBox::Person}
  • {TackleBox::Organization}
  • {TackleBox::Campaign}
    • {TackleBox::Campaign#initialize}
    • {TackleBox::Campaign#each_email}

Examples

require 'tackle_box'

email_template = TackleBox::Email::Template.open('nude_pics.eml')

org = TackleBox::Organization.new(
  'Trail of Bits, Inc.',

  domain:   'trailofbits.com',
  website:  'http://www.trailofbits.com/',
  industry: 'Technology'
)
org.person('[email protected]', name:       'Dan Guido',
                                  title:      'CEO',
                                  department: 'Management',
                                  location:   'New York, NY')

campaign = TackleBox::Campaign.new(
  email_template, org,

  link: 'http://www.imdurr.com/gallery/x5ae18.png',
  tracking_pixel: 'http://www.imdurr.com/pixel.gif',
  account: TackleBox::Person.new(
    '[email protected]',
    name:  'Nick Depetrillo',
    title: 'CTO'
  )
)

sender = TackleBox::Email::Sender.new(
  'trailofberts.com' => {
    address:              'mail.yelpfortoilets.com',
    port:                 587,
    user_name:            'nick.d',
    password:             'test1234',
    authentication:       :plain,
    enable_starttls_auto: true
  }
)

campaign.each_email do |email|
  puts ">>> Sending email to #{email.to}"
  puts email

  sender.send(email)
end

Example Email Template

Date: Tue, 01 Jul 2014 14:21:08 -0700
Message-ID: <[email protected]>
Subject: Nude pics!
Mime-Version: 1.0
Content-Type: text/html;
 charset=ISO-8895-1
Content-Transfer-Encoding: 7bit

<html>
  <head>
    <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
    <title>test email</title>
  </head>
  <body text="#000000" bgcolor="#FFFFFF">
    Yo {{ to.name }}, checkout these <a href="{% link %}">nudes</a>
    of Brian Krebs!
  </body>
</html>

Requirements

Install

$ bundle install

Testing

$ rake spec

Documentation

$ rake yard
$ open ./doc/index.html

Copyright

Copyright (c) 2014 Trail of Bits, Inc.

tacklebox's People

Contributors

dguido avatar isarcasm avatar postmodern avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

tacklebox's Issues

Add CodeClimate test coverage tracking

Add the codeclimate-test-reporter gem to your Gemfile:

gem "codeclimate-test-reporter", group: :test, require: nil

Start the test reporter on the very first line of spec_helper.rb or test_helper.rb:

require "codeclimate-test-reporter"
CodeClimate::TestReporter.start

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.