libcoap 4.3.2rc2

coap_uri.h
Go to the documentation of this file.
1/*
2 * coap_uri.h -- helper functions for URI treatment
3 *
4 * Copyright (C) 2010-2023 Olaf Bergmann <bergmann@tzi.org>
5 *
6 * SPDX-License-Identifier: BSD-2-Clause
7 *
8 * This file is part of the CoAP library libcoap. Please see README for terms
9 * of use.
10 */
11
17#ifndef COAP_URI_H_
18#define COAP_URI_H_
19
20#include <stdint.h>
21
22#include "coap_str.h"
23
28 typedef enum coap_uri_scheme_t {
29 COAP_URI_SCHEME_COAP = 0,
30 COAP_URI_SCHEME_COAPS, /* 1 */
31 COAP_URI_SCHEME_COAP_TCP, /* 2 */
32 COAP_URI_SCHEME_COAPS_TCP, /* 3 */
33 COAP_URI_SCHEME_HTTP, /* 4 Proxy-Uri only */
34 COAP_URI_SCHEME_HTTPS, /* 5 Proxy-Uri only */
35 COAP_URI_SCHEME_COAP_WS, /* 6 */
36 COAP_URI_SCHEME_COAPS_WS, /* 7 */
37 COAP_URI_SCHEME_LAST /* 8 Size of scheme */
38} coap_uri_scheme_t;
39
41#define COAP_URI_SCHEME_SECURE_MASK 0x01
42
43#define COAP_URI_SCHEME_COAP_BIT (1 << COAP_URI_SCHEME_COAP)
44#define COAP_URI_SCHEME_COAPS_BIT (1 << COAP_URI_SCHEME_COAPS)
45#define COAP_URI_SCHEME_COAP_TCP_BIT (1 << COAP_URI_SCHEME_COAP_TCP)
46#define COAP_URI_SCHEME_COAPS_TCP_BIT (1 << COAP_URI_SCHEME_COAPS_TCP)
47#define COAP_URI_SCHEME_HTTP_BIT (1 << COAP_URI_SCHEME_HTTP)
48#define COAP_URI_SCHEME_HTTPS_BIT (1 << COAP_URI_SCHEME_HTTPS)
49#define COAP_URI_SCHEME_COAP_WS_BIT (1 << COAP_URI_SCHEME_COAP_WS)
50#define COAP_URI_SCHEME_COAPS_WS_BIT (1 << COAP_URI_SCHEME_COAPS_WS)
51
52#define COAP_URI_SCHEME_ALL_COAP_BITS (COAP_URI_SCHEME_COAP_BIT | \
53 COAP_URI_SCHEME_COAPS_BIT | \
54 COAP_URI_SCHEME_COAP_TCP_BIT | \
55 COAP_URI_SCHEME_COAPS_TCP_BIT | \
56 COAP_URI_SCHEME_COAP_WS_BIT | \
57 COAP_URI_SCHEME_COAPS_WS_BIT)
58
65 typedef struct {
66 coap_str_const_t host;
67 uint16_t port;
68 coap_str_const_t path;
71 coap_str_const_t query;
75 enum coap_uri_scheme_t scheme;
76} coap_uri_t;
77
78 static inline int
79 coap_uri_scheme_is_secure(const coap_uri_t *uri) {
80 return uri && ((uri->scheme & COAP_URI_SCHEME_SECURE_MASK) != 0);
81}
82
92 int coap_host_is_unix_domain(const coap_str_const_t *host);
93
104 coap_uri_t *coap_new_uri(const uint8_t *uri, unsigned int length);
105
115 coap_uri_t *coap_clone_uri(const coap_uri_t *uri);
116
122 void coap_delete_uri(coap_uri_t *uri);
123
147 int coap_split_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri);
148
165 int coap_split_proxy_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri);
166
188 int coap_uri_into_options(const coap_uri_t *uri, const coap_address_t *dst,
189 coap_optlist_t **optlist_chain,
190 int create_port_host_opt,
191 uint8_t *buf, size_t buflen);
192
206 int coap_split_path(const uint8_t *s,
207 size_t length,
208 unsigned char *buf,
209 size_t *buflen);
210
226 int coap_split_query(const uint8_t *s,
227 size_t length,
228 unsigned char *buf,
229 size_t *buflen);
230
239 coap_string_t *coap_get_query(const coap_pdu_t *request);
240
249 coap_string_t *coap_get_uri_path(const coap_pdu_t *request);
250
253#endif /* COAP_URI_H_ */
coap_str.h
Strings to be used in the CoAP library.
coap_uri_scheme_is_secure
static int coap_uri_scheme_is_secure(const coap_uri_t *uri)
Definition: coap_uri.h:79
coap_uri_scheme_t
coap_uri_scheme_t
The scheme specifiers.
Definition: coap_uri.h:28
COAP_URI_SCHEME_COAPS_WS
@ COAP_URI_SCHEME_COAPS_WS
Definition: coap_uri.h:36
COAP_URI_SCHEME_COAPS_TCP
@ COAP_URI_SCHEME_COAPS_TCP
Definition: coap_uri.h:32
COAP_URI_SCHEME_COAPS
@ COAP_URI_SCHEME_COAPS
Definition: coap_uri.h:30
COAP_URI_SCHEME_COAP_TCP
@ COAP_URI_SCHEME_COAP_TCP
Definition: coap_uri.h:31
COAP_URI_SCHEME_COAP_WS
@ COAP_URI_SCHEME_COAP_WS
Definition: coap_uri.h:35
COAP_URI_SCHEME_HTTPS
@ COAP_URI_SCHEME_HTTPS
Definition: coap_uri.h:34
COAP_URI_SCHEME_COAP
@ COAP_URI_SCHEME_COAP
Definition: coap_uri.h:29
COAP_URI_SCHEME_LAST
@ COAP_URI_SCHEME_LAST
Definition: coap_uri.h:37
COAP_URI_SCHEME_HTTP
@ COAP_URI_SCHEME_HTTP
Definition: coap_uri.h:33
coap_delete_uri
void coap_delete_uri(coap_uri_t *uri)
Removes the specified coap_uri_t object.
Definition: coap_uri.c:699
COAP_URI_SCHEME_SECURE_MASK
#define COAP_URI_SCHEME_SECURE_MASK
This mask can be used to check if a parsed URI scheme is secure.
Definition: coap_uri.h:41
coap_clone_uri
coap_uri_t * coap_clone_uri(const coap_uri_t *uri)
Clones the specified coap_uri_t object.
Definition: coap_uri.c:657
coap_new_uri
coap_uri_t * coap_new_uri(const uint8_t *uri, unsigned int length)
Creates a new coap_uri_t object from the specified URI.
Definition: coap_uri.c:638
coap_host_is_unix_domain
int coap_host_is_unix_domain(const coap_str_const_t *host)
Determines from the host whether this is a Unix Domain socket request.
Definition: coap_uri.c:386
coap_get_uri_path
coap_string_t * coap_get_uri_path(const coap_pdu_t *request)
Extract uri_path string from request PDU.
Definition: coap_uri.c:769
coap_split_path
int coap_split_path(const uint8_t *s, size_t length, unsigned char *buf, size_t *buflen)
Splits the given URI path into segments.
Definition: coap_uri.c:600
coap_split_query
int coap_split_query(const uint8_t *s, size_t length, unsigned char *buf, size_t *buflen)
Splits the given URI query into segments.
Definition: coap_uri.c:612
coap_split_uri
int coap_split_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri)
Parses a given string into URI components.
Definition: coap_uri.c:269
coap_split_proxy_uri
int coap_split_proxy_uri(const uint8_t *str_var, size_t len, coap_uri_t *uri)
Parses a given string into URI components.
Definition: coap_uri.c:274
coap_uri_into_options
int coap_uri_into_options(const coap_uri_t *uri, const coap_address_t *dst, coap_optlist_t **optlist_chain, int create_port_host_opt, uint8_t *buf, size_t buflen)
Takes a coap_uri_t and then adds CoAP options into the optlist_chain.
Definition: coap_uri.c:279
coap_get_query
coap_string_t * coap_get_query(const coap_pdu_t *request)
Extract query string from request PDU according to escape rules in 6.5.8.
Definition: coap_uri.c:718
coap_address_t
Multi-purpose address abstraction.
Definition: coap_address.h:109
coap_optlist_t
Representation of chained list of CoAP options to install.
Definition: coap_option.h:325
coap_pdu_t
structure for CoAP PDUs
Definition: coap_pdu_internal.h:119
coap_str_const_t
CoAP string data definition with const data.
Definition: coap_str.h:46
coap_string_t
CoAP string data definition.
Definition: coap_str.h:38
coap_uri_t
Representation of parsed URI.
Definition: coap_uri.h:65
coap_uri_t::scheme
enum coap_uri_scheme_t scheme
The parsed scheme specifier.
Definition: coap_uri.h:75
coap_uri_t::path
coap_str_const_t path
The complete path if present or {0, NULL}.
Definition: coap_uri.h:68
coap_uri_t::port
uint16_t port
The port in host byte order.
Definition: coap_uri.h:67
coap_uri_t::query
coap_str_const_t query
The complete query if present or {0, NULL}.
Definition: coap_uri.h:71
coap_uri_t::host
coap_str_const_t host
The host part of the URI.
Definition: coap_uri.h:66