Merged revisions 270866 via svnmerge from
[asterisk/asterisk.git] / configs / osp.conf.sample
1 ;
2 ; Open Settlement Protocol Sample Configuration File
3 ;
4 ; This file contains configuration of OSP server providers that are used by the
5 ; Asterisk OSP module.  The section "general" is reserved for global options.
6 ; All other sections describe specific OSP Providers.  The provider "default"
7 ; is used when no provider is otherwise specified.
8 ;
9 ; The "servicepoint" and "source" parameters must be configured.  For most
10 ; implementations the other parameters in this file can be left unchanged.
11 ;
12 [general]
13 ;
14 ; Enable cryptographic acceleration hardware.
15 ; The default value is no.
16 ;
17 ;accelerate=no
18 ;
19 ; Enable security features.
20 ; If security features are disabled, Asterisk cannot validate signed tokens and
21 ; all certificate file name parameters are ignored.
22 ; The default value is no.
23 ;
24 ;securityfeatures=no
25 ;
26 ; Defines the status of tokens that Asterisk will validate.
27 ; 0 - signed tokens only
28 ; 1 - unsigned tokens only
29 ; 2 - both signed and unsigned
30 ; The default value is 0, i.e. the Asterisk will only validate signed tokens.
31 ; If securityfeatures are disabled, Asterisk cannot validate signed tokens.
32 ;
33 ;tokenformat=0
34 ;
35 ;[default]
36 ;
37 ; List all service points (OSP servers) for this provider.
38 ; Use either domain name or IP address.  Most OSP servers use port 1080.
39 ;
40 ;servicepoint=http://osptestserver.transnexus.com:1080/osp
41 ;
42 ; Define the "source" device for requesting OSP authorization.
43 ; This value is usually the domain name or IP address of the the Asterisk server.
44 ;
45 ;source=domain name or [IP address in brackets]
46 ;
47 ; Define path and file name of crypto files.
48 ; The default path for crypto file is /var/lib/asterisk/keys.  If no path is
49 ; defined, crypto files will in /var/lib/asterisk/keys directory.
50 ;
51 ; Specify the private key file name.
52 ; If this parameter is unspecified or not present, the default name will be the
53 ; osp.conf section name followed by "-privatekey.pem" (for example:
54 ; default-privatekey.pem)
55 ; If securityfeatures are disabled, this parameter is ignored.
56 ;
57 ;privatekey=pkey.pem
58 ;
59 ; Specify the local certificate file.
60 ; If this parameter is unspecified or not present, the default name will be the
61 ; osp.conf section name followed by "- localcert.pem " (for example:
62 ; default-localcert.pem)
63 ; If securityfeatures are disabled, this parameter is ignored.
64 ;
65 ;localcert=localcert.pem
66 ;
67 ; Specify one or more Certificate Authority key file names.  If none are listed,
68 ; a single Certificate Authority key file name is added with the default name of
69 ; the osp.conf section name followed by "-cacert_0.pem " (for example:
70 ; default-cacert_0.pem)
71 ; If securityfeatures are disabled, this parameter is ignored.
72 ;
73 ;cacert=cacert_0.pem
74 ;
75 ; Configure parameters for OSP communication between Asterisk OSP client and OSP
76 ; servers.
77 ;
78 ; maxconnections: Max number of simultaneous connections to the provider OSP
79 ;                 server (default=20)
80 ; retrydelay:     Extra delay between retries (default=0)
81 ; retrylimit:     Max number of retries before giving up (default=2)
82 ; timeout:        Timeout for response in milliseconds (default=500)
83 ;
84 ;maxconnections=20
85 ;retrydelay=0
86 ;retrylimit=2
87 ;timeout=500
88 ;
89 ; Set the authentication policy.
90 ; 0 - NO        - Accept all calls.
91 ; 1 - YES       - Accept calls with valid token or no token. Block calls with
92 ;                 invalid token.
93 ; 2 - EXCLUSIVE - Accept calls with valid token. Block calls with invalid token
94 ;                 or no token.
95 ; Default is 1,
96 ; If securityfeatures are disabled, Asterisk cannot validate signed tokens.
97 ;
98 ;authpolicy=1
99 ;
100 ; Set the default destination protocol. The OSP module supports SIP, H323, and
101 ; IAX protocols.  The default protocol is set to SIP.
102 ;
103 ;defaultprotocol=SIP
104 ;
105 ; Set the service type.
106 ; 0 - Normal voice service
107 ; 1 - Ported number query service
108 ; Default is 0,
109 ;
110 ;servicetype=0