User Tools

Site Tools


cookbooks:devel:pseudovariables

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
cookbooks:devel:pseudovariables [2020/04/02 21:57]
miconda [$xavp(id) - XAVPs]
cookbooks:devel:pseudovariables [2021/06/09 13:36]
miconda [$hflc(name) - Number of Header Bodies]
Line 1: Line 1:
 +====== Pseudo-Variables ======
 +
 +Version: Kamailio SIP Server v5.6.x (devel)
 +
 {{ :cookbooks:devel:pseudovariables.png?200|}} {{ :cookbooks:devel:pseudovariables.png?200|}}
-====== Kamailio SIP Server v5.4.x (devel): Pseudo-Variables ====== 
  
 ===== Introduction ===== ===== Introduction =====
Line 193: Line 196:
 **$dd** - reference to domain of destination uri (without port) **$dd** - reference to domain of destination uri (without port)
  
 +==== $def(name) - Defined Value ====
  
 +**$def(name)** - return a defined value.
 +
 +Example:
 +
 +<code c>
 +#!define ABC xyz
 +
 +xlog("FLT_ACC: $def(ABC)\n");
 +</code>
 +
 +==== $defn(name) - Defined Value As Number ====
 +
 +**$defn(name)** - return a defined value as a signed integer.
 +
 +Example:
 +
 +<code c>
 +#!define FLT_ACC 1
 +
 +xlog("FLT_ACC: $defn(FLT_ACC)\n");
 +</code>
 ==== $di - Diversion header URI ==== ==== $di - Diversion header URI ====
  
Line 243: Line 268:
  
 **$fd** - reference to domain in URI of 'From' header **$fd** - reference to domain in URI of 'From' header
 +
 +<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
  
 ==== $fn - From display name ==== ==== $fn - From display name ====
Line 293: Line 320:
  
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices. Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
 +
 ==== $fU - From URI username ==== ==== $fU - From URI username ====
  
Line 300: Line 328:
  
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices. Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
 +
 +==== $fUl - From URI Username Length ====
 +
 +**$fUl** - length of the username in the From URI
 +
 ==== $mb - SIP message buffer ==== ==== $mb - SIP message buffer ====
  
Line 352: Line 385:
  
 **$oU** - reference to username in request's original URI **$oU** - reference to username in request's original URI
 +
 +==== $oUl - Original R-URI Username Length ====
 +
 +**$oUl** - the length of the username in the original R-URI
  
 ==== $pd - Domain in P-Preferred-Identity header URI ==== ==== $pd - Domain in P-Preferred-Identity header URI ====
Line 401: Line 438:
 **$retcode** - same as **$rc** **$retcode** - same as **$rc**
  
 +Note that the value of $rc is overwritten by each new function call.
 +
 +Example of use:
 +
 +<code c>
 + lookup("location");
 + $var(rc) = $rc;
 + if ($var(rc) < 0) {
 + t_newtran();
 + switch ($var(rc)) {
 + case -1:
 + case -3:
 + send_reply("404", "Not Found");
 + exit;
 + case -2:
 + send_reply("405", "Method Not Allowed");
 + exit;
 + }
 + }
 +
 +</code>
 ==== $rd - Domain in R-URI ==== ==== $rd - Domain in R-URI ====
  
Line 476: Line 534:
  
 <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc> <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
 +
 +==== $rUl - R-URI Username Length ====
 +
 +**$rU** - the length of the username in R-URI
  
 ==== $rv - SIP message version ==== ==== $rv - SIP message version ====
Line 615: Line 677:
  
 **$tU** - reference to username in URI of 'To' header **$tU** - reference to username in URI of 'To' header
 +
 +==== $tUl - To URI Username Length ====
 +
 +**$tU** - the length of the username in To URI
  
 ==== $Tb - Startup timestamp ==== ==== $Tb - Startup timestamp ====
Line 819: Line 885:
 </code> </code>
  
 +===== $xavi(id) - XAVIs =====
 +
 +Similar to XAVPs, but with key names are case insensitive. XAVIs are also stored in transaction context and destroyed when the transaction is terminated.
 +
 +
 +Examples:
 +
 +<code c>
 +$xavi(WhatEver=>FoO) = 123; # <- set the value
 +# $xavi(whatever[0]=>foo) == 123
 +</code>
 ===== $hdr(name) - Headers ===== ===== $hdr(name) - Headers =====
  
  
-**$hdr(name)** - represents the body of first header identified by 'name'+**$hdr(name)** - represents the body of first header field identified by 'name'
  
-**$(hdr(name)[N])** - represents the body of the N-th header identified by 'name'.+**$(hdr(name)[N])** - represents the body of the N-th header field identified by 'name'.
  
 If [N] is omitted then the body of the first header is printed. The body of first header is returned when N=0, for the second N=1, a.s.o. In case of a comma-separated multi-body headers, it returns all the bodies, comma-separated. To print the last header of that type, use -1, or other negative values to count from the end. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed. If [N] is omitted then the body of the first header is printed. The body of first header is returned when N=0, for the second N=1, a.s.o. In case of a comma-separated multi-body headers, it returns all the bodies, comma-separated. To print the last header of that type, use -1, or other negative values to count from the end. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.
Line 842: Line 919:
 <fc #0000ff>It is read-only variable. You can remove or add headers using functions from textops module.</fc> <fc #0000ff>It is read-only variable. You can remove or add headers using functions from textops module.</fc>
  
 +===== $hfl(name) - Header Field With List Of Bodies =====
 +
 +Similar to **$hdr(name)**, but for some of the standard headers that can have many bodies serialized in the same header field (i.e., comma separated list of bodies in same header field) is able to return the individual body values.
 +
 +Implemented for:
 +
 +  * Contact
 +  * Record-Route
 +  * Route
 +  * Via
 +
 +For the rest of the headers works like **$hdr(name)**.
 +
 +**$hfl(name)** - represents the first body of first header field identified by 'name'.
 +
 +**$(hfl(name)[N])** - represents the body of the N-th header field identified by 'name'.
 +
 +Example of usage:
 +
 +<code c>
 +if($(hfl(Via)[1])=~"TLS") {
 +...
 +}
 +</code>
 ===== $hdrc(name) - Number of Headers ===== ===== $hdrc(name) - Number of Headers =====
  
Line 854: Line 955:
 </code> </code>
  
 +===== $hflc(name) - Number of Header Bodies =====
 +
 +Similar to **$hdrc(name)**, but for some of the standard headers that can have many bodies serialized in the same header field (i.e., comma separated list of bodies in same header field) is able to count the number of individual bodies.
 +
 +Implemented for:
 +
 +  * Record-Route
 +  * Route
 +  * Via
 +
 +For the rest of the headers works like **$hdrc(name)**.
 +
 +
 +Example of usage:
 +
 +<code c>
 +if($hflc(Via)==3) {
 +...
 +}
 +</code>
 ===== $var(name) - Private memory variables (zero) ===== ===== $var(name) - Private memory variables (zero) =====
  
Line 978: Line 1099:
 <code c> <code c>
 xlog("The time is $utimef(%m/%d/%y %H:%M:%S)\n"); xlog("The time is $utimef(%m/%d/%y %H:%M:%S)\n");
 +</code>
 +
 +===== $ccp(key) - Config Custom Parameters =====
 +
 +Get the value for global custom parameters:
 +
 +  * https://www.kamailio.org/wiki/cookbooks/devel/core#custom_global_parameters
 +
 +
 +Example:
 +
 +<code c>
 +gv.sval = "hello" desc "hello var"
 +gv.ival = 10 desc "ten var"
 +
 +request_route {
 +    xinfo("global vars: $ccp(gv.sval) :: $ccp(gv.ival)\n");
 +}
 </code> </code>
  
Line 1019: Line 1158:
 event_route[core:msg-received] { event_route[core:msg-received] {
   xlog("rcv on $rcv(af)/$rcv(proto): ($rcv(len)) [$rcv(buf)] from [$rcv(srcip):$rcv(srcport)] to [$rcv(rcvip):$rcv(rcvport)]\n");   xlog("rcv on $rcv(af)/$rcv(proto): ($rcv(len)) [$rcv(buf)] from [$rcv(srcip):$rcv(srcport)] to [$rcv(rcvip):$rcv(rcvport)]\n");
 +}
 +</code>
 +
 +==== $rpl(key) ====
 +
 +Attributes of the SIP reply processed at that moment. The variables must be used during SIP reply processing, otherwise it returns $null.
 +
 +The key can be:
 +
 +  * duri - SIP URI corresponding to the address where the SIP reply is going to be sent based on 2nd via
 +  * dhost - host part of duri
 +  * dport - port part of duri
 +  * dproto - proto part of duri
 +  * dprotoid - proto id of duri
 +  * cntvia - the number of Via header bodies
 +
 +Example of usage:
 +
 +<code c>
 +reply_route{
 +  xinfo("reply to be sent to: $rpl(duri)\n");
 } }
 </code> </code>
Line 1083: Line 1243:
   if($sipdump(len) > 1024) {   if($sipdump(len) > 1024) {
     ...     ...
 +  }
 +}
 +</code>
 +
 +
 +===== SIPTRACE Module =====
 +==== $siptrace(name) ====
 +
 +**$siptrace(name)** - return attributes of the message handled in the event_route[siptrace:msg].
 +
 +The name can be:
 +
 +  * src_addr - source socket address (proto:ip:port)
 +  * dst_addr - destination socket address (proto:ip:port)
 +
 +Example:
 +
 +<code c>
 +event_route[siptrace:msg]
 +{
 +  $var(troubleshoot_ip) = $(siptrace(dst_addr){re.subst,/^(udp|tcp|tls):(.*):[0-9]*/\2/});
 +  if (compare_ips($var(troubleshoot_ip), "[2001:DB8::1]")) {
 +      return;
   }   }
 } }
Line 1529: Line 1712:
 ==== $T_branch_idx ==== ==== $T_branch_idx ====
  
-  * the index (starting with for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'.+  * the index (starting with for the first branch) of the branch for which is executed the branch_route[]. 
 +  * in failure_route[] block, the value is the number of completed branches added to the number of new new branches 
 +  * in request_route block, the value is number of created branches 
 +  * in onreply_route[], the value is the index of the branch receiving the reply 
 +  * if used outside of transaction processing, the value is '-1'
  
 ==== $T_reply_ruid ==== ==== $T_reply_ruid ====
Line 1697: Line 1884:
 ==== $nh(key) ==== ==== $nh(key) ====
  
-Return attributes of next hop for the SIP requestAddress is taken from dst_uri, if set, if not from new r-uri or original r-uri.+Return attributes of next hop for the SIP messagesFor SIP requests, the address is taken from dst_uri, if set, if not from new r-uri or original r-uri. For SIP replies, the attributes are taken from 2nd Via header (username is always $null for SIP replies).
  
   * $nh(u) - uri (lower case u)   * $nh(u) - uri (lower case u)
Line 1909: Line 2096:
 ==== $tls_peer_server_name ==== ==== $tls_peer_server_name ====
 The SNI server name of the peer The SNI server name of the peer
 +
 +==== $tls_peer_raw_cert ====
 +The raw PEM-encoded client certificate. String type.
 +
 +==== $tls_my_raw_cert ====
 +The raw PEM-encoded client certificate. String type.
 +
 +==== $tls_peer_urlencoded_cert ====
 +The PEM-encoded client certificate, urlencoded. String type.
 +
 +==== $tls_my_urlencoded_cert ====
 +The PEM-encoded client certificate, urlencoded. String type.
 ===== SIP Message Attributes ===== ===== SIP Message Attributes =====
  
Line 2324: Line 2523:
  
  
 +===== $K(key) - Kamailio Constants =====
  
 +$K(key) - return the numeric values corresponding to Kamailio configuration constants.
  
 +The key can be:
 +
 +  * IPv4 - return AF_INET
 +  * IPv6 - return AF_INET6
 +  * UDP - return PROTO_UDP
 +  * TCP - return PROTO_TCP
 +  * TLS - return PROTO_TLS
 +  * SCTP - return PROTO_SCTP
 +  * WS - return PROTO_WS
 +  * WSS - return PROTO_WSS
 +
 +
 +<code c>
 +xinfo("proto UDP numeric id: $K(UDP)\n");
 +</code>
 ===== Examples ===== ===== Examples =====
  
cookbooks/devel/pseudovariables.txt · Last modified: 2022/04/11 15:24 by henningw