Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Hackuity integration: API key auth, Hackuity.Findings.Status.LastClosedAt #26558

Conversation

Rogdham
Copy link
Contributor

@Rogdham Rogdham commented May 16, 2023

Status

  • Ready

Description

This PR makes the following changes:

  1. Authentication is done by API key instead of user+password. This simplifies the code quite a lot. This is a breaking change.
  2. New data is added in output: Hackuity.Findings.Status.LastClosedAt
  3. Update logo

Minimum version of Cortex XSOAR

  • 6.0.0

Does it break backward compatibility?

  • Yes
    • Further details: Authentication was previously done with user+password, now through an API key. Some details

Must have

  • Tests
  • Documentation

@content-bot content-bot added the Contribution Thank you! Contributions are always welcome! label May 16, 2023
@content-bot content-bot changed the base branch from master to contrib/Rogdham_Hackuity_api_token_auth May 16, 2023 09:31
@content-bot content-bot requested a review from thefrieddan1 May 16, 2023 09:32
@content-bot
Copy link
Collaborator

Thank you for your contribution. Your generosity and caring are unrivaled! Make sure to register your contribution by filling the Contribution Registration form, so our content wizard @thefrieddan1 will know the proposed changes are ready to be reviewed.

@content-bot content-bot added Contribution Form Filled Whether contribution form filled or not. Partner labels May 16, 2023
@Rogdham Rogdham force-pushed the Hackuity_api_token_auth branch from 48d5fe9 to e90e922 Compare May 16, 2023 09:59
@Rogdham
Copy link
Contributor Author

Rogdham commented May 16, 2023

Summary of the checks in error below.

This PR is now ready to review!


The docker image tag is not the latest numeric tag, please update it.

I did not change it since it was been reverted in #26405

[IN129] - You've removed integration parameters, the removed parameters are '{'login'}'

This has been documented as a breaking change.

[IN116] - You've added required, the field is 'apikey'

This has been documented as a breaking change.

@Rogdham Rogdham marked this pull request as ready for review May 16, 2023 11:20
@Rogdham Rogdham force-pushed the Hackuity_api_token_auth branch from e90e922 to 42aa714 Compare May 16, 2023 16:37
Copy link
Contributor

@thefrieddan1 thefrieddan1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Rogdham,
thank you for your contribution we appreciate your effort, I reviewed the content in the PR and would like to provide some feedback:
Because the changes you introduce here are breaking changes I would recommend 2 possible options :

  1. Make the login and password hidden in the yaml file. ( do not remove them )
    And keep the apikey changes with slight modifications. ( example for hidden apikey:
    https://github.com/demisto/content/blob/master/Packs/AbuseDB/Integrations/AbuseDB/AbuseDB.yml
  2. Or keep the breaking changes and add a note to the README file. Basically adding the breakingChangesNotes part from the json in the README as well. example :
    https://github.com/demisto/content/blob/master/Packs/MicrosoftGraphSecurity/ReleaseNotes/2_1_21.md

The advantage of option 1 is that it does not break compatibility to users already using the integration. New users configuring the integration will not see the hidden user and password since its hidden and will configure it with the new apikey.

The advantage of option 2 is that its easier to add a note in the README.
But it might make existing users of the integration dealing the the breaking change.
So its up to you to decide how to proceed from here.

@thefrieddan1 thefrieddan1 added pending-contributor The PR is pending the response of its creator docs-approved labels May 21, 2023
@Rogdham Rogdham force-pushed the Hackuity_api_token_auth branch from 01894c2 to e0cbeb1 Compare May 22, 2023 06:36
@Rogdham
Copy link
Contributor Author

Rogdham commented May 22, 2023

Hello @thefrieddan1 and thank you for your review!

We have chosen option 2, tell me if the wording change in the release notes looks better to you!

@thefrieddan1 thefrieddan1 added pending-demo Demo pending post-demo ready-for-instance-test In contribution PRs, this label will cause a trigger of a build with a modified pack from the PR. and removed pending-contributor The PR is pending the response of its creator pending-demo Demo pending labels May 22, 2023
Copy link
Contributor

@thefrieddan1 thefrieddan1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thefrieddan1 thefrieddan1 merged commit 30551d8 into demisto:contrib/Rogdham_Hackuity_api_token_auth May 24, 2023
@Rogdham Rogdham deleted the Hackuity_api_token_auth branch May 24, 2023 10:10
@content-bot
Copy link
Collaborator

For the Reviewer: Successfully created a pipeline in Gitlab with url: https://code.pan.run/xsoar/content/-/pipelines/5354508

thefrieddan1 added a commit that referenced this pull request May 30, 2023
* Update Hackuity integration: API key auth, Hackuity.Findings.Status.LastClosedAt (#26558)

* Hackuity: API key auth, status last closed at

* Update docker image.

---------

Co-authored-by: Danny_Fried <[email protected]>

* Bump version

* align RN 1_0_7 with master

* Deprecate login password and support api key

* Add default value to deprecated fields.
Update README

* Take api key from hiddenuser name field.

* Remove redundant method.

* Remove redundant line.
Make api key required.

* Change display password.

* Update Packs/Hackuity/Integrations/Hackuity/README.md

Co-authored-by: Rogdham <[email protected]>

* Remove new line in end of file in RN

---------

Co-authored-by: Rogdham <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contribution Form Filled Whether contribution form filled or not. Contribution Thank you! Contributions are always welcome! docs-approved Partner post-demo ready-for-instance-test In contribution PRs, this label will cause a trigger of a build with a modified pack from the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants