RubyGems - gophish-ruby - Versions diffs - 0.2.0 → 0.4.0 - Mend

gophish-ruby 0.2.0 → 0.4.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 (12) hide show

data/docs/GETTING_STARTED.md CHANGED Viewed

@@ -105,6 +105,51 @@ else
 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
@@ -208,6 +253,117 @@ 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/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/smtp.rb ADDED Viewed

@@ -0,0 +1,99 @@
+require_relative 'base'
+require 'active_support/core_ext/object/blank'
+module Gophish
+  class Smtp < Base
+    def self.resource_path
+      '/smtp'
+    end
+    attribute :id, :integer
+    attribute :name, :string
+    attribute :username, :string
+    attribute :password, :string
+    attribute :host, :string
+    attribute :interface_type, :string, default: 'SMTP'
+    attribute :from_address, :string
+    attribute :ignore_cert_errors, :boolean, default: false
+    attribute :modified_date, :string
+    attribute :headers, default: -> { [] }
+    define_attribute_methods :id, :name, :username, :password, :host, :interface_type, :from_address,
+                             :ignore_cert_errors, :modified_date, :headers
+    validates :name, presence: true
+    validates :host, presence: true
+    validates :from_address, presence: true
+    validate :validate_from_address_format
+    validate :validate_headers_structure
+    def body_for_create
+      {
+        name:, username:, password:, host:,
+        interface_type:,
+        from_address:,
+        ignore_cert_errors:,
+        headers:
+      }
+    end
+    def add_header(key, value)
+      headers << { key:, value: }
+      headers_will_change!
+    end
+    def remove_header(key)
+      original_size = headers.size
+      headers.reject! { |header| header[:key] == key || header['key'] == key }
+      headers_will_change! if headers.size != original_size
+    end
+    def has_headers?
+      !headers.empty?
+    end
+    def header_count
+      headers.length
+    end
+    def has_authentication?
+      !username.blank? && !password.blank?
+    end
+    def ignores_cert_errors?
+      ignore_cert_errors == true
+    end
+    private
+    def validate_from_address_format
+      return if from_address.blank?
+      email_regex = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i
+      unless from_address.match? email_regex
+        errors.add :from_address, 'must be a valid email format (email@domain.com)'
+      end
+    end
+    def validate_headers_structure
+      return if headers.blank?
+      return errors.add :headers, 'must be an array' unless headers.is_a? Array
+      headers.each_with_index { |header, index| validate_header header, index }
+    end
+    def validate_header(header, index)
+      return errors.add :headers, "item at index #{index} must be a hash" unless header.is_a? Hash
+      validate_header_field header, index, :key
+      validate_header_field header, index, :value
+    end
+    def validate_header_field(header, index, field)
+      value = header[field] || header[field.to_s]
+      return unless value.blank?
+      errors.add :headers, "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.2.0'
+  VERSION = '0.4.0'
 end

data/lib/gophish-ruby.rb CHANGED Viewed

@@ -2,6 +2,8 @@ require_relative 'gophish/version'
 require_relative 'gophish/configuration'
 require_relative 'gophish/group'
 require_relative 'gophish/template'
+require_relative 'gophish/page'
+require_relative 'gophish/smtp'
 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.2.0
+  version: 0.4.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/smtp.rb
 - lib/gophish/template.rb
 - lib/gophish/version.rb
 - sig/gophish/ruby.rbs