1. Update osp module configuration file.
[asterisk/asterisk.git] / configs / osp.conf.sample
index edd8af1..ea5d911 100644 (file)
@@ -1,51 +1,70 @@
 ;
 ; Open Settlement Protocol Sample Configuration File
 ;
-;
-; This file contains configuration of providers that
-; are used by the OSP subsystem of Asterisk.  The section
-; "general" is reserved for global options.  Each other 
-; section declares an OSP Provider.  The provider "default"
-; is used when no provider is otherwise specified.
+; This file contains configuration of OSP server providers that are used by the 
+; Asterisk OSP module.  The section "general" is reserved for global options.  
+; All other sections describe specific OSP Providers.  The provider "default" 
+; is used when no provider is otherwise specified. 
+:
+: The "servicepoint" and "source" parameters must be configured.  For most 
+; implementations the other parameters in this file can be left unchanged.
 ;
 [general]
 ;
-; Should hardware acceleration be enabled?  May not be changed
-; on a reload.
+; Enable cryptographic acceleration hardware.  
 ;
-;accelerate=yes
+;accelerate=no
 ;
-; Defines the token format that Asterisk can validate. 
+; Defines the status of tokens that Asterisk will validate. 
 ; 0 - signed tokens only 
 ; 1 - unsigned tokens only 
 ; 2 - both signed and unsigned
-; The defaults to 0, i.e. the Asterisk can validate signed tokens only.
+; The default value is 0, i.e. the Asterisk will only validate signed tokens.
 ;
 ;tokenformat=0
-
+;
 ;[default]
 ;
-; All paths are presumed to be under /var/lib/asterisk/keys unless
-; the path begins with '/'
+; List all service points (OSP servers) for this provider.
+; Use either domain name or IP address.  Most OSP servers use port 1080.
+;
+;servicepoint=http://osptestserver.transnexus.com:1080/osp
+;
+; Define the "source" device for requesting OSP authorization.
+; This value is usually the domain name or IP address of the the Asterisk server.
+;
+;source=domain name or [IP address in brackets]
+;
+; Define path and file name of crypto files.
+; The default path for crypto file is /var/lib/asterisk/keys.  If no path is 
+; defined, crypto files will in /var/lib/asterisk/keys directory.
 ;
-; Specify the private keyfile.  If unspecified, defaults to the name
-; of the section followed by "-privatekey.pem" (e.g. default-privatekey.pem)
+; Specify the private key file name.  
+; If this parameter is unspecified or not present, the default name will be the 
+; osp.conf section name followed by "-privatekey.pem" (for example: 
+; default-privatekey.pem)
 ;
 ;privatekey=pkey.pem
 ;
-; Specify the local certificate file.  If unspecified, defaults to
-; the name of the section followed by "-localcert.pem"
+; Specify the local certificate file.  
+; If this parameter is unspecified or not present, the default name will be the 
+; osp.conf section name followed by "- localcert.pem " (for example: 
+; default-localcert.pem)  
 ;
 ;localcert=localcert.pem
 ;
-; Specify one or more Certificate Authority keys.  If none are listed,
-; a single one is added with the name "-cacert.pem"
+; Specify one or more Certificate Authority key file names.  If none are listed, 
+; a single Certificate Authority key file name is added with the default name of 
+; the osp.conf section name followed by "-cacert_0.pem " (for example: 
+; default-cacert_0.pem)
 ;
 ;cacert=cacert_0.pem
 ;
-; Specific parameters can be tuned as well:
+; Configure parameters for OSP communication between Asterisk OSP client and OSP 
+; servers. 
 ;
-; maxconnections: Max number of simultaneous connections to the provider (default=20)
+; maxconnections: Max number of simultaneous connections to the provider OSP 
+;                 server (default=20)
 ; retrydelay:     Extra delay between retries (default=0)
 ; retrylimit:     Max number of retries before giving up (default=2)
 ; timeout:        Timeout for response in milliseconds (default=500)
 ;retrylimit=2
 ;timeout=500
 ;
-; List all service points for this provider
-;
-;servicepoint=http://osptestserver.transnexus.com:1080/osp
-;
-; Set the "source" for requesting authorization
-;
-;source=foo
-;
 ; Set the authentication policy.  
-; 0 - NO 
-; 1 - YES
-; 2 - EXCLUSIVE
-; Default is 1, validate token but allow no token.
+; 0 - NO        - Accept all calls.
+; 1 - YES       - Accept calls with valid token or no token. Block calls with 
+;                 invalid token.  
+; 2 - EXCLUSIVE - Accept calls with valid token. Block calls with invalid token 
+;                 or no token.
+; Default is 1,
 ;
 ;authpolicy=1
+;
+; Set the default destination protocol. The OSP module supports SIP, H323, and 
+; IAX protocols.  The default protocol is set to SIP.
+;
+;defaultprotocol=SIP