Skip to content

feat(security): Update docs for new proxy implementation#981

Merged
bnevis-i merged 6 commits intoedgexfoundry:mainfrom
bnevis-i:proxy-switch
Mar 16, 2023
Merged

feat(security): Update docs for new proxy implementation#981
bnevis-i merged 6 commits intoedgexfoundry:mainfrom
bnevis-i:proxy-switch

Conversation

@bnevis-i
Copy link
Collaborator

@bnevis-i bnevis-i commented Mar 6, 2023

PR Checklist

Please check if your PR fulfills the following requirements:

  • Changes have been rendered and validated locally using mkdocs-material (see edgex-docs README)

Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
@bnevis-i bnevis-i marked this pull request as ready for review March 6, 2023 23:39
@bnevis-i bnevis-i added this to the Minnesota milestone Mar 6, 2023
Comment on lines 489 to 490
* `apps.secrets-config.proxy.tls.cert`
* `apps.secrets-config.proxy.tls.key`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@farshidtz

I don't know how to code support for the pre-seeded cert. I am pretty sure this is broken.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is wrapper around secrets-config which is implemented here. It takes the snap options set by the user (cert and key payloads), writes them to a file, and calls secret-config internally. I have it in my to do list to move it to the edgex-go repo.

Yes it is broken. However, there is no way to make it work because secrets-config doesn't work right now in the snap because of the file ownership change: #981 (comment)

Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
Copy link

@jim-wang-yutsung jim-wang-yutsung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bnevis-i bnevis-i requested a review from lenny-goodell March 15, 2023 19:57
In non-secure mode of EdgeX, the API gateway is not started.


### Local Service-to-Service - Using EdgeX Service Clients
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am looking for a section that explains how to hit one of the services externally on the local system. i.e. using curl or Postman. In V2 we could do this w/o a token. No in 3.0 we can not.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See this commit: 072b306

Copy link

@vyshali-chitikeshi vyshali-chitikeshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me from validation perspective

@vyshali-chitikeshi
Copy link

This section "Prior to EdgeX 3.0, requests that originated remotely were authenticated at the API gateway via an HTTP Authorization header that contained a JWT bearer token. Internally-originated requests required no authentication. In EdgeX 3.0, the Authorization header is additionally checked at the microservice level on a per-route basis, where the majority of URL paths require authentication." it would be helpful to add details how user can add this token as authorization header with curl command or postman collection while executing rest-api's

Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
@bnevis-i
Copy link
Collaborator Author

This section "Prior to EdgeX 3.0, requests that originated remotely were authenticated at the API gateway via an HTTP Authorization header that contained a JWT bearer token. Internally-originated requests required no authentication. In EdgeX 3.0, the Authorization header is additionally checked at the microservice level on a per-route basis, where the majority of URL paths require authentication." it would be helpful to add details how user can add this token as authorization header with curl command or postman collection while executing rest-api's

See this commit: 072b306

@vyshali-chitikeshi
Copy link

LGTM

@bnevis-i bnevis-i requested a review from lenny-goodell March 16, 2023 21:13
Signed-off-by: Bryon Nevis <bryon.nevis@intel.com>
Copy link
Member

@lenny-goodell lenny-goodell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bnevis-i bnevis-i merged commit 4ec2782 into edgexfoundry:main Mar 16, 2023
@bnevis-i bnevis-i deleted the proxy-switch branch March 16, 2023 23:14
edgex-jenkins added a commit that referenced this pull request Mar 16, 2023
Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
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.

5 participants