SUP-1602 Snyk task API migration from deprecated version to REST API version #549
Conversation
Snyk Api base url updated
Update rexml gem to address CVE-2024-35176
to avoid issue on the autocheck
testing 2
testing2
going back
| @token = token | ||
| @api_base_url = "https://#{api_base_url}/v1" |
There was a problem hiding this comment.
having api_base_url being just the base in snyk_v2_task and referring to the whole constructed url in snyk_v2_client is confusing and makes the code harder to read, can we change this to be @host or just @api_url ?
tasks/connectors/snyk_v2/readme.md
Outdated
| @@ -36,4 +37,5 @@ Complete list of Options: | |||
| | kenna_connector_id | false | If set, we'll try to upload to this connector | n/a | | |||
| | kenna_api_key | false | Kenna API Key | n/a | | |||
| | kenna_api_host | false | Kenna API Hostname | api.kennasecurity.com | | |||
| | Snyk_api_url | true | Snyk environment API base URL without prefix e.g. api.eu.snyk.io, api.snyk.io or api.au.snyk.io | n/a | | |||
There was a problem hiding this comment.
- parameter name in snyk_v2_task.rb is snyk_api_base
- parameters are case sensitive when running the toolkit image so we should use all lowercase in readme file to match our definitions
There was a problem hiding this comment.
Task updated with change, thanks!
Version previous to pagination with rest
Lint code update
There was a problem hiding this comment.
Can we try changing
{ name: "snyk_api_base",
type: "string",
required: true,
default: nil,
description: "Snyk environment API base URL without prefix e.g. api.eu.snyk.io or api.snyk.io or api.au.snyk.io" }
to be optional and default to the US otherwise? I think ought to clear up the test failure.
to address issues with the autochecks
updating task to avoid possible duplicated values
|
Am getting this connector error when adding the data to the clients subscription. Exception occurred: NoMethodError - undefined method |
|
@slblack Please try with the new version I sent you. |
Snyk Api base url updated
Problem
Due to changes in Snyk's API, customers now need to specify their API environment. Previously, we used the static URL:
HOST = "https://snyk.io"Solution
We should request that customers provide their unique API_BASE_URL as a parameter during task execution. The API_BASE_URL should be one of the following valid values:
snyk_api_base:{
api.snyk.io
api.eu.snyk.io
api.au.snyk.io}
This base URL should be entered without the protocol (https://) and rest parts, as these will be appended automatically in the code. The complete URL will follow this format:
https://#{snyk_api_base}/restThe task was updated to map the new schema showed in API documentation https://apidocs.snyk.io/?version=2024-04-29
Example of the task execution
docker run -it --rm -v ~/Desktop/toolkit_input:/opt/app/toolkit/input -v ~/Desktop/toolkit_output:/opt/app/toolkit/output -t kennasecurity/toolkit:latest task=snyk_v2 snyk_api_token=XXXXXXXXXXXXXXXXX snyk_api_base=api.eu.snyk.ioOutput file:
Vulns uploaded to CVM
