1 /* ****************************************************************
3 * Copyright 2014 Samsung Electronics All Rights Reserved.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 ******************************************************************/
23 * This file contains the common data structures between Resource , CA and adapters
31 #define HAVE_SYS_POLL_H
39 #ifdef HAVE_SYS_POLL_H
51 #define CA_IPADDR_SIZE 16
54 * Remote Access jabber ID length.
56 #define CA_RAJABBERID_SIZE 256
59 * Mac address length for BT port
61 #define CA_MACADDR_SIZE 18
64 * Max header options data length
66 #define CA_MAX_HEADER_OPTION_DATA_LENGTH 20
71 #define CA_MAX_TOKEN_LEN (8)
77 #define CA_MAX_URI_LENGTH 128 /* maximum size of URI for embedded platforms*/
79 #define CA_MAX_URI_LENGTH 512 /* maximum size of URI for other platforms*/
83 * Max PDU length supported
86 #define COAP_MAX_PDU_SIZE 320 /* maximum size of a CoAP PDU for embedded platforms*/
88 #define COAP_MAX_PDU_SIZE 1400 /* maximum size of a CoAP PDU for big platforms*/
92 #define CA_DEFAULT_BLOCK_SIZE CA_BLOCK_SIZE_1024_BYTE
96 *Maximum length of the remoteEndpoint identity
98 #define CA_MAX_ENDPOINT_IDENTITY_LEN (32)
101 * option types - the highest option number 63
103 #define CA_OPTION_IF_MATCH 1
104 #define CA_OPTION_ETAG 4
105 #define CA_OPTION_IF_NONE_MATCH 5
106 #define CA_OPTION_OBSERVE 6
107 #define CA_OPTION_LOCATION_PATH 8
108 #define CA_OPTION_URI_PATH 11
109 #define CA_OPTION_CONTENT_FORMAT 12
110 #define CA_OPTION_CONTENT_TYPE COAP_OPTION_CONTENT_FORMAT
111 #define CA_OPTION_MAXAGE 14
112 #define CA_OPTION_URI_QUERY 15
113 #define CA_OPTION_ACCEPT 17
114 #define CA_OPTION_LOCATION_QUERY 20
117 * Payload information from resource model
119 typedef uint8_t *CAPayload_t;
122 * URI for the OIC base.CA considers relative URI as the URI.
124 typedef char *CAURI_t;
127 * Token information for mapping the request and responses by resource model
129 typedef char *CAToken_t;
131 // The following flags are the same as the equivalent OIC values in
132 // octypes.h, allowing direct copying with slight fixup.
133 // The CA layer should used the OC types when build allows that.
135 #define MAX_ADDR_STR_SIZE_CA (256)
137 #define MAX_ADDR_STR_SIZE_CA (59)
142 CA_DEFAULT_ADAPTER = 0,
144 // value zero indicates discovery
145 CA_ADAPTER_IP = (1 << 0), // IPv4 and IPv6, including 6LoWPAN
146 CA_ADAPTER_GATT_BTLE = (1 << 1), // GATT over Bluetooth LE
147 CA_ADAPTER_RFCOMM_BTEDR = (1 << 2), // RFCOMM over Bluetooth EDR
150 CA_ADAPTER_REMOTE_ACCESS = (1 << 3), // Remote Access over XMPP.
153 CA_ADAPTER_TCP = (1 << 4), // CoAP over TCP
154 CA_ADAPTER_NFC = (1 << 5), // NFC Adapter
156 CA_ALL_ADAPTERS = 0xffffffff
157 } CATransportAdapter_t;
161 CA_DEFAULT_FLAGS = 0,
163 // Insecure transport is the default (subject to change)
164 CA_SECURE = (1 << 4), // secure the transport path
165 // IPv4 & IPv6 autoselection is the default
166 CA_IPV6 = (1 << 5), // IP adapter only
167 CA_IPV4 = (1 << 6), // IP adapter only
168 // Indication that a message was received by multicast.
169 CA_MULTICAST = (1 << 7),
170 // Link-Local multicast is the default multicast scope for IPv6.
171 // These correspond in both value and position to the IPv6 address bits.
172 CA_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope
173 CA_SCOPE_LINK = 0x2, // IPv6 Link-Local scope (default)
174 CA_SCOPE_REALM = 0x3, // IPv6 Realm-Local scope
175 CA_SCOPE_ADMIN = 0x4, // IPv6 Admin-Local scope
176 CA_SCOPE_SITE = 0x5, // IPv6 Site-Local scope
177 CA_SCOPE_ORG = 0x8, // IPv6 Organization-Local scope
178 CA_SCOPE_GLOBAL = 0xE, // IPv6 Global scope
179 } CATransportFlags_t;
181 #define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
182 #define CA_SCOPE_MASK 0xf // mask scope bits above
185 * @enum CANetworkStatus_t
186 * Information about the network status.
190 CA_INTERFACE_DOWN, /**< Connection is not available */
191 CA_INTERFACE_UP /**< Connection is Available */
195 * remoteEndpoint identity
200 unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
204 * @enum CAMessageType_t
205 * Message Type for Base source code
209 CA_MSG_CONFIRM = 0, /**< confirmable message (requires ACK/RST) */
210 CA_MSG_NONCONFIRM, /**< non-confirmable message (one-shot message) */
211 CA_MSG_ACKNOWLEDGE, /**< used to acknowledge confirmable messages */
212 CA_MSG_RESET /**< used to indicates not-interested or error (lack of context)in
218 * Allowed method to be used by resource model
222 CA_GET = 1, /**< GET Method */
223 CA_POST, /**< POST Method */
224 CA_PUT, /**< PUT Method */
225 CA_DELETE /**< DELETE Method */
230 * it depends on defined size in libCoAP.
234 CA_BLOCK_SIZE_16_BYTE = 0, /**< 16byte */
235 CA_BLOCK_SIZE_32_BYTE = 1, /**< 32byte */
236 CA_BLOCK_SIZE_64_BYTE = 2, /**< 64byte */
237 CA_BLOCK_SIZE_128_BYTE = 3, /**< 128byte */
238 CA_BLOCK_SIZE_256_BYTE = 4, /**< 256byte */
239 CA_BLOCK_SIZE_512_BYTE = 5, /**< 512byte */
240 CA_BLOCK_SIZE_1024_BYTE = 6 /**< 1Kbyte */
244 * Endpoint information for connectivities
245 * Must be identical to OCDevAddr.
249 CATransportAdapter_t adapter; // adapter type
250 CATransportFlags_t flags; // transport modifiers
251 uint16_t port; // for IP
252 char addr[MAX_ADDR_STR_SIZE_CA]; // address for all
253 uint32_t interface; // usually zero for default interface
254 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
255 char routeData[MAX_ADDR_STR_SIZE_CA]; /**< GatewayId:ClientId of
261 * Endpoint information for secure messages
265 CAEndpoint_t endpoint; /**< endpoint */
266 CARemoteId_t identity; /**< endpoint identity */
267 } CASecureEndpoint_t;
271 * Enums for CA return values
275 /* Result code - START HERE */
276 CA_STATUS_OK = 0, /**< Success */
277 CA_STATUS_INVALID_PARAM, /**< Invalid Parameter */
278 CA_ADAPTER_NOT_ENABLED, /**< Adapter is not enabled */
279 CA_SERVER_STARTED_ALREADY, /**< Server is started already */
280 CA_SERVER_NOT_STARTED, /**< Server is not started */
281 CA_DESTINATION_NOT_REACHABLE, /**< Destination is not reachable */
282 CA_SOCKET_OPERATION_FAILED, /**< Socket operation failed */
283 CA_SEND_FAILED, /**< Send request failed */
284 CA_RECEIVE_FAILED, /**< Receive failed */
285 CA_MEMORY_ALLOC_FAILED, /**< Memory allocation failed */
286 CA_REQUEST_TIMEOUT, /**< Request is Timeout */
287 CA_DESTINATION_DISCONNECTED, /**< Destination is disconnected */
288 CA_NOT_SUPPORTED, /**< Not supported */
289 CA_STATUS_NOT_INITIALIZED, /**< Not Initialized*/
290 CA_DTLS_AUTHENTICATION_FAILURE, /**< Decryption error in DTLS */
291 CA_STATUS_FAILED =255 /**< Failure */
292 /* Result code - END HERE */
296 * @enum CAResponseResult_t
297 * Enums for CA Response values
301 /* Response status code - START HERE */
302 CA_EMPTY = 0, /**< Empty */
303 CA_CREATED = 201, /**< Created */
304 CA_DELETED = 202, /**< Deleted */
305 CA_VALID = 203, /**< Valid */
306 CA_CHANGED = 204, /**< Changed */
307 CA_CONTENT = 205, /**< Content */
308 CA_CONTINUE = 231, /**< Continue */
309 CA_BAD_REQ = 400, /**< Bad Request */
310 CA_UNAUTHORIZED_REQ = 401, /**< Unauthorized Request */
311 CA_BAD_OPT = 402, /**< Bad Option */
312 CA_FORBIDDEN_REQ = 403, /**< Forbidden Request */
313 CA_NOT_FOUND = 404, /**< Not found */
314 CA_METHOD_NOT_ALLOWED = 405, /**< Method Not Allowed */
315 CA_NOT_ACCEPTABLE = 406, /**< Not Acceptable */
316 CA_REQUEST_ENTITY_INCOMPLETE = 408, /**< Request Entity Incomplete */
317 CA_REQUEST_ENTITY_TOO_LARGE = 413, /**< Request Entity Too Large */
318 CA_INTERNAL_SERVER_ERROR = 500, /**< Internal Server Error */
319 CA_RETRANSMIT_TIMEOUT = 504 /**< Retransmit timeout */
320 /* Response status code - END HERE */
321 } CAResponseResult_t;
324 * @enum CATransportProtocolID_t
325 * Transport Protocol IDs for additional options
329 CA_INVALID_ID = (1 << 0), /**< Invalid ID */
330 CA_COAP_ID = (1 << 1) /**< COAP ID */
331 } CATransportProtocolID_t;
334 * @enum CAAdapterState_t
335 * Adapter State to indicate the network changed notifications.
339 CA_ADAPTER_DISABLED, /**< Adapter is Disabled */
340 CA_ADAPTER_ENABLED /**< Adapter is Enabled */
344 * Format indicating which encoding has been used on the payload.
348 CA_FORMAT_UNDEFINED = 0, /**< Undefined enoding format */
349 CA_FORMAT_TEXT_PLAIN,
350 CA_FORMAT_APPLICATION_LINK_FORMAT,
351 CA_FORMAT_APPLICATION_XML,
352 CA_FORMAT_APPLICATION_OCTET_STREAM,
353 CA_FORMAT_APPLICATION_RDF_XML,
354 CA_FORMAT_APPLICATION_EXI,
355 CA_FORMAT_APPLICATION_JSON,
356 CA_FORMAT_APPLICATION_CBOR,
357 CA_FORMAT_UNSUPPORTED
361 * Header options structure to be filled
363 * This structure is used to hold header information.
367 CATransportProtocolID_t protocolID; /**< Protocol ID of the Option */
368 uint16_t optionID; /**< The header option ID which will be
369 added to communication packets */
370 uint16_t optionLength; /**< Option Length **/
371 char optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH]; /**< Optional data values**/
375 * Base Information received
377 * This structure is used to hold request & response base information
381 CAMessageType_t type; /**< Qos for the request */
382 #ifdef ROUTING_GATEWAY
383 bool skipRetransmission; /**< Will not attempt retransmission even if type is CONFIRM.
384 Required for packet forwarding */
386 uint16_t messageId; /**< Message id.
387 * if message id is zero, it will generated by CA inside.
388 * otherwise, you can use it */
389 CAToken_t token; /**< Token for CA */
390 uint8_t tokenLength; /**< token length */
391 CAHeaderOption_t *options; /** Header Options for the request */
392 uint8_t numOptions; /**< Number of Header options */
393 CAPayload_t payload; /**< payload of the request */
394 size_t payloadSize; /**< size in bytes of the payload */
395 CAPayloadFormat_t payloadFormat; /**< encoding format of the request payload */
396 CAPayloadFormat_t acceptFormat; /**< accept format for the response payload */
397 CAURI_t resourceUri; /**< Resource URI information **/
398 CARemoteId_t identity; /**< endpoint identity */
402 * Request Information to be sent
404 * This structure is used to hold request information
408 CAMethod_t method; /**< Name of the Method Allowed */
409 CAInfo_t info; /**< Information of the request. */
410 bool isMulticast; /**< is multicast request */
414 * Response information received
416 * This structure is used to hold response information
420 CAResponseResult_t result; /**< Result for response by resource model */
421 CAInfo_t info; /**< Information of the response */
426 * Error information from CA
427 * contains error code and message information
429 * This structure holds error information
433 CAResult_t result; /**< CA API request result */
434 CAInfo_t info; /**< message information such as token and payload data
435 helpful to identify the error */
439 * Hold global variables for CA layer (also used by RI layer)
443 int fd; /**< socket fd */
444 uint16_t port; /**< socket port */
447 #define HISTORYSIZE (4)
451 CATransportFlags_t flags;
453 char token[CA_MAX_TOKEN_LEN];
460 CAHistoryItem_t items[HISTORYSIZE];
464 * Hold interface index for keeping track of comings and goings
468 int32_t ifIndex; /**< network interface index */
472 * Hold the port number assigned from application.
473 * It will be used when creating a socket.
479 uint16_t u6; /**< unicast IPv6 socket port */
480 uint16_t u6s; /**< unicast IPv6 socket secure port */
481 uint16_t u4; /**< unicast IPv4 socket port */
482 uint16_t u4s; /**< unicast IPv4 socket secure port */
487 uint16_t u4; /**< unicast IPv4 socket port */
488 uint16_t u6; /**< unicast IPv6 socket port */
495 CATransportFlags_t clientFlags; /**< flag for client */
496 CATransportFlags_t serverFlags; /**< flag for server */
497 bool client; /**< client mode */
498 bool server; /**< server mode */
504 void *threadpool; /**< threadpool between Initialize and Start */
505 CASocket_t u6; /**< unicast IPv6 */
506 CASocket_t u6s; /**< unicast IPv6 secure */
507 CASocket_t u4; /**< unicast IPv4 */
508 CASocket_t u4s; /**< unicast IPv4 secure */
509 CASocket_t m6; /**< multicast IPv6 */
510 CASocket_t m6s; /**< multicast IPv6 secure */
511 CASocket_t m4; /**< multicast IPv4 */
512 CASocket_t m4s; /**< multicast IPv4 secure */
513 int netlinkFd; /**< netlink */
514 int shutdownFds[2]; /**< shutdown pipe */
515 int selectTimeout; /**< in seconds */
516 int maxfd; /**< highest fd (for select) */
517 bool started; /**< the IP adapter has started */
518 bool terminate; /**< the IP adapter needs to stop */
519 bool ipv6enabled; /**< IPv6 enabled by OCInit flags */
520 bool ipv4enabled; /**< IPv4 enabled by OCInit flags */
521 bool dualstack; /**< IPv6 and IPv4 enabled */
523 struct networkmonitors
525 CAIfItem_t *ifItems; /**< current network interface index list */
526 size_t sizeIfItems; /**< size of network interface index array */
527 size_t numIfItems; /**< number of valid network interfaces */
533 CAHistory_t requestHistory; /**< filter IP family in requests */
538 * Hold global variables for TCP Adapter.
542 void *threadpool; /**< threadpool between Initialize and Start */
543 CASocket_t ipv4; /**< IPv4 accept socket */
544 CASocket_t ipv6; /**< IPv6 accept socket */
545 void *svrlist; /**< unicast IPv4 TCP server information*/
546 int selectTimeout; /**< in seconds */
547 int listenBacklog; /**< backlog counts*/
548 int shutdownFds[2]; /**< shutdown pipe */
549 int connectionFds[2]; /**< connection pipe */
550 int maxfd; /**< highest fd (for select) */
551 bool started; /**< the TCP adapter has started */
552 bool terminate; /**< the TCP adapter needs to stop */
553 bool ipv4tcpenabled; /**< IPv4 TCP enabled by OCInit flags */
554 bool ipv6tcpenabled; /**< IPv6 TCP enabled by OCInit flags */
559 extern CAGlobals_t caglobals;
562 * Callback function type for request delivery.
563 * @param[out] object Endpoint object from which the request is received.
564 * It contains endpoint address based on the connectivity type.
565 * @param[out] requestInfo Info for resource model to understand about the request.
567 typedef void (*CARequestCallback)(const CAEndpoint_t *object,
568 const CARequestInfo_t *requestInfo);
571 * Callback function type for response delivery.
572 * @param[out] object Endpoint object from which the response is received.
573 * @param[out] responseInfo Identifier which needs to be mapped with response.
575 typedef void (*CAResponseCallback)(const CAEndpoint_t *object,
576 const CAResponseInfo_t *responseInfo);
578 * Callback function type for error.
579 * @param[out] object remote device information.
580 * @param[out] errorInfo CA Error information.
582 typedef void (*CAErrorCallback)(const CAEndpoint_t *object,
583 const CAErrorInfo_t *errorInfo);
586 * Callback function type for network status changes delivery from CA common logic.
587 * @param[out] info Endpoint object from which the network status is changed.
588 * It contains endpoint address based on the connectivity type.
589 * @param[out] status Current network status info.
591 typedef void (*CANetworkMonitorCallback)(const CAEndpoint_t *info, CANetworkStatus_t status);
597 #endif // CA_COMMON_H_