Skip to content

Commit

Permalink
GitBook: [gophish#12] No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
secudna authored and gitbook-bot committed Nov 18, 2022
1 parent 04ef767 commit 53fd0c8
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 50 deletions.
Binary file added .gitbook/assets/image (1) (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .gitbook/assets/image (3).png
Binary file not shown.
1 change: 0 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
* [Email Reporting](documentation/email-reporting.md)
* [Webhooks](documentation/webhooks.md)
* [User Management](documentation/user-management.md)
* [Logging](documentation/logging.md)
* [Building Your First Campaign](building-your-first-campaign/README.md)
* [Introducing the Morning Catch Corporation](building-your-first-campaign/introducing-the-morning-catch-corporation.md)
* [Creating the Sending Profile](building-your-first-campaign/creating-the-sending-profile.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For my campaign, I'll be sending emails from Boyd Jenius, the system administrat

The domain used (here compte-google.com) have not been added to your account, you need to be created it before via the _**Campaigns**_ page on your left menu. (_**Campaigns->New Campaign->URL->"click here" )**_

![](<../.gitbook/assets/image (3).png>)
![](<../.gitbook/assets/image (1).png>)

If you want, you can send a test email to another recipient to ensure emails are relayed correctly.

Expand Down
23 changes: 11 additions & 12 deletions documentation/email-reporting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Email Reporting

Gophish supports the ability for users to report the simulated phishing emails they receive. This is to encourage users to report suspicious to their administrators, potentially catching malicious emails earlier.
Gottaphish supports the ability for users to report the simulated phishing emails they receive. This is to encourage users to report suspicious to their administrators, potentially catching malicious emails earlier.

Right now, we only support this reporting feature on the **server side** of things. While we don't yet have actual email extensions and add ons that can be used to facilitate this reporting, as of v0.9.0 we do support email reporting via IMAP.

Expand All @@ -17,37 +17,36 @@ Reporting suspicious emails can help prevent the impact of a phishing campaign.

## Reporting via IMAP

A common \(and good!\) practice for organizations is to create an email address such as security@example.com and encourage employees to forward any suspicious emails. This is a great way to work towards building a collaborative relationship between the employee and security team.
A common (and good!) practice for organizations is to create an email address such as security@example.com and encourage employees to forward any suspicious emails. This is a great way to work towards building a collaborative relationship between the employee and security team.

As of v0.9.0, Gophish has the ability to check a configured mailbox via IMAP for campaign emails that have been reported. Once a campaign email is found, that result is updated to show that the user reported the email.
Gottaphish has the ability to check a configured mailbox via IMAP for campaign emails that have been reported. Once a campaign email is found, that result is updated to show that the user reported the email.

Each Gophish user has the ability to configure their own IMAP settings. These settings are found under "Account Settings &gt; Reporting Settings".
Each Gottaphish user has the ability to configure their own IMAP settings. These settings are found under "Account Settings > Reporting Settings".

![IMAP Configuration Settings](../.gitbook/assets/screen-shot-2020-01-20-at-11.15.48-am.png)

The most common settings you'll need are the IMAP hostname, port, username, and password. It's commonly the case that you'll want to enable TLS but this is something you should confirm with your email provider.

### Advanced Settings

There is also a number of Advanced Settings that allow you to configure which folder campaign emails will be listed in or how often Gophish should poll for new results. Additionally, you can restrict it to only consider emails that have been reported from an address with your organizations domain name. Finally, Gophish can optionally delete campaign emails after they have been reported.
There is also a number of Advanced Settings that allow you to configure which folder campaign emails will be listed in or how often Gottaphish should poll for new results. Additionally, you can restrict it to only consider emails that have been reported from an address with your organizations domain name. Finally, Gottaphish can optionally delete campaign emails after they have been reported.

![Advanced IMAP Settings](../.gitbook/assets/screen-shot-2020-01-20-at-11.19.46-am.png)

After IMAP settings have been configured, you can either save them or use the "Test Settings" button to confirm that Gophish can establish an IMAP connection.
After IMAP settings have been configured, you can either save them or use the "Test Settings" button to confirm that Gottaphish can establish an IMAP connection.

## How Reporting Works in Gophish
## How Reporting Works in Gottaphish

Every email sent by Gophish contains a link pointing to the [Landing Page](landing-pages.md) configured for the campaign. This URL looks like this:
Every email sent by Gottaphish contains a link pointing to the [Landing Page](landing-pages.md) configured for the campaign. This URL looks like this:

```text
```
http://phish_server/?rid=1234567
```

The `rid` parameter specifies which recipient this link was generated for. To report an email sent by Gophish, an HTTP request needs to be made to:
The `rid` parameter specifies which recipient this link was generated for. To report an email sent by Gottaphish, an HTTP request needs to be made to:

```text
```
http://phish_server/report?rid=1234567
```

Sending this HTTP request is usually handled by a mail client extension. As indicated earlier, we're still working on getting those developed. If you're interested in helping make this happen, please [open an issue on Github!](https://github.com/gophish/gophish/issues)

13 changes: 6 additions & 7 deletions documentation/generating-reports.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Generating Reports

Reporting is an important part of any Gophish campaign. To help facilitate generating reports, there are a few options you could consider:
Reporting is an important part of any Gottaphish campaign. To help facilitate generating reports, there are a few options you could consider:

## Using the Web UI

The Gophish dashboard gives a quick overview showing the results for a particular campaign:
The Gottaphish dashboard gives a quick overview showing the results for a particular campaign:

![](../.gitbook/assets/localhost_3333_campaigns_25-macbook.png)
![](../.gitbook/assets/localhost\_3333\_campaigns\_25-macbook.png)

In addition to providing the results in the dashboard, you have the option to export the raw logs from Gophish using the "Export CSV" button at the top of the page. You could then parse these CSV files using other software such as Excel or Google Sheets.
In addition to providing the results in the dashboard, you have the option to export the raw logs from Gottaphish using the "Export CSV" button at the top of the page. You could then parse these CSV files using other software such as Excel or Google Sheets.

## Using GoReport

Gophish has an incredible community that has built tools around the API to help make reporting easy. A great example of this is called [GoReport](https://github.com/chrismaddalena/GoReport).
Gophish has an incredible community that has built tools around the API to help make reporting easy. A great example of this is called [GoReport](https://github.com/chrismaddalena/GoReport). Gottaphish is compatible with this product as well

[GoReport](https://github.com/chrismaddalena/GoReport), created by Github user [@chrismaddalena](https://github.com/chrismaddalena/), provides a really simple, clean way to generate reports for a given Gophish campaign. You can use this script to generate reports for the campaign in either CSV or DOCX format.
[GoReport](https://github.com/chrismaddalena/GoReport), created by Github user [@chrismaddalena](https://github.com/chrismaddalena/), provides a really simple, clean way to generate reports for a given Gottaphish campaign. You can use this script to generate reports for the campaign in either CSV or DOCX format.

## Leveraging the API

If you are wanting to make custom reports, perhaps for one or more campaigns, we strongly suggest you consider leveraging the extensive [Gophish API](https://docs.getgophish.com/api-documentation/).

We have a [Python API client](https://github.com/gophish/api-client-python) that can help facilitate getting the data you need from the API. You can find the documentation for the Python API client [here](https://docs.getgophish.com/python-api-client/).

28 changes: 0 additions & 28 deletions documentation/logging.md

This file was deleted.

2 changes: 1 addition & 1 deletion documentation/sending-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It's important to make sure that your "From" address is a valid email address fo

The domain used in the email (here compte-google.com) must have been acquired before. To see the acquired domains please go to the page Campaign, click on New Campaign and see the available values in the URL field

![](<../.gitbook/assets/image (1).png>)
![](<../.gitbook/assets/image (1) (2).png>)

To test your SMTP configuration, you can click the "Send Test Email" button:

Expand Down
2 changes: 2 additions & 0 deletions documentation/user-management.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# User Management

In addition to use SSO for your account, you can use some local account

Gottaphish supports user accounts with different roles. Right now, we offer two separate roles that can be assigned to users:

* **User** - This role allows the user to do anything _except_ system-level administrative tasks, such as managing users, managing webhooks, etc.
Expand Down

0 comments on commit 53fd0c8

Please sign in to comment.