registrar.h File Reference

---

Detailed Description

Serving-CSCF - Registrar-Related Operations.

Author:

Dragos Vingarzan vingarzan -at- fokus dot fraunhofer dot de

Definition in file registrar.h.

#include "../../sr_module.h"

Go to the source code of this file.

Defines
#define	IMS_USER_NOT_REGISTERED   0
	User Not Registered.
#define	IMS_USER_REGISTERED   1
	User registered.
#define	IMS_USER_UNREGISTERED   -1
	User unregistered (not registered but with services for unregistered state).
#define	IMS_USER_DEREGISTERED   -2
	User de-registered.
Functions
void	registrar_timer (unsigned int ticks, void *param)
	The Registrar timer looks for expires contacts and removes them.
int	S_assign_server (struct sip_msg *msg, char *str1, char *str2)
	Does the Server Assignment procedures, assigning this S-CSCF to the user.
int	S_assign_server_unreg (struct sip_msg *msg, char *str1, char *str2)
	Does the Server Assignment procedures, assigning this S-CSCF to the user without previous registration.
int	S_update_contacts (struct sip_msg *msg, char *str1, char *str2)
	Save the contacts.
int	SAR (struct sip_msg *msg, str realm, str public_identity, str private_identity, int assignment_type, int data_available)
	Sends a SAR.
int	save_location (struct sip_msg *msg, int assignment_type, str *xml, str *ccf1, str *ccf2, str *ecf1, str *ecf2)
	Save the contacts.
int	S_lookup (struct sip_msg *msg, char *str1, char *str2)
	Lookup for the Request-URI in registrar and rewrite request URI with the contact address.
int	r_is_registered_id (str public_identity)
	Finds if the user is registered at this S-CSCF.
int	r_is_not_registered_id (str public_identity)
	Finds if the user is not registered at this S-CSCF.
int	r_is_unregistered_id (str public_identity)
	Finds if the user is unregistered at this S-CSCF.
int	S_is_not_registered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the user in To header is not registered at this S-CSCF.
int	S_term_registered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the terminating user (in the RequestURI) is registered at this S-CSCF.
int	S_term_not_registered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the terminating user (in the RequestURI) is not registered at this S-CSCF.
int	S_term_unregistered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the terminating user (in the RequestURI) is unregistered at this S-CSCF.
int	S_orig_registered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the originating user (in P-Asserted-Identity) is registered at this S-CSCF.
int	S_orig_not_registered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the originating user (in P-Asserted-Identity) is not registered at this S-CSCF.
int	S_orig_unregistered (struct sip_msg *msg, char *str1, char *str2)
	Finds if the originating user (in P-Asserted-Identity) is unregistered at this S-CSCF.
int	S_mobile_originating (struct sip_msg *msg, char *str1, char *str2)
	Finds if the message contains as first route the specific service route for originating case (indicated in the Service-Route at registration), or if the topmost route contains the "orig" parameter.
int	S_originating_barred (struct sip_msg *msg, char *str1, char *str2)
	Finds if the originating user is barred.
int	S_terminating_barred (struct sip_msg *msg, char *str1, char *str2)
	Finds if the terminating user is barred.
int	S_add_p_asserted_identity (struct sip_msg *msg, char *str1, char *str2)
	Adds suplimentary P-Asserted-Identity.

---

Define Documentation

#define IMS_USER_NOT_REGISTERED   0

User Not Registered.

Definition at line 63 of file registrar.h.

#define IMS_USER_REGISTERED   1

User registered.

Definition at line 65 of file registrar.h.

#define IMS_USER_UNREGISTERED   -1

User unregistered (not registered but with services for unregistered state).

Definition at line 67 of file registrar.h.

#define IMS_USER_DEREGISTERED   -2

User de-registered.

Definition at line 69 of file registrar.h.

---

Function Documentation

void registrar_timer	(	unsigned int	ticks,
		void *	param
	)

The Registrar timer looks for expires contacts and removes them.

Parameters:

	ticks	- the current time
	param	- pointer to the domain_list

Definition at line 91 of file registrar.c.

References _r_public::aor, AVP_IMS_SAR_TIMEOUT_DEREGISTRATION, AVP_IMS_SAR_TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME, cscf_get_realm_from_uri(), del_r_contact(), del_r_public(), del_r_subscriber(), DEREGISTERED, _r_contact::expires, get_r_public_previous_lock(), _r_public::hash, _r_public::head, _r_contact::head, r_hash_slot::head, if, IMS_REGISTRAR_CONTACT_EXPIRED, M_NAME, _r_subscriber::next, _r_public::next, _r_contact::next, NOT_REGISTERED, P_security_drop(), _r_contact::pinhole, ims_subscription::private_identity, ims_service_profile::public_identities, ims_service_profile::public_identities_cnt, ims_public_identity::public_identity, r_act_time(), r_hash_size, r_lock(), r_unlock(), r_valid_contact(), r_valid_subscriber(), REG_PENDING, _r_public::reg_state, _r_contact::reg_state, REGISTERED, registrar, _r_public::s, S_event_reg(), SAR(), SEC_IPSEC, SEC_TLS, _r_contact::security, _r_contact::security_temp, server_assignment_store_data, ims_subscription::service_profiles, ims_subscription::service_profiles_cnt, _r_public::shead, _r_subscriber::subscriber, time_now, _r_security::type, UNREGISTERED, and _r_contact::uri.

{
    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
}

int S_assign_server	(	struct sip_msg *	msg,
		char *	str1,
		char *	str2
	)

Does the Server Assignment procedures, assigning this S-CSCF to the user.

Covered cases: AVP_IMS_SAR_NO_ASSIGNMENT = 0 AVP_IMS_SAR_REGISTRATION = 1, YES,HERE AVP_IMS_SAR_RE_REGISTRATION = 2, AVP_IMS_SAR_UNREGISTERED_USER = 3, in S_assign_server_unreg AVP_IMS_SAR_TIMEOUT_DEREGISTRATION = 4, AVP_IMS_SAR_USER_DEREGISTRATION = 5, YES,HERE AVP_IMS_SAR_TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME = 6, AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME = 7, YES,HERE AVP_IMS_SAR_ADMINISTRATIVE_DEREGISTRATION = 8, AVP_IMS_SAR_AUTHENTICATION_FAILURE = 9, AVP_IMS_SAR_AUTHENTICATION_TIMEOUT = 10, AVP_IMS_SAR_DEREGISTRATION_TOO_MUCH_DATA

Parameters:

	msg	- the SIP REGISTER message (that is authorized)
	str1	- the realm to look for in Authorization
	str2	- not used

Returns:

true if ok, false if not, break on error

Definition at line 302 of file registrar.c.

References AVP_IMS_SAR_NO_ASSIGNMENT, AVP_IMS_SAR_RE_REGISTRATION, AVP_IMS_SAR_REGISTRATION, AVP_IMS_SAR_USER_DATA_ALREADY_AVAILABLE, AVP_IMS_SAR_USER_DATA_NOT_AVAILABLE, AVP_IMS_SAR_USER_DEREGISTRATION, AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME, ci, cscf_get_max_expires(), cscf_get_private_identity(), cscf_get_public_identity(), cscf_parse_contacts(), CSCF_RETURN_BREAK, CSCF_RETURN_ERROR, CSCF_RETURN_FALSE, CSCF_RETURN_TRUE, drop_auth_userdata(), get_r_contact(), get_r_public(), _r_public::hash, _r_public::head, M_NAME, _r_contact::next, r_is_registered_id(), r_unlock(), SAR(), save_location(), and server_assignment_store_data.

{
    int ret=CSCF_RETURN_FALSE;
    str private_identity,public_identity,realm;
    int assignment_type = AVP_IMS_SAR_NO_ASSIGNMENT;
    int data_available = AVP_IMS_SAR_USER_DATA_NOT_AVAILABLE;
    int expires;
    r_public *p;
    int require_user_data=0;
    contact_body_t* b=0;
    struct hdr_field *h=0;
    contact_t *ci=0;
    r_contact *c=0;
    int n_contacts=0,contacts_reg=0;

    LOG(L_DBG,"DBG:"M_NAME":S_assign_server: Assigning server...\n");
    
    /* First check the parameters */
    if (msg->first_line.type!=SIP_REQUEST)
    {
        LOG(L_ERR,"ERR:"M_NAME":S_assign_server: This message is not a request\n");
        goto error;
    }       

    realm.s = str1; realm.len = strlen(str1);
    if (!realm.len) {
        LOG(L_ERR,"ERR:"M_NAME":S_assign_server: No realm found\n");
        return CSCF_RETURN_BREAK;
    }
        
    private_identity = cscf_get_private_identity(msg,realm);
    
    public_identity = cscf_get_public_identity(msg);
    if (!public_identity.len) {
        LOG(L_ERR,"ERR:"M_NAME":S_assign_server: public identity missing\n");       
        return ret;
    }
        
    expires = cscf_get_max_expires(msg);
    
    if (expires>0) {
        if (r_is_registered_id(public_identity)) 
            assignment_type = AVP_IMS_SAR_RE_REGISTRATION;
        else{
            assignment_type = AVP_IMS_SAR_REGISTRATION;
            require_user_data=1;
        }
    }
    else {
        if (server_assignment_store_data) 
            assignment_type = AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME;
        else assignment_type = AVP_IMS_SAR_USER_DEREGISTRATION;

        b = cscf_parse_contacts(msg);
        
        if (!b||(!b->contacts && !b->star)) {
            LOG(L_ERR,"ERR:"M_NAME":S_assign_server: No contacts found - this was just bindings fetch, no SAR done\n");
            ret = CSCF_RETURN_TRUE;
            goto done;
        }
        
        if (!b->star){
            // If not all contacts would be de-registered now, then we actually skip the SAR
            p = get_r_public(public_identity);
            if(!p)  goto error;
            
            for(h=msg->contact;h;h=h->next){
                if (h->type==HDR_CONTACT_T && h->parsed){
                    for(ci=((contact_body_t*)h->parsed)->contacts;ci;ci=ci->next){
                        if (get_r_contact(p,ci->uri))
                            n_contacts++;
                    }
                }
            }
            
            for(c=p->head;c;c=c->next)
                contacts_reg++;
            r_unlock(p->hash);
            
            if (n_contacts < contacts_reg){
                // There are still contacts left for this public id
                drop_auth_userdata(private_identity,public_identity);
                ret = save_location(msg,assignment_type,0,0,0,0,0); 
                goto done;
            }           
        }
    }
    
    //TODO
    //if (userdataavailable) data_available = AVP_IMS_SAR_USER_DATA_ALREADY_AVAILABLE;
    //else

    if(require_user_data)
        data_available = AVP_IMS_SAR_USER_DATA_NOT_AVAILABLE;
    else
        data_available = AVP_IMS_SAR_USER_DATA_ALREADY_AVAILABLE;
    
    ret = SAR(msg,realm,public_identity,private_identity,assignment_type,data_available);

done:           
    return ret; 
error:
    ret = CSCF_RETURN_ERROR;        
    return ret;
}

int S_assign_server_unreg	(	struct sip_msg *	msg,
		char *	str1,
		char *	str2
	)

Does the Server Assignment procedures, assigning this S-CSCF to the user without previous registration.

Covered cases: AVP_IMS_SAR_NO_ASSIGNMENT = 0 AVP_IMS_SAR_REGISTRATION = 1, YES, NOT HERE AVP_IMS_SAR_RE_REGISTRATION = 2, AVP_IMS_SAR_UNREGISTERED_USER = 3, YES, HERE AVP_IMS_SAR_TIMEOUT_DEREGISTRATION = 4, AVP_IMS_SAR_USER_DEREGISTRATION = 5, YES, NOT HERE AVP_IMS_SAR_TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME = 6, AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME = 7, YES, NOT HERE AVP_IMS_SAR_ADMINISTRATIVE_DEREGISTRATION = 8, AVP_IMS_SAR_AUTHENTICATION_FAILURE = 9, AVP_IMS_SAR_AUTHENTICATION_TIMEOUT = 10, AVP_IMS_SAR_DEREGISTRATION_TOO_MUCH_DATA

Parameters:

	msg	- the SIP REGISTER message (that is authorized)
	str1	- the realm to look for in Authorization
	str2	- direction - "orig" or "term"

Returns:

true if ok, false if not, break on error

Definition at line 429 of file registrar.c.

References AVP_IMS_SAR_NO_ASSIGNMENT, AVP_IMS_SAR_UNREGISTERED_USER, AVP_IMS_SAR_USER_DATA_NOT_AVAILABLE, cscf_get_asserted_identity(), cscf_get_public_identity_from_requri(), CSCF_RETURN_BREAK, CSCF_RETURN_ERROR, CSCF_RETURN_FALSE, DLG_MOBILE_ORIGINATING, DLG_MOBILE_TERMINATING, get_dialog_direction(), M_NAME, and SAR().

{
    int ret=CSCF_RETURN_FALSE;
    str private_identity={0,0},public_identity={0,0},realm={0,0};
    int assignment_type = AVP_IMS_SAR_NO_ASSIGNMENT;
    int data_available = AVP_IMS_SAR_USER_DATA_NOT_AVAILABLE;

    /* First check the parameters */
    if (msg->first_line.type!=SIP_REQUEST)
    {
        LOG(L_ERR,"ERR:"M_NAME":S_assign_server_unreg: This message is not a request\n");
        goto error;
    }       

    realm.s = str1; realm.len = strlen(str1);
    if (!realm.len) {
        LOG(L_ERR,"ERR:"M_NAME":S_assign_server_unreg: No realm found\n");
        return CSCF_RETURN_BREAK;
    }

    enum s_dialog_direction dir = get_dialog_direction(str2);
    
    switch (dir){
        case DLG_MOBILE_ORIGINATING:
            public_identity = cscf_get_asserted_identity(msg);
            if (!public_identity.len) {
                LOG(L_DBG,"DBG:"M_NAME":S_assign_server_unreg(orig): public identity missing\n");       
                return ret;
            }
            break;
        case DLG_MOBILE_TERMINATING:
            public_identity = cscf_get_public_identity_from_requri(msg);
            if (!public_identity.len) {
                LOG(L_DBG,"DBG:"M_NAME":S_assign_server_unreg(term): public identity missing\n");       
                return ret;
            }
            break;
        default:
            LOG(L_ERR,"ERR:"M_NAME":S_assign_server_unreg: bad dialog direction parameter\n");
            goto error;
    }
    
    assignment_type = AVP_IMS_SAR_UNREGISTERED_USER;
    
    //TODO
    //if (userdataavailable) data_available = AVP_IMS_SAR_USER_DATA_ALREADY_AVAILABLE;
    //else
    data_available = AVP_IMS_SAR_USER_DATA_NOT_AVAILABLE;
    
    ret = SAR(0,realm,public_identity,private_identity,assignment_type,data_available);
    
    return ret; 
error:
    ret = CSCF_RETURN_ERROR;        
    return ret;
}

int S_update_contacts	(	struct sip_msg *	msg,
		char *	str1,
		char *	str2
	)

Save the contacts.

Parameters:

	msg	- the SIP Register that contains the Expire and Contact headers
	str1	- not used
	str2	- not used

Returns:

CSCF_RETURN_TRUE if OK, CSCF_RETURN_FALSE if not or CSCF_RETURN_ERROR on error

Definition at line 1166 of file registrar.c.

References save_location().

{
    return save_location(msg, -1,0,0,0,0,0);
}

int SAR	(	struct sip_msg *	msg,
		str	realm,
		str	public_identity,
		str	private_identity,
		int	assignment_type,
		int	data_available
	)

Sends a SAR.

Can respond with a SIP reply if msg!=0

Parameters:

	msg	- the SIP message
	realm	- the realm
	public_identity	- public identity
	private_identity	- private identity
	assignment_type	- assignment type
	data_available	- if the data is already available

Returns:

CSCF_RETURN_TRUE if ok, CSCF_RETURN_FALSE on error or CSCF_RETURN_BREAK on response sent out

Definition at line 498 of file registrar.c.

References AAA_SUCCESS, AAA_UNABLE_TO_COMPLY, cdp_binds::AAAFreeMessage, AVP_IMS_SAR_ADMINISTRATIVE_DEREGISTRATION, AVP_IMS_SAR_TIMEOUT_DEREGISTRATION, AVP_IMS_SAR_TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME, AVP_IMS_SAR_UNREGISTERED_USER, AVP_IMS_SAR_USER_DEREGISTRATION, AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME, cdpb, cscf_get_realm_from_uri(), CSCF_RETURN_BREAK, CSCF_RETURN_FALSE, CSCF_RETURN_TRUE, Cx_get_charging_info(), Cx_get_experimental_result_code(), Cx_get_result_code(), Cx_get_user_data(), Cx_SAR(), drop_auth_userdata(), MSG_403_AUTH_SCHEME_UNSOPPORTED, MSG_403_IDENTITIES_DONT_MATCH, MSG_403_UNABLE_TO_COMPLY, MSG_403_UNKOWN_EXPERIMENTAL_RC, MSG_403_UNKOWN_RC, MSG_403_USER_UNKNOWN, MSG_480_DIAMETER_MISSING_AVP, MSG_480_DIAMETER_TIMEOUT_SAR, RC_IMS_DIAMETER_ERROR_AUTH_SCHEME_NOT_SUPPORTED, RC_IMS_DIAMETER_ERROR_IDENTITIES_DONT_MATCH, RC_IMS_DIAMETER_ERROR_USER_UNKNOWN, S_REGISTER_reply(), save_location(), and scscf_name_str.

Referenced by registrar_timer(), S_assign_server(), and S_assign_server_unreg().

{
    AAAMessage *saa;
    int rc=-1,experimental_rc=-1;
    str xml={0,0},ccf1={0,0},ccf2={0,0},ecf1={0,0},ecf2={0,0};
        
    if (realm.len==0){
        realm = cscf_get_realm_from_uri(private_identity);
    }       
    saa = Cx_SAR(msg,public_identity,private_identity,scscf_name_str,realm,
        assignment_type,data_available);
    
    if (!saa){
        //TODO - add the warning code 99 in the reply   
        if (msg) S_REGISTER_reply(msg,480,MSG_480_DIAMETER_TIMEOUT_SAR);        
        goto error;
    }
    
    if (!Cx_get_result_code(saa,&rc)&&
        !Cx_get_experimental_result_code(saa,&experimental_rc))
    {
        if (msg) S_REGISTER_reply(msg,480,MSG_480_DIAMETER_MISSING_AVP);
        goto done;
    }
    
    switch(rc){
        case -1:
            switch(experimental_rc){
                case RC_IMS_DIAMETER_ERROR_USER_UNKNOWN:
                    if (msg) S_REGISTER_reply(msg,403,MSG_403_USER_UNKNOWN);        
                    break;
                case RC_IMS_DIAMETER_ERROR_IDENTITIES_DONT_MATCH:
                    if (msg) S_REGISTER_reply(msg,403,MSG_403_IDENTITIES_DONT_MATCH);       
                    break;
                case RC_IMS_DIAMETER_ERROR_AUTH_SCHEME_NOT_SUPPORTED:
                    if (msg) S_REGISTER_reply(msg,403,MSG_403_AUTH_SCHEME_UNSOPPORTED);     
                    break;
                
                default:
                    if (msg) S_REGISTER_reply(msg,403,MSG_403_UNKOWN_EXPERIMENTAL_RC);      
            }
            break;
        
        case AAA_UNABLE_TO_COMPLY:
            if (msg) S_REGISTER_reply(msg,403,MSG_403_UNABLE_TO_COMPLY);        
            break;
                
        case AAA_SUCCESS:
            goto success;           
            break;
                        
        default:
            if (msg) S_REGISTER_reply(msg,403,MSG_403_UNKOWN_RC);       
    }
    
goto done;      
    
success:
    xml = Cx_get_user_data(saa);
    
    if (assignment_type==AVP_IMS_SAR_TIMEOUT_DEREGISTRATION ||
        assignment_type==AVP_IMS_SAR_USER_DEREGISTRATION ||
        assignment_type==AVP_IMS_SAR_TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME ||
        assignment_type==AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME ||
        assignment_type==AVP_IMS_SAR_ADMINISTRATIVE_DEREGISTRATION
       )
    {
        drop_auth_userdata(private_identity,public_identity);
    }
    
    Cx_get_charging_info(saa,&ccf1,&ccf2,&ecf1,&ecf2);
    if (msg||assignment_type==AVP_IMS_SAR_UNREGISTERED_USER){
        int ret = save_location(msg,assignment_type,&xml,&ccf1,&ccf2,&ecf1,&ecf2);
        if (saa) cdpb.AAAFreeMessage(&saa);
        return ret;
    }else{
        /* it was called internally and there is no SIP message to respond to */        
    }
    if (saa) cdpb.AAAFreeMessage(&saa);
    return CSCF_RETURN_TRUE;
done:   
    if (saa) cdpb.AAAFreeMessage(&saa);
    return CSCF_RETURN_FALSE;
error:  
    if (saa) cdpb.AAAFreeMessage(&saa);
    return CSCF_RETURN_BREAK;
}

int save_location	(	struct sip_msg *	msg,
		int	assignment_type,
		str *	xml,
		str *	ccf1,
		str *	ccf2,
		str *	ecf1,
		str *	ecf2
	)

Save the contacts.

1. Parse the user data 2. Parse contacts in the message 3. Update the contacts accordingly 4. Call function to add to the reply the P-Associated-URI header

Parameters:

	msg	- the SIP Register that contains the Expire and Contact headers
	assignment_type	- as sent in the SAR
	xml	- the user data as received in the SAA

Returns:

CSCF_RETURN_TRUE if ok, CSCF_RETURN_FALSE on error or CSCF_RETURN_BREAK on response sent out

Definition at line 1059 of file registrar.c.

References AVP_IMS_SAR_RE_REGISTRATION, AVP_IMS_SAR_REGISTRATION, AVP_IMS_SAR_USER_DEREGISTRATION, AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME, ci, cscf_add_header_rpl(), cscf_get_expires_hdr(), cscf_get_path(), cscf_get_public_identity(), cscf_get_user_agent(), cscf_parse_contacts(), CSCF_RETURN_BREAK, CSCF_RETURN_ERROR, CSCF_RETURN_FALSE, free_user_data(), insert_p_associated_uri(), M_NAME, MSG_423_INTERVAL_TOO_BRIEF, parse_user_data(), print_user_data(), r_is_registered_id(), registration_min_expires, S_REGISTER_reply(), scscf_registration_min_expires, server_assignment_store_data, and update_contacts().

Referenced by S_assign_server(), S_update_contacts(), and SAR().

{
    ims_subscription *s=0,*s_copy=0;
    contact_t *ci;
    contact_body_t* b=0;
    unsigned char star=0;   
    struct hdr_field *h;
    str ua={0,0};
    str path={0,0};
    int result = CSCF_RETURN_FALSE;
    int max_expires, expires_hdr,expires;
    unsigned int exp;
    
    if (xml && xml->len) {
        s = parse_user_data(*xml);
        s_copy = s;
        if (!s){
            LOG(L_ERR,"ERR:"M_NAME":save_location: error parsing user data\n");
            goto error;
        }   
        print_user_data(L_DBG,s);
    }
    
    if (msg){
        if (parse_headers(msg, HDR_EOH_F, 0) <0) {
            LOG(L_ERR,"ERR:"M_NAME":save_location: error parsing headers\n");
            goto error;
        }   
        
        b = cscf_parse_contacts(msg);
        
        if (!b||(!b->contacts && !b->star)) {
            LOG(L_ERR,"ERR:"M_NAME":save_location: No contacts found\n");
            goto error;
        }
            
        /* check for too brief interval for registration */
        expires_hdr = cscf_get_expires_hdr(msg);
        max_expires = expires_hdr;      
        
        for(h=msg->contact;h;h=h->next)
            if (h->type==HDR_CONTACT_T && h->parsed)
             for(ci=((contact_body_t*)h->parsed)->contacts;ci;ci=ci->next){
                if(ci->expires){
                    if (!str2int(&(ci->expires->body), (unsigned int*)&exp)){
                        expires = exp;
                        if (expires>max_expires) max_expires = expires;
                    }
                    else expires = -1;
                }
                else expires = expires_hdr;
                if (expires>0 && expires<registration_min_expires){
                    if (!cscf_add_header_rpl(msg,&scscf_registration_min_expires)) return CSCF_RETURN_ERROR;            
                    S_REGISTER_reply(msg,423,MSG_423_INTERVAL_TOO_BRIEF);       
                    return CSCF_RETURN_BREAK;
                }       
            }
        /* we might get gere and not know what to do actually - e.g. from S_update_contacts */
        if (assignment_type<0){
            if (max_expires>0) {
                str public_identity;
                public_identity=cscf_get_public_identity(msg);
    
                if (r_is_registered_id(public_identity)) 
                    assignment_type = AVP_IMS_SAR_RE_REGISTRATION;
                else
                    assignment_type = AVP_IMS_SAR_REGISTRATION;
            }
            else {
                if (server_assignment_store_data) 
                    assignment_type = AVP_IMS_SAR_USER_DEREGISTRATION_STORE_SERVER_NAME;
                else assignment_type = AVP_IMS_SAR_USER_DEREGISTRATION;
            }
        }
        //LOG(L_CRIT,"max_expires %d assign_type %d\n",max_expires, assignment_type);
    
        ua = cscf_get_user_agent(msg);
        
        path = cscf_get_path(msg);
        
        /* we insert p associated uri first because update will destroy s */
        if (assignment_type==AVP_IMS_SAR_REGISTRATION ||
            assignment_type==AVP_IMS_SAR_RE_REGISTRATION)
            if (!insert_p_associated_uri(msg,s)) goto error;
    }   
    
    if (b) star = b->star;
    else star = 0;
    
    result = update_contacts(msg,assignment_type, star,  &s, &ua,&path,ccf1,ccf2,ecf1,ecf2); 

    if (path.s) pkg_free(path.s);
    return result;
error:
    if (path.s) pkg_free(path.s);
    if (s && s==s_copy) free_user_data(s);  
    return result;
}

int S_lookup	(	struct sip_msg *	msg,
		char *	str1,
		char *	str2
	)

Lookup for the Request-URI in registrar and rewrite request URI with the contact address.

Also adds routing to the destination's path. Depending on the value of append_branches, the request is forked or not on multiple contacts.

Parameters:

	msg	- the SIP message
	str1	- not used
	str2	- not used

Returns:

CSCF_RETURN_TRUE if found, else CSCF_RETURN_FALSE or CSCF_RETURN_ERROR on error

Definition at line 1263 of file registrar.c.

References append_branches, cscf_get_terminating_identity(), CSCF_RETURN_ERROR, CSCF_RETURN_FALSE, CSCF_RETURN_TRUE, get_r_public(), _r_public::hash, _r_public::head, IMS_USER_REGISTERED, M_NAME, r_act_time(), r_add_p_called_party_id(), r_add_route_path(), r_unlock(), r_valid_contact(), _r_public::reg_state, and tmb.

{
    int ret=CSCF_RETURN_FALSE,i;
    str uri,dst={0,0};
    r_public *p=0;
    r_contact *c=0;

    LOG(L_DBG,"DBG:"M_NAME":S_lookup: Looking up for contacts\n");
    //print_r(L_INFO);
    /* First check the parameters */
    if (msg->first_line.type!=SIP_REQUEST)
    {
        LOG(L_ERR,"ERR:"M_NAME":S_lookup: This message is not a request\n");
        goto error;
    }       
    
    if (!cscf_get_terminating_identity(msg,&uri)){
        LOG(L_ERR,"ERR:"M_NAME":S_lookup: Error extracting terminating uri!!!\n");
        return CSCF_RETURN_ERROR;
    }
    
    LOG(L_DBG,"DBG:"M_NAME":S_lookup: Looking for <%.*s>\n",uri.len,uri.s);
    
    p = get_r_public(uri);
//  pkg_free(uri.s);
    if (!p) return CSCF_RETURN_FALSE;
    if (p->reg_state!=IMS_USER_REGISTERED){
        r_unlock(p->hash);
        return CSCF_RETURN_FALSE;
    }
    
    r_act_time();
    c = p->head;
    while(c){
        if (r_valid_contact(c)){
            LOG(L_DBG,"DBG:"M_NAME":S_lookup: Found at <%.*s>\n",
                c->uri.len,c->uri.s);
            
            r_add_route_path(msg,c);    
            r_add_p_called_party_id(msg);
            
            if (rewrite_uri(msg, &(c->uri)) < 0) {
                LOG(L_ERR,"ERR:"M_NAME":S_lookup: Error rewritting uri with <%.*s>\n",
                    c->uri.len,c->uri.s);
                ret = CSCF_RETURN_ERROR;    
            } else {
                if (c->path.len) {
                    dst=c->path;
                    i=0;
                    while(i<dst.len && dst.s[i]!='<')
                        i++;
                    i++;
                    dst.s += i;
                    dst.len -= i;
                    i=0;                    
                    while(i<dst.len && (dst.s[i]!='>'))
                        i++;
                    dst.len = i;
                }
    
                if (*tmb.route_mode==MODE_ONFAILURE) {
                    LOG(L_DBG,"DEBUG:"M_NAME":S_lookup: MODE_ONFAILURE, appending branch\n");
                    /* need to append_branch for this first contact */
                    if (append_branch(msg, c->uri.s, c->uri.len, dst.s,dst.len, c->qvalue, 0) == -1) {
                        LOG(L_ERR,"ERR:"M_NAME":S_lookup: Error appending branch <%.*s>\n",
                            c->uri.len,c->uri.s);
                    }
                }
            
                msg->dst_uri.s = pkg_malloc(dst.len);
                if (!msg->dst_uri.s){
                    LOG(L_ERR, "ERR:"M_NAME":S_lookup: Error allocating %d bytes\n",
                        dst.len);
                    msg->dst_uri.len=0;
                    goto error;
                }
                memcpy(msg->dst_uri.s,dst.s,dst.len);
                msg->dst_uri.len = dst.len;

                set_ruri_q(c->qvalue);

                ret = CSCF_RETURN_TRUE; 
                if (append_branches){
                    c = c->next;
                    while(c){
                        if (r_valid_contact(c))                                                         
                            if (append_branch(msg, c->uri.s, c->uri.len, dst.s,dst.len, c->qvalue, 0) == -1) {
                                LOG(L_ERR,"ERR:"M_NAME":S_lookup: Error appending branch <%.*s>\n",
                                    c->uri.len,c->uri.s);
                            } 
                        c = c->next;
                    }
                }

            }
            
            
            break;
        }
        c = c->next;
    }
    
    if (p) r_unlock(p->hash);       
    return ret;
error:
    if (p) r_unlock(p->hash);       
    ret=CSCF_RETURN_ERROR;
    return ret; 
}

int r_is_registered_id

(

str

public_identity

)

Finds if the user is registered at this S-CSCF.

Parameters:

public_identity

- the public identity

Returns:

1 if registered, 0 if not or error

Definition at line 1379 of file registrar.c.

References get_r_public(), _r_public::hash, _r_public::head, IMS_USER_REGISTERED, M_NAME, r_act_time(), r_unlock(), r_valid_contact(), and _r_public::reg_state.

Referenced by S_assign_server(), S_orig_registered(), S_term_registered(), and save_location().

{
    int ret=0;
    r_public *p;
    r_contact *c;

    LOG(L_DBG,"DBG:"M_NAME":S_is_registered_id: Looking if registered\n");
//  print_r(L_INFO);
    /* First check the parameters */
    
    p = get_r_public(public_identity);
    if (!p) return 0;
    if (p->reg_state!=IMS_USER_REGISTERED){
        r_unlock(p->hash);
        return 0;
    }
    
    r_act_time();
    c = p->head;
    while(c){
        if (r_valid_contact(c)){
            LOG(L_DBG,"DBG:"M_NAME":S_is_registered_id: Found at <%.*s>\n",
                c->uri.len,c->uri.s);
            ret = 1;            
            break;
        }
        c = c->next;
    }
    r_unlock(p->hash);
    return ret;
}

int r_is_not_registered_id

(

str

public_identity

)

Finds if the user is not registered at this S-CSCF.

Parameters:

public_identity

- the SIP message

Returns:

1 if registered, 0 if not or error

Definition at line 1416 of file registrar.c.

References get_r_public(), _r_public::hash, IMS_USER_NOT_REGISTERED, M_NAME, r_unlock(), and _r_public::reg_state.

Referenced by S_is_not_registered(), S_orig_not_registered(), and S_term_not_registered().

{
    int ret=0;
    r_public *p;

    LOG(L_DBG,"DBG:"M_NAME":S_is_not_registered_id: Looking if NOT registered\n");