Outline The HOTARU project is an alias of "The reference software research and development project of IMS/SIP" which is joint effort of the Industry, University and Government. The Execution method for the product of HOTARU to work as each CSCFs or as test UE are shown below. Please refer details of the project to http://www.luciola.net/ . The main reference Technical Specification and RFC of HOTARU is as follows. 3GPP TS 22.228, TS 23.002, TS 23.228, TS 24.228, TS 24.229, TS 29.162, TS 29.228, TS 29.229, TS 33.102, TS 33.105, TS 33.203, TS 33.210, TS 35.205, TS 35.206, TS 35.207, TS 35.208 IETF RFC3261, RFC3262, RFC3264, RFC3265, RFC3310, RFC3312, RFC3313, RFC3323, RFC3325, RFC3327, RFC3329, RFC3455, RFC3608, RFC4028, RFC5407 - System requirements linux - Execution method The execution file of HOTARU can switch operation as each CSCF (P/I/S-CSCF (IMS/SIP server)) or test UE (IMS/SIP client) by setting each configuration file. In the following section 1,2,3 you can see how to construct the execution environment for P-CSCF. And next section 4, you can see how to execute and check it. If you would like to execute as another type node then you can configure similar procedure as following. 1. Environmental setting a. Decompression of HOTARU source code tar zxvf hotaru_code_xxxxxxxx.tgz b. Library installation Please prepare a necessary library files and set the library path in Makefile. In optional compilation, if you would like to use sigcomp functions in HOTARU, then you need to prepare opensigcomp library files and set the library path as following. ./hotaru_mejiro/etc/hotaru_base.mk LIBS = ... -lm -lglib-2.0 -lrt -lc -lopensigcomp -lmd5 c. Installation of tools (setkey) Please install the latest version of setkey on the server. HOTARU use to control IPsec by the setkey command. d. Environment variable setting (HOTARU_ROOT) #export HOTARU_ROOT=/home/hotaru/mejiro/pcscf/hotaru_mejiro (For bash). Note: /home/hotaru/mejiro/pcscf is an given directory expanding of the HOTARU source code. 2. make a. Making of HOTARU library Please execute make command in HOTARU source code expanding directory. #cd /home/hotaru/mejiro/pcscf/hotaru_mejiro #make The HOTARU library is made under ./hotaru_mejiro/libs. These libraries made for each function of HOTARU. b. Making of HOTARU execution file #cd /home/hotaru/mejiro/pcscf/hotaru_mejiro/test #make The HOTARU execution file is made by the name of "sample". Please change the name of the HOTARU execution file properly by setting Makefile. 3. Setting of configuration file a) ./hotaru_mejiro/conf/hotaru.cfg In this configuration file, you can set the specification of the IMS/SIP service port and routing informations. The parameters referred to according to the role of each CSCF and the attribute value are different, here we explain the setting of a common parameters. Please refer to the sample file for other parameters. (hotaru.cfg_XCSCF,hotaru.cfg_UE) [cscf] mode=pcscf Attribute values which allowed: ue/pcscf/icscf/scscf (The operational mode of the HOTARU execution file is specified). [transaction] t1=20000 The t1 timer specified by RFC3261 regulations. [transport] use_recv_mirror_mode=disable For debugging (disable is specified usually): This parameter can output the reception message such as SIP to an external port of the following parameter specification. recv_mirror_port=5000 recv_mirror_host=192.168.0.210 send_mirror_port=5001 send_mirror_host=192.168.0.210 use_send_mirror_mode=disable For debugging (disable is specified usually): This parameter can output transmission message such as SIP to an external port of the above parameter specification. udp_port=6060 SIP server port is specified (UDP) tcp_port=6061 SIP server port is specified (TCP) transport_proto=dual dual is usually specified. (specification of the dual stack of IPv4/IPv6). use_udp_bidirection_mode=disable disable is usually specified. use_tcp_bidirection_mode=enable enable is usually specified. (mode to return response by request reception socket) use_multisocket_mode=enable enable is specified when you operate as pcscf, and disable is specified when you operate as other nodes.(This specification controls the sockets in PCSCF which is described in 3GPP TS33.203.) sigcomp_mode=disable enable is specified when you operate sigcomp function in pcscf. disable is usually spedified. noncomp_addr=192.168.0.210|scscf.luciola.net|icscf.luciola.net It is referred when the above-mentioned sigcomp_mode parameter is enable. The sigcomp function is necessary between UE-PCSCF usually. Please set IP address or FQDN of backend servers of P-CSCF as not to compress the signalling messages. [resolver] next_icscf=192.168.0.210 IP address of ICSCF of the domain where PCSCF belongs is specified (IPv4) next_icscf=2001:e38:2030:0:20c:29ff:fea6:ef9f IP address of ICSCF of the domain where PCSCF belongs is specified (IPv6) NEXT_ICSCF_PROTO=UDP NEXT_ICSCF_PORT=5060 ICSCF1=192.168.0.210 The parameter for the extended function (set IPv4 address information as NEXT_ICSCF is specified). [MESSAGEROUTER] [MESSAGEFACTORY] The route information such as Via/Route/Record-Route which are specified in the following parameters insert on the SIP messages. FQDN=pcscf.luciola.net IPV4_ADDR=192.168.0.210 IPV6_ADDR=2001:e38:2030::20c:29ff:fea6:ef9f [AAA] Parameter for AAA information setting (Basically for test UE . However, DOMAIN must be referred as realm information in each CSCF) USERNAME=1000 DOMAIN=luciola.net DISPLAYNAME=1000 PASSWORD=1000 AUTH_METHOD=md5 [APP] PORT=50003 Command port for debugging and for test UE operation b. ./hotaru_mejiro/conf/messaging.cfg The config and the attribute value (chiefly 3GPP extended header (like as P-Header)) are specified by the parameter setting of each node. Specification of optional parameters are given in the sample reference file. (messaging.cfg_XCSCF,messaging.cfg_UE) Note:The sample configuration file make for each node exist on the same server.(process of PCSCF(4060), ICSCF(5060), and SCSCF(6060) exist on 192.168.0.210. ) If you would like to execute in separated nodes, then you can change separate server and the port number environment. Please change as your environment. 4. Execution method a. Execution of HOTARU #cd /home/hotaru/mejiro/pcscf/hotaru_mejiro/test #./sample The start of PCSCF is completed by this. Please complete the preparation for the IMS core network by similarly starting ICSCF and SCSCF. Please notify the SIP server port of PCSCF to 3GPP IMS conforming UE (or RFC3261 SIP UAC). The user-name, password, and realm information, etc should be shared with other UEs. In the 1st edition HOTARU, user information on the password information etc on each UE is not strictly managed. The password uses same information as the user-name (username part) as an argument of the authentication algorithm. Moreover, AMF/OP parametrical information need at the AKA algorithm we codes by all 0 value. Please notify UE this condition (The password is set in the same way to the user-name). b. Operation of test UE (Please refer this method when you operate in UE mode). #telnet localhost 40000 The command port specified with above-mentioned configuration file APP PORT is specified. Connected to localhost.localdomain (127.0.0.1). Trying 127.0.0.1... Connected to localhost.localdomain (127.0.0.1). Escape character is '^]'. ************************************************************** * hotaru console how to use : ****************************** * * format: > [cmd],[ipproto],[proto] * * - [cmd]: 1=REGISTER,2=reREGIST,3=INVITE,4=ANSWER * 5=deREGIST, 6=CANCEL, 7=BYE, 8=SUBSCRIBE * 10=DUMP AGL TREE, 11=DUMP HOCKTBL,12=DUMP PEERTBL * 13=DUMP SOCKTBL 14=DUMP SECSOCKTBL 15=SEND DUMMY MSG * - [ipproto]: 4=IPv4, 6=IPv6 (default=IPv4)(opt) * [proto]: 0=TCP, 1=UDP (default=UDP)(opt) ************************************************************** >1,4,1 (When you transmit with REGISTER/IPv4/UDP) >8,4,1 (When you transmit with SUBSCRIBE/IPv4/UDP) >3,4,1 (When you transmit with INVITE/IPv4/UDP) :Originator UE (Correspond to the call out),address can be specified by message.cfg(To header)setting >4,4,1 (When you transmit with 200OK(INVITE)/IPv4/UDP) Terminater UE(Correspond to the response) >7,4,1 (When you transmit with BYE/IPv4/UDP) >5,4,1 (When you transmit with DEREGISTER/IPv4/UDP) 2010.3.31 HOTARU first edition opening to the public