feat(security)!: Add authentication hooks to routes #1437
Merged
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
Codecov Report
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. @@ Coverage Diff @@
## main #1437 +/- ##
==========================================
+ Coverage 66.79% 66.83% +0.04%
==========================================
Files 36 36
Lines 3075 3088 +13
==========================================
+ Hits 2054 2064 +10
- Misses 888 891 +3
Partials 133 133
|
BREAKING CHANGE: EdgeX standard routes will require authentication. AddCustomRoute is a new interface method that enables adding authenticated routes. Closes #1435 Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
|
@jim-wang-intel Added unit test. |
Comment on lines
+121
to
+122
| _ = sdk.AddCustomRoute("/test", interfaces.Unauthenticated, func(http.ResponseWriter, *http.Request) {}, http.MethodGet) | ||
| _ = router.Walk(func(route *mux.Route, router *mux.Router, ancestors []*mux.Route) error { |
There was a problem hiding this comment.
Tests should always use verify no errors rather than ignore them.
err := ...
require.NoError(t, err)
Comment on lines
+142
to
+143
| _ = sdk.AddCustomRoute("/test", interfaces.Authenticated, func(http.ResponseWriter, *http.Request) {}, http.MethodGet) | ||
| _ = router.Walk(func(route *mux.Route, router *mux.Router, ancestors []*mux.Route) error { |
| // ApplicationService defines the interface for an edgex Application Service | ||
| type ApplicationService interface { | ||
| // AppContext returns the application service context used to detect cancelled context when the service is terminating. | ||
| // Used by custom app service to appropriately exit any long-running functions. | ||
| AppContext() context.Context | ||
| // AddRoute a custom REST route to the application service's internal webserver | ||
| // AddRoute adds a custom REST route to the application service's internal webserver | ||
| // A reference to this ApplicationService is add the the context that is passed to the handler, which | ||
| // can be retrieved using the `AppService` key | ||
| AddRoute(route string, handler func(http.ResponseWriter, *http.Request), methods ...string) error |
There was a problem hiding this comment.
Need to make this a Deprecated
|
@bnevis-i Need a PR do document this new API |
5 tasks
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.
BREAKING CHANGE: EdgeX standard routes will require authentication.
AddCustomRoute is a new interface method that enables adding authenticated routes.
Closes #1435
PR Checklist
Please check if your PR fulfills the following requirements:
BREAKING CHANGE:describing the break)Testing Instructions
Not fully tested in a full running system, but have added unit tests (make test) and verified basic security functionality.
New Dependency Instructions (If applicable)