Skip to content

Commit 64940ac

Browse files
authored
TOC updates and remove auth/auth overviews
1 parent 3194a77 commit 64940ac

File tree

8 files changed

+64
-86
lines changed

8 files changed

+64
-86
lines changed

articles/iot-hub/TOC.yml

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -191,19 +191,28 @@
191191
href: ../iot-edge/iot-edge-as-gateway.md
192192
- name: Security
193193
items:
194+
- name: Authentication
195+
items:
196+
- name: Azure Active Directory
197+
displayName: authenticate, authentication, auth, authn
198+
href: authenticate-azure-ad.md
199+
- name: Shared access signatures
200+
displayName: authenticate, authentication, auth, authn
201+
href: authenticate-sas.md
202+
- name: X.509 certificates
203+
displayName: authenticate, authentication, auth, authn
204+
href: authenticate-x509.md
205+
- name: Authorization
206+
items:
207+
- name: Authorize with Azure Active Directory
208+
displayName: authorization, authorize, auth, authz
209+
href: authorize-azure-ad.md
210+
- name: Authorize with shared access signatures
211+
displayName: authorization, authorize, auth, authz
212+
href: authorize-sas.md
194213
- name: TLS support
195214
displayName: security, Transport Layer Security
196215
href: iot-hub-tls-support.md
197-
- name: Secure using X.509 CA certificates
198-
items:
199-
- name: X.509 certificate concepts
200-
displayName: Public Key Cryptography, X.509 certificates, public key infrastructure (PKI), certificates, Certification Authorities, encryption, ciphertext
201-
href: iot-hub-x509-certificate-concepts.md
202-
- name: X.509 CA certificate security concepts
203-
displayName: Device Provisioning Service, DPS, Hardware Secure Modules, HSM, self-signed certificate, Public Key Infrastructure, PKI
204-
href: iot-hub-x509ca-concept.md
205-
- name: X.509 CA certificates for IoT Hub
206-
href: iot-hub-x509ca-overview.md
207216
- name: Virtual networks support
208217
displayName: Security, Private Link, network isolation, private endpoint
209218
href: virtual-network-support.md

articles/iot-hub/authenticate-azure-ad.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,14 @@ ms.custom: ['Role: Cloud Development', 'Role: IoT Device', 'Role: System Archite
1313

1414
# Authenticate with Azure Active Directory
1515

16-
Intro
16+
## Authentication in IoT Hub
17+
18+
*Authentication* is the process of proving that you are who you say you are. This is achieved by verification of the identity of a user or device to IoT Hub. It's sometimes shortened to *AuthN*. Authentication is separate from *authorization*, which is the process of confirming permissions for an authenticated user or device on IoT Hub.
19+
20+
This article describes authentication that uses **Azure Active Directory (Azure AD) integration** for service APIs. Azure provides identity-based authentication with AAD and fine-grained authorization with Azure role-based access control (Azure RBAC). Azure AD and RBAC integration is supported for IoT hub service APIs only.
21+
22+
## Azure Active Directory authentication
23+
1724

1825
## Next steps
1926

articles/iot-hub/authenticate-overview.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

articles/iot-hub/authenticate-sas.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ ms.custom: ['Role: Cloud Development', 'Role: IoT Device', 'Role: System Archite
1313

1414
# Authenticate with a shared access signature
1515

16+
## Authentication in IoT Hub
17+
18+
*Authentication* is the process of proving that you are who you say you are. This is achieved by verification of the identity of a user or device to IoT Hub. It's sometimes shortened to *AuthN*. Authentication is separate from *authorization*, which is the process of confirming permissions for an authenticated user or device on IoT Hub.
19+
20+
This article describes authentication that uses **Shared access signatures** lets you group permissions and grant them to applications using access keys and signed security tokens. You can also use symmetric keys or shared access keys to authenticate a device with IoT Hub.
21+
22+
## Shared access signature authentication
23+
1624
Every IoT hub has an identity registry that stores information about the devices and modules permitted to connect to it. Before a device or module can connect, there must be an entry for that device or module in the IoT hub's identity registry. A device or module authenticates with the IoT hub based on credentials stored in the identity registry.
1725

1826
We support two methods of authentication between the device and the IoT hub. You can use SAS token-based authentication or X.509 certificate authentication.

articles/iot-hub/authenticate-x509.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ ms.custom: ['Role: Cloud Development', 'Role: IoT Device', 'Role: System Archite
1313

1414
# Authenticate with X.509 certificates
1515

16+
## Authentication in IoT Hub
17+
18+
*Authentication* is the process of proving that you are who you say you are. This is achieved by verification of the identity of a user or device to IoT Hub. It's sometimes shortened to *AuthN*. Authentication is separate from *authorization*, which is the process of confirming permissions for an authenticated user or device on IoT Hub.
19+
20+
This article describes authentication that uses **X.509 certificates**. You can use any X.509 certificate to authenticate a device with IoT Hub by uploading either a certificate thumbprint or a certificate authority (CA) to Azure IoT Hub. For other authentication options, see [Authenticate with shared access signatures](authenticate-sas.md) or [Authenticate with X.509 certificates](authenticate-x509.md).
21+
22+
## X.509 authentication
23+
1624
Every IoT hub has an identity registry that stores information about the devices and modules permitted to connect to it. Before a device or module can connect, there must be an entry for that device or module in the IoT hub's identity registry. A device or module authenticates with the IoT hub based on credentials stored in the identity registry.
1725

1826
We support two methods of authentication between the device and the IoT hub. You can use SAS token-based authentication or X.509 certificate authentication.

articles/iot-hub/authorize-azure-ad.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,31 @@ titleSuffix: Azure IoT Hub
44
description: Understand how Azure IoT Hub uses Azure Active Directory to authorize access to IoT hubs and devices.
55
author: kgremban
66
ms.service: iot-hub
7-
services: iot-hub
87
ms.author: kgremban
98
ms.topic: conceptual
10-
ms.date: 05/01/2023
9+
ms.date: 09/01/2023
1110
ms.custom: ['Role: Cloud Development', 'Role: IoT Device', 'Role: System Architecture']
1211
---
1312

14-
# Authorize access with Azure Active Directory
13+
# Control access to IoT Hub by using Azure Active Directory
1514

16-
## Control access to IoT Hub by using Azure Active Directory
1715

1816
You can use Azure Active Directory (Azure AD) to authenticate requests to Azure IoT Hub service APIs, like create device identity and invoke direct method. You can also use Azure role-based access control (Azure RBAC) to authorize those same service APIs. By using these technologies together, you can grant permissions to access IoT Hub service APIs to an Azure AD security principal. This security principal could be a user, group, or application service principal.
1917

20-
Authenticating access by using Azure AD and controlling permissions by using Azure RBAC provides improved security and ease of use over [security tokens](iot-hub-dev-guide-sas.md). To minimize potential security issues inherent in security tokens, we recommend that you [use Azure AD with your IoT hub whenever possible](#azure-ad-access-and-shared-access-policies).
18+
Authenticating access by using Azure AD and controlling permissions by using Azure RBAC provides improved security and ease of use over [security tokens](iot-hub-dev-guide-sas.md). To minimize potential security issues inherent in security tokens, we recommend that you use Azure AD with your IoT hub whenever possible.
2119

2220
> [!NOTE]
2321
> Authentication with Azure AD isn't supported for the IoT Hub *device APIs* (like device-to-cloud messages and update reported properties). Use [symmetric keys](iot-hub-dev-guide-sas.md#use-a-symmetric-key-in-the-identity-registry) or [X.509](iot-hub-x509ca-overview.md) to authenticate devices to IoT Hub.
2422
23+
## Authorization in IoT Hub
24+
25+
*Authorization* is the process of confirming permissions for an authenticated user or device on IoT Hub. It specifies what resources and commands you're allowed to access, and what you can do with those resources and commands. Authorization is sometimes shortened to *AuthZ*. Authorization is separate from *authentication*, which is the process of proving that you are who you say you are. For more information about authentication, see [Authentication overview](authenticate-overview.md).
26+
27+
This article describes authorization using **Azure Active Directory (Azure AD) integration** for service APIs. Azure provides identity-based authentication with AAD and fine-grained authorization with Azure role-based access control (Azure RBAC). Azure AD and RBAC integration is supported for IoT hub service APIs only. For other authorization options, see [Authorize access with shared access signatures](authorize-sas.md).
28+
29+
> [!TIP]
30+
> You can enable a lock on your IoT resources to prevent them being accidentally or maliciously deleted. To learn more about Azure Resource locks, please visit, [Lock your resources to protect your infrastructure](../azure-resource-manager/management/lock-resources.md?tabs=json)
31+
2532
## Authentication and authorization
2633

2734
When an Azure AD security principal requests access to an IoT Hub service API, the principal's identity is first *authenticated*. For authentication, the request needs to contain an OAuth 2.0 access token at runtime. The resource name for requesting the token is `https://iothubs.azure.net`. If the application runs in an Azure resource like an Azure VM, Azure Functions app, or Azure App Service app, it can be represented as a [managed identity](../active-directory/managed-identities-azure-resources/how-managed-identities-work-vm.md).

articles/iot-hub/authorize-overview.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

articles/iot-hub/authorize-sas.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@ This article introduces:
2626

2727
You must have appropriate permissions to access any of the IoT Hub endpoints. For example, a device must include a token containing security credentials along with every message it sends to IoT Hub. However, the signing keys, like the device symmetric keys, are never sent over the wire.
2828

29+
## Authorization in IoT Hub
30+
31+
*Authorization* is the process of confirming permissions for an authenticated user or device on IoT Hub. It specifies what resources and commands you're allowed to access, and what you can do with those resources and commands. Authorization is sometimes shortened to *AuthZ*. Authorization is separate from *authentication*, which is the process of proving that you are who you say you are. For more information about authentication, see [Authentication overview](authenticate-overview.md).
32+
33+
This article describes authorization using **Shared access signatures** lets you group permissions and grant them to applications using access keys and signed security tokens. For other authorization options, see [Authorize access with Azure Active Directory](authorize-azure-ad.md).
34+
35+
> [!TIP]
36+
> You can enable a lock on your IoT resources to prevent them being accidentally or maliciously deleted. To learn more about Azure Resource locks, please visit, [Lock your resources to protect your infrastructure](../azure-resource-manager/management/lock-resources.md?tabs=json)
37+
2938
## Access control and permissions
3039

3140
Use shared access policies for IoT hub-level access, and use the individual device credentials to scope access to that device only.

0 commit comments

Comments
 (0)