Files
asterisk/funcs/func_uri.c
Matthew Nicholson e706b5706e According to section 19.1.2 of RFC 3261:
For each component, the set of valid BNF expansions defines exactly
  which characters may appear unescaped.  All other characters MUST be
  escaped.

This patch modifies ast_uri_encode() to encode strings in line with this recommendation.  This patch also adds an ast_escape_quoted() function which escapes '"' and '\' characters in quoted strings in accordance with section 25.1 of RFC 3261.  The ast_uri_encode() function has also been modified to take an ast_flags struct describing the set of rules it should use when escaping characters to allow for it to escape SIP URIs in addition to HTTP URIs and other types of URIs or variations of those two URI types in the future.

The ast_uri_decode() function has also been modified to accept an ast_flags struct describing the set of rules to use when decoding to enable decoding '+' as ' ' in legacy http URLs.

The unit tests for these functions have also been updated.

ABE-2705

Review: https://reviewboard.asterisk.org/r/1081/


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@303509 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2011-01-24 18:59:22 +00:00

122 lines
3.1 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2006, Digium, Inc.
*
* Created by Olle E. Johansson, Edvina.net
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief URI encoding / decoding
*
* \author Olle E. Johansson <oej@edvina.net>
*
* \note For now this code only supports 8 bit characters, not unicode,
which we ultimately will need to support.
*
* \ingroup functions
*/
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
/*** DOCUMENTATION
<function name="URIENCODE" language="en_US">
<synopsis>
Encodes a string to URI-safe encoding according to RFC 2396.
</synopsis>
<syntax>
<parameter name="data" required="true">
<para>Input string to be encoded.</para>
</parameter>
</syntax>
<description>
<para>Returns the encoded string defined in <replaceable>data</replaceable>.</para>
</description>
</function>
<function name="URIDECODE" language="en_US">
<synopsis>
Decodes a URI-encoded string according to RFC 2396.
</synopsis>
<syntax>
<parameter name="data" required="true">
<para>Input string to be decoded.</para>
</parameter>
</syntax>
<description>
<para>Returns the decoded URI-encoded <replaceable>data</replaceable> string.</para>
</description>
</function>
***/
/*! \brief uriencode: Encode URL according to RFC 2396 */
static int uriencode(struct ast_channel *chan, const char *cmd, char *data,
char *buf, size_t len)
{
if (ast_strlen_zero(data)) {
ast_log(LOG_WARNING, "Syntax: URIENCODE(<data>) - missing argument!\n");
return -1;
}
ast_uri_encode(data, buf, len, ast_uri_http);
return 0;
}
/*!\brief uridecode: Decode URI according to RFC 2396 */
static int uridecode(struct ast_channel *chan, const char *cmd, char *data,
char *buf, size_t len)
{
if (ast_strlen_zero(data)) {
ast_log(LOG_WARNING, "Syntax: URIDECODE(<data>) - missing argument!\n");
return -1;
}
ast_copy_string(buf, data, len);
ast_uri_decode(buf, ast_uri_http);
return 0;
}
static struct ast_custom_function urldecode_function = {
.name = "URIDECODE",
.read = uridecode,
};
static struct ast_custom_function urlencode_function = {
.name = "URIENCODE",
.read = uriencode,
};
static int unload_module(void)
{
return ast_custom_function_unregister(&urldecode_function)
|| ast_custom_function_unregister(&urlencode_function);
}
static int load_module(void)
{
return ast_custom_function_register(&urldecode_function)
|| ast_custom_function_register(&urlencode_function);
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "URI encode/decode dialplan functions");