Module documentationGo to table view.
Search interactively in this documentation. This is an overview of SER modules with links to web-based documentation for each module. The documentation is auto-generated every night and is based on SER 2.0 (aka Ottendorf) documentation sources. See development documentation for documentation of the modules in cvs trunk (development version). For SER 0.9.x module documentation, please refer to the README files in each module. As SER and OpenSER 0.9.x are very close to each other, you can also use the OpenSER doc for 0.9.x. The modules you find here are all part of the SER distribution (i.e. found in the modules dir). Each has a status (standard, standard-dep, stable, experimental) with the following meaning:
There are some modules that are missing in this list, but that can be found in the modules dir of the distribution. We are working on making documentation available for these as well. All the doc pages have "Add a comment" at the bottom. Please feel free to add comments. These will guide further improvement of the docs. Only comments that are no longer relevant will be deleted. Standard acc module is used to report on transactionsi to syslog, SQL and RADIUSi. To report on a transactioni using syslog, use "setflag" to mark a transaction you are interested in with a flag, load accounting module and set its "log_flag" to the same flag number. The acc module will then report on completed transaction to syslog. A typical usage of the module takes no acc-specific script command -- the functionality binds invisibly through transaction processing. Script writers just need to mark the transaction for accounting with proper setflag. Jiri Kuthan Standard This is a generic module that itself doesn't provide all functions necessary for authentication but provides functions that are needed by all other authentication related modules (so called authentication backends). We decided to break the authentication code into several modules because there are now more than one backends (currently database authentication and radius are supported). This allows us to create separate packages so uses can install and load only required functionality. This also allows us to avoid unnecessary dependencies in the binary packages. Jan Janak Standard-dep This module contains all authentication related functions that need the access to the database. This module should be used together with auth module, it cannot be used independently because it depends on the module. Select this module if you want to use database to store authentication information like subscriber usernames and passwords. If you want to use radius authentication, then use auth_radius instead. Jan Janak Standard This module contains functions that are used for Enhancements for Authenticated Identity Management in SIP (defined by RFC4474). The purpose of this mechanism is securely identifying originators of SIP requests and providing integrity protection of the message, especially in an interdomain context. Standard-dep This module contains functions that are used to perform authentication using a Radius server. Basically the proxy will pass along the credentials to the radius server which will in turn send a reply containing result of the authentication. So basically the whole authentication is done in the Radius server. Before sending the request to the radius server we perform some sanity checks over the credentials to make sure that only well formed credentials will get to the server. We have implemented radius authentication according to draft-sterman-aaa-sip-00. Jan Janak Standard-dep This module contains several functions that can be used to manipulate the contents of AVPs (Attribute-Value pairs). The AVPs are variables attached to the SIP message being processed. Each variable has its name and value. AVPs can be used to store arbitrary data or as a means of inter-module comminication. Jiri Kuthan Standard-dep AVPops (AVP-operations) modules implements a set of script functions which allow access and manipulation of user AVPs (preferences). AVPs are a powerful tool for implementing services/preferences per user/domain. Now they are usable directly from configuration script. Functions for interfacing DB resources (loading/storing/removing), functions for swapping information between AVPs and SIP messages, function for testing/checking the value of an AVP. Ramona-Elena Modroiu Standard-dep This module contains several functions that can be used to manipulate the contents of AVPs (Attribute-Value pairs). The AVPs are variables attached to the SIP message being processed. Each variable has its name and value. AVPs can be used to store arbitrary data or as a means of inter-module comminication. Jiri Kuthan Standard avp_radius module allows loading of user's attributes into AVPs from Radius. User's name and domain can be based on From URIi, Request URI, or authenticated credentials. The module assumes that Radius returns the AVPs as values of reply attribute SIP-AVP. Its value must be a string of form "name:value" Juha Heinanen |
Navigation |