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
cookbooks:devel:pseudovariables [2020/04/06 02:24]
armenb [$tls_peer_server_name]
cookbooks:devel:pseudovariables [2021/11/25 19:57] (current)
miconda [$tls(key)]
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 1021: Line 1160:
 } }
 </code> </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>
 +
 +===== $msgbuf(index) =====
 +
 +Get or set the character in the message buffer at the position index.
 +
 +The index has to be a positive integer or a variable holding such value.
 +
 +Note that the variable returns a clone of the character stored in a static buffer, copy it to another variable if you want to compare with another $msgbuf(index).
 +
 +The update is done directly and immediately in the message buffer -- use it with care!
 +
 +Example of usage:
 +
 +<code c>
 +if ($msgbuf(20)=="V") {
 +    $msgbuf(20) = "v";
 +}
 +</code>
 +===== Header Field Iterator =====
 +
 +==== $hfitname(iname) ====
 +
 +The header name of the header field iterator.
 +
 +Example:
 +
 +<code c>
 +    hf_iterator_start("i1");
 +    while(hf_iterator_next("i1")) {
 +        xlog("hdr[$hfitname(i1)] is: $hfitbody(i1)\n");
 +    }
 +    hf_iterator_end("i1");
 +</code>
 +
 +==== $hfitbody(iname) ====
 +
 +The header body of the header field iterator.
 +
 +Example:
 +
 +<code c>
 +    hf_iterator_start("i1");
 +    while(hf_iterator_next("i1")) {
 +        xlog("hdr[$hfitname(i1)] is: $hfitbody(i1)\n");
 +    }
 +    hf_iterator_end("i1");
 +</code>
 +
 +===== Body Line Iterator =====
 +
 +==== $blitval(iname) ====
 +
 +The value of the body line iterator.
 +
 +Example:
 +
 +<code c>
 +    bl_iterator_start("b1");
 +    while(bl_iterator_next("b1")) {
 +        xlog("body line: $blitval(b1)");
 +    }
 +    bl_iterator_end("b1");
 +</code>
 +
  
 ===== Send Data Attributes ===== ===== Send Data Attributes =====
Line 1084: Line 1308:
     ...     ...
   }   }
 +}
 +</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)
 +  * src_host - source host, for IPv6 host contains `[]`
 +  * dst_host - destination host, for IPv6 host contains `[]`
 +  * src_hostip - source host, for IPv6 host do not contains `[]`
 +  * dst_hostip - destination host, for IPv6 host do not contains `[]`
 +  * src_port - source port
 +  * dst_port - destination port
 +  * src_proto - source proto
 +  * dst_proto - destination proto
 +
 +Example:
 +
 +<code c>
 +event_route[siptrace:msg]
 +{
 +    if (allow_address("1", "$siptrace(src_hostip)", "0")) {
 +        return;
 +
 +    }
 +    if (compare_ips($siptrace(src_host), "[2001:DB8::1]")) {
 +        return;
 +    }
 } }
 </code> </code>
Line 1529: Line 1787:
 ==== $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 1959:
 ==== $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 1794: Line 2056:
  
 ===== TLS Module ===== ===== TLS Module =====
 +
 +==== $tls(key) ====
 +
 +Variables related to TLS communication and certificates.
 +
 +The **key** can be:
 +
 +  * **m_issuer_line** - return local (my) certificate issuer line
 +  * **p_issuer_line** - return remote (peer) certificate issuer line
 +  * **m_subject_line** - return local (my) certificate subject line
 +  * **p_subject_line** - return remote (peer) certificate subject line
 +
 +Example:
 +
 +<code c>
 +if(proto==TLS) {
 +    xinfo("local certificate subject: $tls(m_subject_line)\n");
 +}
 +</code>
  
 ==== $tls_version ==== ==== $tls_version ====
 +
 The TLS/SSL version which is used on the TLS connection from which the message was received. String type. The TLS/SSL version which is used on the TLS connection from which the message was received. String type.
 ==== $tls_description ==== ==== $tls_description ====
Line 1933: Line 2215:
   * $msg(hdrs) - sip message headers   * $msg(hdrs) - sip message headers
   * $msg(fline) - sip message first line   * $msg(fline) - sip message first line
 +
 +===== POSOPS Module =====
 +
 +==== $pos(key) ====
 +
 +Get attributes after a function of the module is executed.
 +
 +The key can be:
 +
 +  * ret - the return code on success or -1
 +  * idx - position inside message buffer, for find/search it is the start of matching
 +  * len - the length of matching string for search functions
  
 ===== XHTTP Module ===== ===== XHTTP Module =====
Line 2132: Line 2426:
   * 2 charge   * 2 charge
   * 3 spare   * 3 spare
 +
 +
 +==== $sipt(redirection_info) / $sipt_redirection_info ===
 +Returns the value of the Redirecting reason of the Call Diversion Information header from ISUP. 
 +Returns -1 if there is a parsing error or if the Call Diversion Information is not present.
 +
 +Can return the following values:
 +
 +  * 0 Unknown
 +  * 1 User busy
 +  * 2 no reply
 +  * 3 unconditional
 +  * 4 deflection during alerting
 +  * 5 deflection immediate response
 +  * 6 mobile subscriber not reachable
 +
 +
 +==== $sipt(redirection_number) / $sipt_redirection_number ===
 +Returns the value (Address signal) of the Redirection Number.
 +Returns -1 if there is a parsing error or if the Redirection Number is not present.
 +
 +Example:
 +<code c>
 +# get the redirection number
 +$avp(s:redir_num) = $sipt(redirection_number);
 +</code>
 +
 +
 +==== $sipt(redirection_number.nai) / $sipt_redirection_number_nai ===
 +Returns the value of the Nature of Address Indicator of the Redirection Number. Returns -1 if there is a parsing error or if the Redirection Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(calling_party_number) ===
 +Returns the value (Address signal) of the Calling Party for the IAM message.
 +Returns -1 if there is a parsing error or if the Calling Party Number is not present.
 +
 +
 +==== $sipt(called_party_number) ===
 +Returns the value (Address signal) of the Called Party for the IAM message.
 +Returns -1 if there is a parsing error or if the Called Party Number is not present.
 +
 +
 +==== $sipt(sipt_redirection_information_reason) ===
 +Returns the value of the Redirection reason of the Redirection information header from ISUP. 
 +Returns -1 if there is a parsing error or if the Redirection information is not present.
 +
 +
 +==== $sipt(sipt_redirection_information_original_reason) ===
 +Returns the value of the Original Redirection reason of the Redirection information header from ISUP. 
 +Returns -1 if there is a parsing error or if the Redirection information is not present.
 +
 +
 +==== $sipt(redirecting_number.nai) ===
 +Returns the value of the Nature of Address Indicator of the Redirecting Number. Returns -1 if there is a parsing error or if the Redirecting Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(redirecting_number) ===
 +Returns the value (Address signal) of the Redirecting Number for the IAM message.
 +Returns -1 if there is a parsing error or if the Redirecting Number is not present.
 +
 +
 +==== $sipt(original_called_number.nai) ===
 +Returns the value of the Nature of Address Indicator of the Original Called Number. Returns -1 if there is a parsing error or if the Original Called Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(original_called_number) ===
 +Returns the value (Address signal) of the Original Called Number for the IAM message.
 +Returns -1 if there is a parsing error or if the Original Called Number is not present.
 +
 +
 +==== $sipt(generic_number.nai) ===
 +Returns the value of the Nature of Address Indicator of the Generic Number. Returns -1 if there is a parsing error or if the Generic Number is not present.
 +
 +Can return the following values:
 +
 +  * 0 Spare
 +  * 1 Subscriber Number (national use)
 +  * 2 Unknown (national use)
 +  * 3 National (significant) number
 +  * 4 International use
 +
 +
 +==== $sipt(generic_number) ===
 +Returns the value (Address signal) of the Generic Number for the IAM message.
 +Returns -1 if there is a parsing error or if the Generic Number is not present.
  
  
Line 2253: Line 2656:
   * 0x999 - HEP attribute 0x999   * 0x999 - HEP attribute 0x999
  
-===== $phn(rid=>key) - Phonenum Variables =====+===== Phonenum Variables =====
  
 $phn(rid=>key) - rid is an identifier for this query result; it is designated by the second parameter of phonenum_match(). The key can be one of the following: $phn(rid=>key) - rid is an identifier for this query result; it is designated by the second parameter of phonenum_match(). The key can be one of the following:
Line 2275: Line 2678:
 </code> </code>
  
 +===== SecSIPId Variables =====
  
 +$secsipid(key) - return attributes of secsipid module.
 +
 +The key can be:
 +
 +  * val - the value of Identity computed by secsipid_build_identity(...)
 +  * ret - the return code of the libsecsipid function used by secsipid_build_identity(...)
 +
 +Example:
 +
 +<code c>
 +if(secsipid_build_identity("$fU", "$rU", "A", "",
 +        "https://kamailio.org/stir/$rd/cert.pem", "/secsipid/$rd/key.pem")) {
 +    xinfo("identity value: $secsipid(val)\n");
 +}
 +</code>
 ===== sdpops module variables ===== ===== sdpops module variables =====
  
Line 2293: Line 2712:
   * $ltt(x) - $ltt(t) if the transaction was created already, otherwise $ltt(s)   * $ltt(x) - $ltt(t) if the transaction was created already, otherwise $ltt(s)
  
 +===== $via0(attr) - Via[0] Attributes =====
 +
 +$via0(attr) - attributes of first Via header.
 +
 +The attr can be:
 +
 +  * host - host part (string)
 +  * port - port (number)
 +  * proto - protocol - transport part (string)
 +  * protoid - protocol id (integer id)
 +  * branch - branch parameter
 +  * rport - rport parameter value (string)
 +  * received - received parameter value (string)
 +  * i - i parameter value (string)
 +
 +===== $via1(attr) - Second Via Attributes =====
 +
 +$via1(attr) - attributes of second Via header. The attr can be the same as for $via0(attr).
 +
 +===== $viaZ(attr) - Last Via Attributes =====
 +
 +$viaZ(attr) - attributes of last Via header. The attr can be the same as for $via0(attr).
 ===== tcpops module variable ===== ===== tcpops module variable =====
  
Line 2336: Line 2777:
  
  
 +===== $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.1586132695.txt.gz · Last modified: 2020/04/06 02:24 by armenb