-
Notifications
You must be signed in to change notification settings - Fork 493
/
IndividualEnrollment.cs
312 lines (287 loc) · 14.5 KB
/
IndividualEnrollment.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
using Microsoft.Azure.Devices.Shared;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using System;
using System.Collections.Generic;
namespace Microsoft.Azure.Devices.Provisioning.Service
{
/// <summary>
/// Representation of a single Device Provisioning Service enrollment and their accessors with a JSON serializer
/// and deserializer.
/// </summary>
/// <remarks>
/// This object is used to send and receive individualEnrollment information to and from the provisioning service.
///
/// To create or update an Enrollment on the provisioning service you should fill this object and call the
/// public API <see cref="ProvisioningServiceClient.CreateOrUpdateIndividualEnrollmentAsync(IndividualEnrollment)"/>.
///
/// The minimum information required by the provisioning service is the <c>RegistrationId</c> and the
/// <c>Attestation</c>.
///
/// A new device can be provisioned by three attestation mechanisms, Trust Platform Module (see <see cref=
/// "TpmAttestation"/>), X509 (see <see cref="X509Attestation"/>) or Symmetric Key (see <see cref="SymmetricKeyAttestation"/>). The definition of each one you
/// should use depending on the physical authentication hardware that the device contains.
///
/// The content of this class will be serialized in a JSON format and sent as a body of the rest API to the
/// provisioning service. Or the content of this class can be filled by a JSON, received from the provisioning
/// service, as result of a individualEnrollment operation like create, update, or query.
/// </remarks>
/// <example>
/// When serialized, an individualEnrollment will look like the following example:
/// <c>
/// {
/// "registrationId":"validRegistrationId",
/// "deviceId":"ContosoDevice-123",
/// "attestation":{
/// "type":"tpm",
/// "tpm":{
/// "endorsementKey":"validEndorsementKey"
/// }
/// },
/// "iotHubHostName":"ContosoIoTHub.azure-devices.net",
/// "provisioningStatus":"enabled"
/// }
/// </c>
///
/// The following JSON is a sample of the individualEnrollment response, received from the provisioning service.
/// <c>
/// {
/// "registrationId":"validRegistrationId",
/// "deviceId":"ContosoDevice-123",
/// "attestation":{
/// "type":"tpm",
/// "tpm":{
/// "endorsementKey":"validEndorsementKey"
/// }
/// },
/// "iotHubHostName":"ContosoIoTHub.azure-devices.net",
/// "provisioningStatus":"enabled"
/// "createdDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
/// "lastUpdatedDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
/// "etag": "\"00000000-0000-0000-0000-00000000000\""
/// }
/// </c>
/// </example>
public class IndividualEnrollment : IETagHolder
{
/// <summary>
/// Creates a new instance of <c>IndividualEnrollment</c>.
/// </summary>
/// <remarks>
/// This constructor creates an instance of the IndividualEnrollment object with the minimum set of
/// information required by the provisioning service. A valid individualEnrollment must contain the
/// registrationId, which uniquely identify this enrollment, and the attestation mechanism, which can
/// be TPM, X509, or Symmetric key.
///
/// Other parameters can be added by calling the setters on this object.
/// </remarks>
/// <example>
/// When serialized, an IndividualEnrollment will look like the following example:
/// <c>
/// {
/// "registrationId":"validRegistrationId",
/// "attestation":{
/// "type":"tpm",
/// "tpm":{
/// "endorsementKey":"validEndorsementKey"
/// }
/// }
/// }
/// </c>
/// </example>
/// <param name="registrationId">the <c>string</c> that uniquely identify this enrollment in the provisioning
/// service. It cannot be <c>null</c> or empty.</param>
/// <param name="attestation">the <see cref="Attestation"/> object with the attestation mechanism. It cannot be <c>null</c>.</param>
/// <exception cref="ArgumentNullException">if one of the provided parameters is not correct</exception>
public IndividualEnrollment(string registrationId, Attestation attestation)
{
RegistrationId = registrationId ?? throw new ArgumentNullException(nameof(registrationId));
Attestation = attestation ?? throw new ArgumentNullException(nameof(attestation));
}
/// <summary>
/// Creates a new instance of <c>IndividualEnrollment</c> using information in a JSON.
/// </summary>
/// <remarks>
/// This constructor creates an instance of the enrollment filling the class with the information
/// provided in the JSON. It is used by the SDK to parse enrollment responses from the provisioning service.
/// </remarks>
/// <example>
/// The following JSON is a sample of the IndividualEnrollment response, received from the provisioning service.
/// <c>
/// {
/// "registrationId":"validRegistrationId",
/// "deviceId":"ContosoDevice-123",
/// "attestation":{
/// "type":"tpm",
/// "tpm":{
/// "endorsementKey":"validEndorsementKey"
/// }
/// },
/// "iotHubHostName":"ContosoIoTHub.azure-devices.net",
/// "provisioningStatus":"enabled"
/// "createdDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
/// "lastUpdatedDateTimeUtc": "2017-09-28T16:29:42.3447817Z",
/// "etag": "\"00000000-0000-0000-0000-00000000000\""
/// }
/// </c>
/// </example>
/// <param name="registrationId">the <c>string</c> with a unique id for the individualEnrollment. It cannot be <c>null</c> or empty.</param>
/// <param name="attestation">the <see cref="AttestationMechanism"/> for the enrollment. It shall be `TPM`, `X509` or `SymmetricKey`.</param>
/// <param name="deviceId">the <c>string</c> with the device name. This is optional and can be <c>null</c> or empty.</param>
/// <param name="iotHubHostName">the <c>string</c> with the target IoTHub name. This is optional and can be <c>null</c> or empty.</param>
/// <param name="initialTwinState">the <see cref="TwinState"/> with the initial Twin condition. This is optional and can be <c>null</c>.</param>
/// <param name="provisioningStatus">the <see cref="ProvisioningStatus"/> that determine the initial status of the device. This is optional and can be <c>null</c>.</param>
/// <param name="createdDateTimeUtc">the <c>DateTime</c> with the date and time that the enrollment was created. This is optional and can be <c>null</c>.</param>
/// <param name="lastUpdatedDateTimeUtc">the <c>DateTime</c> with the date and time that the enrollment was updated. This is optional and can be <c>null</c>.</param>
/// <param name="eTag">the <c>string</c> with the eTag that identify the correct instance of the enrollment in the service. It cannot be <c>null</c> or empty.</param>
/// <param name="capabilities">the <see cref="DeviceCapabilities"/> that identifies the device capabilities. This is optional and can be <c>null</c>.</param>
/// <exception cref="ProvisioningServiceClientException">if the received JSON is invalid.</exception>
[JsonConstructor]
internal IndividualEnrollment(
string registrationId,
AttestationMechanism attestation,
string deviceId,
string iotHubHostName,
TwinState initialTwinState,
ProvisioningStatus? provisioningStatus,
DateTime createdDateTimeUtc,
DateTime lastUpdatedDateTimeUtc,
string eTag,
DeviceCapabilities capabilities)
{
if (attestation == null)
{
throw new ProvisioningServiceClientException("Service respond an individualEnrollment without attestation.");
}
try
{
RegistrationId = registrationId;
DeviceId = deviceId;
Attestation = attestation.GetAttestation();
IotHubHostName = iotHubHostName;
InitialTwinState = initialTwinState;
ProvisioningStatus = provisioningStatus;
CreatedDateTimeUtc = createdDateTimeUtc;
LastUpdatedDateTimeUtc = lastUpdatedDateTimeUtc;
ETag = eTag;
Capabilities = capabilities;
}
catch (ArgumentException e)
{
throw new ProvisioningServiceClientException(e);
}
}
/// <summary>
/// Registration Id.
/// </summary>
/// <remarks>
/// A valid registration Id shall be alphanumeric, lowercase, and may contain hyphens. Max characters 128.
/// </remarks>
/// <exception cref="ArgumentException">if the provided string does not fit the registration Id requirements</exception>
[JsonProperty(PropertyName = "registrationId")]
public string RegistrationId { get; private set; }
/// <summary>
/// Desired IoT hub device Id (optional).
/// </summary>
[JsonProperty(PropertyName = "deviceId", DefaultValueHandling = DefaultValueHandling.Ignore)]
public string DeviceId { get; set; }
/// <summary>
/// Current registration state.
/// </summary>
[JsonProperty(PropertyName = "registrationState", DefaultValueHandling = DefaultValueHandling.Ignore)]
public DeviceRegistrationState RegistrationState { get; private set; }
/// <summary>
/// Attestation mechanism.
/// </summary>
[JsonProperty(PropertyName = "attestation")]
private AttestationMechanism _attestation;
/// <summary>
/// Attestation
/// </summary>
[JsonIgnore]
public Attestation Attestation
{
get => _attestation?.GetAttestation();
set
{
if (value is X509Attestation attestation)
{
if ((attestation ?? throw new ArgumentNullException(nameof(value))).ClientCertificates == null
&& attestation.CAReferences == null)
{
throw new ArgumentNullException(nameof(value), "Value does not contain client certificate or CA reference.");
}
}
_attestation = new AttestationMechanism(value);
}
}
/// <summary>
/// Desired IotHub to assign the device to
/// </summary>
[JsonProperty(PropertyName = "iotHubHostName", DefaultValueHandling = DefaultValueHandling.Ignore)]
public string IotHubHostName { get; set; }
/// <summary>
/// Initial twin state.
/// </summary>
[JsonProperty(PropertyName = "initialTwin", DefaultValueHandling = DefaultValueHandling.Ignore)]
public TwinState InitialTwinState { get; set; }
/// <summary>
/// The provisioning status.
/// </summary>
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty(PropertyName = "provisioningStatus", DefaultValueHandling = DefaultValueHandling.Ignore)]
public ProvisioningStatus? ProvisioningStatus { get; set; }
/// <summary>
/// The DateTime this resource was created.
/// </summary>
[JsonProperty(PropertyName = "createdDateTimeUtc", DefaultValueHandling = DefaultValueHandling.Ignore)]
public DateTime? CreatedDateTimeUtc { get; private set; }
/// <summary>
/// The DateTime this resource was last updated.
/// </summary>
[JsonProperty(PropertyName = "lastUpdatedDateTimeUtc", DefaultValueHandling = DefaultValueHandling.Ignore)]
public DateTime? LastUpdatedDateTimeUtc { get; private set; }
/// <summary>
/// Enrollment's ETag
/// </summary>
[JsonProperty(PropertyName = "etag", DefaultValueHandling = DefaultValueHandling.Ignore)]
public string ETag { get; set; }
/// <summary>
/// Capabilities of the device.
/// </summary>
[JsonProperty(PropertyName = "capabilities", DefaultValueHandling = DefaultValueHandling.Ignore)]
public DeviceCapabilities Capabilities { get; set; }
/// <summary>
/// The behavior when a device is re-provisioned to an IoT hub.
/// </summary>
[JsonProperty(PropertyName = "reprovisionPolicy", DefaultValueHandling = DefaultValueHandling.Ignore)]
public ReprovisionPolicy ReprovisionPolicy { get; set; }
/// <summary>
/// Custom allocation definition.
/// </summary>
[JsonProperty(PropertyName = "customAllocationDefinition", DefaultValueHandling = DefaultValueHandling.Ignore)]
public CustomAllocationDefinition CustomAllocationDefinition { get; set; }
/// <summary>
/// The allocation policy of this resource. Overrides the tenant level allocation policy.
/// </summary>
[JsonProperty(PropertyName = "allocationPolicy", DefaultValueHandling = DefaultValueHandling.Ignore)]
public AllocationPolicy? AllocationPolicy { get; set; }
#pragma warning disable CA2227 // Collection properties should be read only. Would change public API.
/// <summary>
/// The list of names of IoT hubs the device in this resource can be allocated to. Must be a subset of tenant level list of IoT hubs
/// </summary>
[JsonProperty(PropertyName = "iotHubs", DefaultValueHandling = DefaultValueHandling.Ignore)]
public ICollection<string> IotHubs { get; set; }
#pragma warning restore CA2227 // Collection properties should be read only
/// <summary>
/// Convert this object in a pretty print format.
/// </summary>
/// <returns>The <c>string</c> with the content of this class in a pretty print format.</returns>
public override string ToString()
{
return JsonConvert.SerializeObject(this, Formatting.Indented);
}
}
}