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