482939aa1210e0ebc74f05c7b966f2b35cea19d8
[asterisk/asterisk.git] / doc / siptls.txt
1 Asterisk SIP/TLS Transport
2 ==========================
3
4 When using TLS the client will typically check the validity of the
5 certificate chain.  So that means you either need a certificate that is
6 signed by one of the larger CAs, or if you use a self signed certificate
7 you must install a copy of your CA certificate on the client.
8
9 So far this code has been test with:
10 - Asterisk as client and server (TLS and TCP)
11 - Polycom Soundpoint IP Phones (TLS and TCP)
12         Polycom phones require that the host (ip or hostname) that is
13         configured match the 'common name' in the certificate
14 - Minisip Softphone (TLS and TCP)
15 - Cisco IOS Gateways (TCP only)
16 - SNOM 360 (TLS only)
17 - Zoiper Biz Softphone (TLS and TCP)
18
19
20 sip.conf options
21 ----------------
22 tlsenable=[yes|no]
23         Enable TLS server, default is no
24
25 tlsbindaddr=<ip address>
26         Specify IP address to bind TLS server to, default is 0.0.0.0
27
28 tlscertfile=</path/to/certificate>
29         The server's certificate file. Should include the key and 
30         certificate.  This is mandatory if your going to run a TLS server.
31
32 tlscafile=</path/to/certificate>
33         If the server your connecting to uses a self signed certificate
34         you should have their certificate installed here so the code can 
35         verify the authenticity of their certificate.
36
37 tlscadir=</path/to/ca/dir>
38         A directory full of CA certificates.  The files must be named with 
39         the CA subject name hash value. 
40         (see man SSL_CTX_load_verify_locations for more info) 
41
42 tlsdontverifyserver=[yes|no]
43         If set to yes, don't verify the servers certificate when acting as 
44         a client.  If you don't have the server's CA certificate you can
45         set this and it will connect without requiring tlscafile to be set.
46         Default is no.
47
48 tlscipher=<SSL cipher string>
49         A string specifying which SSL ciphers to use or not use
50
51
52 Sample config
53 -------------
54
55 Here are the relevant bits of config for setting up TLS between 2
56 asterisk servers.  With server_a registering to server_b
57
58 On server_a:
59
60 [general]
61 tlsenable=yes
62 tlscertfgile=/etc/asterisk/asterisk.pem
63 tlscafile=/etc/ssl/ca.pem  ; This is the CA file used to generate both certificates
64 register => tls://100:test@192.168.0.100:5061
65
66 [101]
67 type=friend
68 context=internal
69 host=192.168.0.100 ; The host should be either IP or hostname and should 
70                    ; match the 'common name' field in the servers certificate
71 secret=test
72 dtmfmode=rfc2833
73 disallow=all
74 allow=ulaw
75 transport=tls 
76 port=5061
77
78 On server_b:
79 [general]
80 tlsenable=yes
81 tlscertfgile=/etc/asterisk/asterisk.pem
82
83 [100]
84 type=friend
85 context=internal
86 host=dynamic
87 secret=test
88 dtmfmode=rfc2833
89 disallow=all
90 allow=ulaw
91 ;You can specify transport= and port=5061 for TLS, but its not necessary in
92 ;the server configuration, any type of SIP transport will work
93 ;transport=tls 
94 ;port=5061
95