fix(service-client)- Add IoT hub token scope. #1812

vinagesh · 2021-03-04T19:55:06Z

Checklist

I have read the contribution guidelines.
I added or modified the existing tests to cover the change (we do not allow our test coverage to go down).
This pull-request is submitted against the master branch.

Description of the changes

Reference/Link to the issue solved with this PR (if any)

timtay-microsoft · 2021-03-04T20:04:39Z

common/src/service/CommonConstants.cs

        public const string HttpErrorCodeName = "iothub-errorcode";

+        public const string IotHubAadTokenScope = "https://iothubs.azure.net/.default";


Does .NET allow you to declare a const string[] here rather than creating a new string array each time the token is retrieved?

It does but need to call it readonly instead. I was just torn between that or this, went back and forth and finally chose the current implementation thinking it might be more readable to look at the implementation. But I do see your point and think making a const string[] might be better. And now that I think of it more it might also be better if and when we need to add more scopes. We will just have to update in one place.

FWIW, I would not choose the one that required array construction each time. static readonly is sufficiently comparable to const. I don't see a downside there.

* fix: samples readme links were out-of-date (#1784) * fix: samples arguments and remove 1 more dead link (#1785) * fix(readme): Update the location of ConsoleEventListener in our readme * doc(service-client) - Updating readme (#1799) * fix(doc): Update amqp transport exception doc to have detailed description for quota exceeded error mapping * feature(device-client): Make the DeviceClient and ModuleClient extensible (#1802) * doc(service-client): Added extra comments to clarify true and false in dispose (#1805) * feature,fix (device-client) Handle Twin failures using Amqp (#1796) * fix(iot-service): Update xml comments for ServiceClient * fix(iot-device): Update MqttTransportHandler to not use SemaphoreSlim.WaitAsync(TimeSpan, CancellationToken) * fix(iot-device): Update dotnetty task calls to use ConfigureAwait(true) * fix(iot-device): Fix MqttTransportHandler to not await on user supplied C2D callback * IoTHub Exception for Get and Patch Twin failures (#1815) * fix(edge): UnixDomainSocketEndPoint is available in .NET 2.1 and greater (#1816) * UnixDomainSocketEndPoint has been standard since 2.1. Allowing later versions to use the correct class The edge client HSM provider uses UnixDomainSockets (UDS) for communication. Before .NET 2.1 to implement a Unix Socket you had to create your own class to do so. Since 2.1 there has been a native UnixDomainSocketEndPoint class in the runtime. In 2.1 and 3.1 there is no issue. However in 5.0 there are some changes to the way the Socket class handles the native UnixDomainSocketEndPoint class. I didn't dig down extremely deep, but I suspect it's due to the way the endpoint handles the SocketAddress and the string manipulation there seeing as how there is a specific implementation for Windows and for Unix. * feat(e2e) - Enabling soft delete when creating keyvaults (#1820) * fix(e2e) - Change event logging to opt in to specific events only. (#1824) * (service-client): Design for IoT hub AAD authentication * (service-client: Refactor and add implementation for token credential input) (#1781) * (service-client): Refactor and add sas credential (#1786) * (service-client): Add constructors in service client to accept aad and sas tokens. (#1787) * (service-client): Add constructors in registry manager to accept aad and sas tokens. (#1788) * (service-client): Add constructors in job client to accept aad and sas tokens. (#1789) * (service-client): Add constructors to accept aad and sas tokens for digital twins client. (#1790) * fix(service-client): Support for AzureSasCredential for a better user experience (#1797) * doc(service-client): Update readme about the differnt client and operations (#1798) * tests(service-client): E2E tests for aad auth on all our clients (#1800) * test(service-client): Adding e2e tests for sas credential auth for IoT hub. (#1806) * feature(service-client): Adding chaching for aad tokens. (#1807) * fix(service-client)- Add IoT hub token scope. (#1812) Co-authored-by: David R. Williamson <[email protected]> Co-authored-by: Abhipsa Misra <[email protected]> Co-authored-by: bikamani <[email protected]> Co-authored-by: jamdavi <[email protected]>

…#1922) * (service-client): Design for IoT hub AAD authentication * (service-client: Refactor and add implementation for token credential input) (#1781) * (service-client): Refactor and add sas credential (#1786) * (service-client): Add constructors in service client to accept aad and sas tokens. (#1787) * (service-client): Add constructors in registry manager to accept aad and sas tokens. (#1788) * (service-client): Add constructors in job client to accept aad and sas tokens. (#1789) * (service-client): Add constructors to accept aad and sas tokens for digital twins client. (#1790) * fix(service-client): Support for AzureSasCredential for a better user experience (#1797) * doc(service-client): Update readme about the differnt client and operations (#1798) * tests(service-client): E2E tests for aad auth on all our clients (#1800) * test(service-client): Adding e2e tests for sas credential auth for IoT hub. (#1806) * feature(service-client): Adding chaching for aad tokens. (#1807) * fix(service-client)- Add IoT hub token scope. (#1812) * feat(e2e) - Adding azure core and identity event sources. (#1826) * fix(service-client): Fixing the required format for sending aad tokens to the service (#1834) * refactor(service-client): Pass the correct amqp audience based on auth type (#1835) * feat(e2e): Enable tests for IotHub AAD auth (#1861) * feat(e2e): Enable jobs test on pipeline for aad auth (#1867) * fix(service-client): Add default value for transpor type. (#1870) * feat(e2e): Enable aad auth pnp tests now that the service supports it. (#1888) * feat(e2e-setup): Update script to setup required assets for AAD auth tests (#1920) * Fix merge error * Made changes based on PR comments

…Azure#1922) * (service-client): Design for IoT hub AAD authentication * (service-client: Refactor and add implementation for token credential input) (Azure#1781) * (service-client): Refactor and add sas credential (Azure#1786) * (service-client): Add constructors in service client to accept aad and sas tokens. (Azure#1787) * (service-client): Add constructors in registry manager to accept aad and sas tokens. (Azure#1788) * (service-client): Add constructors in job client to accept aad and sas tokens. (Azure#1789) * (service-client): Add constructors to accept aad and sas tokens for digital twins client. (Azure#1790) * fix(service-client): Support for AzureSasCredential for a better user experience (Azure#1797) * doc(service-client): Update readme about the differnt client and operations (Azure#1798) * tests(service-client): E2E tests for aad auth on all our clients (Azure#1800) * test(service-client): Adding e2e tests for sas credential auth for IoT hub. (Azure#1806) * feature(service-client): Adding chaching for aad tokens. (Azure#1807) * fix(service-client)- Add IoT hub token scope. (Azure#1812) * feat(e2e) - Adding azure core and identity event sources. (Azure#1826) * fix(service-client): Fixing the required format for sending aad tokens to the service (Azure#1834) * refactor(service-client): Pass the correct amqp audience based on auth type (Azure#1835) * feat(e2e): Enable tests for IotHub AAD auth (Azure#1861) * feat(e2e): Enable jobs test on pipeline for aad auth (Azure#1867) * fix(service-client): Add default value for transpor type. (Azure#1870) * feat(e2e): Enable aad auth pnp tests now that the service supports it. (Azure#1888) * feat(e2e-setup): Update script to setup required assets for AAD auth tests (Azure#1920) * Fix merge error * Made changes based on PR comments

vinagesh requested review from abhipsaMisra, azabbasi, barustum, bikamani, drwill-ms, jamdavi and timtay-microsoft as code owners March 4, 2021 19:55

vinagesh force-pushed the vinagesh/scopes branch from 67e9822 to 557ac0b Compare March 4, 2021 19:56

timtay-microsoft reviewed Mar 4, 2021

View reviewed changes

timtay-microsoft approved these changes Mar 4, 2021

View reviewed changes

bikamani approved these changes Mar 4, 2021

View reviewed changes

fix(service-client)- Add IoT hub token scope.

d3e5c54

vinagesh force-pushed the vinagesh/scopes branch from 557ac0b to d3e5c54 Compare March 4, 2021 21:06

vinagesh merged commit 818f332 into previews/RBAC Mar 4, 2021

vinagesh deleted the vinagesh/scopes branch March 4, 2021 21:06

vinagesh added a commit that referenced this pull request Mar 11, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

30ffbc9

vinagesh added a commit that referenced this pull request Mar 22, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

b477b6e

vinagesh added a commit that referenced this pull request Mar 22, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

eadebec

vinagesh added a commit that referenced this pull request Mar 22, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

30a520b

vinagesh added a commit that referenced this pull request Mar 22, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

09f7432

vinagesh added a commit that referenced this pull request Mar 22, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

5722399

vinagesh added a commit that referenced this pull request Mar 23, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

29fcd63

vinagesh added a commit that referenced this pull request Mar 23, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

ba7f71d

vinagesh added a commit that referenced this pull request Mar 24, 2021

fix(service-client)- Add IoT hub token scope. (#1812)

f4e407f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(service-client)- Add IoT hub token scope. #1812

fix(service-client)- Add IoT hub token scope. #1812

vinagesh commented Mar 4, 2021

timtay-microsoft Mar 4, 2021

vinagesh Mar 4, 2021 •

edited

Loading

drwill-ms Mar 4, 2021

		public const string HttpErrorCodeName = "iothub-errorcode";

		public const string IotHubAadTokenScope = "https://iothubs.azure.net/.default";

fix(service-client)- Add IoT hub token scope. #1812

fix(service-client)- Add IoT hub token scope. #1812

Conversation

vinagesh commented Mar 4, 2021

Checklist

Description of the changes

Reference/Link to the issue solved with this PR (if any)

timtay-microsoft Mar 4, 2021

Choose a reason for hiding this comment

vinagesh Mar 4, 2021 • edited Loading

Choose a reason for hiding this comment

drwill-ms Mar 4, 2021

Choose a reason for hiding this comment

vinagesh Mar 4, 2021 •

edited

Loading