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
42 #define CA_IPADDR_SIZE 16
45 * Remote Access jabber ID length.
47 #define CA_RAJABBERID_SIZE 256
50 * Mac address length for BT port
52 #define CA_MACADDR_SIZE 18
55 * Max header options data length
57 #define CA_MAX_HEADER_OPTION_DATA_LENGTH 16
62 #define CA_MAX_TOKEN_LEN (8)
68 #define CA_MAX_URI_LENGTH 128 /* maximum size of URI for embedded platforms*/
70 #define CA_MAX_URI_LENGTH 512 /* maximum size of URI for other platforms*/
74 * Max PDU length supported
77 #define COAP_MAX_PDU_SIZE 320 /* maximum size of a CoAP PDU for embedded platforms*/
79 #define COAP_MAX_PDU_SIZE 1400 /* maximum size of a CoAP PDU for big platforms*/
83 #define CA_DEFAULT_BLOCK_SIZE CA_BLOCK_SIZE_1024_BYTE
87 *Maximum length of the remoteEndpoint identity
89 #define CA_MAX_ENDPOINT_IDENTITY_LEN (32)
92 * option types - the highest option number 63
94 #define CA_OPTION_IF_MATCH 1
95 #define CA_OPTION_ETAG 4
96 #define CA_OPTION_IF_NONE_MATCH 5
97 #define CA_OPTION_OBSERVE 6
98 #define CA_OPTION_LOCATION_PATH 8
99 #define CA_OPTION_URI_PATH 11
100 #define CA_OPTION_CONTENT_FORMAT 12
101 #define CA_OPTION_CONTENT_TYPE COAP_OPTION_CONTENT_FORMAT
102 #define CA_OPTION_MAXAGE 14
103 #define CA_OPTION_URI_QUERY 15
104 #define CA_OPTION_ACCEPT 17
105 #define CA_OPTION_LOCATION_QUERY 20
108 * Payload information from resource model
110 typedef uint8_t *CAPayload_t;
113 * URI for the OIC base.CA considers relative URI as the URI.
115 typedef char *CAURI_t;
118 * Token information for mapping the request and responses by resource model
120 typedef char *CAToken_t;
122 // The following flags are the same as the equivalent OIC values in
123 // octypes.h, allowing direct copying with slight fixup.
124 // The CA layer should used the OC types when build allows that.
126 #define MAX_ADDR_STR_SIZE_CA (256)
128 #define MAX_ADDR_STR_SIZE_CA (40)
133 CA_DEFAULT_ADAPTER = 0,
135 // value zero indicates discovery
136 CA_ADAPTER_IP = (1 << 0), // IPv4 and IPv6, including 6LoWPAN
137 CA_ADAPTER_GATT_BTLE = (1 << 1), // GATT over Bluetooth LE
138 CA_ADAPTER_RFCOMM_BTEDR = (1 << 2), // RFCOMM over Bluetooth EDR
141 CA_ADAPTER_REMOTE_ACCESS = (1 << 3), // Remote Access over XMPP.
144 CA_ADAPTER_TCP = (1 << 4), // CoAP over TCP
145 CA_ALL_ADAPTERS = 0xffffffff
146 } CATransportAdapter_t;
150 CA_DEFAULT_FLAGS = 0,
152 // Insecure transport is the default (subject to change)
153 CA_SECURE = (1 << 4), // secure the transport path
154 // IPv4 & IPv6 autoselection is the default
155 CA_IPV6 = (1 << 5), // IP adapter only
156 CA_IPV4 = (1 << 6), // IP adapter only
157 // Indication that a message was received by multicast.
158 CA_MULTICAST = (1 << 7),
159 // Link-Local multicast is the default multicast scope for IPv6.
160 // These correspond in both value and position to the IPv6 address bits.
161 CA_SCOPE_INTERFACE = 0x1, // IPv6 Interface-Local scope
162 CA_SCOPE_LINK = 0x2, // IPv6 Link-Local scope (default)
163 CA_SCOPE_REALM = 0x3, // IPv6 Realm-Local scope
164 CA_SCOPE_ADMIN = 0x4, // IPv6 Admin-Local scope
165 CA_SCOPE_SITE = 0x5, // IPv6 Site-Local scope
166 CA_SCOPE_ORG = 0x8, // IPv6 Organization-Local scope
167 CA_SCOPE_GLOBAL = 0xE, // IPv6 Global scope
168 } CATransportFlags_t;
170 #define CA_IPFAMILY_MASK (CA_IPV6|CA_IPV4)
171 #define CA_SCOPE_MASK 0xf // mask scope bits above
174 * @enum CANetworkStatus_t
175 * Information about the network status.
179 CA_INTERFACE_DOWN, /**< Connection is not available */
180 CA_INTERFACE_UP /**< Connection is Available */
184 * remoteEndpoint identity
189 unsigned char id[CA_MAX_ENDPOINT_IDENTITY_LEN];
193 * @enum CAMessageType_t
194 * Message Type for Base source code
198 CA_MSG_CONFIRM = 0, /**< confirmable message (requires ACK/RST) */
199 CA_MSG_NONCONFIRM, /**< non-confirmable message (one-shot message) */
200 CA_MSG_ACKNOWLEDGE, /**< used to acknowledge confirmable messages */
201 CA_MSG_RESET /**< used to indicates not-interested or error (lack of context)in
207 * Allowed method to be used by resource model
211 CA_GET = 1, /**< GET Method */
212 CA_POST, /**< POST Method */
213 CA_PUT, /**< PUT Method */
214 CA_DELETE /**< DELETE Method */
219 * it depends on defined size in libCoAP.
223 CA_BLOCK_SIZE_16_BYTE = 0, /**< 16byte */
224 CA_BLOCK_SIZE_32_BYTE = 1, /**< 32byte */
225 CA_BLOCK_SIZE_64_BYTE = 2, /**< 64byte */
226 CA_BLOCK_SIZE_128_BYTE = 3, /**< 128byte */
227 CA_BLOCK_SIZE_256_BYTE = 4, /**< 256byte */
228 CA_BLOCK_SIZE_512_BYTE = 5, /**< 512byte */
229 CA_BLOCK_SIZE_1024_BYTE = 6 /**< 1Kbyte */
233 * Endpoint information for connectivities
234 * Must be identical to OCDevAddr.
238 CATransportAdapter_t adapter; // adapter type
239 CATransportFlags_t flags; // transport modifiers
240 uint16_t port; // for IP
241 char addr[MAX_ADDR_STR_SIZE_CA]; // address for all
242 uint32_t interface; // usually zero for default interface
246 * Endpoint information for secure messages
250 CAEndpoint_t endpoint; /**< endpoint */
251 CARemoteId_t identity; /**< endpoint identity */
252 } CASecureEndpoint_t;
256 * Enums for CA return values
260 /* Result code - START HERE */
261 CA_STATUS_OK = 0, /**< Success */
262 CA_STATUS_INVALID_PARAM, /**< Invalid Parameter */
263 CA_ADAPTER_NOT_ENABLED, /**< Adapter is not enabled */
264 CA_SERVER_STARTED_ALREADY, /**< Server is started already */
265 CA_SERVER_NOT_STARTED, /**< Server is not started*/
266 CA_DESTINATION_NOT_REACHABLE, /**< Destination is not reachable */
267 CA_SOCKET_OPERATION_FAILED, /**< Socket operation failed */
268 CA_SEND_FAILED, /**< Send request failed */
269 CA_RECEIVE_FAILED, /**< Receive failed */
270 CA_MEMORY_ALLOC_FAILED, /**< Memory allocation failed */
271 CA_REQUEST_TIMEOUT, /**< Request is Timeout */
272 CA_DESTINATION_DISCONNECTED, /**< Destination is disconnected */
273 CA_NOT_SUPPORTED, /**< Not supported */
274 CA_STATUS_NOT_INITIALIZED, /**< Not Initialized*/
275 CA_STATUS_FAILED =255 /**< Failure */
276 /* Result code - END HERE */
280 * @enum CAResponseResult_t
281 * Enums for CA Response values
285 /* Response status code - START HERE */
286 CA_EMPTY = 0, /**< Empty */
287 CA_SUCCESS = 200, /**< Success */
288 CA_CREATED = 201, /**< Created */
289 CA_DELETED = 202, /**< Deleted */
290 CA_VALID = 203, /**< Valid */
291 CA_CHANGED = 204, /**< Changed */
292 CA_CONTENT = 205, /**< Content */
293 CA_CONTINUE = 231, /**< Continue */
294 CA_BAD_REQ = 400, /**< Bad Request */
295 CA_UNAUTHORIZED_REQ = 401, /**< Unauthorized Request */
296 CA_BAD_OPT = 402, /**< Bad Option */
297 CA_FORBIDDEN_REQ = 403, /**< Forbidden Request */
298 CA_NOT_FOUND = 404, /**< Not found */
299 CA_NOT_ACCEPTABLE = 406, /**< Not Acceptable */
300 CA_REQUEST_ENTITY_INCOMPLETE = 408, /**< Request Entity Incomplete */
301 CA_REQUEST_ENTITY_TOO_LARGE = 413, /**< Request Entity Too Large */
302 CA_INTERNAL_SERVER_ERROR = 500, /**< Internal Server Error */
303 CA_RETRANSMIT_TIMEOUT = 504 /**< Retransmit timeout */
304 /* Response status code - END HERE */
305 } CAResponseResult_t;
308 * @enum CATransportProtocolID_t
309 * Transport Protocol IDs for additional options
313 CA_INVALID_ID = (1 << 0), /**< Invalid ID */
314 CA_COAP_ID = (1 << 1) /**< COAP ID */
315 } CATransportProtocolID_t;
318 * @enum CAAdapterState_t
319 * Adapter State to indicate the network changed notifications.
323 CA_ADAPTER_DISABLED, /**< Adapter is Disabled */
324 CA_ADAPTER_ENABLED /**< Adapter is Enabled */
328 * Format indicating which encoding has been used on the payload.
332 CA_FORMAT_UNDEFINED = 0, /**< Undefined enoding format */
333 CA_FORMAT_TEXT_PLAIN,
334 CA_FORMAT_APPLICATION_LINK_FORMAT,
335 CA_FORMAT_APPLICATION_XML,
336 CA_FORMAT_APPLICATION_OCTET_STREAM,
337 CA_FORMAT_APPLICATION_RDF_XML,
338 CA_FORMAT_APPLICATION_EXI,
339 CA_FORMAT_APPLICATION_JSON,
340 CA_FORMAT_APPLICATION_CBOR,
341 CA_FORMAT_UNSUPPORTED
345 * Header options structure to be filled
347 * This structure is used to hold header information.
351 CATransportProtocolID_t protocolID; /**< Protocol ID of the Option */
352 uint16_t optionID; /**< The header option ID which will be
353 added to communication packets */
354 uint16_t optionLength; /**< Option Length **/
355 char optionData[CA_MAX_HEADER_OPTION_DATA_LENGTH]; /**< Optional data values**/
359 * Base Information received
361 * This structure is used to hold request & response base information
366 CAMessageType_t type; /**< Qos for the request */
367 uint16_t messageId; /**< Message id.
368 * if message id is zero, it will generated by CA inside.
369 * otherwise, you can use it */
370 CAToken_t token; /**< Token for CA */
371 uint8_t tokenLength; /**< token length*/
372 CAHeaderOption_t *options; /** Header Options for the request */
373 uint8_t numOptions; /**< Number of Header options */
374 CAPayload_t payload; /**< payload of the request */
375 size_t payloadSize; /**< size in bytes of the payload */
376 CAPayloadFormat_t payloadFormat; /**< encoding format of the request payload */
377 CAPayloadFormat_t acceptFormat; /**< accept format for the response payload */
378 CAURI_t resourceUri; /**< Resource URI information **/
379 CARemoteId_t identity; /**< endpoint identity */
383 * Request Information to be sent
385 * This structure is used to hold request information
389 CAMethod_t method; /**< Name of the Method Allowed */
390 CAInfo_t info; /**< Information of the request. */
391 bool isMulticast; /**< is multicast request */
395 * Response information received
397 * This structure is used to hold response information
401 CAResponseResult_t result; /**< Result for response by resource model */
402 CAInfo_t info; /**< Information of the response */
407 * Error information from CA
408 * contains error code and message information
410 * This structure holds error information
414 CAResult_t result; /**< CA API request result */
415 CAInfo_t info; /**< message information such as token and payload data
416 helpful to identify the error */
420 * CA Remote Access information for XMPP Client
425 char *hostname; /**< XMPP server hostname */
426 uint16_t port; /**< XMPP server serivce port */
427 char *xmpp_domain; /**< XMPP login domain */
428 char *username; /**< login username */
429 char *password; /**< login password */
430 char *resource; /**< specific resource for login */
431 char *user_jid; /**< specific JID for login */
436 * Hold global variables for CA layer (also used by RI layer)
440 int fd; /**< socket fd */
441 uint16_t port; /**< socket port */
444 #define HISTORYSIZE (4)
448 CATransportFlags_t flags;
455 CAHistoryItem_t items[HISTORYSIZE];
459 * Hold interface index for keeping track of comings and goings
463 int32_t ifIndex; /**< network interface index */
468 CATransportFlags_t clientFlags; /**< flag for client */
469 CATransportFlags_t serverFlags; /**< flag for server */
470 bool client; /**< client mode */
471 bool server; /**< server mode */
475 void *threadpool; /**< threadpool between Initialize and Start */
476 CASocket_t u6; /**< unicast IPv6 */
477 CASocket_t u6s; /**< unicast IPv6 secure */
478 CASocket_t u4; /**< unicast IPv4 */
479 CASocket_t u4s; /**< unicast IPv4 secure */
480 CASocket_t m6; /**< multicast IPv6 */
481 CASocket_t m6s; /**< multicast IPv6 secure */
482 CASocket_t m4; /**< multicast IPv4 */
483 CASocket_t m4s; /**< multicast IPv4 secure */
484 int netlinkFd; /**< netlink */
485 int shutdownFds[2]; /**< shutdown pipe */
486 int selectTimeout; /**< in seconds */
487 int maxfd; /**< highest fd (for select) */
488 bool started; /**< the IP adapter has started */
489 bool terminate; /**< the IP adapter needs to stop */
490 bool ipv6enabled; /**< IPv6 enabled by OCInit flags */
491 bool ipv4enabled; /**< IPv4 enabled by OCInit flags */
492 bool dualstack; /**< IPv6 and IPv4 enabled */
494 struct networkmonitors
496 CAIfItem_t *ifItems; /**< current network interface index list */
497 size_t sizeIfItems; /**< size of network interface index array */
498 size_t numIfItems; /**< number of valid network interfaces */
504 CAHistory_t requestHistory; /**< filter IP family in requests */
505 CAHistory_t responseHistory; /**< filter IP family in responses */
506 CATransportFlags_t previousRequestFlags;/**< address family filtering */
507 uint16_t previousRequestMessageId; /**< address family filtering */
512 * Hold global variables for TCP Adapter.
516 void *threadpool; /**< threadpool between Initialize and Start */
517 void *svrlist; /**< unicast IPv4 TCP server information*/
518 int selectTimeout; /**< in seconds */
519 int listenBacklog; /**< backlog counts*/
520 int maxfd; /**< highest fd (for select) */
521 bool started; /**< the TCP adapter has started */
522 bool terminate; /**< the TCP adapter needs to stop */
523 bool ipv4tcpenabled; /**< IPv4 TCP enabled by OCInit flags */
528 extern CAGlobals_t caglobals;
534 #endif // CA_COMMON_H_