registrar.c File Reference

---

Detailed Description

Proxy-CSCF -Registrar Related Operations.

Author:

Dragos Vingarzan vingarzan -at- fokus dot fraunhofer dot de

Definition in file registrar.c.

#include <time.h>
#include "../../parser/contact/contact.h"
#include "../../parser/contact/parse_contact.h"
#include "../../ut.h"
#include "../tm/tm_load.h"
#include "../../dset.h"
#include "registrar.h"
#include "registrar_subscribe.h"
#include "mod.h"
#include "sip.h"
#include "nat_helper.h"
#include "security.h"
#include "ims_pm.h"

Go to the source code of this file.

Functions
void	registrar_timer (unsigned int ticks, void *param)
	The Registrar timer looks for expires contacts and removes them.
static int	r_calc_expires (contact_t *c, int expires_hdr, int local_time_now)
	Calculates the expiration time for one contact.
static int	update_contacts (struct sip_msg *req, struct sip_msg *rpl, unsigned char is_star, int expires_hdr, str *public_id, int public_id_cnt, str *service_route, int service_route_cnt, int requires_nat)
	Updates the registrar with the new values.
int	P_save_location (struct sip_msg *rpl, char *str1, char *str2)
	Save the contacts and their associated public ids.
int	r_is_integrity_protected (str host, int port, int r_port, int transport, unsigned long session_hash)
	Finds if the message is integrity protected.
int	r_is_registered (str host, int port, int transport)
	Finds if the user is registered.
name_addr_t	r_assert_identity (str host, int port, int transport, name_addr_t preferred)
	Asserts the identity of the user and returns the value.
Variables
tm_binds	tmb
	Structure with pointers to tm funcs.
time_t	time_now
	current time
r_hash_slot *	registrar
	the actual registrar
int	r_hash_size
	number of hash slots in the registrar
int	pcscf_nat_enable
	whether to enable NAT
int	pcscf_nat_ping
	whether to ping anything
int	pcscf_nat_pingall
	whether to ping also the UA that don't look like being behind a NAT
int	pcscf_nat_detection_type
	the NAT detection tests

---

Function Documentation

void registrar_timer	(	unsigned int	ticks,
		void *	param
	)

The Registrar timer looks for expires contacts and removes them.

For the non-deleted contacts a ping is sent if the UA is behind a NAT.

Parameters:

	ticks	- the current time
	param	- pointer to the domain_list

Definition at line 91 of file registrar.c.

Referenced by mod_init().

{
    r_contact *c,*cn;
    int i;
    #ifdef WITH_IMS_PM
        int impu_cnt=0,contact_cnt=0,ipsec_cnt=0,tls_cnt=0,nat_cnt=0;
        r_public *rp;
    #endif
    
    LOG(L_DBG,"DBG:"M_NAME":registrar_timer: Called at %d\n",ticks);
    if (!registrar) registrar = (r_hash_slot*)param;

    r_act_time();
    
    for(i=0;i<r_hash_size;i++){
        r_lock(i);
            c = registrar[i].head;
            while(c){
                cn = c->next;
                switch (c->reg_state){
                    case NOT_REGISTERED:
                        LOG(L_DBG,"DBG:"M_NAME":registrar_timer: Contact <%.*s> Not Registered and removed.\n",
                                c->uri.len,c->uri.s);
                        del_r_contact(c);
                        break;
                    case REGISTERED:
                        if (c->expires<=time_now) {
                            LOG(L_DBG,"DBG:"M_NAME":registrar_timer: Contact <%.*s> expired and Deregistered.\n",
                                c->uri.len,c->uri.s);       
                            if (c->security){
                                /* If we have IPSec SAs, we keep them 60 seconds more to relay further messages */
                                c->reg_state = DEREGISTERED;
                                c->expires = time_now + 60;
                            }else{
                                LOG(L_DBG,"DBG:"M_NAME":registrar_timer: Contact <%.*s> expired and removed.\n",
                                    c->uri.len,c->uri.s);                       
                                del_r_contact(c);
                            }
                        }
                        #ifdef WITH_IMS_PM
                            else {
                                    contact_cnt++;
                                    for(rp=c->head;rp;rp=rp->next)
                                        impu_cnt++;
                                    if (c->security && c->security->type==SEC_IPSEC) ipsec_cnt++;
                                    if (c->security && c->security->type==SEC_TLS) tls_cnt++;               
                                    if (c->pinhole) nat_cnt++;
                            }           
                        #endif
                        break;
                    case DEREGISTERED:
                        if (c->expires<=time_now) {
                            LOG(L_DBG,"DBG:"M_NAME":registrar_timer: Contact <%.*s> expired and removed.\n",
                                c->uri.len,c->uri.s);       
                            P_security_drop(c,c->security);
                            P_security_drop(c,c->security_temp);
                            del_r_contact(c);
                        }
                        break;
                    case REG_PENDING:
                        if (c->expires<=time_now) {
                            LOG(L_DBG,"DBG:"M_NAME":registrar_timer: Contact <%.*s> Registration pending expired and removed.\n",
                                c->uri.len,c->uri.s);       
                            P_security_drop(c,c->security);
                            P_security_drop(c,c->security_temp);
                            del_r_contact(c);
                        }
                        break;
                }               
                if (pcscf_nat_enable && pcscf_nat_ping) nat_send_ping(c);
                c = cn;
            }
        r_unlock(i);
    }
    print_r(L_INFO);
    #ifdef WITH_IMS_PM
        IMS_PM_LOG01(RD_NbrContact,contact_cnt);
        IMS_PM_LOG01(RD_NbrIMPU,impu_cnt);
        IMS_PM_LOG01(RD_NbrIPSecSA,ipsec_cnt);
        IMS_PM_LOG01(RD_NbrTLSSA,tls_cnt);
        IMS_PM_LOG01(RD_NbrNATPinHoles,nat_cnt);
    #endif
}

static int r_calc_expires	(	contact_t *	c,
		int	expires_hdr,
		int	local_time_now
	)			[inline, static]

Calculates the expiration time for one contact.

Tries to use the Expiration header, if not present then use the expires parameter of the contact, if param not present it defaults to the default value. Also checks

Parameters:

	c	- the contact to calculate for
	expires_hdr	- value of expires hdr if present, if not -1
	local_time_now	- the local time

Returns:

the time of expiration

Definition at line 187 of file registrar.c.

Referenced by update_contacts().

{
    unsigned int r;
    if (expires_hdr>=0) r = expires_hdr;
    if (c) 
        str2int(&(c->expires->body), (unsigned int*)&r);
        
    return local_time_now+r;
}

static int update_contacts	(	struct sip_msg *	req,
		struct sip_msg *	rpl,
		unsigned char	is_star,
		int	expires_hdr,
		str *	public_id,
		int	public_id_cnt,
		str *	service_route,
		int	service_route_cnt,
		int	requires_nat
	)			[inline, static]

Updates the registrar with the new values.

Parameters:

	req	- the REGISTER request - to extract NAT info
	rpl	- the REGISTER reply - to extract contact info
	is_star	- whether this was a STAR contact header
	expires_hdr	- value of the Expires header
	public_id	- array of public identities attached to this contact
	public_id_cnt	- size of the public_id array
	service_route	- array of Service-Routes
	service_route_cnt	- size of the service_route array
	requires_nat	- if to create pinholes

Returns:

the maximum expiration time, -1 on error

Add the public identities

Definition at line 211 of file registrar.c.

References DEREGISTERED, _r_contact::hash, M_NAME, nat_msg_origin(), r_act_time(), r_calc_expires(), r_unlock(), REGISTERED, time_now, update_r_contact(), and update_r_public().

Referenced by P_save_location(), and save_location().

{
    r_contact *rc;
    enum Reg_States reg_state=REGISTERED;
    int expires=0;
    int is_default=0,i;
    struct sip_uri puri;
    int max_expires=-1;
    int local_time_now;
    struct hdr_field *h;
    contact_t *c;
    r_nat_dest *pinhole;
    
    
    r_act_time();
    local_time_now = time_now;
    if (is_star){
        /* first of all, we shouldn't get here...
         * then, we will update on NOTIFY */
        return 0;
    }   
    for(h=rpl->contact;h;h=h->next)
        if (h->type==HDR_CONTACT_T && h->parsed)
         for(c=((contact_body_t*)h->parsed)->contacts;c;c=c->next){
            LOG(L_DBG,"DBG:"M_NAME":update_contact: <%.*s>\n",c->uri.len,c->uri.s);
            
            expires = r_calc_expires(c,expires_hdr,local_time_now);
            
            if (parse_uri(c->uri.s,c->uri.len,&puri)<0){
                LOG(L_DBG,"DBG:"M_NAME":update_contact: Error parsing Contact URI <%.*s>\n",c->uri.len,c->uri.s);
                continue;           
            }
            if (puri.port_no==0) puri.port_no=5060;
            LOG(L_DBG,"DBG:"M_NAME":update_contact: %d %.*s : %d\n",
                puri.proto, puri.host.len,puri.host.s,puri.port_no);
            
            if (expires>local_time_now) {
                if (requires_nat) {     
                    pinhole = nat_msg_origin(req);
                    rc = update_r_contact(puri.host,puri.port_no,puri.proto,
                        &(c->uri),&reg_state,&expires,&service_route,&service_route_cnt, &pinhole);
                }else{
                    rc = update_r_contact(puri.host,puri.port_no,puri.proto,
                        &(c->uri),&reg_state,&expires,&service_route,&service_route_cnt, 0);
                }
                if (expires-time_now>max_expires) max_expires=expires-time_now;
            }
            else {
                reg_state = DEREGISTERED;
                expires = local_time_now+30;
                rc = update_r_contact(puri.host,puri.port_no,puri.proto,
                        0,&reg_state,&expires,0,0,0);
                if (rc) r_unlock(rc->hash);
                if (0>max_expires) max_expires = 0;
                rc = 0;
            }
            
            if (rc){
                is_default=1;
                if (public_id_cnt){
                    update_r_public(rc,public_id[0],&is_default);
                    is_default=0;
                    for(i=1;i<public_id_cnt;i++)
                        update_r_public(rc,public_id[i],&is_default);
                }
                r_unlock(rc->hash);
            }
    }
    return max_expires;
}

int P_save_location	(	struct sip_msg *	rpl,
		char *	str1,
		char *	str2
	)

Save the contacts and their associated public ids.

Parameters:

	rpl	- the SIP Register 200 OK response that contains the Expire and Contact headers
	str1	- not used
	str2	- not used

Returns:

CSCF_RETURN_TRUE if OK, CSCF_RETURN_ERROR on error

Removed because this would parse the hdr, but then it will fail to free the hdr->parsed

Definition at line 294 of file registrar.c.

References cscf_get_expires_hdr(), cscf_get_p_associated_uri(), cscf_get_realm(), cscf_get_request_from_reply(), cscf_get_service_route(), cscf_parse_contacts(), CSCF_RETURN_ERROR, CSCF_RETURN_TRUE, M_NAME, requires_nat(), and update_contacts().

{
    struct sip_msg *req;
    contact_body_t* b=0;    
    str realm;
    int expires_hdr=0;
    str *public_id=0;
    int public_id_cnt=0;
    int expires;
    str *service_route=0;
    int service_route_cnt;
        
    req = cscf_get_request_from_reply(rpl);
    if (!req){
        LOG(L_ERR,"ERR:"M_NAME":P_save_location: No transactional request found.\n");
        goto error;
    }
    
    expires_hdr = cscf_get_expires_hdr(rpl);
//  if (expires_hdr<0) 
//      expires_hdr = cscf_get_expires_hdr(req);
    
    if (parse_headers(rpl, HDR_EOH_F, 0) <0) {
        LOG(L_ERR,"ERR:"M_NAME":r_save_location: error parsing headers\n");
        return CSCF_RETURN_ERROR;
    }   
    
    b = cscf_parse_contacts(rpl);
    
    if (!b||(!b->contacts && !b->star)) {
        LOG(L_DBG,"DBG:"M_NAME":r_save_location: No contacts found\n");
        return 0;
    }
    
    realm = cscf_get_realm(req);
    
    cscf_get_p_associated_uri(rpl,&public_id,&public_id_cnt);
    
    service_route = cscf_get_service_route(rpl,&service_route_cnt);
            
    if ((expires=update_contacts(req,rpl,b->star,expires_hdr,public_id,public_id_cnt,service_route,service_route_cnt,requires_nat(req)))<0) 
        goto error;

    //print_r(L_ERR);
    
    
    if (service_route)  pkg_free(service_route);
    if (public_id) pkg_free(public_id);
    return CSCF_RETURN_TRUE;
error:
    if (service_route)  pkg_free(service_route);
    if (public_id) pkg_free(public_id);
    return CSCF_RETURN_ERROR;
}

int r_is_integrity_protected	(	str	host,
		int	port,
		int	r_port,
		int	transport,
		unsigned long	session_hash
	)

Finds if the message is integrity protected.

Parameters:

	host	- host of the UE
	port	- port of the UE
	r_port	- received port (added by PCSCF)
	transport	- transport of the UE
	session_hash	- TLS session hash

Returns:

1 if registered, 0 if not or error

Definition at line 360 of file registrar.c.

References _r_security::data, get_r_contact(), _r_contact::hash, _r_security::ipsec, _r_tls::port_tls, _r_ipsec::port_uc, _r_ipsec::port_us, r_unlock(), SEC_IPSEC, SEC_NONE, SEC_TLS, _r_contact::security, _r_contact::security_temp, _r_tls::session_hash, _r_security::tls, and _r_security::type.

Referenced by P_is_integrity_protected().

{
    int ret=0;
    r_contact *c;

    if (port==0) port=5060;
//  LOG(L_ERR,"DBG:"M_NAME":r_is_registered: Looking if registered <%d://%.*s:%d>\n",
//      transport,host.len,host.s,port);

//  print_r(L_INFO);
    c = get_r_contact(host,port,transport);

    if (!c) return 0;
    
    if (c->security){
        switch (c->security->type){
            case SEC_NONE:
                break;
            case SEC_TLS:
                if (c->security->data.tls&& 
                    (c->security->data.tls->port_tls==r_port) &&
                    (session_hash!= 0 && c->security->data.tls->session_hash == session_hash) // test same session
                    ){
                    ret = 1;
                }
                break;
            case SEC_IPSEC:
                if (c->security->data.ipsec&&
                    (c->security->data.ipsec->port_uc==port || c->security->data.ipsec->port_us==port)){
                    ret = 1;
                }
                break;
        }           
    }
    if (!ret && c->security_temp){
        switch (c->security_temp->type){
            case SEC_NONE:
                break;
            case SEC_TLS:
                //nothing to do here becaues TLS security in temp does not mean that the user knows the password!
                break;
            case SEC_IPSEC:
                if (c->security_temp->data.ipsec&&
                    (c->security_temp->data.ipsec->port_uc==port || c->security_temp->data.ipsec->port_us==port)){
                    ret = 1;
                }
                break;
        }           
    }
    r_unlock(c->hash);
    return ret;
}

int r_is_registered	(	str	host,
		int	port,
		int	transport
	)

Finds if the user is registered.

Parameters:

	host	- host of the UE
	port	- port of the UE
	transport	- transport of the UE

Returns:

1 if registered, 0 if not or error

Definition at line 420 of file registrar.c.

References get_r_contact(), _r_contact::hash, r_act_time(), r_reg_contact(), and r_unlock().

Referenced by P_is_registered().

{
    int ret=0;
    r_contact *c;

    if (port==0) port=5060;
//  LOG(L_ERR,"DBG:"M_NAME":r_is_registered: Looking if registered <%d://%.*s:%d>\n",
//      transport,host.len,host.s,port);

//  print_r(L_INFO);
    c = get_r_contact(host,port,transport);

    if (!c){        
        return 0;
    }   
    r_act_time();
    if (r_reg_contact(c)){
        ret = 1;
    }
    r_unlock(c->hash);
    
    return ret;
}

name_addr_t r_assert_identity	(	str	host,
		int	port,
		int	transport,
		name_addr_t	preferred
	)

Asserts the identity of the user and returns the value.

Parameters:

	host	- host of the UE
	port	- port of the UE
	transport	- transport of the UE
	preferred	- the P-Preferred-Identity header value

Returns:

1 if registered, {0,0} if not or error

Definition at line 453 of file registrar.c.

References _r_public::aor, get_r_contact(), _r_contact::hash, _r_contact::head, id, _r_public::is_default, M_NAME, _r_public::next, r_act_time(), r_reg_contact(), and r_unlock().

Referenced by P_assert_identity().

{
    r_contact *c;
    r_public *p;
    name_addr_t id;
    if (port==0) port=5060;

    memset(&id,0,sizeof(name_addr_t));
    
    LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: Asserting preferred id <%.*s>\n",
        preferred.uri.len,preferred.uri.s);
//  print_r(L_INFO);
    c = get_r_contact(host,port,transport);

    if (!c){
        LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: Contact not found\n");       
        return id;
    }
    r_act_time();
    if (!r_reg_contact(c)){
        LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: Contact expired\n");
        r_unlock(c->hash);  
        return id;
    }
    
    if (!c->head){
        LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: No public ids for this user\n");
        r_unlock(c->hash);
        return id;  
    }
    id.name = preferred.name;   
    if (!preferred.uri.len){
        p = c->head;
        while(p&&!p->is_default)
            p = p->next;
        if (p) {
            LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: to <%.*s>\n",p->aor.len,p->aor.s);
            id.uri=p->aor;
            r_unlock(c->hash);
            return id;
        } else {
            LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: to <%.*s>\n",c->head->aor.len,c->head->aor.s);
            id.uri=c->head->aor;
            r_unlock(c->hash);
            return id;  
        }
    }else{
        p = c->head;
        while(p){
            if (p->aor.len==preferred.uri.len &&
                strncasecmp(p->aor.s,preferred.uri.s,preferred.uri.len)==0)
            {
                LOG(L_DBG,"DBG:"M_NAME":r_assert_identity: to <%.*s>\n",p->aor.len,p->aor.s);
                id.uri = preferred.uri;
                r_unlock(c->hash);
                return id;                  
            }
            p = p->next;
        }
    }
    r_unlock(c->hash);
    return id;
}

---

Variable Documentation

struct tm_binds tmb

Structure with pointers to tm funcs.

Definition at line 257 of file mod.c.

time_t time_now

current time

Definition at line 71 of file registrar_storage.c.

Referenced by get_r_public_expires(), P_security_200(), print_r(), print_subs(), r_act_time(), r_calc_expires(), r_create_notifications(), r_get_reginfo_full(), r_get_reginfo_partial(), r_notification_process(), r_private_expire(), r_public_expire(), r_reg_contact(), r_update_subscription_status(), r_valid_contact(), r_valid_subscriber(), registrar_timer(), S_subscribe(), save_contact_security(), subscription_timer(), update_contacts(), and update_r_subscription().

r_hash_slot* registrar

the actual registrar

Definition at line 72 of file registrar_storage.c.

int r_hash_size

number of hash slots in the registrar

Definition at line 73 of file registrar_storage.c.

int pcscf_nat_enable

whether to enable NAT

Definition at line 142 of file mod.c.

int pcscf_nat_ping

whether to ping anything

Definition at line 143 of file mod.c.

int pcscf_nat_pingall

whether to ping also the UA that don't look like being behind a NAT

Definition at line 144 of file mod.c.

Referenced by nat_msg_origin(), nat_uac_test(), and requires_nat().

int pcscf_nat_detection_type

the NAT detection tests

Definition at line 145 of file mod.c.

Referenced by nat_uac_test().

---