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

Adding APIs for synthetics #684

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding APIs for synthetics #684

wants to merge 1 commit into from

Conversation

jguay
Copy link
Contributor

@jguay jguay commented Mar 9, 2024

Adding following API calls from 8.12.0 (we may be able to set a lower minimum version if no sensitive data is returned) :

GET kbn:/internal/uptime/service/locations
GET kbn:/api/synthetics/private_locations
GET kbn:/api/uptime/settings
GET kbn:/internal/synthetics/monitor/filters

Additionally code for this API was added and API is disabled on purpose pending review that API does not include sensitive information :

GET kbn:/internal/synthetics/service/monitors?perPage=100&page=1

Checklist

  • Review from dev required related to inclusion of sensitive data

Adding following API calls from `8.12.0` (we may be able to set a lower minimum version) :
```
GET kbn:/internal/uptime/service/locations
GET kbn:/api/synthetics/private_locations
GET kbn:/api/uptime/settings
GET kbn:/internal/synthetics/monitor/filters
```

Additionally code for this API was added and API is disabled on purpose pending review that API does not include sensitive information :
```
GET kbn:/internal/synthetics/service/monitors?perPage=100&page=1
```
@jguay jguay requested a review from a team as a code owner March 9, 2024 11:45
@jguay
Copy link
Contributor Author

jguay commented Mar 12, 2024

@lucabelluccini Can you ping the synthetics developers related to check for sensitive data in case monitors list is (the only one) unsafe to collect and if they know which version is safe to collect these APIs from ? Thanks

@lucabelluccini
Copy link
Contributor

Hello @jguay thank you a lot for the contribution.
As discussed with @devcorpio (sorry for the direct ping - if you want to delegate this to other members of the Synthetics team please do), we would like to confirm if the APIs we're planning to add are not dumping secrets or sensitive information.
Can we have a confirmation? If there's a specific minimum version to use, please let us know.

@devcorpio
Copy link

devcorpio commented Mar 14, 2024

Hi @jguay @lucabelluccini,

I'm trying to find the proper person(or people) who might give a thorough answer to this.

We will add our review as soon as possible

Thanks,
Alberto

@devcorpio
Copy link

Hi again!,

@awahab07 has been checking this and provided the following information (thanks Abdul!):

So the decrypted query param is on the Get One monitor endpoint /internal/synthetics/service/monitor/{monitorId} and should be set to false. This will omit sensitive/encrypted fields while returning the monitor. List of sensitive fields.

The list of non-decrypted fields are.

So generally no sensitive fields will be returned. However, there might be sensitive information contained in the non-decrypted fields, depending on how the user has configured the monitor. E.g. Playwright Options accepts a JSON but is not encrypted.

--

Hope this helps

Cheers,
Alberto

@lucabelluccini
Copy link
Contributor

Hello @jguay - I think this should be safe to merge if we tested it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants