Faxback Port Server RADIUS Support (RFC 2865, 2866) Manuel d'utilisateur

7409 SW Tech Center Drive, Suite 100 Tigard, OR 97223 USA http://www.faxback.com Port Server RADIUS Support (RFC 2865, 2866) Version 1.0

FaxBack Proprietary and Confidential Page 10 of 58 Session Diagrams Send Fax Outbound faxes require one RADIUS packet exchange for real-time fax cli

FaxBack Proprietary and Confidential Page 11 of 58 Receive Fax Inbound faxes are routed using two RADIUS packets exchanges, the first of which ident

FaxBack Proprietary and Confidential Page 12 of 58 Example Access Request Packets Get-Account / Account-Login Sent when a client logs in, or late

FaxBack Proprietary and Confidential Page 13 of 58 the account is a real-time fax account, or fax ATA account. If the port server will host fax ATA

FaxBack Proprietary and Confidential Page 14 of 58 Len=18, Type=User-Password(2) Value=4D FA EA C5 A0 1A 6B FF D6 95 5E A3 FA 4A EF D9 End ◄── RE

FaxBack Proprietary and Confidential Page 15 of 58 Length=113 Authenticator B3 7E 5D 1C 63 6E 96 4C A3 0B E8 3D 40 61 7B 42 Attributes: Len=18, Ty

FaxBack Proprietary and Confidential Page 16 of 58 FB-Save-CDR Determines if a CDR will be saved for this session. FB-Snd-ANI Specifies an ANI to

FaxBack Proprietary and Confidential Page 17 of 58 Len=34, Type=Acct-Session-Id(44) Value=03bb96b4af2d41f08dd0e46c250c274f Len=18, Type=Vendor-Spe

FaxBack Proprietary and Confidential Page 18 of 58 User-Name The account requesting to receive a fax. Request Packet Code=Access-Request(1) Packet

FaxBack Proprietary and Confidential Page 19 of 58 FB-Command Get-Account-From-DID (2) FB-Context Pre-Receive-Session (4) User-Name The DID to ma

FaxBack Proprietary and Confidential Page 2 of 58 Table of Contents Overview...

FaxBack Proprietary and Confidential Page 20 of 58 The RADIUS server must respond with an Access-Accept packet that includes an e-mail address in th

FaxBack Proprietary and Confidential Page 21 of 58 Sent in response to an external component, such as a fax ATA provisioning server, requesting info

FaxBack Proprietary and Confidential Page 22 of 58 Value=account Len=76, Type=Vendor-Specific(26), Id=FaxBack(30694) Len=70, Type=FB-Queue-Profi

FaxBack Proprietary and Confidential Page 23 of 58 Response Packet Code=Access-Accept(2) Packet identifier=11 Length=105 Authenticator 00 00 00 0

FaxBack Proprietary and Confidential Page 24 of 58 Attributes: Len=18, Type=Vendor-Specific(26), Id=FaxBack(30694) Len=6, Type=FB-Command(1) V

FaxBack Proprietary and Confidential Page 25 of 58 Attribute Value FB-Command Get-Account-From-Sender-Email-Address (3) FB-Context For-External-

FaxBack Proprietary and Confidential Page 26 of 58 A response that includes additional account information is not required. To prevent the port se

FaxBack Proprietary and Confidential Page 27 of 58 Language and time zone information do not need to be included, as these values are specified at t

FaxBack Proprietary and Confidential Page 28 of 58 ◄── RESPONSE TO PORT SERVER ─── Required Purpose RADIUS code Access-Accept or Access-Reject Op

FaxBack Proprietary and Confidential Page 29 of 58 Request Packet Code=Access-Request(1) Packet identifier=3 Length=44 Authenticator C9 EC 4F 8D

FaxBack Proprietary and Confidential Page 3 of 58 FB-Rule-Group ...

FaxBack Proprietary and Confidential Page 30 of 58 User-Name Load-balance group account Acct-Session-Id The session id of the new receive fax sess

FaxBack Proprietary and Confidential Page 31 of 58 Access-Request Attributes The following attributes appear in Accounting-Request and Accounting-Re

FaxBack Proprietary and Confidential Page 32 of 58 1 The account is “Shared Send-Only”, allowing other clients to login using the same account/pass

FaxBack Proprietary and Confidential Page 33 of 58 FaxBack vendor-specific String (UTF-8) 0-128 chars The port server will include the FB-Client-I

FaxBack Proprietary and Confidential Page 34 of 58 0 The DID is disabled for routing. When this attribute is omitted in a RADIUS response packet,

FaxBack Proprietary and Confidential Page 35 of 58 <QPXml Rf="0" Dn="1" Ndn="1" Ea="" Ef="" Ln=

FaxBack Proprietary and Confidential Page 36 of 58 E. Africa Standard Time E. Africa* Georgian Standard Time Georgian* Iran Standard Time Iran* A

FaxBack Proprietary and Confidential Page 37 of 58 The port server e-mail gateway will use the value from the FB-Rcv-Email attribute as the target

FaxBack Proprietary and Confidential Page 38 of 58 When this attribute is omitted in a RADIUS response packet, the default value is 0. FB-Rcv-Tim

FaxBack Proprietary and Confidential Page 39 of 58 When this attribute is omitted in a RADIUS response packet, the default value is an empty string

FaxBack Proprietary and Confidential Page 4 of 58 FB-V21-Frame-Error-Count...

FaxBack Proprietary and Confidential Page 40 of 58 be able to log the send failure as “sending is disabled”. If a session cannot be started, no CDR

FaxBack Proprietary and Confidential Page 41 of 58 The port server will include the FB-Transfer-Type attribute in the Get-Account command for the Pr

FaxBack Proprietary and Confidential Page 42 of 58 Accounting-Requests Session Lifecycle When the port server billing database (BillingDb) is config

FaxBack Proprietary and Confidential Page 43 of 58 An Accounting Start packet (Acct-Status-Type=Start) is sent after a client has been approved to s

FaxBack Proprietary and Confidential Page 44 of 58 Len=6, Type=FB-Is-Send(32) Value=1 Len=12, Type=Vendor-Specific(26), Id=FaxBack(30694) Le

FaxBack Proprietary and Confidential Page 45 of 58 Len=2, Type=FB-CDR-Info(11) Value= Len=8, Type=Vendor-Specific(26), Id=FaxBack(30694) Len

FaxBack Proprietary and Confidential Page 46 of 58 Len=12, Type=FB-Dial-Number(34) Value=5552223333 Len=10, Type=Vendor-Specific(26), Id=FaxBa

FaxBack Proprietary and Confidential Page 47 of 58 Len=6, Type=FB-Total-Seconds(39) Value=17 Len=12, Type=Vendor-Specific(26), Id=FaxBack(3069

FaxBack Proprietary and Confidential Page 48 of 58 Value=0 End Accounting-Request Attributes The following attributes appear in Accounting-Reque

FaxBack Proprietary and Confidential Page 49 of 58 FaxBack vendor-specific Integer 4 bytes The FB-CDR-Type attribute categorizes the CDR according

FaxBack Proprietary and Confidential Page 5 of 58 Overview For account management and billing, the port server supports a flexible architecture for

FaxBack Proprietary and Confidential Page 50 of 58 FB-Dial-Number Attribute Type Data Type Length FaxBack vendor-specific String (UTF-8) 0-

FaxBack Proprietary and Confidential Page 51 of 58 If 1 fax was a Send, of 0 fax was a Receive. FB-Local-CSID Attribute Type Data Type Lengt

FaxBack Proprietary and Confidential Page 52 of 58 The account that actually received the fax. This field is set only for received faxes where the

FaxBack Proprietary and Confidential Page 53 of 58 FB-Total-Seconds Attribute Type Data Type Length FaxBack vendor-specific Integer 4 bytes

FaxBack Proprietary and Confidential Page 54 of 58 UUID Mode To simplify the RADIUS server implementation, accounts are managed by exchanging accoun

FaxBack Proprietary and Confidential Page 55 of 58 RADIUS Dictionary This following RADIUS dictionary contains all port server RADIUS attributes. T

FaxBack Proprietary and Confidential Page 56 of 58 ATTRIBUTE FB-RTP-Count 55 integer FaxBack ATTRIBUTE FB-Snd-On-Behalf-Of

FaxBack Proprietary and Confidential Page 57 of 58 # Values for FB-Rcv-Format VALUE FB-Rcv-Format TIFF 0 VALUE FB-Rcv-Format PDF 1 # Values for

FaxBack Proprietary and Confidential Page 58 of 58 VALUE FB-Upload-Logs After-All-Sessions 2 # Values for FB-Msg-Type VALUE FB-Msg-Type Message

FaxBack Proprietary and Confidential Page 6 of 58 To support “Accounting-Requests”, a RADIUS server must properly save and/or process the FaxBack ve

FaxBack Proprietary and Confidential Page 7 of 58 RADIUS is an optional interface type that can be enabled for some of the databases that the port s

FaxBack Proprietary and Confidential Page 8 of 58 Fax ATA Call-Ahead Call-ahead support in the RADIUS server is optional. If the port server call-a

FaxBack Proprietary and Confidential Page 9 of 58 • For a fax number that resulted in a voice error, future queries of the called numbers database