https://github.com/t94j0/gophish-notifier

Notification webhook for GoPhish
https://github.com/t94j0/gophish-notifier

gophish hacking infosec red-team

Last synced: about 1 month ago
JSON representation

Notification webhook for GoPhish

• Host: GitHub
• URL: https://github.com/t94j0/gophish-notifier
• Owner: t94j0
• License: bsd-3-clause
• Created: 2021-08-13T19:56:16.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-10T08:29:44.000Z (6 months ago)
• Last Synced: 2024-09-11T03:43:45.838Z (3 months ago)
• Topics: gophish, hacking, infosec, red-team
• Language: Go
• Homepage:
• Size: 59.6 KB
• Stars: 51
• Watchers: 5
• Forks: 16
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - t94j0/gophish-notifier - Notification webhook for GoPhish (Go)

README

        
# GoPhish Notifier

GoPhish Notifier notifies red team members when their GoPhish campaign status

has been updated. It supports both Slack and Email notification profiles by

default, but it's very extensible so new notification profiles can be added

easily.

## Installation

### From Source

```bash

git clone https://github.com/t94j0/gophish-webhook-slack

cd gophish-webhook-slack

go build -o phishbot

```

### Ansible

See [ansible-gophish-notifier](https://github.com/t94j0/ansible-gophish-notifier)

## Configuration

The configuration path is `/etc/gophish_notifier/config.yml`. Below is an example config:

```yaml

# Host to listen on. If GoPhish is running on the same host, you can set this to 127.0.0.1

listen_host: 0.0.0.0

# Port to listen on

listen_port: 9999

# Webhook path. The full address will be http://:. Ex: http://127.0.0.1:9999/webhook

webhook_path: /webhook

# Secret for GoPhish authentication

secret: secretpassword123

# Log level. Log levels are panic, fatal, error, warning, info, debug, trace.

log_level: debug

# (Optional) Base URL of GoPhish instance so that Slack notifications can link to campaign

base_url: https://10.0.0.15:3333

# Enables sending profiles. Options are `slack` and `email`. Make sure to configure the required parameters for each profile

profiles:

  - slack

  - email

# Slack Profile

slack:

  # Webhook address. Typically starts with https://hooks.slack.com/services/...

  webhook: ''

  # Username displayed in Slack

  username: PhishBot

  # Channel to post in

  channel: '#testing2'

  # Bot profile picture

  emoji: ':blowfish:'

  # (Optional) Disable email, username, and credentials from being sent to Slack

  disable_credentials: true

# Email Profile

# Email to send from

email:

  sender: [email protected]

  # Password of sender email. Uses plain SMTP authentication

  sender_password: password123

  # Recipient of notifications

  recipient: [email protected]

  # Email host to send to

  host: smtp.gmail.com

  # Email host address

  host_addr: smtp.gmail.com:587

# Ghostwriter Profile

ghostwriter:

  # Ghostwriter graphql endpoint

  graphql_endpoint: 'https://ghostwriter/v1/graphql'

  # Ghostwriter API key

  api_key: 'deadbeef'

  # Oplog ID

  oplog_id: 1

  # (Optional) Disable email, username, and credentials from being sent to ghostwriter

  disable_credentials: true

  # Ignore SSL Self Signed error

  ignore_self_signed_certificate: true

# You can also supply an email template for each notification

email_submitted_credentials_template: |

  Someone submitted credentials!

  Email ID - {{ .ID }}

  Email Address - {{ .Email }}

  IP Address - {{ .Address }}

  User Agent - {{ .UserAgent }}

  Username - {{ .Username }}

  Password - {{ .Password }}

```

Project inspired by [gophish-notifications]

[gophish-notifications]: https://github.com/dunderhay/gophish-notifications