fix: Switch from MAC address stored in Nautobot asset_tag to custom field #502
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stevekeay
changed the title
skrobul
approved these changes
Nov 20, 2024
Comment on lines
150
to
160
| formatted_list = json.dumps(list(mac_addresses)) | ||
| pattern = "|".join(mac_addresses) | ||
|
|
||
| query = ( | ||
| """{ | ||
| devices(asset_tag: %s){ | ||
| devices(cf_chassis_mac_address__re: "(%s)"){ | ||
| id name | ||
| mac: asset_tag | ||
| mac: cf_chassis_mac_address | ||
| location { id name } | ||
| rack { id name } | ||
| } | ||
| }""" | ||
| % formatted_list | ||
| % pattern |
There was a problem hiding this comment.
string interpolation creates the GraphQL injection vulnerability. For example, one could say
mac_addresses={"a.*", "dummy_input\") { devices { id passwords } } #"}Consider replacing this with query variables (untested):
query = """
query($pattern: String!) {
devices(cf_chassis_mac_address__re: $pattern) {
id name
mac: cf_chassis_mac_address
location { id name }
rack { id name }
}
}
"""
variables = {"pattern": "|".join(mac_addresses)}
result = nautobot.graphql.query(query, variables=variables)
cardoe
reviewed
Nov 20, 2024
python/understack-workflows/understack_workflows/nautobot_device.py
Outdated
Show resolved
Hide resolved
|
I updated all the queries to avoid suspicion due to string interpolation. |
added 3 commits
November 20, 2024 17:24
We have to change the graphql filter - you could search in Nautobot's built-in string attributes by passing an array of possible values to find, but that doesn't work for custom fields.
Learn the lessons of the 1990s and use "variables", as God intended.
Use the "variables" feature to avoid string interpolation in making these queries.
cardoe
force-pushed
the
mac-addr-custom-field
branch
from
78582d8
to
84afca5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The custom fields have been added to ansible, and to the dev and staging environments, and in those environments the data has been copied from the asset_tag field to the new custom field.
We had to change how we do the graphql filter - you could search in Nautobot's built-in string attributes by passing an array of possible values to find, but that doesn't work for custom fields.