= IPv6 support = [[PageOutline(2-3,,inline)]] == Availability == IPv6 support is available in the following platforms: - Windows families, e.g.: Windows 7/8/10, Windows XP, Windows Server 2003, and Windows Vista, using Microsoft Platform SDK for Windows Server 2003 SP1 - !Linux/Unix/MacOS X with GNU development systems, IPv6 features are detected by the {{{./configure}}} script. - iOS - Symbian Note about Windows 2000: - Windows 2000 does not have IPv6 installed, but it may be added by installing [http://msdn.microsoft.com/downloads/sdks/platform/tpipv6/ReadMe.asp Microsoft IPv6 Technology Preview for Windows 2000 (IPv6Kit)]. This software was designed to work for Win2K SP1 and SP2, however there is an information on how to install IPv6Kit on Win2K SP4, please see [http://www.microsoft.com/technet/network/ipv6/ipv6faq.mspx IPv6 FAQ]. - Even with IPv6Kit installed, pjsip still would '''NOT''' run normally because the Win2K's IPHLPAPI.DLL does not support enumerating IPv6 interfaces. Because of this, pjsip would always return the loopback interface ("::1") as the host's IPv6 address, unless a specific IPv6 address is specified when creating the transports. IPv6 is '''NOT''' supported by Platform SDK that comes with Microsoft Visual Studio 6. To use Visual Studio 6, you must install and download the newer Platform SDK above. Please see [http://www.pjsip.org/using.htm PJSIP Getting Started Guide] on how to configure VS6 with newer Platform SDK. == IPv6 Support in pjlib == The work for adding IPv6 support in pjlib is documented by ticket #415. pjlib supports IPv6, but for now this has to be enabled in {{{pj/config_site.h}}}: {{{ #define PJ_HAS_IPV6 1 }}} '''Socket Addresses''': - An IPv4 socket address is represented by {{{pj_sockaddr_in}}} structure, while an IPv6 socket address is represented by {{{pj_sockaddr_in6}}} structure. The {{{pj_sockaddr}}} is a union which may contain IPv4 or IPv6 socket address, depending on the address family field. - Various new socket address API's have been added which can work on both IPv4 and IPv6 address, such as: - pj_inet_pton() - pj_inet_ntop() - pj_inet_ntop2() - pj_sockaddr_init() - pj_sockaddr_get_addr() - pj_sockaddr_has_addr() - pj_sockaddr_get_addr_len() - pj_sockaddr_set_str_addr() - pj_sockaddr_get_port() - pj_sockaddr_set_port() - pj_sockaddr_get_len() '''Socket and IOQueue API''': - The {{{pj_sockaddr}}} structure is a union which may contain IPv4 or IPv6 socket address. Application may pass this structure to various pjlib socket functions which take {{{pj_sockaddr_t}}} as an argument, such as {{{pj_sock_bind()}}}, {{{pj_sock_sendto()}}}, {{{pj_sock_recvfrom()}}}, {{{pj_sock_accept()}}}, etc. - The ''ioqueue'' also supports IPv6 sockets. '''Address Resolution API''': - A new API {{{pj_getaddrinfo()}}} has been added to resolve both IPv4 and IPv6 addresses, in addition to existing {{{pj_gethostbyname()}}} API which resolves IPv4 address. - The {{{pj_gethostip()}}} and {{{pj_getdefaultipinterface()}}} API has been modified to take an additional address family argument. '''IP Helper API''': - The {{{pj_enum_ip_interface()}}} API has been modified to take an additional address family argument. == IPv6 Support in pjsip == The work for adding IPv6 support in pjlib is documented by ticket #421. '''IPv6 SIP Transport''': - The SIP UDP transport now supports IPv6 sockets, and new API's have been added to facilitate IPv6 transport creation ({{{pjsip_udp_transport_start6()}}} and {{{pjsip_udp_transport_attach2()}}}). Note that if application wants to support both IPv4 and IPv6 UDP transports, two separate UDP transport instances must be created, one for each address family. - The SIP TCP and TLS transports also support IPv6 sockets since version 2.1 (ticket #1585). '''IPv6 Address Representation''': - IPv6 address may appear in two types of places in the SIP message: in a host part of a header field (such as host part of an URI, or host part in a Via header), and as a parameter value (such as the value of ''received'' and ''maddr'' parameter). - Although in the SIP ABNF grammar an IPv6 may or may not be enclosed in square brackets ('''[''' and ''']''' characters), in pjsip all IPv6 addresses will be represented '''without''' the square brackets, for consistency. This means pjsip will remove the square brackets, if they are present, during parsing process, and will enclose the address with square brackets as necessary when pjsip prints the Ipv6 address in a packet for transmission. When application inspects a message component that contains IPv6 address, it will always find it without the enclosing brackets. == IPv6 Support in pjlib-util (DNS SRV and AAAA resolution) == To be done. The work for adding IPv6 support in pjlib-util is documented by ticket #419. == IPv6 Support in pjmedia (SDP, media transport) == The work for adding IPv6 support in pjmedia is documented by ticket #420. The SDP representation has been updated to support IPv6 address, and the UDP media transport now also supports IPv6 sockets. There have been some ''incompatible'' changes introduced in pjmedia: - the {{{rtp_addr_name}}} and {{{rtcp_addr_name}}} fields in {{{pjmedia_sock_info}}} structure (which describes the media transport address information) has been changed to use {{{pj_sockaddr}}} union rather than {{{pj_sockaddr_in}}} structure which is specific to IPv4, - the {{{rem_addr}}} and {{{rem_rtcp}}} fields in {{{pjmedia_stream_info}}} also have been changed to use {{{pj_sockaddr}}} union. == IPv6 Support in pjnath (STUN and ICE) == To be done. The work for adding IPv6 support in pjnath is documented by ticket #422. == Enabling IPv6 support in application using PJSUA == Application needs to configure SIP transport and SIP account with IPv6 support. === Creating SIP transport === Here is sample code for IPv6 SIP transport initializations. {{{ pjsua_transport_config tp_cfg; pjsip_transport_type_e tp_type; pjsua_transport_id tp_id = -1; pjsua_transport_config_default(&tp_cfg); tp_cfg.port = 5060; /* TCP */ tp_type = PJSIP_TRANSPORT_TCP6; status = pjsua_transport_create(tp_type, &tp_cfg, &tp_id); if (status != PJ_SUCCESS) ... /* UDP */ tp_type = PJSIP_TRANSPORT_UDP6; status = pjsua_transport_create(tp_type, &tp_cfg, &tp_id); if (status != PJ_SUCCESS) ... /* TLS */ tp_type = PJSIP_TRANSPORT_TLS6; tp_cfg.port = 5061; tp_cfg.tls_setting.ca_list_file = pj_str(""); tp_cfg.tls_setting.cert_file = ...; tp_cfg.tls_setting.privkey_file = ...; tp_cfg.tls_setting.password = ...; status = pjsua_transport_create(tp_type, &tp_cfg, &tp_id); if (status != PJ_SUCCESS) ... }}} === Adding SIP Account === Here is sample code for setting up account using IPv6 SIP server. {{{ #define SIP_USER "user" #define SIP_SERVER "example.com" #define SIP_SERVER_IPv6 "[1234::5678]" #define SIP_PASSWD "pwd" pjsua_acc_config acc_cfg; pjsua_acc_config_default(&acc_cfg); acc_cfg.id = pj_str("sip:" SIP_USER "@" SIP_SERVER); acc_cfg.reg_uri = pj_str("sip:" SIP_SERVER); acc_cfg.cred_count = 1; acc_cfg.cred_info[0].realm = pj_str("*"); acc_cfg.cred_info[0].scheme = pj_str("digest"); acc_cfg.cred_info[0].username = pj_str(SIP_USER); acc_cfg.cred_info[0].data_type = PJSIP_CRED_DATA_PLAIN_PASSWD; acc_cfg.cred_info[0].data = pj_str(SIP_PASSWD); /* As currently IPv6 DNS resolution is not supported yet, application should resolve it manually, e.g: using getaddrinfo(), and set the IPv6 address via proxy setting */ /* Note that application may add 'hide' param to hide the proxy setting from the message (this is PJSIP proprietary feature) */ acc_cfg.proxy_cnt = 1; acc_cfg.proxy[0] = pj_str("sip:" SIP_SERVER_IPv6 ";lr;hide"); /* Enable IPv6 in media transport */ acc_cfg.ipv6_media_use = PJSUA_IPV6_ENABLED; /* Finally */ status = pjsua_acc_add(&acc_cfg, PJ_TRUE, NULL); if (status != PJ_SUCCESS) ... }}}