1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
Auth_radius Module
Juha Heinanen
Edited by
Daniel-Constantin Mierla
Copyright 2004 Juha Heinanen
_________________________________________________________
Table of Contents
1. User's Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSER Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. radius_config (string)
1.3.2. caller_service_type (integer)
1.3.3. callee_service_type (integer)
1.4. Exported Functions
1.4.1. avp_load_radius(user)
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. "SIP-AVP" RADIUS AVP exmaples
1-2. radius_config parameter usage
1-3. caller_service_type parameter usage
1-4. callee_service_type parameter usage
1-5. avp_load_radius() usage
_________________________________________________________
Chapter 1. User's Guide
1.1. Overview
avp_radius module allows loading of user's attributes into
AVPs from Radius. User's name and domain can be based on From
URI, 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:
* value = SIP_AVP_NAME SIP_AVP_VALUE
* SIP_AVP_NAME = STRING_NAME | '#'ID_NUMBER
* SIP_AVP_VALUE = ':'STRING_VALUE | '#'NUMBER_VALUE
Example 1-1. "SIP-AVP" RADIUS AVP exmaples
....
"email:joe@yahoo.com"
-> STRING NAME AVP (email) with STRING VALUE (joe@yahoo.com)
"#14:joe@yahoo.com"
-> ID AVP (14) with STRING VALUE (joe@yahoo.com)
"age#28"
-> STRING NAME AVP (age) with INTEGER VALUE (28)
"#14#28"
-> ID AVP (14) with INTEGER VALUE (28)
....
For AVP with STRING NAME, the module prefixes each attribute
name as returned from Radius by string "caller_" or "callee_"
depending if caller's or callee's attributes are loaded.
_________________________________________________________
1.2. Dependencies
1.2.1. OpenSER Modules
The module depends on the following modules (in the other
words the listed modules must be loaded before this module):
* none
_________________________________________________________
1.2.2. External Libraries or Applications
The following libraries or applications must be installed
before compilling OpenSER with this module loaded:
* radiusclient-ng 0.5.0 or higher -- library and development
files. See
http://developer.berlios.de/projects/radiusclient-ng/.
_________________________________________________________
1.3. Exported Parameters
1.3.1. radius_config (string)
This is the location of the configuration file of radius
client libraries.
Default value is
"/usr/local/etc/radiusclient-ng/radiusclient.conf".
Example 1-2. radius_config parameter usage
modparam("avp_radius", "radius_config", "/etc/radiusclient.conf")
_________________________________________________________
1.3.2. caller_service_type (integer)
This is the value of the Service-Type radius attribute to be
used, when caller's attributes are loaded.
Default value is dictionary value of "SIP-Caller-AVPs"
Service-Type.
Example 1-3. caller_service_type parameter usage
modparam("avp_radius", "caller_service_type", 18)
_________________________________________________________
1.3.3. callee_service_type (integer)
This is the value of the Service-Type radius attribute to be
used, when callee's attributes are loaded.
Default value is dictionary value of "SIP-Callee-AVPs"
Service-Type.
Example 1-4. callee_service_type parameter usage
modparam("avp_radius", "callee_service_type", 19)
_________________________________________________________
1.4. Exported Functions
1.4.1. avp_load_radius(user)
The functions loads user's attributes from radius and stores
them into AVPs. Parameter "user" is used to indicate, whose
attributes are loaded. Possible values are:
* caller - attributes belong to the user of the From URI are
loaded
* callee - attributes belong to the user of the Request URI
are loaded
* digest - attributes belong to the authenticated user are
loaded
AVP name returned from Radius is prefixed by string "caller_",
if avp_load_radius parameter is "caller" or "digest", and by
"callee_", if parameter is "callee".
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1-5. avp_load_radius() usage
...
avp_load_radius("callee");
...
_________________________________________________________
Chapter 2. Developer's Guide
The module does not provide any API to use in other OpenSER
modules.
_________________________________________________________
Chapter 3. Frequently Asked Questions
3.1. Where can I find more about OpenSER?
3.2. Where can I post a question about this module?
3.3. How can I report a bug?
3.1. Where can I find more about OpenSER?
Take a look at http://openser.org/.
3.2. Where can I post a question about this module?
First at all check if your question was already answered on
one of our mailing lists:
* User Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/devel
E-mails regarding any stable OpenSER release should be sent to
<users@openser.org> and e-mails regarding development versions
should be sent to <devel@openser.org>.
If you want to keep the mail private, send it to
<team@openser.org>.
3.3. How can I report a bug?
Please follow the guidelines provided at:
http://sourceforge.net/tracker/?group_id=139143.
|
