/// <summary>
/// Registers a device described by the message.
/// </summary>
/// <param name="message">The provisioning message.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The registration result.</returns>
public async override Task <DeviceRegistrationResult> RegisterAsync(
ProvisioningTransportRegisterMessage message,
CancellationToken cancellationToken)
{
if (Logging.IsEnabled)
{
Logging.Enter(this, $"{nameof(ProvisioningTransportHandlerHttp)}.{nameof(RegisterAsync)}");
}
cancellationToken.ThrowIfCancellationRequested();
try
{
HttpAuthStrategy authStrategy;
if (message.Security is SecurityProviderTpm)
{
authStrategy = new HttpAuthStrategyTpm((SecurityProviderTpm)message.Security);
}
else if (message.Security is SecurityProviderX509)
{
authStrategy = new HttpAuthStrategyX509((SecurityProviderX509)message.Security);
}
else if (message.Security is SecurityProviderSymmetricKey)
{
authStrategy = new HttpAuthStrategySymmetricKey((SecurityProviderSymmetricKey)message.Security);
}
else
{
if (Logging.IsEnabled)
{
Logging.Error(this, $"Invalid {nameof(SecurityProvider)} type.");
}
throw new NotSupportedException(
$"{nameof(message.Security)} must be of type {nameof(SecurityProviderTpm)} " +
$"or {nameof(SecurityProviderX509)}");
}
if (Logging.IsEnabled)
{
Logging.Associate(authStrategy, this);
}
var builder = new UriBuilder()
{
Scheme = Uri.UriSchemeHttps,
Host = message.GlobalDeviceEndpoint,
Port = Port,
};
HttpClientHandler httpClientHandler = new HttpClientHandler();
if (Proxy != DefaultWebProxySettings.Instance)
{
httpClientHandler.UseProxy = (Proxy != null);
httpClientHandler.Proxy = Proxy;
if (Logging.IsEnabled)
{
Logging.Info(this, $"{nameof(RegisterAsync)} Setting HttpClientHandler.Proxy");
}
}
DeviceProvisioningServiceRuntimeClient client = authStrategy.CreateClient(builder.Uri, httpClientHandler);
client.HttpClient.DefaultRequestHeaders.Add("User-Agent", message.ProductInfo);
if (Logging.IsEnabled)
{
Logging.Info(this, $"Uri: {builder.Uri}; User-Agent: {message.ProductInfo}");
}
DeviceRegistration deviceRegistration = authStrategy.CreateDeviceRegistration();
if (message.Payload != null && message.Payload.Length > 0)
{
deviceRegistration.Payload = new JRaw(message.Payload);
}
string registrationId = message.Security.GetRegistrationID();
RegistrationOperationStatus operation =
await client.RuntimeRegistration.RegisterDeviceAsync(
registrationId,
message.IdScope,
deviceRegistration).ConfigureAwait(false);
int attempts = 0;
string operationId = operation.OperationId;
if (Logging.IsEnabled)
{
Logging.RegisterDevice(
this,
registrationId,
message.IdScope,
deviceRegistration.Tpm == null ? "X509" : "TPM",
operation.OperationId,
operation.RetryAfter,
operation.Status);
}
// Poll with operationId until registration complete.
while (string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusAssigning) == 0 ||
string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusUnassigned) == 0)
{
cancellationToken.ThrowIfCancellationRequested();
TimeSpan?serviceRecommendedDelay = operation.RetryAfter;
if (serviceRecommendedDelay != null && serviceRecommendedDelay?.TotalSeconds < s_defaultOperationPoolingIntervalMilliseconds.TotalSeconds)
{
if (Logging.IsEnabled)
{
Logging.Error(this, $"Service recommended unexpected retryAfter of {operation.RetryAfter?.TotalSeconds}, defaulting to delay of {s_defaultOperationPoolingIntervalMilliseconds.ToString()}", nameof(RegisterAsync));
}
serviceRecommendedDelay = s_defaultOperationPoolingIntervalMilliseconds;
}
await Task.Delay(serviceRecommendedDelay ?? RetryJitter.GenerateDelayWithJitterForRetry(s_defaultOperationPoolingIntervalMilliseconds)).ConfigureAwait(false);
cancellationToken.ThrowIfCancellationRequested();
operation = await client.RuntimeRegistration.OperationStatusLookupAsync(
registrationId,
operationId,
message.IdScope).ConfigureAwait(false);
if (Logging.IsEnabled)
{
Logging.OperationStatusLookup(
this,
registrationId,
operation.OperationId,
operation.RetryAfter,
operation.Status,
attempts);
}
attempts++;
}
if (string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusAssigned) == 0)
{
authStrategy.SaveCredentials(operation);
}
return(ConvertToProvisioningRegistrationResult(operation.RegistrationState));
}
catch (HttpOperationException oe)
{
if (Logging.IsEnabled)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} threw exception {oe}",
nameof(RegisterAsync));
}
bool isTransient = oe.Response.StatusCode >= HttpStatusCode.InternalServerError || (int)oe.Response.StatusCode == 429;
try
{
var errorDetails = JsonConvert.DeserializeObject <ProvisioningErrorDetailsHttp>(oe.Response.Content);
throw new ProvisioningTransportException(oe.Response.Content, oe, isTransient, errorDetails);
}
catch (JsonException ex)
{
if (Logging.IsEnabled)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} server returned malformed error response." +
$"Parsing error: {ex}. Server response: {oe.Response.Content}",
nameof(RegisterAsync));
}
throw new ProvisioningTransportException(
$"HTTP transport exception: malformed server error message: '{oe.Response.Content}'",
ex,
false);
}
}
catch (Exception ex) when(!(ex is ProvisioningTransportException))
{
if (Logging.IsEnabled)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} threw exception {ex}",
nameof(RegisterAsync));
}
throw new ProvisioningTransportException($"HTTP transport exception", ex, true);
}
finally
{
if (Logging.IsEnabled)
{
Logging.Exit(this, $"{nameof(ProvisioningTransportHandlerHttp)}.{nameof(RegisterAsync)}");
}
}
}
public async override Task <DeviceRegistrationResult> RegisterAsync(
ProvisioningTransportRegisterMessage message,
CancellationToken cancellationToken)
{
if (Logging.IsEnabled)
{
Logging.Enter(this, $"{nameof(ProvisioningTransportHandlerHttp)}.{nameof(RegisterAsync)}");
}
cancellationToken.ThrowIfCancellationRequested();
try
{
HttpAuthStrategy authStrategy;
if (message.Security is SecurityClientHsmTpm)
{
authStrategy = new HttpAuthStrategyTpm((SecurityClientHsmTpm)message.Security);
}
else if (message.Security is SecurityClientHsmX509)
{
authStrategy = new HttpAuthStrategyX509((SecurityClientHsmX509)message.Security);
}
else
{
if (Logging.IsEnabled)
{
Logging.Error(this, $"Invalid {nameof(SecurityClient)} type.");
}
throw new NotSupportedException(
$"{nameof(message.Security)} must be of type {nameof(SecurityClientHsmTpm)} " +
$"or {nameof(SecurityClientHsmX509)}");
}
if (Logging.IsEnabled)
{
Logging.Associate(authStrategy, this);
}
var builder = new UriBuilder()
{
Scheme = Uri.UriSchemeHttps,
Host = message.GlobalDeviceEndpoint
};
DeviceProvisioningServiceRuntimeClient client = authStrategy.CreateClient(builder.Uri);
client.HttpClient.DefaultRequestHeaders.Add("User-Agent", message.ProductInfo);
if (Logging.IsEnabled)
{
Logging.Info(this, $"Uri: {builder.Uri}; User-Agent: {message.ProductInfo}");
}
DeviceRegistration deviceRegistration = authStrategy.CreateDeviceRegistration();
string registrationId = message.Security.GetRegistrationID();
RegistrationOperationStatus operation =
await client.RuntimeRegistration.RegisterDeviceAsync(
registrationId,
message.IdScope,
deviceRegistration).ConfigureAwait(false);
int attempts = 0;
string operationId = operation.OperationId;
if (Logging.IsEnabled)
{
Logging.RegisterDevice(
this,
registrationId,
message.IdScope,
deviceRegistration.Tpm == null ? "X509" : "TPM",
operation.OperationId,
operation.RetryAfter,
operation.Status);
}
// Poll with operationId until registration complete.
while (string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusAssigning) == 0 ||
string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusUnassigned) == 0)
{
cancellationToken.ThrowIfCancellationRequested();
await Task.Delay(
operation.RetryAfter ??
s_defaultOperationPoolingIntervalMilliseconds).ConfigureAwait(false);
cancellationToken.ThrowIfCancellationRequested();
operation = await client.RuntimeRegistration.OperationStatusLookupAsync(
registrationId,
operationId,
message.IdScope).ConfigureAwait(false);
if (Logging.IsEnabled)
{
Logging.OperationStatusLookup(
this,
registrationId,
operation.OperationId,
operation.RetryAfter,
operation.Status,
attempts);
}
attempts++;
}
if (string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusAssigned) == 0)
{
authStrategy.SaveCredentials(operation);
}
return(ConvertToProvisioningRegistrationResult(operation.RegistrationState));
}
// TODO: Catch only expected exceptions from HTTP and REST.
catch (Exception ex)
{
if (Logging.IsEnabled)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} threw exception {ex}",
nameof(RegisterAsync));
}
// TODO: Extract trackingId from the exception.
throw new ProvisioningTransportException($"HTTP transport exception", true, "", ex);
}
finally
{
if (Logging.IsEnabled)
{
Logging.Exit(this, $"{nameof(ProvisioningTransportHandlerHttp)}.{nameof(RegisterAsync)}");
}
}
}
/// <summary>
/// Registers a device described by the message.
/// </summary>
/// <param name="message">The provisioning message.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>The registration result.</returns>
public async override Task <DeviceRegistrationResult> RegisterAsync(
ProvisioningTransportRegisterMessage message,
CancellationToken cancellationToken)
{
Logging.Enter(this, $"{nameof(ProvisioningTransportHandlerHttp)}.{nameof(RegisterAsync)}");
if (message == null)
{
throw new ArgumentNullException(nameof(message));
}
cancellationToken.ThrowIfCancellationRequested();
try
{
HttpAuthStrategy authStrategy;
switch (message.Security)
{
case SecurityProviderTpm _:
authStrategy = new HttpAuthStrategyTpm((SecurityProviderTpm)message.Security);
break;
case SecurityProviderX509 _:
authStrategy = new HttpAuthStrategyX509((SecurityProviderX509)message.Security);
break;
case SecurityProviderSymmetricKey _:
authStrategy = new HttpAuthStrategySymmetricKey((SecurityProviderSymmetricKey)message.Security);
break;
default:
Logging.Error(this, $"Invalid {nameof(SecurityProvider)} type.");
throw new NotSupportedException(
$"{nameof(message.Security)} must be of type {nameof(SecurityProviderTpm)}, {nameof(SecurityProviderX509)} or {nameof(SecurityProviderSymmetricKey)}");
}
Logging.Associate(authStrategy, this);
var httpClientHandler = new HttpClientHandler
{
// Cannot specify a specific protocol here, as desired due to an error:
// ProvisioningDeviceClient_ValidRegistrationId_AmqpWithProxy_SymmetricKey_RegisterOk_GroupEnrollment failing for me with System.PlatformNotSupportedException: Operation is not supported on this platform.
// When revisiting TLS12 work for DPS, we should figure out why. Perhaps the service needs to support it.
//SslProtocols = TlsVersions.Preferred,
};
if (Proxy != DefaultWebProxySettings.Instance)
{
httpClientHandler.UseProxy = Proxy != null;
httpClientHandler.Proxy = Proxy;
Logging.Info(this, $"{nameof(RegisterAsync)} Setting HttpClientHandler.Proxy");
}
var builder = new UriBuilder
{
Scheme = Uri.UriSchemeHttps,
Host = message.GlobalDeviceEndpoint,
Port = Port,
};
DeviceProvisioningServiceRuntimeClient client = authStrategy.CreateClient(builder.Uri, httpClientHandler);
client.HttpClient.DefaultRequestHeaders.Add("User-Agent", message.ProductInfo);
Logging.Info(this, $"Uri: {builder.Uri}; User-Agent: {message.ProductInfo}");
DeviceRegistration deviceRegistration = authStrategy.CreateDeviceRegistration();
if (message.Payload != null &&
message.Payload.Length > 0)
{
deviceRegistration.Payload = new JRaw(message.Payload);
}
string registrationId = message.Security.GetRegistrationID();
RegistrationOperationStatus operation = await client.RuntimeRegistration
.RegisterDeviceAsync(
registrationId,
message.IdScope,
deviceRegistration)
.ConfigureAwait(false);
int attempts = 0;
string operationId = operation.OperationId;
Logging.RegisterDevice(
this,
registrationId,
message.IdScope,
deviceRegistration.Tpm == null ? "X509" : "TPM",
operation.OperationId,
operation.RetryAfter,
operation.Status);
// Poll with operationId until registration complete.
while (string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusAssigning) == 0 ||
string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusUnassigned) == 0)
{
cancellationToken.ThrowIfCancellationRequested();
TimeSpan?serviceRecommendedDelay = operation.RetryAfter;
if (serviceRecommendedDelay != null &&
serviceRecommendedDelay?.TotalSeconds < s_defaultOperationPoolingIntervalMilliseconds.TotalSeconds)
{
Logging.Error(this, $"Service recommended unexpected retryAfter of {operation.RetryAfter?.TotalSeconds}, defaulting to delay of {s_defaultOperationPoolingIntervalMilliseconds.ToString()}", nameof(RegisterAsync));
serviceRecommendedDelay = s_defaultOperationPoolingIntervalMilliseconds;
}
await Task
.Delay(serviceRecommendedDelay ?? RetryJitter.GenerateDelayWithJitterForRetry(s_defaultOperationPoolingIntervalMilliseconds))
.ConfigureAwait(false);
cancellationToken.ThrowIfCancellationRequested();
try
{
operation = await client
.RuntimeRegistration.OperationStatusLookupAsync(
registrationId,
operationId,
message.IdScope)
.ConfigureAwait(false);
}
catch (HttpOperationException ex)
{
bool isTransient = ex.Response.StatusCode >= HttpStatusCode.InternalServerError ||
(int)ex.Response.StatusCode == 429;
try
{
var errorDetails = JsonConvert.DeserializeObject <ProvisioningErrorDetailsHttp>(ex.Response.Content);
if (isTransient)
{
serviceRecommendedDelay = errorDetails.RetryAfter;
}
else
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} threw exception {ex}",
nameof(RegisterAsync));
throw new ProvisioningTransportException(ex.Response.Content, ex, isTransient, errorDetails);
}
}
catch (JsonException jex)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} server returned malformed error response." +
$"Parsing error: {jex}. Server response: {ex.Response.Content}",
nameof(RegisterAsync));
throw new ProvisioningTransportException(
$"HTTP transport exception: malformed server error message: '{ex.Response.Content}'",
jex,
false);
}
}
Logging.OperationStatusLookup(
this,
registrationId,
operation.OperationId,
operation.RetryAfter,
operation.Status,
attempts);
++attempts;
}
if (string.CompareOrdinal(operation.Status, RegistrationOperationStatus.OperationStatusAssigned) == 0)
{
authStrategy.SaveCredentials(operation);
}
return(ConvertToProvisioningRegistrationResult(operation.RegistrationState));
}
catch (HttpOperationException ex)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} threw exception {ex}",
nameof(RegisterAsync));
bool isTransient = ex.Response.StatusCode >= HttpStatusCode.InternalServerError ||
(int)ex.Response.StatusCode == 429;
try
{
var errorDetails = JsonConvert.DeserializeObject <ProvisioningErrorDetailsHttp>(ex.Response.Content);
throw new ProvisioningTransportException(ex.Response.Content, ex, isTransient, errorDetails);
}
catch (JsonException jex)
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} server returned malformed error response. Parsing error: {jex}. Server response: {ex.Response.Content}",
nameof(RegisterAsync));
throw new ProvisioningTransportException(
$"HTTP transport exception: malformed server error message: '{ex.Response.Content}'",
jex,
false);
}
}
catch (Exception ex) when(!(ex is ProvisioningTransportException))
{
Logging.Error(
this,
$"{nameof(ProvisioningTransportHandlerHttp)} threw exception {ex}",
nameof(RegisterAsync));
throw new ProvisioningTransportException($"HTTP transport exception", ex, true);
}
finally
{
Logging.Exit(this, $"{nameof(ProvisioningTransportHandlerHttp)}.{nameof(RegisterAsync)}");
}
}