resource/csdk/stack/samples/linux/secure/occlientbasicops.cpp

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH 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 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <signal.h>
  25 #include <unistd.h>
  26 #include <iostream>
  27 #include <sstream>
  28 #include "ocstack.h"
  29 #include "logger.h"
  30 #include "occlientbasicops.h"
  31 #include "cJSON.h"
  32 #include "common.h"
  33
  34 #define TAG "occlientbasicops"
  35 static int UNICAST_DISCOVERY = 0;
  36 static int TEST_CASE = 0;
  37
  38 static int IPV4_ADDR_SIZE = 16;
  39 static char UNICAST_DISCOVERY_QUERY[] = "coap://%s:5298/oc/core";
  40 static char MULTICAST_DISCOVERY_QUERY[] = "/oc/core";
  41
  42 static std::string putPayload = "{\"state\":\"off\",\"power\":10}";
  43 static std::string coapServerIP;
  44 static std::string coapServerPort;
  45 static std::string coapServerResource;
  46 static int coapSecureResource;
  47 static OCConnectivityType ocConnType;
  48
  49
  50 //File containing Client's Identity and the PSK credentials
  51 //of other devices which the client trusts
  52 //This can be generated using 'gen_sec_bin' application
  53 static char CRED_FILE[] = "client_cred.bin";
  54
  55
  56 int gQuitFlag = 0;
  57
  58 /* SIGINT handler: set gQuitFlag to 1 for graceful termination */
  59 void handleSigInt(int signum)
  60 {
  61     if (signum == SIGINT)
  62     {
  63         gQuitFlag = 1;
  64     }
  65 }
  66
  67 static void PrintUsage()
  68 {
  69     OC_LOG(INFO, TAG, "Usage : occlient -u <0|1> -t <1|2|3>");
  70     OC_LOG(INFO, TAG, "-u <0|1> : Perform multicast/unicast discovery of resources");
  71     OC_LOG(INFO, TAG, "-t 1 : Discover Resources");
  72     OC_LOG(INFO, TAG, "-t 2 : Discover Resources and"
  73             " Initiate Nonconfirmable Get/Put/Post Requests");
  74     OC_LOG(INFO, TAG, "-t 3 : Discover Resources and Initiate Confirmable Get/Put/Post Requests");
  75 }
  76
  77 OCStackResult InvokeOCDoResource(std::ostringstream &query,
  78         OCMethod method, OCQualityOfService qos,
  79         OCClientResponseHandler cb, OCHeaderOption * options, uint8_t numOptions)
  80 {
  81     OCStackResult ret;
  82     OCCallbackData cbData;
  83     OCDoHandle handle;
  84
  85     cbData.cb = cb;
  86     cbData.context = NULL;
  87     cbData.cd = NULL;
  88
  89     ret = OCDoResource(&handle, method, query.str().c_str(), 0,
  90             (method == OC_REST_PUT || method == OC_REST_POST) ? putPayload.c_str() : NULL,
  91             ocConnType, qos, &cbData, options, numOptions);
  92
  93     if (ret != OC_STACK_OK)
  94     {
  95         OC_LOG_V(ERROR, TAG, "OCDoResource returns error %d with method %d", ret, method);
  96     }
  97
  98     return ret;
  99 }
 100
 101 OCStackApplicationResult putReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse)
 102 {
 103     OC_LOG(INFO, TAG, "Callback Context for PUT recvd successfully");
 104
 105     if(clientResponse)
 106     {
 107         OC_LOG_V(INFO, TAG, "StackResult: %s",  getResult(clientResponse->result));
 108         OC_LOG_V(INFO, TAG, "JSON = %s =============> Put Response", clientResponse->resJSONPayload);
 109     }
 110     return OC_STACK_DELETE_TRANSACTION;
 111 }
 112
 113 OCStackApplicationResult postReqCB(void *ctx, OCDoHandle handle, OCClientResponse *clientResponse)
 114 {
 115     OC_LOG(INFO, TAG, "Callback Context for POST recvd successfully");
 116
 117     if(clientResponse)
 118     {
 119         OC_LOG_V(INFO, TAG, "StackResult: %s",  getResult(clientResponse->result));
 120         OC_LOG_V(INFO, TAG, "JSON = %s =============> Post Response",
 121                 clientResponse->resJSONPayload);
 122     }
 123     return OC_STACK_DELETE_TRANSACTION;
 124 }
 125
 126 OCStackApplicationResult getReqCB(void* ctx, OCDoHandle handle, OCClientResponse * clientResponse)
 127 {
 128     OC_LOG(INFO, TAG, "Callback Context for GET query recvd successfully");
 129
 130     if(clientResponse)
 131     {
 132         OC_LOG_V(INFO, TAG, "StackResult: %s",  getResult(clientResponse->result));
 133         OC_LOG_V(INFO, TAG, "SEQUENCE NUMBER: %d", clientResponse->sequenceNumber);
 134         OC_LOG_V(INFO, TAG, "JSON = %s =============> Get Response",
 135                 clientResponse->resJSONPayload);
 136     }
 137     return OC_STACK_DELETE_TRANSACTION;
 138 }
 139
 140 // This is a function called back when a device is discovered
 141 OCStackApplicationResult discoveryReqCB(void* ctx, OCDoHandle handle,
 142         OCClientResponse * clientResponse)
 143 {
 144     uint8_t remoteIpAddr[4];
 145     uint16_t remotePortNu;
 146
 147     OC_LOG(INFO, TAG, "Callback Context for DISCOVER query recvd successfully");
 148
 149     if (clientResponse)
 150     {
 151         OC_LOG_V(INFO, TAG, "StackResult: %s", getResult(clientResponse->result));
 152
 153         OCDevAddrToIPv4Addr((OCDevAddr *) clientResponse->addr, remoteIpAddr,
 154                 remoteIpAddr + 1, remoteIpAddr + 2, remoteIpAddr + 3);
 155         OCDevAddrToPort((OCDevAddr *) clientResponse->addr, &remotePortNu);
 156
 157         OC_LOG_V(INFO, TAG,
 158                 "Device =============> Discovered %s @ %d.%d.%d.%d:%d",
 159                 clientResponse->resJSONPayload, remoteIpAddr[0], remoteIpAddr[1],
 160                 remoteIpAddr[2], remoteIpAddr[3], remotePortNu);
 161
 162         ocConnType = clientResponse->connType;
 163
 164         if (parseClientResponse(clientResponse) != -1)
 165         {
 166             switch(TEST_CASE)
 167             {
 168                 case TEST_NON_CON_OP:
 169                     InitGetRequest(OC_LOW_QOS);
 170                     InitPutRequest();
 171                     //InitPostRequest(OC_LOW_QOS);
 172                     break;
 173                 case TEST_CON_OP:
 174                     InitGetRequest(OC_HIGH_QOS);
 175                     InitPutRequest();
 176                     //InitPostRequest(OC_HIGH_QOS);
 177                     break;
 178             }
 179         }
 180     }
 181
 182     return (UNICAST_DISCOVERY) ? OC_STACK_DELETE_TRANSACTION : OC_STACK_KEEP_TRANSACTION ;
 183
 184 }
 185
 186 int InitPutRequest()
 187 {
 188     OC_LOG_V(INFO, TAG, "\n\nExecuting %s", __func__);
 189     std::ostringstream query;
 190     query << (coapSecureResource ? "coaps://" : "coap://") << coapServerIP
 191         << ":" << coapServerPort  << coapServerResource;
 192     return (InvokeOCDoResource(query, OC_REST_PUT, OC_LOW_QOS, putReqCB, NULL, 0));
 193 }
 194
 195 int InitPostRequest(OCQualityOfService qos)
 196 {
 197     OCStackResult result;
 198     OC_LOG_V(INFO, TAG, "\n\nExecuting %s", __func__);
 199     std::ostringstream query;
 200     query << (coapSecureResource ? "coaps://" : "coap://") << coapServerIP
 201         << ":" << coapServerPort << coapServerResource;
 202
 203     // First POST operation (to create an LED instance)
 204     result = InvokeOCDoResource(query, OC_REST_POST,
 205             ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
 206             postReqCB, NULL, 0);
 207     if (OC_STACK_OK != result)
 208     {
 209         // Error can happen if for example, network connectivity is down
 210         OC_LOG(INFO, TAG, "First POST call did not succeed");
 211     }
 212
 213     // Second POST operation (to create an LED instance)
 214     result = InvokeOCDoResource(query, OC_REST_POST,
 215             ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
 216             postReqCB, NULL, 0);
 217     if (OC_STACK_OK != result)
 218     {
 219         OC_LOG(INFO, TAG, "Second POST call did not succeed");
 220     }
 221
 222     // This POST operation will update the original resourced /a/led
 223     return (InvokeOCDoResource(query, OC_REST_POST,
 224                 ((qos == OC_HIGH_QOS) ? OC_HIGH_QOS: OC_LOW_QOS),
 225                 postReqCB, NULL, 0));
 226 }
 227
 228 int InitGetRequest(OCQualityOfService qos)
 229 {
 230     OC_LOG_V(INFO, TAG, "\n\nExecuting %s", __func__);
 231     std::ostringstream query;
 232     query << (coapSecureResource ? "coaps://" : "coap://") << coapServerIP
 233         << ":" << coapServerPort << coapServerResource;
 234
 235     return (InvokeOCDoResource(query, OC_REST_GET, (qos == OC_HIGH_QOS)?
 236             OC_HIGH_QOS:OC_LOW_QOS, getReqCB, NULL, 0));
 237 }
 238
 239 int InitDiscovery()
 240 {
 241     OCStackResult ret;
 242     OCCallbackData cbData;
 243     OCDoHandle handle;
 244     char szQueryUri[MAX_URI_LENGTH] = { 0 };
 245     OCConnectivityType discoveryReqConnType;
 246
 247     if (UNICAST_DISCOVERY)
 248     {
 249         char ipv4addr[IPV4_ADDR_SIZE];
 250         printf("Enter IPv4 address of the Server hosting secure resource (Ex: 11.12.13.14)\n");
 251         if (fgets(ipv4addr, IPV4_ADDR_SIZE, stdin))
 252         {
 253             //Strip newline char from ipv4addr
 254             StripNewLineChar(ipv4addr);
 255             snprintf(szQueryUri, sizeof(szQueryUri), UNICAST_DISCOVERY_QUERY, ipv4addr);
 256         }
 257         else
 258         {
 259             OC_LOG(ERROR, TAG, "!! Bad input for IPV4 address. !!");
 260             return OC_STACK_INVALID_PARAM;
 261         }
 262         printf("Select Connectivity type on which discovery request needs to be send : ");
 263         printf("0:ETH, 1:WIFI\n");
 264         discoveryReqConnType = ((getchar() - '0') == 0) ? OC_ETHERNET : OC_WIFI;
 265     }
 266     else
 267     {
 268         //Send discovery request on Wifi and Ethernet interface
 269         discoveryReqConnType = OC_ALL;
 270         strcpy(szQueryUri, MULTICAST_DISCOVERY_QUERY);
 271     }
 272
 273     cbData.cb = discoveryReqCB;
 274     cbData.context = NULL;
 275     cbData.cd = NULL;
 276
 277     /* Start a discovery query*/
 278     OC_LOG_V(INFO, TAG, "Initiating %s Resource Discovery : %s\n",
 279         (UNICAST_DISCOVERY) ? "Unicast" : "Multicast",
 280         szQueryUri);
 281
 282     ret = OCDoResource(&handle, OC_REST_GET, szQueryUri, 0, 0,
 283             discoveryReqConnType, OC_LOW_QOS, &cbData, NULL, 0);
 284     if (ret != OC_STACK_OK)
 285     {
 286         OC_LOG(ERROR, TAG, "OCStack resource error");
 287     }
 288     return ret;
 289 }
 290
 291 int main(int argc, char* argv[])
 292 {
 293     int opt;
 294     struct timespec timeout;
 295
 296     while ((opt = getopt(argc, argv, "u:t:")) != -1)
 297     {
 298         switch(opt)
 299         {
 300             case 'u':
 301                 UNICAST_DISCOVERY = atoi(optarg);
 302                 break;
 303             case 't':
 304                 TEST_CASE = atoi(optarg);
 305                 break;
 306             default:
 307                 PrintUsage();
 308                 return -1;
 309         }
 310     }
 311
 312     if ((UNICAST_DISCOVERY != 0 && UNICAST_DISCOVERY != 1) ||
 313             (TEST_CASE < TEST_DISCOVER_REQ || TEST_CASE >= MAX_TESTS) )
 314     {
 315         PrintUsage();
 316         return -1;
 317     }
 318
 319     /* Initialize OCStack*/
 320     if (OCInit(NULL, 0, OC_CLIENT) != OC_STACK_OK)
 321     {
 322         OC_LOG(ERROR, TAG, "OCStack init error");
 323         return 0;
 324     }
 325
 326     /*
 327      * Read DTLS PSK credentials from persistent storage and
 328      * set in the OC stack.
 329      */
 330     if (SetCredentials(CRED_FILE) != OC_STACK_OK)
 331     {
 332         OC_LOG(ERROR, TAG, "SetCredentials failed");
 333         return 0;
 334     }
 335
 336     InitDiscovery();
 337
 338     timeout.tv_sec  = 0;
 339     timeout.tv_nsec = 100000000L;
 340
 341     // Break from loop with Ctrl+C
 342     OC_LOG(INFO, TAG, "Entering occlient main loop...");
 343     signal(SIGINT, handleSigInt);
 344     while (!gQuitFlag)
 345     {
 346         if (OCProcess() != OC_STACK_OK)
 347         {
 348             OC_LOG(ERROR, TAG, "OCStack process error");
 349             return 0;
 350         }
 351
 352         nanosleep(&timeout, NULL);
 353     }
 354     OC_LOG(INFO, TAG, "Exiting occlient main loop...");
 355
 356     if (OCStop() != OC_STACK_OK)
 357     {
 358         OC_LOG(ERROR, TAG, "OCStack stop error");
 359     }
 360
 361     return 0;
 362 }
 363
 364 std::string getIPAddrTBServer(OCClientResponse * clientResponse)
 365 {
 366     if(!clientResponse) return "";
 367     if(!clientResponse->addr) return "";
 368     uint8_t a, b, c, d = 0;
 369     if(0 != OCDevAddrToIPv4Addr(clientResponse->addr, &a, &b, &c, &d) ) return "";
 370
 371     char ipaddr[16] = {'\0'};
 372     // ostringstream not working correctly here, hence snprintf
 373     snprintf(ipaddr,  sizeof(ipaddr), "%d.%d.%d.%d", a,b,c,d);
 374     return std::string (ipaddr);
 375 }
 376
 377
 378 std::string getPortTBServer(OCClientResponse * clientResponse)
 379 {
 380     if(!clientResponse) return "";
 381     if(!clientResponse->addr) return "";
 382     uint16_t p = 0;
 383     if(0 != OCDevAddrToPort(clientResponse->addr, &p) ) return "";
 384     std::ostringstream ss;
 385     ss << p;
 386     return ss.str();
 387 }
 388
 389 int parseClientResponse(OCClientResponse * clientResponse)
 390 {
 391     int port = -1;
 392     cJSON * root = NULL;
 393     cJSON * oc = NULL;
 394
 395     // Initialize all global variables
 396     coapServerResource.clear();
 397     coapServerPort.clear();
 398     coapServerIP.clear();
 399     coapSecureResource = 0;
 400
 401     root = cJSON_Parse((char *)(clientResponse->resJSONPayload));
 402     if (!root)
 403     {
 404         return -1;
 405     }
 406
 407     oc = cJSON_GetObjectItem(root,"oc");
 408     if (!oc)
 409     {
 410         return -1;
 411     }
 412
 413     if (oc->type == cJSON_Array)
 414     {
 415         if (cJSON_GetArraySize(oc) > 0)
 416         {
 417             cJSON * resource = cJSON_GetArrayItem(oc, 0);
 418             if (cJSON_GetObjectItem(resource, "href"))
 419             {
 420                 coapServerResource.assign(cJSON_GetObjectItem(resource, "href")->valuestring);
 421             }
 422             else
 423             {
 424                 coapServerResource = "";
 425             }
 426             OC_LOG_V(INFO, TAG, "Uri -- %s", coapServerResource.c_str());
 427
 428             cJSON * prop = cJSON_GetObjectItem(resource,"prop");
 429             if (prop)
 430             {
 431                 // If this is a secure resource, the info about the port at which the
 432                 // resource is hosted on server is embedded inside discovery JSON response
 433                 if (cJSON_GetObjectItem(prop, "sec"))
 434                 {
 435                     if ((cJSON_GetObjectItem(prop, "sec")->valueint) == 1)
 436                     {
 437                         coapSecureResource = 1;
 438                     }
 439                 }
 440                 OC_LOG_V(INFO, TAG, "Secure -- %s", coapSecureResource == 1 ? "YES" : "NO");
 441                 if (cJSON_GetObjectItem(prop, "port"))
 442                 {
 443                     port = cJSON_GetObjectItem(prop, "port")->valueint;
 444                     OC_LOG_V(INFO, TAG, "Hosting Server Port (embedded inside JSON) -- %u", port);
 445
 446                     std::ostringstream ss;
 447                     ss << port;
 448                     coapServerPort = ss.str();
 449                 }
 450             }
 451         }
 452     }
 453     cJSON_Delete(root);
 454
 455     coapServerIP = getIPAddrTBServer(clientResponse);
 456     if (port == -1)
 457     {
 458         coapServerPort = getPortTBServer(clientResponse);
 459         OC_LOG_V(INFO, TAG, "Hosting Server Port -- %s", coapServerPort.c_str());
 460     }
 461     return 0;
 462 }