You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: samples/cors/ts/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ This sample demonstrates a few alternatives to integrating with Azure Key Vault
37
37
38
38
## Prerequisites
39
39
40
-
The sample is compatible with Node.js >= 8.0.0
40
+
The sample is compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/)
41
41
42
42
Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript].
Copy file name to clipboardExpand all lines: samples/frameworks/electron/ts/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ In this sample, we build a simple [Electron][electron] application and integrati
9
9
10
10
## Prerequisites
11
11
12
-
The samples are compatible with Node.js >= 8.0.0.
12
+
The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/)
13
13
14
14
Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript].
Copy file name to clipboardExpand all lines: samples/frameworks/react/ts/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ In this sample, we build a simple Todo application in React using [create-react-
9
9
10
10
## Prerequisites
11
11
12
-
The samples are compatible with Node.js >= 8.0.0.
12
+
The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/).
13
13
14
14
Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript].
Copy file name to clipboardExpand all lines: samples/web-workers/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,15 @@ In this sample we demonstrate how to polyfill the necessary APIs for using our l
12
12
13
13
### XML Parsing
14
14
15
-
When used in the browser, our XML parsing library relies on DOM APIs to support parsing and stringifying XML. Since the DOM APIs are generally available this reduces bundle size and minimizes our dependencies. When running from a Web Worker, however, DOM APIs are not available. This is a browser limitation and requires a polyfill before importing our client libraries in web workers.
15
+
When used in the browser, our XML parsing library relies on DOM APIs to support parsing and stringifying XML. Since the DOM APIs are generally available this reduces bundle size and minimizes our dependencies. When running from a Web Worker, however, DOM APIs are not available. This is a browser limitation and requires a polyfill before importing our client libraries in web workers.
16
16
17
17
> Note: Not all client libraries use XML. When running in a web worker, our library will emit a useful error explaining what APIs are required if they are missing so that you can add them as needed.
18
18
19
19
In these samples we use [JSDOM][jsdom] but you can use any library that provides a DOM implementation.
20
20
21
21
## Prerequisites
22
22
23
-
The samples are compatible with Node.js >= 8.0.0.
23
+
The samples are compatible with [LTS versions of Node.js](https://nodejs.org/about/releases/).
24
24
25
25
Before running the TypeScript samples, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript].
Copy file name to clipboardExpand all lines: sdk/appconfiguration/app-configuration/README.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,10 +24,17 @@ Key links:
24
24
npm install @azure/app-configuration
25
25
```
26
26
27
+
### Currently supported environments
28
+
29
+
-[LTS versions of Node.js](https://nodejs.org/about/releases/)
30
+
- Latest versions of Safari, Chrome, Edge, and Firefox.
31
+
32
+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
33
+
27
34
### Prerequisites
28
35
29
-
-You must have an [Azure Subscription](https://azure.microsoft.com) and an [App Configuration](https://docs.microsoft.com/azure/azure-app-configuration/) resource to use this package.
-[LTS versions of Node.js](https://nodejs.org/about/releases/)
27
+
- Latest versions of Safari, Chrome, Edge, and Firefox.
28
+
29
+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
27
30
28
31
### Prerequisites
29
32
30
-
- An Azure subscription. To use Azure services, including the Microsoft Azure Attestation service, you'll need a subscription. If you do not have an existing Azure account, you may sign up for a [free trial][azure_sub] or use your [Visual Studio Subscription](https://visualstudio.microsoft.com/subscriptions/) benefits when you [create an account](https://account.windowsazure.com/Home/Index).
33
+
- An [Azure Subscription](https://azure.microsoft.com)
31
34
- An existing Azure Attestation Instance, or you can use the "shared provider" available in each Azure region. If you need to create an Azure Attestation service instance, you can use the Azure Portal or [Azure CLI][azure_cli].
32
35
33
36
### Install the @azure/attestation package
34
37
35
-
Install the Microsoft Azure Attestation client library for JavaScript with [NPM][Attestation_npm]:
38
+
Install the Microsoft Azure Attestation client library for JavaScript with [NPM][attestation_npm]:
36
39
37
40
```Powershell
38
41
npm install @azure/attestation
@@ -41,9 +44,9 @@ npm install @azure/attestation
41
44
### Authenticate the client
42
45
43
46
In order to interact with the Microsoft Azure Attestation service, you'll need to create an instance of the [Attestation Client][attestation_client] or [Attestation Administration Client][attestation_admin_client] class. You need a **attestation instance url**, which you may see as "DNS Name" in the portal,
44
-
and **client secret credentials (client id, client secret, tenant id)** to instantiate a client object.
47
+
and **client secret credentials (client id, client secret, tenant id)** to instantiate a client object.
45
48
46
-
Client secret credential authentication is being used in this getting started section but you can find more ways to authenticate with [Azure identity][azure_identity]. To use the [DefaultAzureCredential][DefaultAzureCredential] provider shown below,
49
+
Client secret credential authentication is being used in this getting started section but you can find more ways to authenticate with [Azure identity][azure_identity]. To use the [DefaultAzureCredential][defaultazurecredential] provider shown below,
47
50
or other credential providers provided with the Azure SDK, you should install the Azure.Identity package:
48
51
49
52
```Powershell
@@ -56,35 +59,35 @@ Use the [Azure CLI][azure_cli] snippet below to create/get client secret credent
56
59
57
60
- Create a service principal and configure its access to Azure resources:
58
61
59
-
```Powershell
60
-
az ad sp create-for-rbac -n <your-application-name> --skip-assignment
61
-
```
62
+
```Powershell
63
+
az ad sp create-for-rbac -n <your-application-name> --skip-assignment
64
+
```
62
65
63
-
Output:
66
+
Output:
64
67
65
-
```json
66
-
{
67
-
"appId": "generated-app-ID",
68
-
"displayName": "dummy-app-name",
69
-
"name": "http://dummy-app-name",
70
-
"password": "random-password",
71
-
"tenant": "tenant-ID"
72
-
}
73
-
```
68
+
```json
69
+
{
70
+
"appId": "generated-app-ID",
71
+
"displayName": "dummy-app-name",
72
+
"name": "http://dummy-app-name",
73
+
"password": "random-password",
74
+
"tenant": "tenant-ID"
75
+
}
76
+
```
74
77
75
78
- Take note of the service principal objectId
76
79
77
-
```Powershell
78
-
az ad sp show --id <appId> --query objectId
79
-
```
80
+
```Powershell
81
+
az ad sp show --id <appId> --query objectId
82
+
```
80
83
81
-
Output:
84
+
Output:
82
85
83
-
```Powershell
84
-
"<your-service-principal-object-id>"
85
-
```
86
+
```Powershell
87
+
"<your-service-principal-object-id>"
88
+
```
86
89
87
-
- Use the returned credentials above to set **AZURE_CLIENT_ID** (appId), **AZURE_CLIENT_SECRET** (password), and **AZURE_TENANT_ID** (tenant) environment variables. The following example shows a way to do this in Powershell:
90
+
- Use the returned credentials above to set **AZURE_CLIENT_ID** (appId), **AZURE_CLIENT_SECRET** (password), and **AZURE_TENANT_ID** (tenant) environment variables. The following example shows a way to do this in Powershell:
88
91
89
92
```Powershell
90
93
$Env:AZURE_CLIENT_ID="generated-app-ID"
@@ -99,7 +102,7 @@ For more information about the Azure Identity APIs and how to use them, see [Azu
99
102
There are four major families of functionality provided in this preview SDK:
100
103
101
104
-[SGX and TPM enclave attestation.](#attestation)
102
-
-[MAA Attestation Token signing certificate discovery and validation.](#attestation-token-signing-certificate-discovery-and-validation)
105
+
-[MAA Attestation Token signing certificate discovery and validation.](#attestation-token-signing-certificate-discovery-and-validation)
@@ -143,9 +146,9 @@ clients to "roll" the policy management certificates.
143
146
144
147
### Isolated Mode and AAD Mode
145
148
146
-
Each Microsoft Azure Attestation service instance operates in either "AAD" mode or "Isolated" mode. When an MAA instance is operating in AAD mode, it means that the customer which created the attestation instance allows Azure Active Directory and Azure Role Based Access control policies to verify access to the attestation instance.
149
+
Each Microsoft Azure Attestation service instance operates in either "AAD" mode or "Isolated" mode. When an MAA instance is operating in AAD mode, it means that the customer which created the attestation instance allows Azure Active Directory and Azure Role Based Access control policies to verify access to the attestation instance.
147
150
148
-
### *AttestationType*
151
+
### _AttestationType_
149
152
150
153
The Microsoft Azure Attestation service supports attesting different types of evidence depending on the environment.
151
154
Currently, MAA supports the following Trusted Execution environments:
@@ -186,13 +189,13 @@ The `getPolicy` method retrieves the attestation policy from the service.
186
189
Attestation Policies are instanced on a per-attestation type basis, the `AttestationType` parameter defines the type to retrieve.
// The hash returned in expectedHash will match the value in
240
+
// `setResult.value.policy_token_hash.
239
241
```
240
242
241
243
### Attest SGX Enclave
@@ -248,7 +250,7 @@ One solution to this problem is what is known as "Secure Key Release", which is
248
250
249
251
To implement the "Secure Key Release" pattern, the enclave code generates an ephemeral asymmetric key. It then serializes the public portion of the key to some format (possibly a JSON Web Key, or PEM, or some other serialization format).
250
252
251
-
The enclave code then calculates the SHA256 value of the public key and passes it as an input to code which generates an SGX Quote (for OpenEnclave, that would be the [oe_get_evidence](https://openenclave.io/apidocs/v0.14/attester_8h_a7d197e42468636e95a6ab97b8e74c451.html#a7d197e42468636e95a6ab97b8e74c451) or [oe_get_report](https://openenclave.io/apidocs/v0.14/enclave_8h_aefcb89c91a9078d595e255bd7901ac71.html#aefcb89c91a9078d595e255bd7901ac71)).
253
+
The enclave code then calculates the SHA256 value of the public key and passes it as an input to code which generates an SGX Quote (for OpenEnclave, that would be the [oe_get_evidence](https://openenclave.io/apidocs/v0.14/attester_8h_a7d197e42468636e95a6ab97b8e74c451.html#a7d197e42468636e95a6ab97b8e74c451) or [oe_get_report](https://openenclave.io/apidocs/v0.14/enclave_8h_aefcb89c91a9078d595e255bd7901ac71.html#aefcb89c91a9078d595e255bd7901ac71)).
252
254
253
255
The client then sends the SGX quote and the serialized key to the attestation service. The attestation service will validate the quote and ensure that the hash of the key is present in the quote and will issue an "Attestation Token".
254
256
@@ -259,11 +261,9 @@ This example shows one common pattern of calling into the attestation service to
259
261
This example assumes that you have an existing `AttestationClient` object which is configured with the base URI for your endpoint. It also assumes that you have an SGX Quote (`quote`) generated from within the SGX enclave you are attesting, and "Runtime Data" (`binaryRuntimeData`) which is referenced in the SGX Quote.
0 commit comments