Configuration settings of the HTTPS Client tests.
Configuration settings are C pre-processor constants. They can be set with a #define in the iot_config.h or by using a compiler option such as -D in gcc. If a configuration setting is not defined, the library will use a "sensible" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed.

The settings on this page only affect the HTTPS Client tests. In addition to the settings on this page, the HTTPS Client tests will also be affected by settings that affect all tests.

configpagemarker

IOT_TEST_HTTPS_SERVER_HOST_NAME

The HTTP server used for this test.

This server needs to accept methods HEAD, GET, POST, and PUT. This server needs to send some data on a GET request. It can be a simple HTTP echo server.

Possible values: Any server host name string. This host name must not include "https://" or "http://" in the name.
Default value (if undefined): "httpbin.org"

IOT_TEST_HTTPS_PORT

The socket port number of the server to connect to.

Possible values: Any positive integer up to 2^16.
Default value (if undefined): 443

IOT_TEST_HTTPS_ALPN_PROTOCOLS

APLN protocol string if necessary to connect to a secure testing server configured in IOT_TEST_HTTPS_SERVER_HOST_NAME.

This is a comma separated list of protocol. Please see Transport Layer Security (TLS) Application-Layer Protocol Negotiation Extension for more information.

Possible values: A comma separated string of ALPN protocol names or NULL. An empty string is not allowed.
Default value (if undefined): NULL

IOT_TEST_HTTPS_ROOT_CA

Root certificate authority to verify the server that the HTTPS_Client_System tests are connecting to.

Possible values: A valid PEM encoded certificate string.
Default value (if undefined): NULL

IOT_TEST_HTTPS_CLIENT_CERTIFICATE

The client certificate used in TLS negotiation with the test HTTP server configured in IOT_TEST_HTTPS_SERVER_HOST_NAME.

With PKCS #11 provisioning of the keys these parameters are deprecated.

Possible values: A valid RSA-2048 or ECC-P256 PEM encoded certificate string.
Default value (if undefined): The system provisioned client certificate.

IOT_TEST_HTTPS_CLIENT_PRIVATE_KEY

The client private key used in TLS negotiation with the test HTTP server configured in IOT_TEST_HTTPS_SERVER_HOST_NAME.

With PKCS #11 provisioning of the keys these parameters are deprecated.

Possible values: A valid RSA-2048 or ECC-P256 PEM encoded private key string.
Default value (if undefined): The system provisioned client private key.

IOT_TEST_HTTPS_SYNC_TIMEOUT_MS

Timeout in milliseconds for tests that synchronously send HTTP requests.

This timeout encompasses the waiting time for the both sending of the request and receiving the response.

Possible values: Any positive integer.
Default value (if undefined): 60000

IOT_TEST_HTTPS_ASYNC_TIMEOUT_MS

Timeout in milliseconds for tests asynchronously send HTTP requests.

This timeout encompasses the waiting time for the both sending of the request and receiving the response.

Possible values: Any positive integer.
Default value (if undefined): 60000

IOT_TEST_HTTPS_INITIAL_CONNECTION_RETRY_DELAY

The initial delay in milliseconds that is doubled each retry of server connection.

Possible values: Any positive integer.
Default value (if undefined): 300

IOT_TEST_HTTPS_CONNECTION_NUM_RETRIES

The amount of times to retry the server connection if it fails.

Possible values: Any positive integer.
Default value (if undefined): 3