Update reqresp_parser parse_uri doxygen comments.
[asterisk/asterisk.git] / channels / sip / include / reqresp_parser.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*!
18  * \file
19  * \brief sip request response parser header file
20  */
21
22 #ifndef _SIP_REQRESP_H
23 #define _SIP_REQRESP_H
24
25 /*!
26  * \brief parses a URI in its components.
27  *
28  * \note
29  * - Multiple scheme's can be specified ',' delimited. ex: "sip:,sips:"
30  * - If a component is not requested, do not split around it. This means
31  *   that if we don't have domain, we cannot split name:pass.
32  * - It is safe to call with ret_name, pass, hostport pointing all to
33  *   the same place.
34  * - If no secret parameter is provided, ret_name will return with both
35  *   parts, user:secret.
36  * - If the URI contains a port number, hostport will return with both
37  *   parts, host:port.
38  * - This function overwrites the the URI string.
39  * 
40  * \retval 0 on success
41  * \retval -1 on error.
42  *
43  * \verbatim
44  * general form we are expecting is sip:user:password;user-parameters@host:port;uri-parameters?headers
45  * \endverbatim
46  */
47 int parse_uri(char *uri, const char *scheme, char **ret_name, char **pass,
48               char **hostport, char **transport);
49
50 /*!
51  * \brief parses a URI in to all of its components and any trailing residue
52  *
53  * \retval 0 on success
54  * \retval -1 on error.
55  *
56  */
57 int parse_uri_full(char *uri, const char *scheme, char **user, char **pass,
58                    char **hostport, struct uriparams *params, char **headers,
59                    char **residue);
60
61 /*!
62  * \brief  Get caller id name from SIP headers, copy into output buffer
63  *
64  * \retval input string pointer placed after display-name field if possible
65  */
66 const char *get_calleridname(const char *input, char *output, size_t outputsize);
67
68 /*!
69  * \brief  Get name and number from sip header
70  *
71  * \note name and number point to malloced memory on return and must be
72  * freed. If name or number is not found, they will be returned as NULL.
73  *
74  * \retval 0 success
75  * \retval -1 failure
76  */
77 int get_name_and_number(const char *hdr, char **name, char **number);
78
79 /*! \brief Pick out text in brackets from character string
80  * \return pointer to terminated stripped string
81  * \param tmp input string that will be modified
82  *
83  * Examples:
84  * \verbatim
85  * "foo" <bar>  valid input, returns bar
86  *  foo returns the whole string
87  * < "foo ... > returns the string between brackets
88  * < "foo...    bogus (missing closing bracket), returns the whole string
89  * \endverbatim
90  */
91 char *get_in_brackets(char *tmp);
92
93 /*! \brief Get text in brackets and any trailing residue
94  *
95  * \retval 0 success
96  * \retval -1 failure
97  * \retval 1 no brackets so got all
98  */
99 int get_in_brackets_full(char *tmp, char **out, char **residue);
100
101 /*! \brief Parse the ABNF structure
102  * name-andor-addr = name-addr / addr-spec
103  * into its components and return any trailing message-header parameters
104  *
105  * \retval 0 success
106  * \retval -1 failure
107  */
108 int parse_name_andor_addr(char *uri, const char *scheme, char **name,
109                           char **user, char **pass, char **domain,
110                           struct uriparams *params, char **headers,
111                           char **remander);
112
113 /*! \brief Parse all contact header contacts
114  * \retval 0 success
115  * \retval -1 failure
116  * \retval 1 all contacts (star)
117  */
118
119 int get_comma(char *parse, char **out);
120
121 int parse_contact_header(char *contactheader, struct contactliststruct *contactlist);
122
123 /*!
124  * \brief register request parsing tests
125  */
126 void sip_request_parser_register_tests(void);
127
128 /*!
129  * \brief unregister request parsing tests
130  */
131 void sip_request_parser_unregister_tests(void);
132
133 /*!
134  * \brief Parse supported header in incoming packet
135  *
136  * \details This function parses through the options parameters and
137  * builds a bit field representing all the SIP options in that field. When an
138  * item is found that is not supported, it is copied to the unsupported
139  * out buffer.
140  *
141  * \param option list
142  * \param unsupported out buffer (optional)
143  * \param unsupported out buffer length (optional)
144  */
145 unsigned int parse_sip_options(const char *options, char *unsupported, size_t unsupported_len);
146
147 /*!
148  * \brief Compare two URIs as described in RFC 3261 Section 19.1.4
149  *
150  * \param input1 First URI
151  * \param input2 Second URI
152  * \retval 0 URIs match
153  * \retval nonzero URIs do not match or one or both is malformed
154  */
155 int sip_uri_cmp(const char *input1, const char *input2);
156
157 /*!
158  * \brief initialize request and response parser data
159  *
160  * \retval 0 Success
161  * \retval -1 Failure
162  */
163 int sip_reqresp_parser_init(void);
164
165 /*!
166  * \brief Free resources used by request and response parser
167  */
168 void sip_reqresp_parser_exit(void);
169
170 /*!
171  * \brief Parse a Via header
172  *
173  * This function parses the Via header and processes it according to section
174  * 18.2 of RFC 3261 and RFC 3581. Since we don't have a transport layer, we
175  * only care about the maddr and ttl parms.  The received and rport params are
176  * not parsed.
177  *
178  * \note This function fails to parse some odd combinations of SWS in parameter
179  * lists.
180  *
181  * \code
182  * VIA syntax. RFC 3261 section 25.1
183  * Via               =  ( "Via" / "v" ) HCOLON via-parm *(COMMA via-parm)
184  * via-parm          =  sent-protocol LWS sent-by *( SEMI via-params )
185  * via-params        =  via-ttl / via-maddr
186  *                   / via-received / via-branch
187  *                   / via-extension
188  * via-ttl           =  "ttl" EQUAL ttl
189  * via-maddr         =  "maddr" EQUAL host
190  * via-received      =  "received" EQUAL (IPv4address / IPv6address)
191  * via-branch        =  "branch" EQUAL token
192  * via-extension     =  generic-param
193  * sent-protocol     =  protocol-name SLASH protocol-version
194  *                   SLASH transport
195  * protocol-name     =  "SIP" / token
196  * protocol-version  =  token
197  * transport         =  "UDP" / "TCP" / "TLS" / "SCTP"
198  *                   / other-transport
199  * sent-by           =  host [ COLON port ]
200  * ttl               =  1*3DIGIT ; 0 to 255
201  * \endcode
202  */
203 struct sip_via *parse_via(const char *header);
204
205 /*
206  * \brief Free parsed Via data.
207  */
208 void free_via(struct sip_via *v);
209
210 #endif