{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This article provides information regarding A-Series Phones' VPN setup.","type":"text"}]},{"type":"paragraph","content":[{"text":"You may also wish to visit the ","type":"text"},{"text":"A-Series IP Phones for Asterisk Overview","type":"text","marks":[{"type":"link","attrs":{"href":"https://sangomakb.atlassian.net/wiki/spaces/Phones/pages/418054164"}}]},{"text":" for additional information and links to related articles.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Our Digium A-Phones support VPN services via OpenVPN. You can configure this feature either by Web interface or by phone configuration file. We will review both options in this KB article.","type":"text"},{"type":"hardBreak"},{"text":"Before beginning, please review the information below: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In other to enable VPN service, you need to have a OpenVPN server and Client OpenVPN configuration file (client.ovpn), a Root (CA) certificate (ca.crt) ,client KEY (client.key), and client CRT (client.crt) files. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Files: client.ovpn , ca.crt , client.key and client.crt will be uploaded to the phone.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you are using setting up the phones via configuration files, please note that the files that should be uploaded to the phone must be available outside of the VPN","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Digium A-Phone supports HTTP authentication basic and digest as well as connecting without authentication.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configuration files that are downloaded by the phone will be stored in the phone and will be used for subsequent reboots. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OpenVPN server configuration must not require manual password entry in order to connect. The phone does not provide the user a means of inputting user and/or password credentials as a part of VPN connection.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Only Certificates within CRT format are supported.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Web interface configuration","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log into the web interface by surfing to the IP of the phone on your network. The default username is ","type":"text"},{"text":"admin","type":"text","marks":[{"type":"underline"},{"type":"strong"}]},{"text":", and the default password is ","type":"text"},{"text":"789","type":"text","marks":[{"type":"underline"},{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on ","type":"text"},{"text":"Network","type":"text","marks":[{"type":"strong"}]},{"text":" and then click on the ","type":"text"},{"text":"VPN","type":"text","marks":[{"type":"strong"}]},{"text":" tab.","type":"text"}]}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":753,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":753,"alt":"image-20241007-211813.png","id":"523c47f2-a9b1-41f1-838e-1ecb54363050","collection":"contentId-426770592","type":"file","height":440}}]},{"type":"orderedList","attrs":{"order":3},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click on \"Enable VPN\" option","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Upload the following files by click the \"upload\" button next to each item.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OpenVPN Configuration file","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CA Root Certification","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Client Certification","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Client Key","type":"text"}]}]}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":832,"alt":"image-20241007-211836.png","id":"8ae03ad6-764c-479a-9eeb-8906955d3d91","collection":"contentId-426770592","type":"file","height":231}}]},{"type":"orderedList","attrs":{"order":5},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Apply Changes and exit the GUI.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Using configuration files ","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Phone configuration file example:","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":760.0,"localId":"79b86587-95c7-43d8-a363-2aaee02a2bf0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A2x VPN Configuration Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"<>Version:2.0000000000","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"VPN mode :2","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"Enable VPN Tunnel :1","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"Auto etc Url :https://user:password@server.example.com/openvpn/etc.tar.gz","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"<>","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph"}]}]}]}]}]},{"type":"table","attrs":{"layout":"align-start","width":760.0,"localId":"afe4daae-ef25-49c3-afd4-f351edcea710"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A30 VPN Configuration Example","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"<>Version:2.0000000000","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"VPN mode :2","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"Enable VPN :1","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"Auto etc Url :https://user:password@server.example.com/openvpn/etc.tar.gz","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"<>","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"VPN mode","type":"text","marks":[{"type":"strong"}]},{"text":" element controls the type of VPN to be used. In this case, we are configuring for OpenVPN, so the value is 2.","type":"text"},{"type":"hardBreak"},{"text":"The ","type":"text"},{"text":"Enable VPN Tunnel","type":"text","marks":[{"type":"strong"}]},{"text":" element controls whether or not the phone is to start up the OpenVPN connection. It defaults to 0, so it must be set to 1.","type":"text"},{"type":"hardBreak"},{"text":"The ","type":"text"},{"text":"Auto etc Url","type":"text","marks":[{"type":"strong"}]},{"text":" element contains the URL path to a .tar.gz package of the OpenVPN configuration files, containing. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ca.crt","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"client.crt","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"client.key","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"client.ovpn","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creating OpenVPN configuration files ","type":"text"}]},{"type":"paragraph","content":[{"text":"OpenVPN is very extensive in terms of the configuration options and therefore is almost impossible for us to test each possible scenario as how you should setup this file is depended on your OpenVPN Server configuration. If you need assistance adding additional parameter please contact your IT Network team as they should provide more information about what parameters are needed in your VPN implementation. if you are implementing a new OpenVPN, you can use the example below, we have confirmed that the following configuration works with Digium A-Phones","type":"text"}]},{"type":"paragraph","content":[{"text":"client.ovpn:","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"align-start","width":760.0,"localId":"3a618e78-0a46-4019-a40d-b19e63059547"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"client\ndev tun\nproto udp\nremote server.example.com 1194\nresolv-retry infinite\nnobind\npersist-key\npersist-tun\nca ca.crt\ncert client.crt\nkey client.key\nns-cert-type server\nverb 3","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"Please note that you ","type":"text"},{"text":"must","type":"text","marks":[{"type":"strong"}]},{"text":" pass in the ","type":"text"},{"text":"ca","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"cert","type":"text","marks":[{"type":"strong"}]},{"text":", and ","type":"text"},{"text":"key","type":"text","marks":[{"type":"strong"}]},{"text":" parameters as ca.crt, client.crt, and client.key and they should not have any directory declaration (example /something/ca.cert ). Also It is not possible to in-line the ","type":"text"},{"text":"ca","type":"text","marks":[{"type":"strong"}]},{"text":", ","type":"text"},{"text":"cert","type":"text","marks":[{"type":"strong"}]},{"text":", or ","type":"text"},{"text":"key","type":"text","marks":[{"type":"strong"}]},{"text":" parameters.","type":"text"}]},{"type":"paragraph","content":[{"text":"Once you have ca.crt, client.crt, client.key ,client.ovpn files, please use the following line in order to create the correct tar file that should be uploaded into the phone. ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"}]},{"type":"table","attrs":{"layout":"align-start","width":760.0,"localId":"5ca5f46d-8779-4d4d-81c5-11b09621a670"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"codeBlock","content":[{"text":"tar czvf etc.tar.gz ca.crt client.crt client.key client.ovpn","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"type":"hardBreak"},{"text":"Testing the Configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"When the ","type":"text"},{"text":"Enable VPN Tunnel","type":"text","marks":[{"type":"strong"}]},{"text":" element is enabled on the phone, the phone will display a lock in the status bar, e.g.:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":320,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":320,"alt":"image-20241007-211926.png","id":"46f4cdec-d197-4569-9e9b-6b168c668c0a","collection":"contentId-426770592","type":"file","height":240}}]},{"type":"paragraph","content":[{"text":"In the event of an issue, or the VPN not enabling, the lock won't appear: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":324,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":320,"alt":"image-20241007-211952.png","id":"9dced447-8638-48cc-b2b6-fc454166d184","collection":"contentId-426770592","type":"file","height":240}}]},{"type":"paragraph","content":[{"text":"The VPN-connected IP address is visible only in the phone's web UI, in the Network>VPN screen under \"Virtual Private Network (VPN) Status.\"","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":550,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":550,"alt":"image-20241007-212204.png","id":"9efee2f5-f5f7-44a5-9591-d24ddbaef280","collection":"contentId-426770592","type":"file","height":224}}]},{"type":"paragraph"}],"version":1}

Browser not supported