-
Notifications
You must be signed in to change notification settings - Fork 266
Validate edge device ID headers #4825
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
Open
fallintoplace
wants to merge
3
commits into
NVIDIA:main
Choose a base branch
from
fallintoplace:fix-edge-device-id-header
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Copyright (c) 2026, NVIDIA CORPORATION. All rights reserved. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from urllib.parse import urlencode | ||
|
|
||
| import pytest | ||
| from flask import Flask | ||
|
|
||
| from nvflare.edge.constants import EdgeApiStatus, HttpHeaderKey | ||
| from nvflare.edge.web.models.api_error import ApiError | ||
| from nvflare.edge.web.models.base_model import EdgeProtoKey | ||
| from nvflare.edge.web.views.feg_views import _process_headers | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def app(): | ||
| return Flask(__name__) | ||
|
|
||
|
|
||
| def _process_headers_with(app, headers): | ||
| with app.test_request_context("/job", headers=headers): | ||
| return _process_headers() | ||
|
|
||
|
|
||
| def test_process_headers_uses_device_id_header_if_device_info_is_absent(app): | ||
| headers = {HttpHeaderKey.DEVICE_ID: "device-1"} | ||
|
|
||
| parsed = _process_headers_with(app, headers) | ||
|
|
||
| device_info = parsed[EdgeProtoKey.DEVICE_INFO] | ||
| assert device_info.device_id == "device-1" | ||
|
|
||
|
|
||
| def test_process_headers_uses_device_id_header_if_device_info_has_no_device_id(app): | ||
| headers = { | ||
| HttpHeaderKey.DEVICE_ID: "device-1", | ||
| HttpHeaderKey.DEVICE_INFO: urlencode({"platform": "ios"}), | ||
| } | ||
|
|
||
| parsed = _process_headers_with(app, headers) | ||
|
|
||
| device_info = parsed[EdgeProtoKey.DEVICE_INFO] | ||
|
greptile-apps[bot] marked this conversation as resolved.
|
||
| assert device_info.device_id == "device-1" | ||
| assert device_info.platform == "ios" | ||
|
|
||
|
|
||
| def test_process_headers_accepts_matching_device_info_device_id(app): | ||
| headers = { | ||
| HttpHeaderKey.DEVICE_ID: "device-1", | ||
| HttpHeaderKey.DEVICE_INFO: urlencode({EdgeProtoKey.DEVICE_ID: "device-1", "platform": "ios"}), | ||
| } | ||
|
|
||
| parsed = _process_headers_with(app, headers) | ||
|
|
||
| device_info = parsed[EdgeProtoKey.DEVICE_INFO] | ||
| assert device_info.device_id == "device-1" | ||
| assert device_info.platform == "ios" | ||
|
|
||
|
|
||
| def test_process_headers_rejects_mismatched_device_info_device_id(app): | ||
| headers = { | ||
| HttpHeaderKey.DEVICE_ID: "device-1", | ||
| HttpHeaderKey.DEVICE_INFO: urlencode({EdgeProtoKey.DEVICE_ID: "device-2", "platform": "ios"}), | ||
| } | ||
|
|
||
| with pytest.raises(ApiError) as exc_info: | ||
| _process_headers_with(app, headers) | ||
|
|
||
| assert exc_info.value.status_code == 400 | ||
| assert exc_info.value.status == EdgeApiStatus.INVALID_REQUEST | ||
| assert "Device ID mismatch" in str(exc_info.value) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.