Asterisk 1.8 sip 协议栈分析（1）…

看了一下 asterisk 1.8 ，chan_sip 更新了许多内容，下面结合asterisk 1.4 asterisk 1.6分析一下sip协议栈。

此笔记为本人学习记录，有些地方描述其他人可能看不懂，望见谅。

分析路线

sipsock_read->parse_request->find_call->handle_inconming->handle_request_方法名。。。。

协议栈初始化：load_module() 函数加载SIP配置信息，解析sip.conf挂载到全局变量中。

    首先初始化user,peer,register全局链表（1.6 版本中已经改为hash存储估计性能提高不少），这三个链表分别存储用户，peer,register三个实体。

   接下来创建调度器，IO管理器，这里IO即监听socketfd句柄上的IO事件，chan_sip用poll异步IO实现此功能，io_context 结构封装了此功能。

 创建IO调度器后注册各种app，load_module（）最后调用restart_monitor()函数创建一个线程（do_monitor()）监听sip端口（5060）上的事件， 在do_monitor()函数中首先将sip socket句柄添加到之前创建的IO管理器中，同时指定此sipsocket句柄上的IO事件对应的回调函数(sipsock_read)，即当监听的sip socket 句柄上有事件发生时调用sipsocket_read函数，此函数是所有sip包的入口，负责接收监听端口(5060)上的数据包。do_monitor函数接下来，遍历全局sip channle 链表iflock ，遍历的同时 考虑 channle 的重载 （cli reload）,，挂断那些不符合规则的sip channel,比如 rtp 超时，onhold rtp 超时、释放sip channle资源(调用sip_destroy()函数), 锁的释放，rtp，vrtp,udps 等 结构的释放。

现在回到 sipsock_read函数：

sipsock_read 函数调用 经典的udp socket 函数 recvfrom（1.8版本中已将这些经典函数封装）读取网络数据包，保存到buffer中，

 此函数中声明sip_request 结构，此结构如下：

struct sip_request {

ptrdiff_trlPart1;     
 ptrdiff_trlPart2;     
 intlen;               
 intheaders;           
 intmethod;            
 intlines;             
 unsigned int sdp_start;
 unsigned int sdp_count;
 chardebug;            
 charhas_to_tag;       
 charignore;           
 ptrdiff_t header[SIP_MAX_HEADERS];
 ptrdiff_tline[SIP_MAX_LINES];    
 struct ast_str *data;
 struct ast_str *content;
 
 struct sip_socketsocket;         
 AST_LIST_ENTRY(sip_request) next;
};

对于每一个udp数据都作为为是一次请求，此结构封装了sip 协议的消息头，方法，body,及此请求的socket句柄，保存此次请求数据的data字段，此处只是将sipsock_read读到的数据包保存到sip_request 结构的data字段，数据包的处理留给 parse_request（）函数处理。

sipsock_read函数接下来调用handle_request_do(&req,&addr); 函数处理此次请求，参数为sip_request 结构及此此数据包的来源。

handle_request_do(&req, &addr)函数内部首先 对 pedanticsipchecking 处理，此处解释一下 pedanticsipchecking

pedanticsipchecking为sip.conf文件的一个配置选项，表示是否开启将多个请求头放在一个请求头里的情况，我们知道sip消息由若干个消息头（from,to,contact等）组成，每个请求头部用/r/n分隔，但是有些情况下所有sip轻轻头放在一个轻轻头部，而没有用/r/n分隔，所以当pedanticsipchecking 设置为yes时handle_request_do会调用lws2sws函数处理此种情况，如果不显示设置pedanticsipchecking 为no，貌似1.8中默认为yes了，如果将sip debug打开，

if (req->debug) {
  ast_verbose("/n<--- SIP read from%s:%s--->/n%s/n<------------->/n",
  get_transport(req->socket.type),ast_sockaddr_stringify(addr),req->data->str);
 }

此处应该可以看到数据包的内容，在我的平台上

注册消息 在handle_request_do 内部打印内容如下：

<--- SIP read from UDP:10.10.10.84:51126--->
REGISTER sip:10.10.10.182 SIP/2.0
Via: SIP/2.0/UDP10.10.10.84:51126;branch=z9hG4bK-d87543-b525b54eb12a8030-1--d87543-;rport
Max-Forwards: 70
Contact:<sip:15011599734@10.10.10.84:51126;rinstance=aa35be9f21f51771>
To:"15011599734"<sip:15011599734@10.10.10.182>
From:"15011599734"<sip:15011599734@10.10.10.182>;tag=dc3d5677
Call-ID: OWIyMWViOThiZjQ3YmEwNTFhNzg3YzA1M2Q3ZTRhMDM.
CSeq: 1 REGISTER
Expires: 3600
Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, NOTIFY, MESSAGE,SUBSCRIBE, INFO
User-Agent: X-Lite release 1011s stamp 41150
Content-Length: 0

handle_request_do函数接下来调用parse_request（）函数正式解析数据包为rfc3261规定的sip格式，同时根据rfc3261定义做sip包的额外检查，parse_request（） 即解析进来的数据包也解析系统发出的数据包。

parse_request（） 函数内部按CRLF解析数据包(res->data),rfc3261规定SIP消息头与消息体（一般为sdp,presens或im时为xml数据）之间要用一个空行来分隔，对于一个PUBLISH请求具体形式 如下：

<--- SIP read from UDP:10.10.10.84:51126--->
PUBLISH sip:15011599734@10.10.10.182 SIP/2.0
Via: SIP/2.0/UDP10.10.10.84:51126;branch=z9hG4bK-d87543-3d691e75b7321d47-1--d87543-;rport
Max-Forwards: 70
Contact:<sip:15011599734@10.10.10.84:51126>
To:"15011599734"<sip:15011599734@10.10.10.182>
From:"15011599734"<sip:15011599734@10.10.10.182>;tag=20557655
Call-ID: YWQ1OTg4ZDg2MGFiMGUwMDk5YjI1NTYzMzQwNTc4Y2I.
CSeq: 1 PUBLISH
Expires: 3600
Allow: INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, NOTIFY, MESSAGE,SUBSCRIBE, INFO
Content-Type: application/pidf+xml
User-Agent: X-Lite release 1011s stamp 41150
Event: presence
Content-Length: 463

<?xml version='1.0'encoding='UTF-8'?><presencexmlns='urn:ietf:params:xml:ns:pidf'xmlns:dm='urn:ietf:params:xml:ns:pidf:data-model'xmlns:rpid='urn:ietf:params:xml:ns:pidf:rpid'xmlns:c='urn:ietf:params:xml:ns:pidf:cipid'entity='sip:15011599734@10.10.10.182'><tupleid='t733b0f62'><status><basic>open</basic></status></tuple><dm:personid='p0725b86e'><rpid:activities><rpid:on-the-phone/></rpid:activities><dm:note>OnthePhone</dm:note></dm:person></presence>
<------------->

加黑部分为消息头，下面为消息体，此处为软电话的presence携带状态消息，<status><basic>open</basic></status>，表示当前在线。可以看到消息头与消息体有一行空格分隔。parse_request（）函数接下来会计算消息头数量以及消息体行数，然后保存到sip_request结构的req->headers属性及req->req->lines属性上，最后parse_request（）调用determine_firstline_parts（）从sip 消息的第一个头域解析出 方法名、协议版本、及请求地址赋值给req->rlPart1及req->rlPart2属性，同时还会对sip消息的态码验证是否为三位，协议版本是否为SIP/2.0，不符合协议要求则返回错误。

现在返回到 handle_request_do()函数，调用parse_request返回后，调用find_sip_method解析sip_request的rlpart1属性找出方法名字，解析包结束后从debug消息可以输出消息头及消息体的行数

if (req->debug)
  ast_verbose("--- (%d headers %d lines)%s ---/n",req->headers, req->lines,(req->headers + req->lines == 0) ? "Nat keepalive" : "");

--- (14 headers 1 lines) ---

正常的sip消息头至少两行，所以这里同样做了验证，接下来调用find_call （），此函数的作用为查找此请求的CALL-ID，如果没找到则创建之，我们知道sip协议里有两个重要概念会话及事务，会话是一路通话的唯一标识，会话用CALL-ID及from，totag标示，事务是会话过程中某一请求及与此请求对应的效应的标识，可以认为会话包含事务，因为一路通话可能包含很多请求。

下面我们来看find_call（），对于第一次进入系统则call-ID不存在，所以find_call会创建此会话，如果请求的CALL-ID在系统中存在，则将此请求与存在的会话对接。

首先 find_call 从此次请求的sip包中解析出call-ID, From, to,Cseq头域，实际上rfc3261要求每个sip包至少还要包含Max-forwoards及VIa 头域，但chan_sip似乎没对上面两项验证，这里如果验证不通过则发 400 bad request 响应。

 原则上讲 CALL-ID 唯一标识一路通话，但是在一些代理服务器fork 时候由于CAll-ID相同，所以要用to,from tag唯一标识，如果有这种情况我们应该在sip。conf文件中打开pedanticsipchecking 选项 为 yes时find_call只是根据 CALL-ID查找是否存在，为no时根据call-id,to,from tog 查找会话是否存在，协议要求所有sip消息一定有from tag, 同时，ACK, BYE消息一定要有to tag, 否则 sip消息会被丢弃。对于from。to, tag 的解释 有一点很重要，即在响应消息中，响应者不会将 from 及to调换，因为to,from头域用来提示请求的方向而不是消息的流向，比如 bob发请求给tom，那么所有响应中的from为bob,to域为tom.

find_call 找到会话后会直接返回此会话的channle, 否则创建sip_pvt 结构并返回。1.4版本中查找会话方式是用过遍历会话链表，而1.6及1.8中已经替换为 hash方式，性能应该提高很多。

如果没找到会话则创建 channle, 创建时会 考虑 哪些方法支持 创建channel,这里ACK，PRACK,BYE，INFO,CANCEL,update方法是不可创建channle的，我们知道这些方法都是在会话已经存在时可用。如果方法不能创建会话则会响应协议本身不支持方法，返回 501 Mothed not implement, 500 serverinternal error.

这里创建sip channel 结构 sip_pvt，此结构对应一路会话的所有信息，包括 注册，协商，呼叫。

通过 sip_alloc（）创建sip_pvt结构，并将其 添加进全局会话链表 dialloglist。

下面 来分析 sip_alloc ： 此函数的参数为 call-id,前面初始化的sip_request结构，以及方法，

首先调用ao2_t_alloc 申请 对象sip_pvt内存，同时指定 垃圾回收回调函数（1.6,1.8 新增），

 这里1.8增加了 CCSS Call complete supplementaryservices ，所以分配 ccss结构。

如果此回话为请求会话，则存储请求的参数到sip_pvt属性中。包括Cseq,及branch,这里sip协议要求所有branch要以.z9hG4bK 开始，

接下来给sip_pvt 属性赋值，包括 transport type, 此会话的默认 编码（全局配置），max_forwords最大跳数(全局默认)，

sip  事务 定时器（全局 timer_t1），sip 消息转发定时器(全局配置timer_b), 此消息客户端 ip地址（），如果轻轻地客户端地址为空则拷贝默认地址（全局配置），否则将客户端地址赋值给p->ourip, 如果sip 方法支持rtp则设置 比特率（一般码率越高质量越高，录音文件越大），这里sip_alloc有个参数useglobal_nat，传进来时为1，涉及到nat穿透问题，表示 强迫 rport，即使请求中没有 rport （via头域），接下来调用do_setnat（p）rtp, vrtp,udpl 的nat 模式是否开启，设置 关于nat 穿透及rport解释参考另一篇文章 SIP通过NAT的实例解析，接下来设置 FROm 头域中的 域名（全局默认），然后调用built_via构造via头域p->via，

接下来设置默认等待音乐，是否支持转移(allowtransfer)，编码转换（capability），context,，默认的parklot, 最后 sip_alloc 函数调用工具函数ao2_t_link 把创建的会话插入全局会话容器（1.4为链表）dialogs。同时把此请求放到请求队列中。

 find_call 结束，返回handle_request_do,在find_call中将请求放入请求队列，返回后此处调用process_request_queue处理此会上上的所有请求，下面来看process_request_queue内部做了什么，此函数不断遍历sip_pvt 属性request_queue链表，从链表头取出一个请求，然后调用 Handle_incoming 处理 请求,开开sipdebug,

ast_debug(4, "**** Received %s (%d) - Command in SIP %s/n",sip_methods[p->method].text,sip_methods[p->method].id, cmd);

对于 注册请求输出如下：

Dec 16 14:06:58] DEBUG[17316]: chan_sip.c:23539 handle_incoming:**** Received REGISTER (2) - Command in SIP REGISTER

Handle_incoming 是所有sip 请求的毕经入口，下面看看内部做了什么，首先检查sequence是否正确，从请求头中找出User-Agent 保存客户端，接下来 分析 此次请求的 方法，根据不同的方法调用Handle_request_方法名 具体处理请求, 包含如下一些 方法的处理函数。

 
 switch (p->method) {
 case SIP_OPTIONS:
  res = handle_request_options(p, req, addr,e);
  break;
 case SIP_INVITE:
  res = handle_request_invite(p, req, debug,seqno, addr, recount, e, nounlock);
  break;
 case SIP_REFER:
  res = handle_request_refer(p, req, debug, seqno,nounlock);
  break;
 case SIP_CANCEL:
  res = handle_request_cancel(p, req);
  break;
 case SIP_BYE:
  res = handle_request_bye(p, req);
  break;
 case SIP_MESSAGE:
  res = handle_request_message(p, req);
  break;
 case SIP_PUBLISH:
  res = handle_request_publish(p, req, addr,seqno, e);
  break;
 case SIP_SUBSCRIBE:
  res = handle_request_subscribe(p, req, addr,seqno, e);
  break;
 case SIP_REGISTER:
  res = handle_request_register(p, req, addr,e);
  break;
 case SIP_INFO:
  if (req->debug)
   ast_verbose("ReceivingINFO!/n");
  if (!req->ignore)
   handle_request_info(p,req);
  else 
   transmit_response(p, "200 OK",req);
  break;
 case SIP_NOTIFY:
  res = handle_request_notify(p, req, addr, seqno,e);
  break;
 case SIP_UPDATE:
  res = handle_request_update(p, req);
  break;
 case SIP_ACK:
 
  if (seqno == p->pendinginvite){
   p->invitestate= INV_TERMINATED;
  p->pendinginvite = 0;
   acked = __sip_ack(p, seqno, 1, 0);
   if (find_sdp(req)) {
    if(process_sdp(p, req, SDP_T38_NONE))
    return -1;
   }
   check_pendings(p);
  } else if (p->glareinvite ==seqno) {
  
   p->glareinvite= 0;
   acked = __sip_ack(p, seqno, 1,0);
  }
  if (!acked) {
  
   p->method =oldmethod;
  }
  if (!p->lastinvite&&ast_strlen_zero(p->randdata)) {
   pvt_set_needdestroy(p,"unmatched ACK");
  }
  break;
 default:
  transmit_response_with_allow(p, "501 Method NotImplemented", req, 0);
  ast_log(LOG_NOTICE, "Unknown SIP command '%s'from '%s'/n",
   cmd,ast_sockaddr_stringify(&p->sa));
 
  if (!p->initreq.headers) {
   pvt_set_needdestroy(p,"unimplemented method");
  }
  break;
 }

 下面分析  当请求方法为register时handle_request_register做了什么。。。

路线：

handle_request_register-->register_verify->find_peer()->check_auth()->parse_register_contact()->transmit_response_with_date().

 首先，调用copy_request复制此请求到p->inireq中，此属性表明此次请求为一个已经存在的对话的请求，而不是新创建的会话的请求，

 主要用来做 未来的响应消息调用（p->inireq），接下来handle_request_register 调用register_verify

 
static enum check_auth_result register_verify(struct sip_pvt *p,struct ast_sockaddr *addr,
          struct sip_request *req, const char *uri)

 调用parse_uri从请求头中取出 To 头域，解析 To头域的请求URI，分解出域名，用户名，然后设置分机号码 为用户名，

调用build_contact 构造 constact 域，然后根据分机号码调用 find_peer，查看是否已存在，find_peer可以根据ip地址及分机号码查找peer，此处注册时根据分机号码查找，比我我想注册号码 1234到服务器10.10.10.134，则查找1234，需要注意的是此函数可能查数据库(用realtime时)，当然了，第一次注册肯定找不到，所以为了简化我们不过多讨论。

根据 find_peer返回结果 会做不同处理：

1：找到peer ，但没有设置为 host=dynamic则返回AUTH_PEER_NOT_DYNAMIC，如果设置host=dynamic ，则接下来会调用

 check_auth做验证，如果transport 错误则返回403forbidden,  验证成功则根据此次注册请求更新peer（因为找到peer所以已经认证，此时只更新peer）,调用parse_register_contact解析 contact头域做更新动作 根据不同结果 调用transmit_response_with_date做响应,这里，当响应是200ok时把contact域的地址换成了received地址，同时，当不指定强制使用rport端口时会根据contact uri中的域名解析ip地址及端口号，如果在请求的uri中有端口号则不会做域名解析，同时根据transport 类型指定端口，当为uri时端口为5060，uris时5061，

在不用请求的uri中的端口时 直接将rport端口指定到contact uri的端口上，这一点对于sipnat穿透很重要。

接下来parse_register函数验证此peer的IP地址是否为sip.conf里面配置的禁止注册ip地址，这点可以防止注册攻击，

接下来把此peer的ip地址放入peers_by_ip全局链表中，以便以后通过ip地址查找此peer,接下来处理此peer的存活时间，如果是realtime peer且开启 catche功能(sip.conf配置)，则增加此peer的存活时间。

peer->expire = ast_sched_add(sched, (expire + 10)* 1000, expire_register,
   ref_peer(peer, "add registration ref"));

同时指定 回调函数expire_register，当peer存活时间到期时调用它来销毁peer,这里（expire_register）又调用destroy_association 从数据库或ast_db中删除peer注册信息，首先，destroy_association  调用intrealtimeregs = ast_check_realtime("sipregs");返回是否存在sipregs表，不存在则指定为sippeers表，接下来又有一个特殊情况，即当sip。conf中配置了ignor_regexpire（即不考虑peer存活时间）时，此函数不会删除peer注册信息，同时，如果开启了rtupdate(sip.conf)选项，则只是用peer的注册信息更新数据库内容。除了以上情况，则调用ast_db_del("SIP/Registry", peer->name);
   ast_db_del("SIP/PeerMethods",peer->name); 删除peer信息。

同时peer信息会从内存中被删除，包括realtime peer.

下面返回注册成功信息，

注册成功则将peer信息放到ast_db中，。parse_register_contact函数接下来调用sip_poke_peer判断peer的可达性，保持nat开启，然后调用register_peer_exten 把peer分机号加入dialplan中。

最后返回到 register_verify函数调用transmit_response_with_date对此次请求做响应。

2：没找到peer且sip.conf文件中autocreatpeer选项开启（如果没找到peer，则自动创建peer,默认配置为 no），

  

根据 分机号码 （exten）创建peer结构，连接到 全局链表peers中，

 注意 此处如果是注册更新则会触发ami 事件 PeerStatus

manager_event(EVENT_FLAG_SYSTEM, "PeerStatus", "ChannelType:SIP/r/nPeer: SIP/%s/r/nPeerStatus: Registered/r/nAddress: %s/r/n",peer->name, ast_sockaddr_stringify(addr));

3： 没找到peer,sip.conf中 alwaysauthreject 开启(请求失败发 401 未认证响应)