RubyGems - gophish-ruby - Versions diffs - 0.1.0 → 0.3.0 - Mend

gophish-ruby 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

data/docs/GETTING_STARTED.md CHANGED Viewed

@@ -84,6 +84,72 @@ else
 end
 ```
+### 4. Create Your First Template
+Templates define the email content for your phishing campaigns:
+```ruby
+# Create a basic email template
+template = Gophish::Template.new(
+  name: "Security Awareness Test",
+  subject: "Important Security Update Required",
+  html: "<h1>Security Update</h1><p>Please click <a href='{{.URL}}'>here</a> to update your password.</p>",
+  text: "Security Update\n\nPlease visit {{.URL}} to update your password."
+)
+if template.save
+  puts "✓ Template created successfully with ID: #{template.id}"
+else
+  puts "✗ Failed to create template:"
+  template.errors.full_messages.each { |error| puts "  - #{error}" }
+end
+```
+### 5. Create Your First Landing Page
+Landing pages are what users see when they click phishing links:
+```ruby
+# Create a basic landing page
+page = Gophish::Page.new(
+  name: "Microsoft Login Page",
+  html: <<~HTML
+    <!DOCTYPE html>
+    <html>
+    <head>
+      <title>Microsoft Account</title>
+      <style>
+        body { font-family: Arial, sans-serif; margin: 40px; background: #f5f5f5; }
+        .container { max-width: 400px; margin: 0 auto; background: white; padding: 40px; border-radius: 8px; }
+        input { width: 100%; padding: 12px; margin: 10px 0; border: 1px solid #ccc; border-radius: 4px; }
+        button { width: 100%; padding: 12px; background: #0078d4; color: white; border: none; border-radius: 4px; }
+      </style>
+    </head>
+    <body>
+      <div class="container">
+        <h2>Sign in to your account</h2>
+        <form method="post">
+          <input type="email" name="username" placeholder="Email" required>
+          <input type="password" name="password" placeholder="Password" required>
+          <button type="submit">Sign in</button>
+        </form>
+      </div>
+    </body>
+    </html>
+  HTML,
+  capture_credentials: true,
+  redirect_url: "https://www.microsoft.com"
+)
+if page.save
+  puts "✓ Landing page created successfully with ID: #{page.id}"
+  puts "  Captures credentials: #{page.captures_credentials?}"
+else
+  puts "✗ Failed to create page:"
+  page.errors.full_messages.each { |error| puts "  - #{error}" }
+end
+```
 ## Common Workflows
 ### Importing Targets from CSV
@@ -125,6 +191,179 @@ else
 end
 ```
+### Working with Templates
+#### Creating Templates with Attachments
+```ruby
+# Create template with file attachments
+template = Gophish::Template.new(
+  name: "Invoice Template",
+  subject: "Your Invoice #{{.RId}}",
+  html: "<p>Dear {{.FirstName}},</p><p>Please find your invoice attached.</p>"
+)
+# Add PDF attachment
+pdf_content = File.read("sample_invoice.pdf")
+template.add_attachment(pdf_content, "application/pdf", "invoice.pdf")
+# Check attachments
+puts "Template has #{template.attachment_count} attachments" if template.has_attachments?
+template.save
+```
+#### Importing Email Templates
+```ruby
+# Import an existing email (.eml file)
+email_content = File.read("phishing_template.eml")
+imported_data = Gophish::Template.import_email(
+  email_content,
+  convert_links: true  # Convert links for Gophish tracking
+)
+template = Gophish::Template.new(imported_data)
+template.name = "Imported Email Template"
+template.save
+puts "Imported template: #{template.name}"
+```
+#### Managing Existing Templates
+```ruby
+# List all templates
+puts "Existing templates:"
+Gophish::Template.all.each do |template|
+  attachment_info = template.has_attachments? ? " (#{template.attachment_count} attachments)" : ""
+  puts "  #{template.id}: #{template.name}#{attachment_info}"
+end
+# Update a template
+template = Gophish::Template.find(1)
+template.subject = "Updated Subject Line"
+template.html = "<h1>Updated Content</h1><p>New message content here.</p>"
+# Add or remove attachments
+template.add_attachment(File.read("new_file.pdf"), "application/pdf", "new_file.pdf")
+template.remove_attachment("old_file.pdf")
+template.save
+```
+### Working with Landing Pages
+#### Creating Pages with Different Features
+```ruby
+# Simple page without credential capture
+basic_page = Gophish::Page.new(
+  name: "Generic Landing Page",
+  html: "<html><body><h1>Thank you!</h1><p>Your action has been completed.</p></body></html>"
+)
+# Page with credential capture and redirect
+login_page = Gophish::Page.new(
+  name: "Banking Login Clone",
+  html: <<~HTML
+    <html>
+    <head>
+      <title>Secure Banking</title>
+      <style>
+        body { font-family: Arial, sans-serif; background: #003366; color: white; padding: 50px; }
+        .form-container { max-width: 350px; margin: 0 auto; background: white; color: black; padding: 30px; border-radius: 8px; }
+        input { width: 100%; padding: 10px; margin: 10px 0; border: 1px solid #ddd; }
+        button { width: 100%; padding: 12px; background: #003366; color: white; border: none; cursor: pointer; }
+      </style>
+    </head>
+    <body>
+      <div class="form-container">
+        <h2>Online Banking Login</h2>
+        <form method="post">
+          <input type="text" name="username" placeholder="Username" required>
+          <input type="password" name="password" placeholder="Password" required>
+          <button type="submit">Login</button>
+        </form>
+      </div>
+    </body>
+    </html>
+  HTML,
+  capture_credentials: true,
+  capture_passwords: true,
+  redirect_url: "https://www.realbank.com/login"
+)
+# Save both pages
+[basic_page, login_page].each do |page|
+  if page.save
+    puts "✓ Created page: #{page.name} (ID: #{page.id})"
+    puts "  Captures credentials: #{page.captures_credentials?}"
+  end
+end
+```
+#### Importing Pages from Existing Websites
+```ruby
+# Import a real website as a landing page template
+begin
+  imported_data = Gophish::Page.import_site(
+    "https://login.live.com",
+    include_resources: true  # Include CSS, JS, and images
+  )
+  page = Gophish::Page.new(imported_data)
+  page.name = "Microsoft Live Login Clone"
+  page.capture_credentials = true
+  if page.save
+    puts "✓ Successfully imported website as landing page"
+    puts "  Page ID: #{page.id}"
+    puts "  HTML size: #{page.html.length} characters"
+  end
+rescue StandardError => e
+  puts "✗ Failed to import website: #{e.message}"
+  puts "  Falling back to manual page creation"
+  # Create a manual fallback page
+  fallback_page = Gophish::Page.new(
+    name: "Manual Microsoft Login Clone",
+    html: "<html><body><h1>Microsoft</h1><form method='post'><input name='email' type='email' placeholder='Email'><input name='password' type='password' placeholder='Password'><button type='submit'>Sign in</button></form></body></html>",
+    capture_credentials: true
+  )
+  fallback_page.save
+end
+```
+#### Managing Existing Pages
+```ruby
+# List all pages
+puts "Existing pages:"
+Gophish::Page.all.each do |page|
+  credential_info = page.captures_credentials? ? " [Captures Credentials]" : ""
+  redirect_info = page.has_redirect? ? " → #{page.redirect_url}" : ""
+  puts "  #{page.id}: #{page.name}#{credential_info}#{redirect_info}"
+end
+# Update a page
+page = Gophish::Page.find(1)
+page.name = "Updated Page Name"
+page.capture_credentials = true
+page.redirect_url = "https://example.com/success"
+# Modify the HTML content
+page.html = page.html.gsub("Sign in", "Login")
+if page.save
+  puts "✓ Page updated successfully"
+  puts "  Now captures credentials: #{page.captures_credentials?}"
+end
+```
 ### Managing Existing Groups
 ```ruby

data/lib/gophish/base.rb CHANGED Viewed

@@ -13,12 +13,13 @@ module Gophish
     include ActiveModel::Model
     include ActiveModel::Attributes
     include ActiveModel::Validations
+    include ActiveModel::Dirty
     include ActiveRecord::Callbacks
     def initialize(attributes = {})
       @persisted = false
-      @changed_attributes = {}
       super(attributes)
+      clear_changes_information
     end
     def self.configuration
@@ -125,7 +126,7 @@ module Gophish
         send "#{key}=", value if respond_to? "#{key}="
       end
       @persisted = true
-      @changed_attributes.clear
+      clear_changes_information
     end
     def handle_error_response(response)
@@ -145,9 +146,9 @@ module Gophish
     def update_record
       return false if id.nil?
-      return true if @changed_attributes.empty?
+      return true unless changed?
-      response = self.class.put "#{self.class.resource_path}/#{id}/", request_options(body_for_update)
+      response = self.class.put "#{self.class.resource_path}/#{id}", request_options(body_for_update)
       return handle_error_response response unless response.success?
       update_attributes_from_response response.parsed_response
@@ -177,29 +178,10 @@ module Gophish
     end
     def body_for_update
-      body_for_create
-    end
-    def attribute_changed?(attribute)
-      @changed_attributes.key? attribute.to_s
-    end
-    def changed_attributes
-      @changed_attributes.keys
-    end
-    def attribute_was(attribute)
-      @changed_attributes[attribute.to_s]
+      body_for_create.merge id:
     end
     def []=(attribute, value)
-      attribute_str = attribute.to_s
-      current_value = send attribute if respond_to? attribute
-      unless current_value == value
-        @changed_attributes[attribute_str] = current_value
-      end
       send "#{attribute}=", value if respond_to? "#{attribute}="
     end
   end

data/lib/gophish/group.rb CHANGED Viewed

@@ -9,6 +9,8 @@ module Gophish
     attribute :modified_date, :string
     attribute :targets
+    define_attribute_methods :id, :name, :modified_date, :targets
     validates :name, presence: true
     validates :targets, presence: true
     validate :validate_targets_structure

data/lib/gophish/page.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require_relative 'base'
+require 'active_support/core_ext/object/blank'
+module Gophish
+  class Page < Base
+    attribute :id, :integer
+    attribute :name, :string
+    attribute :html, :string
+    attribute :capture_credentials, :boolean, default: false
+    attribute :capture_passwords, :boolean, default: false
+    attribute :modified_date, :string
+    attribute :redirect_url, :string
+    define_attribute_methods :id, :name, :html, :capture_credentials, :capture_passwords, :modified_date, :redirect_url
+    validates :name, presence: true
+    validates :html, presence: true
+    def body_for_create
+      {
+        name:,
+        html:,
+        capture_credentials:,
+        capture_passwords:,
+        redirect_url:
+      }
+    end
+    def self.import_site(url, include_resources: false)
+      options = build_import_options url, include_resources
+      response = post '/import/site', options
+      raise StandardError, 'Failed to import site' unless response.success?
+      response.parsed_response
+    end
+    def self.build_import_options(url, include_resources)
+      {
+        body: { url:, include_resources: }.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+    end
+    def captures_credentials?
+      capture_credentials == true
+    end
+    def captures_passwords?
+      capture_passwords == true
+    end
+    def has_redirect?
+      !redirect_url.blank?
+    end
+  end
+end

data/lib/gophish/template.rb ADDED Viewed

@@ -0,0 +1,94 @@
+require_relative 'base'
+require 'active_support/core_ext/object/blank'
+require 'base64'
+module Gophish
+  class Template < Base
+    attribute :id, :integer
+    attribute :name, :string
+    attribute :subject, :string
+    attribute :text, :string
+    attribute :html, :string
+    attribute :modified_date, :string
+    attribute :attachments, default: -> { [] }
+    define_attribute_methods :id, :name, :subject, :text, :html, :modified_date, :attachments
+    validates :name, presence: true
+    validate :validate_content_presence
+    validate :validate_attachments_structure
+    def body_for_create
+      { name:, subject:, text:, html:, attachments: }
+    end
+    def self.import_email(content, convert_links: false)
+      options = build_import_options content, convert_links
+      response = post '/import/email', options
+      raise StandardError, 'Failed to import email' unless response.success?
+      response.parsed_response
+    end
+    def self.build_import_options(content, convert_links)
+      {
+        body: { content:, convert_links: }.to_json,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+    end
+    def add_attachment(content, type, name)
+      encoded_content = encode_content content
+      attachments << { content: encoded_content, type:, name: }
+      attachments_will_change!
+    end
+    def remove_attachment(name)
+      original_size = attachments.size
+      attachments.reject! { |attachment| attachment[:name] == name || attachment['name'] == name }
+      attachments_will_change! if attachments.size != original_size
+    end
+    def has_attachments?
+      !attachments.empty?
+    end
+    def attachment_count
+      attachments.length
+    end
+    private
+    def encode_content(content)
+      content.is_a?(String) ? Base64.strict_encode64(content) : content
+    end
+    def validate_content_presence
+      return unless text.blank? && html.blank?
+      errors.add :base, 'Need to specify at least plaintext or HTML content'
+    end
+    def validate_attachments_structure
+      return if attachments.blank?
+      return errors.add :attachments, 'must be an array' unless attachments.is_a? Array
+      attachments.each_with_index { |attachment, index| validate_attachment attachment, index }
+    end
+    def validate_attachment(attachment, index)
+      return errors.add :attachments, "item at index #{index} must be a hash" unless attachment.is_a? Hash
+      validate_attachment_field attachment, index, :content
+      validate_attachment_field attachment, index, :type
+      validate_attachment_field attachment, index, :name
+    end
+    def validate_attachment_field(attachment, index, field)
+      value = attachment[field] || attachment[field.to_s]
+      return unless value.blank?
+      errors.add :attachments, "item at index #{index} must have a #{field}"
+    end
+  end
+end

data/lib/gophish/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Gophish
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/gophish-ruby.rb CHANGED Viewed

@@ -1,7 +1,8 @@
 require_relative 'gophish/version'
 require_relative 'gophish/configuration'
-require_relative 'gophish/base'
 require_relative 'gophish/group'
+require_relative 'gophish/template'
+require_relative 'gophish/page'
 module Gophish
   class << self

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gophish-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eli Sebastian Herrera Aguilar
@@ -105,6 +105,8 @@ files:
 - lib/gophish/base.rb
 - lib/gophish/configuration.rb
 - lib/gophish/group.rb
+- lib/gophish/page.rb
+- lib/gophish/template.rb
 - lib/gophish/version.rb
 - sig/gophish/ruby.rbs
 homepage: https://github.com/EliSebastian/gopish-ruby