resource/csdk/security/provisioning/include/pmutility.h

   1 /* *****************************************************************
   2  *
   3  * Copyright 2015 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * *****************************************************************/
  20
  21 #ifndef _PM_UTILITY_H_
  22 #define _PM_UTILITY_H_
  23
  24 #include <stdbool.h>
  25 #include "ocstack.h"
  26 #include "pmtypes.h"
  27
  28 #ifdef __cplusplus
  29 extern "C"
  30 {
  31 #endif
  32
  33 #define DEFAULT_SECURE_PORT 5684
  34
  35 #define COAPS_PREFIX "coaps://"
  36 #define COAP_PREFIX "coap://"
  37 #define COAPS_QUERY "coaps://%s:%d%s"
  38 #define COAP_QUERY "coap://%s:%d%s"
  39
  40 #define COAP_TCP_PREFIX "coap+tcp://"
  41 #define COAPS_TCP_PREFIX "coaps+tcp://"
  42
  43 /**
  44  * Discover owned/unowned devices in the specified endpoint.
  45  * It will return when found one or more device even though timeout is not exceeded
  46  *
  47  * @param[in] waittime           Timeout in seconds
  48  * @param[in] host               address of target endpoint
  49  * @param[in] connType           connectivity type of endpoint
  50  * @param[out] ppDevicesList      List of OCProvisionDev_t
  51  *
  52  * @return OC_STACK_OK on success otherwise error.
  53  */
  54 OCStackResult PMSingleDeviceDiscovery(unsigned short waittime, const char* host,
  55                                  OCConnectivityType connType, OCProvisionDev_t **ppDevicesList);
  56
  57 /**
  58  * Discover owned/unowned devices in the same IP subnet. .
  59  *
  60  * @param[in] waittime      Timeout in seconds.
  61  * @param[in] isOwned       bool flag for owned / unowned discovery
  62  * @param[in] ppList        List of OCProvisionDev_t.
  63  *
  64  * @return OC_STACK_OK on success otherwise error.
  65  */
  66 OCStackResult PMDeviceDiscovery(unsigned short waittime, bool isOwned, OCProvisionDev_t **ppList);
  67
  68 /**
  69  * This function deletes list of provision target devices
  70  *
  71  * @param[in] pList         List of OCProvisionDev_t.
  72  */
  73 void PMDeleteDeviceList(OCProvisionDev_t *pList);
  74
  75 /**
  76  * Timeout implementation for secure discovery. When performing secure discovery,
  77  * we should wait a certain period of time for getting response of each devices.
  78  *
  79  * @param[in]  waittime  Timeout in seconds.
  80  * @param[in]  waitForStackResponse if true timeout function will call OCProcess while waiting.
  81  * @return OC_STACK_OK on success otherwise error.
  82  */
  83 OCStackResult PMTimeout(unsigned short waittime, bool waitForStackResponse);
  84
  85 /**
  86  * Function to clone OCProvisionDev_t
  87  *
  88  * @param[in] src pointer of OCProvisionDev_t to be copied.
  89  *
  90  * @return copied OCProvisionDev_t on success otherwise NULL.
  91  */
  92 OCProvisionDev_t* PMCloneOCProvisionDev(const OCProvisionDev_t* src);
  93
  94
  95 /**
  96  * Function to generate qurey for coap/coaps request.
  97  *
  98  * @param[in] isSeucre Choose whether to encrypt the payload.
  99  * @param[in] address Network address of remote device
 100  * @param[in] port Port number
 101  * @param[in] connType Connectivity type of remote device
 102  * @param[in,out] buffer A buffer to save the query.
 103  * @param[in] bufferSize Size of buffer
 104  * @param[in] uri The resource URI
 105  *
 106  * @return true on success
 107  */
 108 bool PMGenerateQuery(bool isSecure,
 109                      const char* address, uint16_t port,
 110                      OCConnectivityType connType,
 111                      char* buffer, size_t bufferSize, const char* uri);
 112
 113 /**
 114  * Function to print OCProvisionDev_t for debug purpose.
 115  *
 116  * @param[in] pDev Pointer to OCProvisionDev_t. It's information will be printed by OIC_LOG_XX
 117  *
 118  */
 119 void PMPrintOCProvisionDev(const OCProvisionDev_t* pDev);
 120
 121 /** Function to delete matched UUID from the UUIDlist.
 122  *
 123  * @param[in] pUuidList a pointer to UUID list.
 124  * @param[in] targetId  a pointer to UUID to be deleted in the list.
 125  *
 126  * @return true when deletion is happened, false when no deletion is occured. In case either of
 127  * two arguments is null it will return false.
 128  */
 129 bool PMDeleteFromUUIDList(OCUuidList_t **pUuidList, OicUuid_t *targetId);
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134 #endif //_PM_UTILITY_H_