aws_iot_provisioning.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef AWS_IOT_PROVISIONING_H_
#define AWS_IOT_PROVISIONING_H_

/* The config header is always included first. */
#include "iot_config.h"

/* Provisioning types include. */
#include "types/aws_iot_provisioning_types.h"

/* MQTT Types */
#include "types/iot_mqtt_types.h"

/*------------------------- AWS Provisioning library functions --------------------------*/

/* @[declare_provisioning_init] */
AwsIotProvisioningError_t AwsIotProvisioning_Init( uint32_t mqttTimeout );
/* @[declare_provisioning_init] */

/* @[declare_provisioning_createkeysandcertificate] */
AwsIotProvisioningError_t AwsIotProvisioning_CreateKeysAndCertificate( IotMqttConnection_t connection,
                                                                       uint32_t flags,
                                                                       uint32_t timeoutMs,
                                                                       const AwsIotProvisioningCreateKeysAndCertificateCallbackInfo_t * pResponseCallback );
/* @[declare_provisioning_createkeysandcertificate] */

/* @[declare_provisioning_createcertificatefromcsr] */
AwsIotProvisioningError_t AwsIotProvisioning_CreateCertificateFromCsr( IotMqttConnection_t connection,
                                                                       IotMqttQos_t operationQos,
                                                                       const char * pCertificateSigningRequest,
                                                                       size_t csrLength,
                                                                       uint32_t timeoutMs,
                                                                       const AwsIotProvisioningCreateCertFromCsrCallbackInfo_t * pResponseCallback );
/* @[declare_provisioning_createcertificatefromcsr] */

/* @[declare_provisioning_registerthing] */

AwsIotProvisioningError_t AwsIotProvisioning_RegisterThing( IotMqttConnection_t connection,
                                                            const AwsIotProvisioningRegisterThingRequestInfo_t * pProvisioningDataInfo,
                                                            uint32_t timeoutMs,
                                                            const AwsIotProvisioningRegisterThingCallbackInfo_t * pResponseCallback );
/* @[declare_provisioning_registerthing] */


/* @[declare_provisioning_cleanup] */
void AwsIotProvisioning_Cleanup( void );
/* @[declare_provisioning_cleanup] */

/*------------------------- Provisioning helper functions -------------------------*/

/* @[declare_provisioning_strerror] */
const char * AwsIotProvisioning_strerror( AwsIotProvisioningError_t status );
/* @[declare_provisioning_strerror] */

#endif /* ifndef AWS_IOT_PROVISIONING_H_ */