commonfields: id: Gophish version: -1 name: Gophish display: Gophish category: Deception & Breach Simulation provider: Open Source description: Gophish is a powerful, open-source phishing framework that makes it easy to test your organization's exposure to phishing. For Free. configuration: - display: Server URL (e.g. https://fqdnofyourserver:3333) name: url type: 0 required: true - display: API Key name: apikey type: 4 required: true additionalinfo: input the API key - display: Trust any certificate (not secure) name: insecure type: 8 required: false - display: Use system proxy settings name: proxy type: 8 required: false script: script: '' type: python commands: - name: gophish-get-users arguments: [] outputs: - contextPath: Gophish.Users description: All users details. type: String description: Gets all users from gophish - name: gophish-get-user arguments: - name: id required: true description: ID of the user as an integer. outputs: - contextPath: Gophish.User description: User details. type: string description: Get single user details from gophish - name: gophish-create-user arguments: - name: role required: true auto: PREDEFINED predefined: - admin - user description: Role of the user to be created. - name: username required: true description: Username for the new user. - name: password required: true description: Password for the new user. outputs: - contextPath: Gophish.NewUser description: New user details that was created. type: String description: Creates a new user - name: gophish-modify-user arguments: - name: id required: true description: The user ID. - name: role auto: PREDEFINED predefined: - user - admin description: The role slug to use for the account. - name: password description: The password to set for the account. - name: username required: true description: The username for the account. outputs: - contextPath: Gophish.ModifiedUser description: Modified user details. type: String description: Modifies a user account. This can be used to change the role, reset the password, or change the username. - name: gophish-delete-user arguments: - name: id required: true description: The user ID. outputs: - contextPath: Gophish.DeletedUser description: Info about the deleted user. type: string description: Deletes a user, as well as every object (landing page, template, etc.) and campaign they've created. - name: gophish-get-all-sending-profiles arguments: [] outputs: - contextPath: Gophish.AllSendingProfiles description: Sending profiles information. type: String description: Gets a list of the sending profiles created by the authenticated user. - name: gophish-get-sending-profile arguments: - name: id required: true description: The sending profile ID to return. outputs: - contextPath: Gophish.SendingProfile description: info about the sending profile. type: String description: Returns a sending profile given an ID, returning a 404 error if no sending profile with the provided ID is found. - name: gophish-create-sending-profile arguments: - name: name required: true description: Profile name. - name: from_address required: true description: From Address to use (John Doe ). - name: host required: true description: Host and port of the SMTP sender (smtp.example.com:25). - name: username required: true description: Username to use. - name: password required: true description: Password to use. - name: ignore_cert_errors required: true auto: PREDEFINED predefined: - "True" - "False" description: Ignore untrusted certificates. - name: headers description: Custom headers for the sending profile in format key1:value1,key2:value2 etc. isArray: true outputs: - contextPath: Gophish.CreatedSendingProfile description: Info about the newly created Sendin Profile. type: String description: Creates a sending profile. - name: gophish-delete-sending-profile arguments: - name: id required: true description: ID of the profile to be deleted. outputs: - contextPath: Gophish.DeletedSendingProfile description: This method returns a status message indicating the sending profile was deleted successfully. type: String description: Deletes a sending profile by ID. - name: gophish-get-all-landing-pages arguments: [] outputs: - contextPath: Gophish.AllLandingPages description: Returns a list of landing pages. type: String description: Returns a list of landing pages. - name: gophish-create-landing-page arguments: - name: name required: true description: Name of the page. - name: html required: true description: HTML of the page. - name: capture_credentials required: true auto: PREDEFINED predefined: - "True" - "False" description: Capturing credentials is a powerful feature of Gophish. By setting certain flags, you have the ability to capture all user input, or just non-password input. - name: capture_passwords required: true auto: PREDEFINED predefined: - "True" - "False" description: If you want to capture passwords as well, set the capture_passwords attribute. - name: redirect_url required: true description: Gophish also provides the ability to redirect users to a URL after they submit credentials. This is controlled by setting the redirect_url attribute. outputs: - contextPath: Gophish.CreatedLandingPage description: info about the created page. type: String description: Creates a landing page. - name: gophish-delete-landing-page arguments: - name: id required: true description: ID of the page to be deleted. outputs: - contextPath: Gophish.DeletedLandingPage description: Deletes a landing page. type: String description: Deletes a landing page. - name: gophish-import-site-as-landing-page arguments: - name: url required: true description: The URL to fetch (include http or https://). - name: include_resources default: true auto: PREDEFINED predefined: - "True" - "False" description: 'Whether or not to create a tag in the resulting HTML to resolve static references (recommended: false).' defaultValue: "False" outputs: - contextPath: Gophish.ImportedSite description: This API endpoint doesn't actually create a new landing page. Instead, you can use the HTML returned from this endpoint as an input to the Create Landing Page method. type: String description: Fetches a URL to be later imported as a landing page - name: gophish-get-all-templates arguments: [] outputs: - contextPath: Gophish.AllTemplates description: Info about all templates. type: String description: Returns a list of templates. - name: gophish-get-template arguments: - name: id required: true description: The template ID. outputs: - contextPath: Gophish.Template description: Returns a template with the provided ID. type: String description: 'Returns a template with the provided ID.Returns a 404: Not Found error if the specified template doesn''t exist.' - name: gophish-delete-template arguments: - name: id required: true description: The template ID to delete. outputs: - contextPath: Gophish.DeletedTemplate description: Deleted Template. type: String description: Deletes a template by ID. - name: gophish-import-template arguments: - name: convert_links required: true auto: PREDEFINED predefined: - "True" - "False" description: Whether or not to convert the links within the email to automatically. defaultValue: "False" - name: content required: true description: The original email content in RFC 2045 format, including the original headers. outputs: - contextPath: Gophish.ImportedTemplate description: Info about the imported template. type: string description: This method doesn't fully import the email as a template. Instead, it parses the email, returning a response that can be used with the "Create Template" endpoint. - name: gophish-create-template arguments: - name: name required: true description: Name of the template. - name: subject required: true description: 'Subject to use: {{.FirstName}}, please reset your password.' - name: text description: 'Text formatted content: Please reset your password here: {{.URL}}.' - name: html description: 'HTML formatted content: Please reset your password here".' - name: attachmentContent description: attachment is expected to be base64 encoded. isArray: true - name: attachmentType description: Type of the attachment. isArray: true - name: attachmentName description: Name of the attachment. isArray: true outputs: - contextPath: Gophish.CreatedTemplate description: Information about the created template. type: string description: Creates a new template from the provided data - name: gophish-get-all-campaigns arguments: [] outputs: - contextPath: Gophish.AllCampaigns description: List of all campaigns. type: String description: Returns a list of campaigns. - name: gophish-get-campaign-details arguments: - name: id required: true description: The campaign ID. outputs: - contextPath: Gophish.CampaignDetails description: info about the campaign details. type: string description: Returns a campaign given an ID. - name: gophish-get-campaign-results arguments: - name: id required: true description: The campaign ID. outputs: - contextPath: Gophish.CampaignResults description: Results of the campaign. type: String description: Gets the results for a campaign. - name: gophish-get-campaign-summary arguments: - name: id required: true description: The campaign ID. outputs: - contextPath: Gophish.CampaignSummary description: Summary stats of the campaign. type: String description: Returns summary information about a campaign. - name: gophish-delete-campaign arguments: - name: id required: true description: The campaign ID. outputs: - contextPath: Gophish.DeletedCampaign description: The delelted campaign. type: String description: Deletes a campaign by ID - name: gophish-complete-campaign arguments: - name: id required: true description: The campaign ID. outputs: - contextPath: Gophish.CompletedCampaign description: Details about the completed campaign. type: String description: Marks a campaign as complete. - name: gophish-create-campaign arguments: - name: name required: true description: Name of the Campaign. - name: template required: true description: Template to use. - name: url required: true description: URL to use. - name: page required: true description: Landing Page to use. - name: smtp required: true description: Sending profile to use. - name: launch_date required: true description: When to launch the campaign for example (2018-10-08T16:20:00+00:00). - name: send_by_date description: Send all emails by for example (2018-10-10T16:20:00+00:00). - name: groups required: true description: Group names to send to as a list (Group1,group2 etc). outputs: - contextPath: Gophish.CreatedCampaign description: info about the created campaign. type: String description: Creates and launches a new campaign. - name: gophish-get-all-groups arguments: [] outputs: - contextPath: Gophish.AllGroups description: List of all groups. type: String description: Returns a list of groups. - name: gophish-get-group arguments: - name: id required: true description: The group ID. outputs: - contextPath: Gophish.Group description: Info about the group. type: String description: Returns a group with the given ID. - name: gophish-get-all-groups-summary arguments: [] outputs: - contextPath: Gophish.AllGroupsSummary description: Summary data of all groups. type: String description: Returns a summary of each group. - name: gophish-get-group-summary arguments: - name: id required: true description: The group ID. outputs: - contextPath: Gophish.GroupSummary description: Summary data for the group. type: String description: It may be the case that you just want the number of members in a group, not necessarily the full member details. This API endpoint returns a summary for a group. - name: gophish-create-group arguments: - name: name required: true description: name of the group. - name: targets required: true description: 'List of targets format: email,firstname,lastname,position:email,firstname,lastname,position etc.' outputs: - contextPath: Gophish.CreatedGroup description: details about the created group. type: String description: Creates a new group. - name: gophish-delete-group arguments: - name: id required: true description: The group ID. outputs: - contextPath: Gophish.DeletedGroup description: info about the group that was deleted. type: String description: Deletes a group - name: gophish-get-landing-page arguments: - name: id required: true description: id of the page to get. outputs: - contextPath: Gophish.LandingPage description: info about the landing page. type: string description: Gets a landing page info dockerimage: demisto/python3:3.12.8.3296088 runonce: false subtype: python3 tests: - no tests - test in NonCircleTests fromversion: 5.0.0