Skip to content

Commit 990a129

Browse files
committed
Updates
1 parent a200760 commit 990a129

8 files changed

+50
-57
lines changed

articles/attestation/quickstart-portal.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Follow this quickstart to get started with Azure Attestation. Learn how to manag
1616

1717
## Prerequisites
1818

19-
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin. The user creating an attestation provider should have sufficient access levels on the subscription to create a resource (e.g: owner/contributor). Please refer [Azure built-in roles](../role-based-access-control/built-in-roles.md) for more information.
19+
If you don't have an Azure subscription, create a [free account](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) before you begin. The user creating an attestation provider should have sufficient access levels on the subscription to create a resource (e.g: owner/contributor). For more information, see [Azure built-in roles](../role-based-access-control/built-in-roles.md).
2020

2121
## Attestation provider
2222

@@ -37,7 +37,7 @@ In this section, you'll create an attestation provider and configure it with eit
3737
- **Policy signer certificates file**: Don't upload the policy signer certificates file to configure the provider with unsigned policies.
3838

3939
1. After you provide the required inputs, select **Review+Create**.
40-
1. If there are validation issues, fix them and then select **Create**.
40+
1. Fix any validation issues and select **Create**.
4141

4242
### Create and configure the provider with signed policies
4343

@@ -54,7 +54,7 @@ In this section, you'll create an attestation provider and configure it with eit
5454
- **Policy signer certificates file**: Upload the policy signer certificates file to configure the attestation provider with signed policies. [See examples of policy signer certificates](./policy-signer-examples.md).
5555

5656
1. After you provide the required inputs, select **Review+Create**.
57-
1. If there are validation issues, fix them and then select **Create**.
57+
1. Fix any validation issues and select **Create**.
5858

5959
### View the attestation provider
6060

@@ -86,7 +86,7 @@ Follow the steps in this section to view, add, and delete policy signer certific
8686
1. Go to the Azure portal menu or the home page and select **All resources**.
8787
1. In the filter box, enter the attestation provider name.
8888
1. Select the attestation provider and go to the overview page.
89-
1. Select **Policy signer certificates** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, please click cancel to proceed.
89+
1. Select **Policy signer certificates** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, select cancel to proceed.
9090
1. Select **Download policy signer certificates**. The button will be disabled for attestation providers created without the policy signing requirement.
9191
1. The downloaded text file will have all certificates in a JWS format.
9292
1. Verify the certificate count and the downloaded certificates.
@@ -96,7 +96,7 @@ Follow the steps in this section to view, add, and delete policy signer certific
9696
1. Go to the Azure portal menu or the home page and select **All resources**.
9797
1. In the filter box, enter the attestation provider name.
9898
1. Select the attestation provider and go to the overview page.
99-
1. Select **Policy signer certificates** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, please click cancel to proceed.
99+
1. Select **Policy signer certificates** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, select cancel to proceed.
100100
1. Select **Add** on the upper menu. The button will be disabled for attestation providers created without the policy signing requirement.
101101
1. Upload the policy signer certificate file and select **Add**. [See examples of policy signer certificates](./policy-signer-examples.md).
102102

@@ -105,7 +105,7 @@ Follow the steps in this section to view, add, and delete policy signer certific
105105
1. Go to the Azure portal menu or the home page and select **All resources**.
106106
1. In the filter box, enter the attestation provider name.
107107
1. Select the attestation provider and go to the overview page.
108-
1. Select **Policy signer certificates** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, please click cancel to proceed.
108+
1. Select **Policy signer certificates** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, Select **Cancel** to proceed.
109109
1. Select **Delete** on the upper menu. The button will be disabled for attestation providers created without the policy signing requirement.
110110
1. Upload the policy signer certificate file and select **Delete**. [See examples of policy signer certificates](./policy-signer-examples.md).
111111

@@ -118,7 +118,7 @@ This section describes how to view an attestation policy and how to configure po
118118
1. Go to the Azure portal menu or the home page and select **All resources**.
119119
1. In the filter box, enter the attestation provider name.
120120
1. Select the attestation provider and go to the overview page.
121-
1. Select **Policy** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, please click cancel to proceed.
121+
1. Select **Policy** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, select **Cancel** to proceed.
122122
1. Select the preferred **Attestation Type** and view the **Current policy**.
123123

124124
### Configure an attestation policy
@@ -128,7 +128,7 @@ Follow these steps to upload a policy in JWT or text format if the attestation p
128128
1. Go to the Azure portal menu or the home page and select **All resources**.
129129
1. In the filter box, enter the attestation provider name.
130130
1. Select the attestation provider and go to the overview page.
131-
1. Select **Policy** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, please click cancel to proceed.
131+
1. Select **Policy** on the resource menu on the left side of the window or on the lower pane. If you see a prompt to select certificate for authentication, select **Cancel** proceed.
132132
1. Select **Configure** on the upper menu.
133133
1. Select **Policy Format** as **JWT** or as **Text**.
134134

articles/attestation/quickstart-powershell.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: attestation
55
author: msmbaldwin
66
ms.service: attestation
77
ms.topic: overview
8-
ms.date: 08/31/2020
8+
ms.date: 01/23/2023
99
ms.author: mbaldwin
1010
ms.custom: devx-track-azurepowershell
1111

@@ -17,7 +17,7 @@ Follow the below steps to create and configure an attestation provider using Azu
1717

1818
> [!NOTE]
1919
> Az.Attestation module is now integrated into Az PowerShell module. Minimum version of Az module required to support attestation operations:
20-
- Az 6.5.0
20+
- Az PowerShell 6.5.0
2121

2222
The PowerShell Gallery has deprecated Transport Layer Security (TLS) versions 1.0 and 1.1. TLS 1.2 or a later version is recommended. Hence you may receive the following errors:
2323

@@ -46,7 +46,7 @@ Set-AzContext -Subscription <subscription id>
4646

4747
## Register Microsoft.Attestation resource provider
4848

49-
Register the Microsoft.Attestation resource provider in subscription. For more information about Azure resource providers and how to configure and manage resources providers, see [Azure resource providers and types](../azure-resource-manager/management/resource-providers-and-types.md). Note that registering a resource provider is required only once for a subscription.
49+
Register the Microsoft.Attestation resource provider in subscription. For more information about Azure resource providers and how to configure and manage resources providers, see [Azure resource providers and types](../azure-resource-manager/management/resource-providers-and-types.md). Registering a resource provider is required only once for a subscription.
5050

5151
```powershell
5252
Register-AzResourceProvider -ProviderNamespace Microsoft.Attestation
@@ -59,7 +59,7 @@ Register-AzResourceProvider -ProviderNamespace Microsoft.Attestation
5959

6060
## Create an Azure resource group
6161

62-
Create a resource group for the attestation provider. Note that other Azure resources (including a virtual machine with client application instance) can be put in the same resource group.
62+
Create a resource group for the attestation provider. Other Azure resources (including a virtual machine with client application instance) can be put in the same resource group.
6363

6464
```powershell
6565
$location = "uksouth"
@@ -94,7 +94,7 @@ Get-AzAttestation retrieves the attestation provider properties like status and
9494
Get-AzAttestation -Name $attestationProvider -ResourceGroupName $attestationResourceGroup
9595
```
9696

97-
The above command should produce an output like the one below:
97+
The above command should produce output in this format:
9898

9999
```
100100
Id:/subscriptions/MySubscriptionID/resourceGroups/MyResourceGroup/providers/Microsoft.Attestation/attestationProviders/MyAttestationProvider
@@ -126,7 +126,7 @@ In order to manage policies, an Azure AD user requires the following permissions
126126
In order to read policies, an Azure AD user requires the following permission for "Actions":
127127
- Microsoft.Attestation/attestationProviders/attestation/read
128128

129-
To perform this action, an Azure AD user must have **Attestation Reader** role on the attestation provider. The read permission can be also be inherited with roles such as **Reader** (wildcard permissions) on the subscription/ resource group.
129+
To perform this action, an Azure AD user must have **Attestation Reader** role on the attestation provider. The read permissions can be also be inherited with roles such as **Reader** (wildcard permissions) on the subscription/ resource group.
130130

131131
Below PowerShell cmdlets provide policy management for an attestation provider (one TEE at a time).
132132

@@ -161,7 +161,7 @@ Reset-AzAttestationPolicy -Name $attestationProvider -ResourceGroupName $attesta
161161

162162
## Policy signer certificates management
163163

164-
Below PowerShell cmdlets provide policy signer certificates management for an attestation provider:
164+
These PowerShell cmdlets provide policy signer certificates management for an attestation provider:
165165

166166
```powershell
167167
Get-AzAttestationPolicySigners -Name $attestationProvider -ResourceGroupName $attestationResourceGroup
@@ -171,7 +171,7 @@ Add-AzAttestationPolicySigner -Name $attestationProvider -ResourceGroupName $att
171171
Remove-AzAttestationPolicySigner -Name $attestationProvider -ResourceGroupName $attestationResourceGroup -Signer <signer>
172172
```
173173

174-
Policy signer certificate is a signed JWT with claim named "maa-policyCertificate". Value of the claim is a JWK which contains the trusted signing key to add. The JWT must be signed with private key corresponding to any of the existing policy signer certificates.
174+
Policy signer certificate is a signed JWT with claim named "maa-policyCertificate". Value of the claim is a JWK, which contains the trusted signing key to add. The JWT must be signed with private key corresponding to any of the existing policy signer certificates.
175175

176176
Note that all semantic manipulation of the policy signer certificate must be done outside of PowerShell. As far as PowerShell is concerned, it is a simple string.
177177

articles/attestation/quickstart-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.service: attestation
77
ms.topic: quickstart
88
ms.custom: subject-armqs, devx-track-azurepowershell, mode-arm
99
ms.author: mbaldwin
10-
ms.date: 05/20/2021
10+
ms.date: 01/23/2023
1111
---
1212

1313
# Quickstart: Create an Azure Attestation provider with an ARM template

articles/attestation/tpm-attestation-sample-policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: prsriva
1212
---
1313
# Examples of an attestation policy for TPM endpoint
1414

15-
Attestation policy is used to process the attestation evidence and determine whether Azure Attestation will issue an attestation token. Attestation token generation can be controlled with custom policies. Below are some examples of an attestation policy.
15+
Attestation policy is used to process the attestation evidence and determine whether Azure Attestation will issue an attestation token. Attestation token generation can be controlled with custom policies.
1616

1717
## Sample policy for TPM using Policy version 1.0
1818

articles/attestation/troubleshoot-guide.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,19 @@ services: attestation
55
author: msmbaldwin
66
ms.service: attestation
77
ms.topic: reference
8-
ms.date: 07/20/2020
8+
ms.date: 01/23/2023
99
ms.author: mbaldwin
1010
ms.custom: devx-track-azurepowershell
1111

12-
1312
---
1413

1514
# Microsoft Azure Attestation troubleshooting guide
1615

1716
Error handling in Azure Attestation is implemented following [Microsoft REST API guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). The error response returned by Azure Attestation APIs contains HTTP status code and name/value pairs with the names “code” and “message”. The value of “code” is human-readable and is an indicator of the type of error. The value of “message” intends to aid the user and provides error details.
1817

19-
If your issue is not addressed in this article, you can also submit an Azure support request on the [Azure support page](https://azure.microsoft.com/support/options/).
20-
21-
Below are some examples of the errors returned by Azure Attestation:
18+
If your issue isn't addressed in this article, you can also submit an Azure support request on the [Azure support page](https://azure.microsoft.com/support/options/).
2219

23-
## 1. HTTP–401 : Unauthorized exception
20+
## 1. HTTP–401: Unauthorized exception
2421

2522
### HTTP status code
2623
401
@@ -29,8 +26,8 @@ Below are some examples of the errors returned by Azure Attestation:
2926
Unauthorized
3027

3128
**Scenario examples**
32-
- Unable to manage attestation policies as the user is not assigned with appropriate roles
33-
- Unable to manage attestation policy signers as the user is not assigned with appropriate roles
29+
- Unable to manage attestation policies as the user isn't assigned with appropriate roles
30+
- Unable to manage attestation policy signers as the user isn't assigned with appropriate roles
3431

3532
User with Reader role trying to edit an attestation policy in PowerShell
3633

@@ -50,7 +47,7 @@ In order to manage policies, an Azure AD user requires the following permissions
5047
- Microsoft.Attestation/attestationProviders/attestation/write
5148
- Microsoft.Attestation/attestationProviders/attestation/delete
5249

53-
To perform these actions, an Azure AD user must have "Attestation Contributor" role on the attestation provider. These permissions can be also be inherited with roles such as "Owner" (wildcard permissions), "Contributor" (wildcard permissions) on the subscription/ resource group.
50+
To perform these actions, an Azure AD user must have "Attestation Contributor" role on the attestation provider. These permissions can also be inherited with roles such as "Owner" (wildcard permissions), "Contributor" (wildcard permissions) on the subscription/ resource group.
5451

5552
In order to read policies, an Azure AD user requires the following permission for "Actions":
5653
- Microsoft.Attestation/attestationProviders/attestation/read
@@ -61,7 +58,7 @@ To verify the roles in PowerShell, run the below steps:
6158

6259
a. Launch PowerShell and log into Azure via the "Connect-AzAccount" cmdlet
6360

64-
b. Please refer the guidance [here](../role-based-access-control/role-assignments-list-powershell.md) to verify your Azure role assignment on the attestation provider
61+
b. Refer to the guidance [here](../role-based-access-control/role-assignments-list-powershell.md) to verify your Azure role assignment on the attestation provider
6562

6663
c. If you don't find an appropriate role assignment, follow the instructions in [here](../role-based-access-control/role-assignments-powershell.md)
6764

@@ -102,7 +99,7 @@ See [attestation policy examples](./policy-examples.md)
10299
InvalidParameter
103100

104101
**Scenario examples**
105-
SGX attestation failure due to invalid input. Below are some of the examples for error messages:
102+
SGX attestation failure due to invalid input. Here are some examples of error messages:
106103
- The specified quote was invalid due to an error in the quote collateral
107104
- The specified quote was invalid because the device on which the quote was generated does not meet the Azure baseline requirements
108105
- The specified quote was invalid because the TCBInfo or QEID provided by the PCK Cache Service was invalid

articles/attestation/view-logs.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,24 @@ services: attestation
55
author: msmbaldwin
66
ms.service: attestation
77
ms.topic: reference
8-
ms.date: 11/23/2020
8+
ms.date: 01/23/2023
99
ms.author: mbaldwin
1010

11-
1211
---
1312

1413
# Azure Attestation logging
1514

16-
If you create one or more Azure Attestation resources, you’ll want to monitor how and when your attestation instance is accessed, and by whom. You can do this by enabling logging for Microsoft Azure Attestation, which saves information in an Azure storage account you provide.
15+
If you create one or more Azure Attestation resources, you’ll want to monitor how and when your attestation instance is accessed, and by whom. You can do so by enabling logging for Microsoft Azure Attestation, which saves information in an Azure storage account you provide.
1716

18-
Logging information will be available up to 10 minutes after the operation occurred (in most cases, it will be quicker than this). Since you provide the storage account, you can secure your logs via standard Azure access controls and delete logs you no longer want to keep in your storage account.
17+
Logging information will be available up to 10 minutes after the operation occurred (in most cases, it will be quicker). Since you provide the storage account, you can secure your logs via standard Azure access controls and delete logs you no longer want to keep in your storage account.
1918

2019
## Interpret your Azure Attestation logs
2120

2221
When logging is enabled, up to three containers may be automatically created for you in your specified storage account: **insights-logs-auditevent, insights-logs-operational, insights-logs-notprocessed**. It is recommended to only use **insights-logs-operational** and **insights-logs-notprocessed**. **insights-logs-auditevent** was created to provide early access to logs for customers using VBS. Future enhancements to logging will occur in the **insights-logs-operational** and **insights-logs-notprocessed**.
2322

2423
**Insights-logs-operational** contains generic information across all TEE types.
2524

26-
**Insights-logs-notprocessed** contains requests which the service was unable to process, typically due to malformed HTTP headers, incomplete message bodies, or similar issues.
25+
**Insights-logs-notprocessed** contains requests that the service was unable to process, typically due to malformed HTTP headers, incomplete message bodies, or similar issues.
2726

2827
Individual blobs are stored as text, formatted as a JSON blob. Let’s look at an example log entry:
2928

@@ -72,11 +71,11 @@ Most of these fields are documented in the [Top-level common schema](../azure-mo
7271
| traceContext | JSON blob representing the W3C trace-context |
7372
| uri | Request URI |
7473

75-
The properties contain additional Azure attestation specific context:
74+
The properties contain additional Azure attestation specific context:
7675

7776
| Field Name | Description |
7877
|------------------------------------------|-----------------------------------------------------------------------------------------------|
79-
| failureResourceId | Resource ID of component which resulted in request failure |
78+
| failureResourceId | Resource ID of component that resulted in request failure |
8079
| failureCategory | Broad category indicating category of a request failure. Includes categories such as AzureNetworkingPhysical, AzureAuthorization etc. |
8180
| failureDetails | Detailed information about a request failure, if available |
8281
| infoDataReceived | Information about the request received from the client. Includes some HTTP headers, the number of headers received, the content type and content length |

0 commit comments

Comments
 (0)