Skip to content

Commit

Permalink
DPS Samples Update (Azure#946)
Browse files Browse the repository at this point in the history 
Update logging for TRUST PEM. Align code with macros ordering.
  • Loading branch information
@momuno
momuno authored Jul 21, 2020
1 parent 6ba9008 commit 9dc24aa
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 59 deletions.
68 changes: 42 additions & 26 deletions sdk/samples/iot/provisioning/src/paho_iot_provisioning_example.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,25 +82,27 @@
(void)printf("\n"); \
}

// Buffers
static char x509_cert_pem_file_path_buffer[256];
static char x509_trust_pem_file_path_buffer[256];
// Store environment variables
static char global_provisioning_endpoint_buffer[256];
static char id_scope_buffer[16];
static char registration_id_buffer[256];
static char mqtt_client_id_buffer[128];
static char mqtt_username_buffer[128];
static char register_publish_topic_buffer[128];
static char query_topic_buffer[256];
static char x509_cert_pem_file_path_buffer[256];
static char x509_trust_pem_file_path_buffer[256];

// Clients
static az_iot_provisioning_client provisioning_client;
static MQTTClient mqtt_client;
static char mqtt_client_id_buffer[128];
static char mqtt_username_buffer[128];

// Topics
static char register_publish_topic_buffer[128];
static char query_topic_buffer[256];

// Functions
static void create_and_configure_client();
static az_result read_environment_variables(
az_span* endpoint,
az_span* global_provisioning_endpoint,
az_span* id_scope,
az_span* registration_id);
static az_result read_configuration_entry(
Expand Down Expand Up @@ -150,19 +152,21 @@ int main()
static void create_and_configure_client()
{
int rc;
az_span endpoint;
az_span global_provisioning_endpoint;
az_span id_scope;
az_span registration_id;

if (az_failed(rc = read_environment_variables(&endpoint, &id_scope, &registration_id)))
if (az_failed(
rc
= read_environment_variables(&global_provisioning_endpoint, &id_scope, &registration_id)))
{
LOG_ERROR("Failed to read evironment variables: az_result return code 0x%04x.", rc);
exit(rc);
}

if (az_failed(
rc = az_iot_provisioning_client_init(
&provisioning_client, endpoint, id_scope, registration_id, NULL)))
&provisioning_client, global_provisioning_endpoint, id_scope, registration_id, NULL)))
{
LOG_ERROR("Failed to initialize provisioning client: az_result return code 0x%04x.", rc);
exit(rc);
Expand All @@ -178,7 +182,7 @@ static void create_and_configure_client()

if ((rc = MQTTClient_create(
&mqtt_client,
(char*)az_span_ptr(endpoint),
(char*)az_span_ptr(global_provisioning_endpoint),
mqtt_client_id_buffer,
MQTTCLIENT_PERSISTENCE_NONE,
NULL))
Expand All @@ -190,27 +194,18 @@ static void create_and_configure_client()
}

static az_result read_environment_variables(
az_span* endpoint,
az_span* global_provisioning_endpoint,
az_span* id_scope,
az_span* registration_id)
{
// Certification variables
az_span device_cert = AZ_SPAN_FROM_BUFFER(x509_cert_pem_file_path_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_DEVICE_X509_CERT_PEM_FILE_PATH, NULL, false, device_cert, &device_cert));

az_span trusted_cert = AZ_SPAN_FROM_BUFFER(x509_trust_pem_file_path_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_DEVICE_X509_TRUST_PEM_FILE_PATH, "", false, trusted_cert, &trusted_cert));

// Connection variables
*endpoint = AZ_SPAN_FROM_BUFFER(global_provisioning_endpoint_buffer);
*global_provisioning_endpoint = AZ_SPAN_FROM_BUFFER(global_provisioning_endpoint_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_GLOBAL_PROVISIONING_ENDPOINT,
ENV_GLOBAL_PROVISIONING_ENDPOINT_DEFAULT,
false,
*endpoint,
endpoint));
*global_provisioning_endpoint,
global_provisioning_endpoint));

*id_scope = AZ_SPAN_FROM_BUFFER(id_scope_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(ENV_ID_SCOPE_ENV, NULL, false, *id_scope, id_scope));
Expand All @@ -219,6 +214,23 @@ static az_result read_environment_variables(
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_REGISTRATION_ID_ENV, NULL, false, *registration_id, registration_id));

// Certification variables
az_span x509_cert_pem_file_path = AZ_SPAN_FROM_BUFFER(x509_cert_pem_file_path_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_DEVICE_X509_CERT_PEM_FILE_PATH,
NULL,
false,
x509_cert_pem_file_path,
&x509_cert_pem_file_path));

az_span x509_trust_pem_file_path = AZ_SPAN_FROM_BUFFER(x509_trust_pem_file_path_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_DEVICE_X509_TRUST_PEM_FILE_PATH,
"",
false,
x509_trust_pem_file_path,
&x509_trust_pem_file_path));

LOG(" "); // Log formatting
return AZ_OK;
}
Expand Down Expand Up @@ -282,7 +294,11 @@ static void connect_client_to_provisioning_service()

if ((rc = MQTTClient_connect(mqtt_client, &mqtt_connect_options)) != MQTTCLIENT_SUCCESS)
{
LOG_ERROR("Failed to connect: MQTTClient return code %d.", rc);
LOG_ERROR(
"Failed to connect: MQTTClient return code %d.\n"
"If on Windows, confirm the AZ_IOT_DEVICE_X509_TRUST_PEM_FILE environment variable is set "
"correctly.",
rc);
exit(rc);
}

Expand Down
71 changes: 38 additions & 33 deletions sdk/samples/iot/provisioning/src/paho_iot_provisioning_sas_example.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,22 @@
#include <azure/core/az_span.h>
#include <azure/iot/az_iot_provisioning_client.h>

#define TIMEOUT_MQTT_RECEIVE_MS (60 * 1000)
#define TIMEOUT_MQTT_DISCONNECT_MS (10 * 1000)

#ifdef _MSC_VER
// "'getenv': This function or variable may be unsafe. Consider using _dupenv_s instead."
#pragma warning(disable : 4996)
#endif

// DO NOT MODIFY: Service information
#define ENV_GLOBAL_PROVISIONING_ENDPOINT_DEFAULT "ssl://global.azure-devices-provisioning.net:8883"
#define ENV_GLOBAL_PROVISIONING_ENDPOINT "AZ_IOT_GLOBAL_PROVISIONING_ENDPOINT"
#define ENV_ID_SCOPE "AZ_IOT_ID_SCOPE"

// DO NOT MODIFY: Device information
#define ENV_REGISTRATION_ID_SAS "AZ_IOT_REGISTRATION_ID_SAS"

// DO NOT MODIFY: IoT Provisioning SAS Key
#define ENV_IOT_PROVISIONING_SAS_KEY "AZ_IOT_PROVISIONING_SAS_KEY"
#define ENV_IOT_PROVISIONING_SAS_KEY_DURATION_MINUTES \
Expand All @@ -44,17 +55,6 @@
// This is usually not needed on Linux or Mac but needs to be set on Windows.
#define ENV_DEVICE_X509_TRUST_PEM_FILE_PATH "AZ_IOT_DEVICE_X509_TRUST_PEM_FILE"

// DO NOT MODIFY: Service information
#define ENV_GLOBAL_PROVISIONING_ENDPOINT_DEFAULT "ssl://global.azure-devices-provisioning.net:8883"
#define ENV_GLOBAL_PROVISIONING_ENDPOINT "AZ_IOT_GLOBAL_PROVISIONING_ENDPOINT"
#define ENV_ID_SCOPE "AZ_IOT_ID_SCOPE"

// DO NOT MODIFY: Device information
#define ENV_REGISTRATION_ID_SAS "AZ_IOT_REGISTRATION_ID_SAS"

#define TIMEOUT_MQTT_RECEIVE_MS (60 * 1000)
#define TIMEOUT_MQTT_DISCONNECT_MS (10 * 1000)

// Logging with formatting
#define LOG_ERROR(...) \
{ \
Expand Down Expand Up @@ -88,13 +88,13 @@
}

// Store environment variables
static char global_provisioning_endpoint_buffer[256];
static char id_scope_buffer[16];
static char registration_id_buffer[256];
static char iot_provisioning_sas_key_buffer[128];
static az_span iot_provisioning_sas_key;
static uint32_t iot_provisioning_sas_key_duration;
static char x509_trust_pem_file_path_buffer[256];
static char global_provisioning_endpoint_buffer[256];
static char id_scope_buffer[16];
static char registration_id_buffer[256];

// Generate SAS key variables
static char sas_signature_buffer[128];
Expand All @@ -109,13 +109,14 @@ static MQTTClient mqtt_client;
static char mqtt_client_id_buffer[128];
static char mqtt_client_username_buffer[128];

// Topics
static char register_publish_topic_buffer[128];
static char query_topic_buffer[256];

// Functions
static void create_and_configure_client();
static az_result read_environment_variables(
az_span* endpoint,
az_span* global_provisioning_endpoint,
az_span* id_scope,
az_span* registration_id);
static az_result read_configuration_entry(
Expand Down Expand Up @@ -218,7 +219,23 @@ static az_result read_environment_variables(
az_span* id_scope,
az_span* registration_id)
{
// Certification and SAS variables
// Connection variables
*global_provisioning_endpoint = AZ_SPAN_FROM_BUFFER(global_provisioning_endpoint_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_GLOBAL_PROVISIONING_ENDPOINT,
ENV_GLOBAL_PROVISIONING_ENDPOINT_DEFAULT,
false,
*global_provisioning_endpoint,
global_provisioning_endpoint));

*id_scope = AZ_SPAN_FROM_BUFFER(id_scope_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(ENV_ID_SCOPE, NULL, false, *id_scope, id_scope));

*registration_id = AZ_SPAN_FROM_BUFFER(registration_id_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_REGISTRATION_ID_SAS, NULL, false, *registration_id, registration_id));

// SAS and Certification variables
iot_provisioning_sas_key = AZ_SPAN_FROM_BUFFER(iot_provisioning_sas_key_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_IOT_PROVISIONING_SAS_KEY,
Expand All @@ -241,22 +258,6 @@ static az_result read_environment_variables(
x509_trust_pem_file_path,
&x509_trust_pem_file_path));

// Connection variables
*global_provisioning_endpoint = AZ_SPAN_FROM_BUFFER(global_provisioning_endpoint_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_GLOBAL_PROVISIONING_ENDPOINT,
ENV_GLOBAL_PROVISIONING_ENDPOINT_DEFAULT,
false,
*global_provisioning_endpoint,
global_provisioning_endpoint));

*id_scope = AZ_SPAN_FROM_BUFFER(id_scope_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(ENV_ID_SCOPE, NULL, false, *id_scope, id_scope));

*registration_id = AZ_SPAN_FROM_BUFFER(registration_id_buffer);
AZ_RETURN_IF_FAILED(read_configuration_entry(
ENV_REGISTRATION_ID_SAS, NULL, false, *registration_id, registration_id));

LOG(" "); // Log formatting
return AZ_OK;
}
Expand Down Expand Up @@ -400,7 +401,11 @@ static void connect_client_to_provisioning_service()

if ((rc = MQTTClient_connect(mqtt_client, &mqtt_connect_options)) != MQTTCLIENT_SUCCESS)
{
LOG_ERROR("Failed to connect: MQTTClient return code %d.", rc);
LOG_ERROR(
"Failed to connect: MQTTClient return code %d.\n"
"If on Windows, confirm the AZ_IOT_DEVICE_X509_TRUST_PEM_FILE environment variable is set "
"correctly.",
rc);
exit(rc);
}

Expand Down

0 comments on commit 9dc24aa

Please sign in to comment.