| /* |
| * Copyright (c) 2017, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * This file implements a simple CLI for the CoAP service. |
| */ |
| |
| #include <openthread/config.h> |
| |
| #if OPENTHREAD_ENABLE_APPLICATION_COAP |
| |
| #include "cli_coap.hpp" |
| |
| #include <ctype.h> |
| |
| #include "cli/cli.hpp" |
| #include "coap/coap_header.hpp" |
| |
| namespace ot { |
| namespace Cli { |
| |
| void Coap::PrintPayload(otMessage *aMessage) const |
| { |
| uint8_t buf[kMaxBufferSize]; |
| uint16_t bytesToPrint; |
| uint16_t bytesPrinted = 0; |
| uint16_t length = otMessageGetLength(aMessage) - otMessageGetOffset(aMessage); |
| |
| if (length > 0) |
| { |
| mInterpreter.mServer->OutputFormat(" with payload: "); |
| |
| while (length > 0) |
| { |
| bytesToPrint = (length < sizeof(buf)) ? length : sizeof(buf); |
| otMessageRead(aMessage, otMessageGetOffset(aMessage) + bytesPrinted, buf, bytesToPrint); |
| |
| mInterpreter.OutputBytes(buf, static_cast<uint8_t>(bytesToPrint)); |
| |
| length -= bytesToPrint; |
| bytesPrinted += bytesToPrint; |
| } |
| } |
| |
| mInterpreter.mServer->OutputFormat("\r\n"); |
| } |
| |
| otError Coap::Process(int argc, char *argv[]) |
| { |
| otError error = OT_ERROR_NONE; |
| |
| VerifyOrExit(argc > 0, error = OT_ERROR_INVALID_ARGS); |
| |
| if (strcmp(argv[0], "start") == 0) |
| { |
| SuccessOrExit(error = otCoapStart(mInterpreter.mInstance, OT_DEFAULT_COAP_PORT)); |
| mInterpreter.mServer->OutputFormat("Coap service started: "); |
| } |
| else if (strcmp(argv[0], "stop") == 0) |
| { |
| otCoapRemoveResource(mInterpreter.mInstance, &mResource); |
| SuccessOrExit(error = otCoapStop(mInterpreter.mInstance)); |
| mInterpreter.mServer->OutputFormat("Coap service stopped: "); |
| } |
| else if (strcmp(argv[0], "resource") == 0) |
| { |
| mResource.mUriPath = mUriPath; |
| mResource.mContext = this; |
| mResource.mHandler = &Coap::HandleServerResponse; |
| |
| if (argc > 1) |
| { |
| strlcpy(mUriPath, argv[1], kMaxUriLength); |
| SuccessOrExit(error = otCoapAddResource(mInterpreter.mInstance, &mResource)); |
| } |
| |
| mInterpreter.mServer->OutputFormat("Resource name is '%s': ", mResource.mUriPath); |
| } |
| else |
| { |
| error = ProcessRequest(argc, argv); |
| } |
| |
| exit: |
| return error; |
| } |
| |
| void OTCALL Coap::HandleServerResponse(void *aContext, otCoapHeader *aHeader, otMessage *aMessage, |
| const otMessageInfo *aMessageInfo) |
| { |
| static_cast<Coap *>(aContext)->HandleServerResponse(aHeader, aMessage, aMessageInfo); |
| } |
| |
| void Coap::HandleServerResponse(otCoapHeader *aHeader, otMessage *aMessage, const otMessageInfo *aMessageInfo) |
| { |
| otError error = OT_ERROR_NONE; |
| otCoapHeader responseHeader; |
| otMessage *responseMessage; |
| otCoapCode responseCode = OT_COAP_CODE_EMPTY; |
| char responseContent = '0'; |
| |
| mInterpreter.mServer->OutputFormat("Received coap request from [%x:%x:%x:%x:%x:%x:%x:%x]: ", |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[0]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[1]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[2]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[3]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[4]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[5]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[6]), |
| HostSwap16(aMessageInfo->mSockAddr.mFields.m16[7])); |
| |
| switch (otCoapHeaderGetCode(aHeader)) |
| { |
| case OT_COAP_CODE_GET: |
| mInterpreter.mServer->OutputFormat("GET"); |
| break; |
| |
| case OT_COAP_CODE_DELETE: |
| mInterpreter.mServer->OutputFormat("DELETE"); |
| break; |
| |
| case OT_COAP_CODE_PUT: |
| mInterpreter.mServer->OutputFormat("PUT"); |
| break; |
| |
| case OT_COAP_CODE_POST: |
| mInterpreter.mServer->OutputFormat("POST"); |
| break; |
| |
| default: |
| mInterpreter.mServer->OutputFormat("Undefined\r\n"); |
| return; |
| } |
| |
| PrintPayload(aMessage); |
| |
| if ((otCoapHeaderGetType(aHeader) == OT_COAP_TYPE_CONFIRMABLE) || otCoapHeaderGetCode(aHeader) == OT_COAP_CODE_GET) |
| { |
| if (otCoapHeaderGetCode(aHeader) == OT_COAP_CODE_GET) |
| { |
| responseCode = OT_COAP_CODE_CONTENT; |
| } |
| else |
| { |
| responseCode = OT_COAP_CODE_VALID; |
| } |
| |
| otCoapHeaderInit(&responseHeader, OT_COAP_TYPE_ACKNOWLEDGMENT, responseCode); |
| otCoapHeaderSetMessageId(&responseHeader, otCoapHeaderGetMessageId(aHeader)); |
| otCoapHeaderSetToken(&responseHeader, otCoapHeaderGetToken(aHeader), otCoapHeaderGetTokenLength(aHeader)); |
| |
| if (otCoapHeaderGetCode(aHeader) == OT_COAP_CODE_GET) |
| { |
| otCoapHeaderSetPayloadMarker(&responseHeader); |
| } |
| |
| responseMessage = otCoapNewMessage(mInterpreter.mInstance, &responseHeader); |
| VerifyOrExit(responseMessage != NULL, error = OT_ERROR_NO_BUFS); |
| |
| if (otCoapHeaderGetCode(aHeader) == OT_COAP_CODE_GET) |
| { |
| SuccessOrExit(error = otMessageAppend(responseMessage, &responseContent, sizeof(responseContent))); |
| } |
| |
| SuccessOrExit(error = otCoapSendResponse(mInterpreter.mInstance, responseMessage, aMessageInfo)); |
| } |
| |
| exit: |
| |
| if (error != OT_ERROR_NONE && responseMessage != NULL) |
| { |
| mInterpreter.mServer->OutputFormat("Cannot send coap response message: Error %d: %s\r\n", |
| error, otThreadErrorToString(error)); |
| otMessageFree(responseMessage); |
| } |
| else if (responseCode >= OT_COAP_CODE_RESPONSE_MIN) |
| { |
| mInterpreter.mServer->OutputFormat("coap response sent successfully!\r\n"); |
| } |
| } |
| |
| otError Coap::ProcessRequest(int argc, char *argv[]) |
| { |
| otError error = OT_ERROR_NONE; |
| otMessage *message = NULL; |
| otMessageInfo messageInfo; |
| otCoapHeader header; |
| uint16_t payloadLength = 0; |
| |
| // Default parameters |
| char coapUri[kMaxUriLength] = "test"; |
| otCoapType coapType = OT_COAP_TYPE_NON_CONFIRMABLE; |
| otCoapCode coapCode = OT_COAP_CODE_GET; |
| otIp6Address coapDestinationIp; |
| |
| VerifyOrExit(argc > 0, error = OT_ERROR_INVALID_ARGS); |
| |
| // CoAP-Code |
| if (strcmp(argv[0], "get") == 0) |
| { |
| coapCode = OT_COAP_CODE_GET; |
| } |
| else if (strcmp(argv[0], "post") == 0) |
| { |
| coapCode = OT_COAP_CODE_POST; |
| } |
| else if (strcmp(argv[0], "put") == 0) |
| { |
| coapCode = OT_COAP_CODE_PUT; |
| } |
| else if (strcmp(argv[0], "delete") == 0) |
| { |
| coapCode = OT_COAP_CODE_DELETE; |
| } |
| else |
| { |
| ExitNow(error = OT_ERROR_PARSE); |
| } |
| |
| // Destination IPv6 address |
| if (argc > 1) |
| { |
| SuccessOrExit(error = otIp6AddressFromString(argv[1], &coapDestinationIp)); |
| } |
| else |
| { |
| ExitNow(error = OT_ERROR_INVALID_ARGS); |
| } |
| |
| // CoAP-URI |
| if (argc > 2) |
| { |
| strlcpy(coapUri, argv[2], kMaxUriLength); |
| } |
| else |
| { |
| ExitNow(error = OT_ERROR_INVALID_ARGS); |
| } |
| |
| // CoAP-Type |
| if (argc > 3) |
| { |
| if (strcmp(argv[3], "con") == 0) |
| { |
| coapType = OT_COAP_TYPE_CONFIRMABLE; |
| } |
| } |
| |
| otCoapHeaderInit(&header, coapType, coapCode); |
| otCoapHeaderGenerateToken(&header, ot::Coap::Header::kDefaultTokenLength); |
| SuccessOrExit(error = otCoapHeaderAppendUriPathOptions(&header, coapUri)); |
| |
| if (argc > 4) |
| { |
| payloadLength = static_cast<uint16_t>(strlen(argv[4])); |
| |
| if (payloadLength > 0) |
| { |
| otCoapHeaderSetPayloadMarker(&header); |
| } |
| } |
| |
| message = otCoapNewMessage(mInterpreter.mInstance, &header); |
| VerifyOrExit(message != NULL, error = OT_ERROR_NO_BUFS); |
| |
| // Embed content into message if given |
| if (payloadLength > 0) |
| { |
| SuccessOrExit(error = otMessageAppend(message, argv[4], payloadLength)); |
| } |
| |
| memset(&messageInfo, 0, sizeof(messageInfo)); |
| messageInfo.mPeerAddr = coapDestinationIp; |
| messageInfo.mPeerPort = OT_DEFAULT_COAP_PORT; |
| messageInfo.mInterfaceId = OT_NETIF_INTERFACE_ID_THREAD; |
| |
| if ((coapType == OT_COAP_TYPE_CONFIRMABLE) || (coapCode == OT_COAP_CODE_GET)) |
| { |
| error = otCoapSendRequest(mInterpreter.mInstance, message, &messageInfo, &Coap::HandleClientResponse, this); |
| } |
| else |
| { |
| error = otCoapSendRequest(mInterpreter.mInstance, message, &messageInfo, NULL, NULL); |
| } |
| |
| mInterpreter.mServer->OutputFormat("Sending coap request: "); |
| |
| exit: |
| |
| if ((error != OT_ERROR_NONE) && (message != NULL)) |
| { |
| otMessageFree(message); |
| } |
| |
| return error; |
| } |
| |
| void OTCALL Coap::HandleClientResponse(void *aContext, otCoapHeader *aHeader, otMessage *aMessage, |
| const otMessageInfo *aMessageInfo, otError aError) |
| { |
| static_cast<Coap *>(aContext)->HandleClientResponse(aHeader, aMessage, aMessageInfo, aError); |
| } |
| |
| void Coap::HandleClientResponse(otCoapHeader *aHeader, otMessage *aMessage, const otMessageInfo *aMessageInfo, |
| otError aError) |
| { |
| if (aError != OT_ERROR_NONE) |
| { |
| mInterpreter.mServer->OutputFormat("Error receiving coap response message: Error %d: %s\r\n", |
| aError, otThreadErrorToString(aError)); |
| } |
| else |
| { |
| mInterpreter.mServer->OutputFormat("Received coap response"); |
| PrintPayload(aMessage); |
| } |
| |
| OT_UNUSED_VARIABLE(aHeader); |
| OT_UNUSED_VARIABLE(aMessageInfo); |
| } |
| |
| } // namespace Cli |
| } // namespace ot |
| |
| #endif // OPENTHREAD_ENABLE_APPLICATION_COAP |
