Brekeke SIP Server Wiki

SIP

Configure SIP settings, NAT traversal, Authentications, Performance Optimizations and various timeout settings.

 

SIP exchanger
Item Default value Explanation
Session Limit -1 Maximum number of concurrent SIP sessions the server will handle. “-1” specifies an unlimited number of SIP sessions.
Local Port 5060 Port number to send/receive SIP packets.
Please use the default value of 5060 if you don’t have any specific reason for changing this port.
B2B-UA mode off When set to “on”, the B2B-UA mode will be enabled. With the B2B-UA mode, Brekeke SIP Server hides Via and Record-Route headers and replaces the original Call-ID header with a unique value.
Check Maximum UDP packet size off When set to “on”, Brekeke SIP Server will check if each incoming UDP packets size has exceeded the maximum acceptable size set in [Maximum UDP packet size] field.
Maximum UDP packet size 1500 Maximum size of each UDP packet can be accepted by Brekeke SIP Server. If packet size is larger than that set in this field, Brekeke SIP Server will decline the request.

 

NAT traversal

For the details of NAT traversal, please refer to the section “NAT Traversal”.

Item Default value Explanation
Keep address/port mapping on When set to “on”, the Brekeke SIP Server will send keep-alive packets to SIP UAs that are behind NAT at specified intervals so that NAT will not close the external port used by Brekeke SIP Server to send packets to SIP UAs that are behind NAT.
Interval (ms) 12000 Interval for above setting.

If the server cannot reach a SIP UA that is behind NAT, please set a shorter value here.

Method OPTIONS Method of the keep-alive packets sent by Brekeke SIP Server to SIP UAs that are behind NAT
Add’rport’ parameter (Send) off When “on” is set, Brekeke SIP server will add “rport” in Via header of an outgoing request packet so that the server can detect its own port number.
Add’rport’ parameter (Receive) off When “on” is set, Brekeke SIP Server will add “rport” with the value of the sender’s source port in Via header of an incoming request packet.

 

Authentication

When REGISTER or INVITE authentication is enabled, an administrator needs to add users in the [User Authentication] page. Refer to the section “User Authentication” for more details.

Item Default value Explanation
REGISTER on When set to “on”, the Brekeke SIP Server authenticates REGISTER requests.
INVITE on When set to “on”, the Brekeke SIP Server authenticates INVITE requests.
MESSAGE off When set to “on”, the Brekeke SIP Server authenticates MESSAGE requests.
SUBSCRIBE off When set to “on”, the Brekeke SIP Server authenticates SUBSCRIBE requests.
Realm (ex: domain name) This is set as the “realm” value.

If left blank, Brekeke SIP Server IP address is used as the “realm”.

Auth-user=user in “To:” (Register) yes When set to “yes”, the Brekeke SIP Server will authenticate REGISTER requests only when authentication user name matches the user name in the To header.

When set to “no”, the Brekeke SIP Server will authenticate all REGISTER requests.

Auth-user=user in “From:” yes When set to “yes”, the Brekeke SIP Server will authenticate requests only when authentication user name matches the user name in the From header.

When set to “no”, the Brekeke SIP Server will authenticate all requests.

Terminating character for user-info If this character is used in the naming of a user-info, the SIP server considers only that part of the user-info’ before the character is reached in sequence’ and neglects or terminates the remaining part of the user-info after the character is reached for authentication purpose.

Note: The part before the character must be a valid user-info.

FQDN only no When set to “yes”, only SIP URIs that contain an FQDN will be accepted. SIP URIs that contains IP addresses will not be accepted.
Nonce Expires 60 The length of the nonce expiration for authentication. [seconds]

 

Registration
Item Default value Explanation
Adjusted Expires Adjusted registration expiration value

 

Upper Registration

See the section “Brekeke SIP Server Upper and Thru Registration Features” for more details. 

Item Default value Explanation
On/Off off Enable/disable Upper Registration
Register Server IP address or FQDN of a register server to be used as the Upper Registration destination
Protocol UDP Transport protocol used for upper registration

UDP, TCP or TLS

 

Thru Registration
Item Default value Explanation
On/Off on Enable/disable Thru Registration

 

Timeout
Item Default value Explanation
Ringing Timeout (ms) 240000 Timeout for ringing time [milliseconds]
Talking Timeout (ms) 259200000 Timeout for talking time [milliseconds]
Upper/Thru Timeout (ms) 30000 Timeout for waiting the response for a REGISTER request to Upper Registration/Thru Registration destination [milliseconds]
Dial Plan
Item Default value Explanation
Maximum history records 10 The maximum number of records shown in [Dial Plan] > [History] page

 

Miscellaneous
Item Default value Explanation
100 Trying any requests When “any requests” is selected, the SIP Server will send back 100 Trying response for any initial request.
When “only for initial INVITE” is selected, the SIP Server will send back 100 Trying response for initial INIVTE request only.
Check Request-URI’s validity no If set to “yes”, Brekeke SIP Server will check if request URI is valid
Server/User-Agent The specified name will be shown in Server and User-Agent headers.

 

Note: This feature is available in the Advanced Edition only.

 

TCP

TCP feature is not available in the Academic Edition. Please refer the section “TCP” for specific configuration. 

Item Default value Explanation
TCP-handling on Enable/disable TCP-handling
Queue Size 50 The size of the TCP connection queue
Maximum Active Connections (0=unlimited) 0 The number of maximum active connections

(v3.4 or later)

 

TLS 
Item Default value Explanation
TLS-handling on Enable/disable TLS-handling.
Queue Size 50 The size of the TLS connection queue
Maximum Active Connections (0=unlimited) 0 The number of maximum active connections

(v3.4 or later)

File Type Certificate TLS certification format: Certificate or JKS
Private Key File Browse and upload key file
Certificate File Browser and upload certificate file
JKS Key File Browse and upload JKS key file
JKS Password Set JKS password
Enable TLS 1.0 or older enable Enable/disable older version of TLS.
  • TLS feature is available in the Advanced Edition only.
  • From v3.4, The fields to set Key Files are moved in the “Key and Certificate” section
  • From v3.7, “Enable TLS 1.0 or older” field has been added.

 

WS (WebSocket) (v3.4 or later)
Item Default value Explanation
WS-handling off Enable/disable WS-handling.
Listen port 10080 Listening port of WS
Queue Size 50 The size of the WS connection queue
Maximum Active Connections (0=unlimited) 0

  

WSS (WebSocket over TLS) (v3.4 or later)
Item Default value Explanation
WSS-handling off Enable/disable WSS-handling.
Listen port 10081 Listening port of WSS
Queue Size 50 The size of the WSS connection queue
Maximum Active Connections (0=unlimited) 0
  • WSS feature is available in the Advanced Edition only.

 

Performance Optimization (Proxy)
Item Default value Explanation
Initial threads 10 Maximum number of pre-created (pooled) threads for the proxy service.
Maximum Sessions per thread 50 Maximum number of sessions per thread for the proxy service.

 

Performance Optimization (Registrar)
Item Default value Explanation
Initial threads 10 Maximum number of pre-created (pooled) threads for the registrar service.
Maximum Sessions per thread 10 Maximum number of sessions per thread for the registrar service.

 

Yes No
Suggest Edit