Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:01:52 2007

Asterisk developer's documentation :: Codename Pineapple

---

sip3_parse.c File Reference

---

Detailed Description

Various SIP parsing functions Version 3 of chan_sip.

Author:

Mark Spencer <markster@digium.com>

Olle E. Johansson <oej@edvina.net> (all the chan_sip3 changes)

See Also:

• CREDITS

Definition in file sip3_parse.c.

#include "asterisk.h"
#include <stdio.h>
#include <ctype.h>
#include <string.h>
#include <unistd.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <net/if.h>
#include <errno.h>
#include <stdlib.h>
#include <fcntl.h>
#include <netdb.h>
#include <signal.h>
#include <sys/signal.h>
#include <netinet/in.h>
#include <netinet/in_systm.h>
#include <arpa/inet.h>
#include <netinet/ip.h>
#include <regex.h>
#include "asterisk/lock.h"
#include "asterisk/channel.h"
#include "asterisk/config.h"
#include "asterisk/logger.h"
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/options.h"
#include "asterisk/sched.h"
#include "asterisk/io.h"
#include "asterisk/rtp.h"
#include "asterisk/udptl.h"
#include "asterisk/acl.h"
#include "asterisk/manager.h"
#include "asterisk/callerid.h"
#include "asterisk/cli.h"
#include "asterisk/musiconhold.h"
#include "asterisk/features.h"
#include "asterisk/causes.h"
#include "asterisk/utils.h"
#include "asterisk/file.h"
#include "asterisk/astobj.h"
#include "asterisk/linkedlists.h"
#include "asterisk/stringfields.h"
#include "asterisk/monitor.h"
#include "asterisk/compiler.h"
#include "sip3.h"
#include "sip3funcs.h"

Include dependency graph for sip3_parse.c:

Go to the source code of this file.

Functions
const char *	__get_header (struct sip_request *req, const char *name, int *start)
int	copy_all_header (struct sip_request *req, struct sip_request *orig, const char *field)
	Copy all headers from one request to another.
int	copy_header (struct sip_request *req, struct sip_request *orig, const char *field)
	Copy one header field from one request to another.
void	copy_request (struct sip_request *dst, const struct sip_request *src)
	copy SIP request (mostly used to save request for responses)
int	copy_via_headers (struct sip_dialog *p, struct sip_request *req, struct sip_request *orig, const char *field)
	Copy SIP VIA Headers from the request to the response.
int	determine_firstline_parts (struct sip_request *req)
	Parse first line of incoming SIP request.
void	extract_uri (struct sip_dialog *p, struct sip_request *req)
	Check Contact: URI of SIP message.
const char *	find_alias (const char *name, const char *_default)
	Find compressed SIP alias Structure for conversion between compressed SIP and "normal" SIP.
static const char *	find_closing_quote (const char *start, const char *lim)
	Locate closing quote in a string, skipping escaped quotes. optionally with a limit on the search. start must be past the first quote.
int	find_sip_method (const char *msg)
	find_sip_method: Find SIP method from header
char *	generate_random_string (char *buf, size_t size)
	Generate 32 byte random string for callid's etc.
int	get_destination (struct sip_dialog *p, struct sip_request *oreq)
	Find out who the call is for We use the INVITE request uri to find out Runs a dialplan lookup.
const char *	get_header (struct sip_request *req, const char *name)
	Get header from SIP request.
char *	get_in_brackets (char *tmp)
	Pick out text in brackets from character string.
int	get_rdnis (struct sip_dialog *p, struct sip_request *oreq)
	Get referring dnis.
const char *	gettag (const char *header, char *tagbuf, int tagbufsize)
	Get tag from packet.
GNURK int	lws2sws (char *msgbuf, int len)
	Parse multiline SIP headers into one header This is enabled if pedanticsipchecking is enabled.
int	method_match (enum sipmethod id, const char *name)
	returns true if 'name' (with optional trailing whitespace) matches the sip method 'id'. Strictly speaking, SIP methods are case SENSITIVE, but we do a case-insensitive comparison to be more tolerant. following Jon Postel's rule: Be gentle in what you accept, strict with what you send
void	parse_moved_contact (struct sip_dialog *p, struct sip_request *req)
	Parse 302 Moved temporalily response.
GNURK void	parse_request (struct sip_request *req)
	Parse a SIP message.
unsigned int	parse_sip_options (struct sip_dialog *pvt, const char *supported)
	Parse supported header in incoming packet.
char *	sip_method2txt (int method)
	return text string for sip method
int	sip_method_needrtp (int method)
	Check whether method needs RTP.
char *	sip_option2text (int option)
	Return text representation of SIP option.
int	sip_option_lookup (const char *optionlabel)
	Check if sip option is known to us, avoid x- options (non-standard).
void	sip_options_print (int options, int fd)
	Print options to cli.
static void	sip_set_redirstr (struct sip_dialog *p, char *reason)
	Translate referring cause.
Variables
const struct cfsip_methods	sip_methods []
static const struct cfsip_options	sip_options []
	List of well-known SIP options. If we get this in a require, we should check the list and answer accordingly.

---

Function Documentation

const char* __get_header (  struct sip_request *  req, const char *  name, int *  start )

Definition at line 587 of file sip3_parse.c. References ast_log(), ast_test_flag, sip_request::header, sip_request::headers, len, LOG_ERROR, parse_request(), SIP_PKT_CONNECTED, and SIP_PKT_PARSED. { int pass; if (!ast_test_flag(req, SIP_PKT_PARSED)) { /* Ok, so this req is not parse by parse_request yet. */ /* Parsing it before we have finished re-transmit may be bad. */ if (!ast_test_flag(req, SIP_PKT_CONNECTED)) parse_request(req); else { ast_log(LOG_ERROR, "Can't get header %s from request before parsing. Hang in for a jumpy ride!\n", name); return ""; } } /* * Technically you can place arbitrary whitespace both before and after the ':' in * a header, although RFC3261 clearly says you shouldn't before, and place just * one afterwards. If you shouldn't do it, what absolute idiot decided it was * a good idea to say you can do it, and if you can do it, why in the hell would. * you say you shouldn't. */ for (pass = 0; name && pass < 2;pass++) { int x, len = strlen(name); for (x=*start; x<req->headers; x++) { if (!strncasecmp(req->header[x], name, len)) { char *r = req->header[x] + len; /* skip name */ r = ast_skip_blanks(r); if (*r == ':') { *start = x+1; return ast_skip_blanks(r+1); } } } if (pass == 0) /* Try aliases */ name = find_alias(name, NULL); } /* Don't return NULL, so get_header is always a valid pointer */ return ""; }

int copy_all_header (  struct sip_request *  req, struct sip_request *  orig, const char *  field )

Copy all headers from one request to another. Definition at line 649 of file sip3_parse.c. References __get_header(), add_header(), and ast_strlen_zero(). { int start = 0; int copied = 0; int res; for (;;) { const char *tmp = __get_header(orig, field, &start); if (ast_strlen_zero(tmp)) break; /* Add what we're responding to */ res = add_header(req, field, tmp); if (res != -1) copied++; else return -1; } return copied ? 0 : -1; }

int copy_header (  struct sip_request *  req, struct sip_request *  orig, const char *  field )

Copy one header field from one request to another. Definition at line 638 of file sip3_parse.c. References add_header(), ast_log(), ast_strlen_zero(), get_header(), and LOG_NOTICE. { const char *tmp = get_header(orig, field); if (!ast_strlen_zero(tmp)) /* Add what we're responding to */ return add_header(req, field, tmp); ast_log(LOG_NOTICE, "No field '%s' present to copy\n", field); return -1; }

void copy_request (  struct sip_request *  dst, const struct sip_request *  src )

copy SIP request (mostly used to save request for responses) Definition at line 238 of file sip3_parse.c. References ast_calloc, ast_log(), free, LOG_DEBUG, offset, and option_debug. { long offset; int x; offset = ((void *)dst) - ((void *)src); /* First copy stuff */ memcpy(dst, src, sizeof(*dst)); /* Now, fix data part */ if (dst->data) free(dst->data); dst->data = ast_calloc(1, src->data_size); dst->data_size = src->data_size; memcpy(dst->data, src->data, src->data_size); /* Now fix pointer arithmetic */ for (x=0; x < src->headers; x++) dst->header[x] += offset; for (x=0; x < src->lines; x++) dst->line[x] += offset; if (option_debug > 3) ast_log(LOG_DEBUG, "==== Copied request... \n"); }

int copy_via_headers (  struct sip_dialog *  p, struct sip_request *  req, struct sip_request *  orig, const char *  field )

Copy SIP VIA Headers from the request to the response. Note: If the client indicates that it wishes to know the port we received from, it adds ;rport without an argument to the topmost via header. We need to add the port number (from our point of view) to that parameter. We always add ;received=<ip address>=""> to the topmost via header. Received: RFC 3261, rport RFC 3581 Definition at line 677 of file sip3_parse.c. References __get_header(), add_header(), ast_inet_ntoa(), ast_strlen_zero(), ast_test_flag, sip_dialog::flags, sip_dialog::recv, SIP_NAT, SIP_NAT_ALWAYS, and SIP_NAT_RFC3581. { int copied = 0; int start = 0; for (;;) { char new[256]; const char *oh = __get_header(orig, field, &start); if (ast_strlen_zero(oh)) break; if (!copied) { /* Only check for empty rport in topmost via header */ char leftmost[256], *others, *rport; /* Only work on leftmost value */ ast_copy_string(leftmost, oh, sizeof(leftmost)); others = strchr(leftmost, ','); if (others) *others++ = '\0'; /* Find ;rport; (empty request) */ rport = strstr(leftmost, ";rport"); if (rport && *(rport+6) == '=') rport = NULL; /* We already have a parameter to rport */ if (rport && ( (ast_test_flag(&p->flags[0], SIP_NAT) == SIP_NAT_ALWAYS) || (ast_test_flag(&p->flags[0], SIP_NAT) == SIP_NAT_RFC3581) ) ) { /* We need to add received port - rport */ char *end; rport = strstr(leftmost, ";rport"); if (rport) { end = strchr(rport + 1, ';'); if (end) memmove(rport, end, strlen(end) + 1); else *rport = '\0'; } /* Add rport to first VIA header if requested */ /* Whoo hoo! Now we can indicate port address translation too! Just another RFC (RFC3581). I'll leave the original comments in for posterity. */ snprintf(new, sizeof(new), "%s;received=%s;rport=%d%s%s", leftmost, ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), others ? "," : "", others ? others : ""); } else { /* We should *always* add a received to the topmost via */ snprintf(new, sizeof(new), "%s;received=%s%s%s", leftmost, ast_inet_ntoa(p->recv.sin_addr), others ? "," : "", others ? others : ""); } oh = new; /* the header to copy */ } /* else add the following via headers untouched */ add_header(req, field, oh); copied++; } if (!copied) { ast_log(LOG_NOTICE, "No header field '%s' present to copy\n", field); return -1; } return 0; }

int determine_firstline_parts (  struct sip_request *  req  )

Parse first line of incoming SIP request. Definition at line 865 of file sip3_parse.c. References ast_log(), sip_request::header, LOG_WARNING, sip_request::rlPart1, and sip_request::rlPart2. { char *e = ast_skip_blanks(req->header[0]); /* there shouldn't be any */ if (!*e) return -1; req->rlPart1 = e; /* method or protocol */ e = ast_skip_nonblanks(e); if (*e) *e++ = '\0'; /* Get URI or status code */ e = ast_skip_blanks(e); if ( !*e ) return -1; ast_trim_blanks(e); if (!strcasecmp(req->rlPart1, "SIP/2.0") ) { /* We have a response */ if (strlen(e) < 3) /* status code is 3 digits */ return -1; req->rlPart2 = e; } else { /* We have a request */ if ( *e == '<' ) { /* XXX the spec says it must not be in <> ! */ ast_log(LOG_WARNING, "bogus uri in <> %s\n", e); e++; if (!*e) return -1; } req->rlPart2 = e; /* URI */ e = ast_skip_nonblanks(e); if (*e) *e++ = '\0'; e = ast_skip_blanks(e); if (strcasecmp(e, "SIP/2.0") ) { ast_log(LOG_WARNING, "Bad request protocol %s\n", e); return -1; } } return 1; }

void extract_uri (  struct sip_dialog *  p, struct sip_request *  req )

Check Contact: URI of SIP message. Definition at line 906 of file sip3_parse.c. References ast_string_field_set, ast_strlen_zero(), get_header(), get_in_brackets(), and strsep(). { char stripped[256]; char *c; ast_copy_string(stripped, get_header(req, "Contact"), sizeof(stripped)); c = get_in_brackets(stripped); c = strsep(&c, ";"); /* trim ; and beyond */ if (!ast_strlen_zero(c)) ast_string_field_set(p, uri, c); }

const char* find_alias (  const char *  name, const char *  _default )

Find compressed SIP alias Structure for conversion between compressed SIP and "normal" SIP. Definition at line 320 of file sip3_parse.c. References aliases. { /*! \brief Structure for conversion between compressed SIP and "normal" SIP */ static const struct cfalias { char * const fullname; char * const shortname; } aliases[] = { { "Content-Type", "c" }, { "Content-Encoding", "e" }, { "From", "f" }, { "Call-ID", "i" }, { "Contact", "m" }, { "Content-Length", "l" }, { "Subject", "s" }, { "To", "t" }, { "Supported", "k" }, { "Refer-To", "r" }, { "Referred-By", "b" }, { "Allow-Events", "u" }, { "Event", "o" }, { "Via", "v" }, { "Accept-Contact", "a" }, { "Reject-Contact", "j" }, { "Request-Disposition", "d" }, { "Session-Expires", "x" }, { "Identity", "y" }, { "Identity-Info", "n" }, }; int x; for (x=0; x<sizeof(aliases) / sizeof(aliases[0]); x++) if (!strcasecmp(aliases[x].fullname, name)) return aliases[x].shortname; return _default; }

static const char* find_closing_quote (  const char *  start, const char *  lim )  [static]

Locate closing quote in a string, skipping escaped quotes. optionally with a limit on the search. start must be past the first quote. Definition at line 749 of file sip3_parse.c. References s. { char last_char = '\0'; const char *s; for (s = start; *s && s != lim; last_char = *s++) { if (*s == '"' && last_char != '\\') break; } return s; }

int find_sip_method (  const char *  msg  )

find_sip_method: Find SIP method from header Definition at line 163 of file sip3_parse.c. References ast_strlen_zero(), method_match(), and sip_methods. { int i, res = 0; if (ast_strlen_zero(msg)) return 0; for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) { if (method_match(i, msg)) res = sip_methods[i].id; } return res; }

char* generate_random_string (  char *  buf, size_t  size )

Generate 32 byte random string for callid's etc. Definition at line 852 of file sip3_parse.c. References ast_random(). { long val[4]; int x; for (x=0; x<4; x++) val[x] = ast_random(); snprintf(buf, size, "%08lx%08lx%08lx%08lx", val[0], val[1], val[2], val[3]); return buf; }

int get_destination (  struct sip_dialog *  p, struct sip_request *  oreq )

Find out who the call is for We use the INVITE request uri to find out Runs a dialplan lookup. Definition at line 448 of file sip3_parse.c. References sip_globals::allow_external_domains, ast_log(), AST_MAX_EXTENSION, ast_string_field_set, ast_strlen_zero(), ast_uri_decode(), ASTOBJ_CONTAINER_TRAVERSE, ASTOBJ_RDLOCK, ASTOBJ_UNLOCK, check_sip_domain(), context, domains_configured(), FALSE, sip_request::from, get_header(), get_in_brackets(), global, sip_dialog::initreq, LOG_DEBUG, LOG_WARNING, sip_request::method, option_debug, REG_MAGICMARKER, sip_dialog::registry, regl, sip_request::rlPart2, SIP_INVITE, sip_method2txt(), SIP_REFER, strsep(), and TRUE. { char tmp[256] = "", *uri, *a; char tmpf[256] = "", *from; struct sip_request *req; char *colon; int localdomain = TRUE; req = oreq; if (!req) req = p->initreq; /* Find the request URI */ if (req->rlPart2) ast_copy_string(tmp, req->rlPart2, sizeof(tmp)); ast_uri_decode(tmp); uri = get_in_brackets(tmp); if (strncmp(uri, "sip:", 4)) { ast_log(LOG_WARNING, "Huh? Not a SIP header (%s)?\n", uri); return -1; } uri += 4; /* Now find the From: caller ID and name */ ast_copy_string(tmpf, get_header(req, "From"), sizeof(tmpf)); if (!ast_strlen_zero(tmpf)) { ast_uri_decode(tmpf); from = get_in_brackets(tmpf); } else { from = NULL; } if (!ast_strlen_zero(from)) { if (strncmp(from, "sip:", 4)) { ast_log(LOG_WARNING, "Huh? Not a SIP header (%s)?\n", from); return -1; } from += 4; if ((a = strchr(from, '@'))) *a++ = '\0'; else a = from; /* just a domain */ from = strsep(&from, ";"); /* Remove userinfo options */ a = strsep(&a, ";"); /* Remove URI options */ ast_string_field_set(p, fromdomain, a); } /* Skip any options and find the domain */ /* Get the target domain */ if ((a = strchr(uri, '@'))) { *a++ = '\0'; } else { /* No username part */ a = uri; uri = "s"; /* Set extension to "s" */ } colon = strchr(a, ':'); /* Remove :port */ if (colon) *colon = '\0'; uri = strsep(&uri, ";"); /* Remove userinfo options */ a = strsep(&a, ";"); /* Remove URI options */ ast_string_field_set(p, domain, a); if (domains_configured()) { char domain_context[AST_MAX_EXTENSION]; domain_context[0] = '\0'; if (!check_sip_domain(p->domain, domain_context, sizeof(domain_context))) { localdomain = FALSE; if (!global.allow_external_domains && (req->method == SIP_INVITE || req->method == SIP_REFER)) { if (option_debug) ast_log(LOG_DEBUG, "Got SIP %s to non-local domain '%s'; refusing request.\n", sip_method2txt(req->method), p->domain); return -2; } } /* If we have a domain context defined, overwrite the original context */ if (!ast_strlen_zero(domain_context)) ast_string_field_set(p, context, domain_context); } /* If the URI starts with our magic marker and has a corresponding entry in the registry, then replace the URI with the extension we want to use */ /* We don't have to check this at all if we have no registry entries... */ if (localdomain && req->method == SIP_INVITE) { if (option_debug) ast_log(LOG_DEBUG, "Checking %s for magic registry marker \n", uri); /* Check if the incoming URI is a registry entry */ /* Need a function in ASTOBJ to check if there are objects in the container at all here to avoid this check when we have no registry entries */ if (!strncmp(uri, REG_MAGICMARKER, strlen(REG_MAGICMARKER))) { int found = FALSE; if (option_debug) ast_log(LOG_DEBUG, "Checking for %s in registry\n", uri); /* Traverse the registry to find something */ ASTOBJ_CONTAINER_TRAVERSE(&regl, !found, do { ASTOBJ_RDLOCK(iterator); if (!strcmp(uri, iterator->contact)) { found = TRUE; /* Use the extension of this registry item for the incoming call */ uri = (char *) iterator->extension; p->registry = iterator; } ASTOBJ_UNLOCK(iterator); } while(0)); } } if (sip_debug_test_pvt(p)) ast_verbose("Looking for %s in %s (domain %s)\n", uri, p->context, p->domain); /* Check the dialplan for the username part of the request URI, the domain will be stored in the SIPDOMAIN variable Return 0 if we have a matching extension */ if (ast_exists_extension(NULL, p->context, uri, 1, from) || !strcmp(uri, ast_pickup_ext())) { if (!oreq) ast_string_field_set(p, exten, uri); return 0; } /* Return 1 for pickup extension or overlap dialling support (if we support it) */ if((ast_test_flag(&global.flags[1], SIP_PAGE2_ALLOWOVERLAP) && ast_canmatch_extension(NULL, p->context, uri, 1, from)) || !strncmp(uri, ast_pickup_ext(), strlen(uri))) { return 1; } return -1; }

const char* get_header (  struct sip_request *  req, const char *  name )

Get header from SIP request. Definition at line 631 of file sip3_parse.c. References __get_header(). { int start = 0; return __get_header(req, name, &start); }

char* get_in_brackets (  char *  tmp  )

Pick out text in brackets from character string. Returns: pointer to terminated stripped string Parameters: tmp  input string that will be modified Examples: "foo" <bar> valid input, returns bar foo returns the whole string < "foo ... > returns the string between brackets < "foo... bogus (missing closing bracket), returns the whole string XXX maybe should still skip the opening bracket Definition at line 771 of file sip3_parse.c. References ast_log(), find_closing_quote(), LOG_WARNING, and parse(). { const char *parse = tmp; char *first_bracket; /* * Skip any quoted text until we find the part in brackets. * On any error give up and return the full string. */ while ( (first_bracket = strchr(parse, '<')) ) { char *first_quote = strchr(parse, '"'); if (!first_quote || first_quote > first_bracket) break; /* no need to look at quoted part */ /* the bracket is within quotes, so ignore it */ parse = find_closing_quote(first_quote + 1, NULL); if (!*parse) { /* not found, return full string ? */ /* XXX or be robust and return in-bracket part ? */ ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp); break; } parse++; } if (first_bracket) { char *second_bracket = strchr(first_bracket + 1, '>'); if (second_bracket) { *second_bracket = '\0'; tmp = first_bracket + 1; } else { ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp); } } return tmp; }

int get_rdnis (  struct sip_dialog *  p, struct sip_request *  oreq )

Get referring dnis. Definition at line 390 of file sip3_parse.c. References ast_log(), ast_string_field_set, ast_strip_quoted(), ast_strlen_zero(), ast_verbose(), exten, get_header(), get_in_brackets(), sip_dialog::initreq, LOG_WARNING, sip_dialog::owner, pbx_builtin_setvar_helper(), sip_debug_test_pvt(), sip_set_redirstr(), strcasestr(), and strsep(). { char tmp[256], *exten, *rexten, *rdomain; char *params, *reason = NULL; struct sip_request *req; req = oreq ? oreq : p->initreq; ast_copy_string(tmp, get_header(req, "Diversion"), sizeof(tmp)); if (ast_strlen_zero(tmp)) return 0; exten = get_in_brackets(tmp); if (strncmp(exten, "sip:", 4)) { ast_log(LOG_WARNING, "Huh? Not an RDNIS SIP header (%s)?\n", exten); return -1; } exten += 4; /* Get diversion-reason param if present */ if ((params = strchr(tmp, ';'))) { *params = '\0'; /* Cut off parameters */ params++; while (*params == ';' || *params == ' ') params++; /* Check if we have a reason parameter */ if ((reason = strcasestr(params, "reason="))) { reason+=7; /* Remove enclosing double-quotes */ if (*reason == '"') ast_strip_quoted(reason, "\"", "\""); if (!ast_strlen_zero(reason)) { sip_set_redirstr(p, reason); if (p->owner) { pbx_builtin_setvar_helper(p->owner, "__PRIREDIRECTREASON", p->redircause); pbx_builtin_setvar_helper(p->owner, "__SIPREDIRECTREASON", reason); } } } } rdomain = exten; rexten = strsep(&rdomain, "@"); /* trim anything after @ */ if (p->owner) pbx_builtin_setvar_helper(p->owner, "__SIPRDNISDOMAIN", rdomain); if (sip_debug_test_pvt(p)) ast_verbose("RDNIS for this call is is %s (reason %s)\n", exten, reason ? reason : ""); ast_string_field_set(p, rdnis, rexten); return 0; }

const char* gettag (  const char *  header, char *  tagbuf, int  tagbufsize )

Get tag from packet. Returns: Returns the pointer to the provided tag buffer, or NULL if the tag was not found. Definition at line 200 of file sip3_parse.c. References strcasestr(), and strsep(). { const char *thetag; if (!tagbuf) return NULL; tagbuf[0] = '\0'; /* reset the buffer */ thetag = strcasestr(header, ";tag="); if (thetag) { thetag += 5; ast_copy_string(tagbuf, thetag, tagbufsize); return strsep(&tagbuf, ";"); } return NULL; }

GNURK int lws2sws (  char *  msgbuf, int  len )

Parse multiline SIP headers into one header This is enabled if pedanticsipchecking is enabled. sip3_parse.c Definition at line 807 of file sip3_parse.c. { int h = 0, t = 0; int lws = 0; for (; h < len;) { /* Eliminate all CRs */ if (msgbuf[h] == '\r') { h++; continue; } /* Check for end-of-line */ if (msgbuf[h] == '\n') { /* Check for end-of-message */ if (h + 1 == len) break; /* Check for a continuation line */ if (msgbuf[h + 1] == ' ' || msgbuf[h + 1] == '\t') { /* Merge continuation line */ h++; continue; } /* Propagate LF and start new line */ msgbuf[t++] = msgbuf[h++]; lws = 0; continue; } if (msgbuf[h] == ' ' || msgbuf[h] == '\t') { if (lws) { h++; continue; } msgbuf[t++] = msgbuf[h++]; lws = 1; continue; } msgbuf[t++] = msgbuf[h++]; if (lws) lws = 0; } msgbuf[t] = '\0'; return t; }

int method_match (  enum sipmethod  id, const char *  name )

returns true if 'name' (with optional trailing whitespace) matches the sip method 'id'. Strictly speaking, SIP methods are case SENSITIVE, but we do a case-insensitive comparison to be more tolerant. following Jon Postel's rule: Be gentle in what you accept, strict with what you send Definition at line 152 of file sip3_parse.c. References len, sip_methods, and cfsip_options::text. { int len = strlen(sip_methods[id].text); int l_name = name ? strlen(name) : 0; /* true if the string is long enough, and ends with whitespace, and matches */ return (l_name >= len && name[len] < 33 && !strncasecmp(sip_methods[id].text, name, len)); }

void parse_moved_contact (  struct sip_dialog *  p, struct sip_request *  req )

Parse 302 Moved temporalily response. Definition at line 919 of file sip3_parse.c. References ast_log(), ast_string_field_build, ast_string_field_set, ast_test_flag, sip_dialog::flags, get_header(), get_in_brackets(), LOG_DEBUG, option_debug, sip_dialog::owner, pbx_builtin_setvar_helper(), s, SIP_PROMISCREDIR, and strsep(). { char tmp[256]; char *s, *e; char *domain; ast_copy_string(tmp, get_header(req, "Contact"), sizeof(tmp)); s = get_in_brackets(tmp); s = strsep(&s, ";"); /* strip ; and beyond */ if (ast_test_flag(&p->flags[0], SIP_PROMISCREDIR)) { if (!strncasecmp(s, "sip:", 4)) s += 4; e = strchr(s, '/'); if (e) *e = '\0'; if (option_debug) ast_log(LOG_DEBUG, "Found promiscuous redirection to 'SIP/%s'\n", s); if (p->owner) ast_string_field_build(p->owner, call_forward, "SIP/%s", s); } else { e = strchr(tmp, '@'); if (e) { *e++ = '\0'; domain = e; } else { /* No username part */ domain = tmp; } e = strchr(tmp, '/'); if (e) *e = '\0'; if (!strncasecmp(s, "sip:", 4)) s += 4; if (option_debug > 1) ast_log(LOG_DEBUG, "Received 302 Redirect to extension '%s' (domain %s)\n", s, domain); if (p->owner) { pbx_builtin_setvar_helper(p->owner, "SIPDOMAIN", domain); ast_string_field_set(p->owner, call_forward, s); } } }

GNURK void parse_request (  struct sip_request *  req  )

Parse a SIP message. Note: this function is used both on incoming and outgoing packets Definition at line 964 of file sip3_parse.c. References ast_log(), ast_strlen_zero(), sip_request::data, sip_request::header, sip_request::headers, sip_request::line, LOG_DEBUG, option_debug, sip_request::seqno, SIP_MAX_HEADERS, SIP_MAX_LINES, and sipdebug. { char *c = req->data, **dst = req->header; int i = 0, lim = SIP_MAX_HEADERS - 1; int seqno = 0; req->header[0] = c; req->headers = -1; /* mark that we are working on the header */ for (; *c; c++) { if (*c == '\r') /* remove \r */ *c = '\0'; else if (*c == '\n') { /* end of this line */ *c = '\0'; if (sipdebug && option_debug > 3) ast_log(LOG_DEBUG, "%7s %2d [%3d]: %s\n", req->headers < 0 ? "Header" : "Body", i, (int)strlen(dst[i]), dst[i]); if (ast_strlen_zero(dst[i]) && req->headers < 0) { req->headers = i; /* record number of header lines */ dst = req->line; /* start working on the body */ i = 0; lim = SIP_MAX_LINES - 1; } else { /* move to next line, check for overflows */ if (i++ >= lim) break; } dst[i] = c + 1; /* record start of next line */ } } /* update count of header or body lines */ if (req->headers >= 0) /* we are in the body */ req->lines = i; else { /* no body */ req->headers = i; req->lines = 0; req->line[0] = ""; } if (*c) ast_log(LOG_WARNING, "Too many lines, skipping <%s>\n", c); /* Split up the first line parts */ determine_firstline_parts(req); /* Determine the seqno of this request once and for all */ ast_set_flag(req, SIP_PKT_PARSED); req->callid = get_header(req, "Call-ID"); req->from = get_header(req, "From"); req->to = get_header(req, "To"); req->via = get_header(req, "Via"); /* Get the first via header only */ req->cseqheader = get_header(req, "CSeq"); /* Seqno can be zero, but anyway... */ if (!req->seqno && sscanf(req->cseqheader, "%d ", &seqno) != 1) req->seqno = seqno; }

unsigned int parse_sip_options (  struct sip_dialog *  pvt, const char *  supported )

Parse supported header in incoming packet. Definition at line 266 of file sip3_parse.c. References ast_log(), ast_strdupa, ast_strlen_zero(), FALSE, cfsip_options::id, LOG_DEBUG, option_debug, sip_option_lookup(), sip_options, and sipdebug. { char *next, *sep; char *temp; unsigned int profile = 0; int i, found; if (ast_strlen_zero(supported)) return 0; temp = ast_strdupa(supported); if (option_debug > 2 && sipdebug) ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported); for (next = temp; next; next = sep) { found = FALSE; if ( (sep = strchr(next, ',')) != NULL) *sep++ = '\0'; next = ast_skip_blanks(next); if (option_debug > 2 && sipdebug) ast_log(LOG_DEBUG, "Got SIP option: -%s-\n", next); i = sip_option_lookup(next); if (i > 0) profile |= sip_options[i].id; } if (pvt) pvt->sipoptions = profile; return profile; }

char* sip_method2txt (  int  method  )

return text string for sip method Definition at line 177 of file sip3_parse.c. References ast_log(), LOG_DEBUG, option_debug, and sip_methods. Referenced by __sip_autodestruct(), __sip_destroy(), __sip_pretend_ack(), __sip_semi_ack(), append_send_history(), build_reply_digest(), do_proxy_auth(), get_destination(), handle_request(), handle_request_subscribe(), handle_response(), init_req(), reqprep(), retrans_pkt(), sip_alloc(), sip_scheddestroy(), transmit_final_response(), and transmit_register(). { int max = sizeof(sip_methods) / sizeof(sip_methods[0]); if (method > max || method < 0) { if (option_debug > 3) ast_log(LOG_DEBUG, "Unknown SIP method %d given to this function. Strange... \n", method); return "<unknown>"; } return sip_methods[method].text; }

int sip_method_needrtp (  int  method  )

Check whether method needs RTP. Definition at line 190 of file sip3_parse.c. References cfsip_methods::need_rtp, and sip_methods. Referenced by sip_alloc(). { return sip_methods[method].need_rtp; }

char* sip_option2text (  int  option  )

Return text representation of SIP option. Definition at line 298 of file sip3_parse.c. References sip_options, and cfsip_options::text. { return sip_options[option].text; }

int sip_option_lookup (  const char *  optionlabel  )

Check if sip option is known to us, avoid x- options (non-standard). Definition at line 217 of file sip3_parse.c. References ast_log(), LOG_DEBUG, option_debug, sip_options, sipdebug, and cfsip_options::text. Referenced by parse_sip_options(). { int i; for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) { if (!strcasecmp(optionlabel, sip_options[i].text)) { if (option_debug > 2 && sipdebug) ast_log(LOG_DEBUG, "Matched SIP option: %s\n", optionlabel); return i; } } if (option_debug > 2) { if (!strncasecmp(optionlabel, "x-", 2)) ast_log(LOG_DEBUG, "Found private SIP option, not supported: %s\n", optionlabel); else ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", optionlabel); } return -1; }

void sip_options_print (  int  options, int  fd )

Print options to cli. Definition at line 304 of file sip3_parse.c. References ast_cli(), sip_options, and cfsip_options::text. Referenced by _sip_show_device(), and sip_show_channel(). { int x; int lastoption = -1; for (x=0 ; (x < (sizeof(sip_options) / sizeof(sip_options[0]))); x++) { if (sip_options[x].id != lastoption) { if (options & sip_options[x].id) ast_cli(fd, "%s ", sip_options[x].text); lastoption = x; } } }

static void sip_set_redirstr (  struct sip_dialog *  p, char *  reason )  [static]

Translate referring cause. Definition at line 359 of file sip3_parse.c. References ast_string_field_set. { if (strcmp(reason, "unknown")==0) { ast_string_field_set(p, redircause, "UNKNOWN"); } else if (strcmp(reason, "user-busy")==0) { ast_string_field_set(p, redircause, "BUSY"); } else if (strcmp(reason, "no-answer")==0) { ast_string_field_set(p, redircause, "NOANSWER"); } else if (strcmp(reason, "unavailable")==0) { ast_string_field_set(p, redircause, "UNREACHABLE"); } else if (strcmp(reason, "unconditional")==0) { ast_string_field_set(p, redircause, "UNCONDITIONAL"); } else if (strcmp(reason, "time-of-day")==0) { ast_string_field_set(p, redircause, "UNKNOWN"); } else if (strcmp(reason, "do-not-disturb")==0) { ast_string_field_set(p, redircause, "UNKNOWN"); } else if (strcmp(reason, "deflection")==0) { ast_string_field_set(p, redircause, "UNKNOWN"); } else if (strcmp(reason, "follow-me")==0) { ast_string_field_set(p, redircause, "UNKNOWN"); } else if (strcmp(reason, "out-of-service")==0) { ast_string_field_set(p, redircause, "UNREACHABLE"); } else if (strcmp(reason, "away")==0) { ast_string_field_set(p, redircause, "UNREACHABLE"); } else { ast_string_field_set(p, redircause, "UNKNOWN"); } }

---

Variable Documentation

const struct cfsip_methods sip_methods[]

XXX Note that sip_methods[i].id == i must hold or the code breaks Definition at line 86 of file sip3_parse.c.

const struct cfsip_options sip_options[] [static]

List of well-known SIP options. If we get this in a require, we should check the list and answer accordingly. Definition at line 107 of file sip3_parse.c.

---

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen