-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathREADME
1360 lines (957 loc) · 37.4 KB
/
README
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
perl Module
Bastian Friedrich
Collax GmbH
Edited by
Bastian Friedrich
Copyright © 2007 Collax GmbH
Revision History
Revision $Revision$ $Date: 2008-08-06 13:08:33 +0300
(Wed, 06 Aug 2008) $
__________________________________________________________
Table of Contents
1. Admin Guide
1.1. Overview
1.2. Installing the module
1.3. Using the module
1.4. Dependencies
1.4.1. Kamailio Modules
1.4.2. External Libraries or Applications
1.5. Exported Parameters
1.5.1. filename (string)
1.5.2. modpath (string)
1.6. Exported Functions
1.6.1. perl_exec_simple(func, [param])
1.6.2. perl_exec(func, [param])
2. OpenSER Perl API
2.1. OpenSER
2.1.1. log(level,message)
2.2. OpenSER::Message
2.2.1. getType()
2.2.2. getStatus()
2.2.3. getReason()
2.2.4. getVersion()
2.2.5. getRURI()
2.2.6. getMethod()
2.2.7. getFullHeader()
2.2.8. getBody()
2.2.9. getMessage()
2.2.10. getHeader(name)
2.2.11. getHeaderNames()
2.2.12. moduleFunction(func,string1,string2)
2.2.13. log(level,message) (deprecated type)
2.2.14. rewrite_ruri(newruri)
2.2.15. setFlag(flag)
2.2.16. resetFlag(flag)
2.2.17. isFlagSet(flag)
2.2.18. pseudoVar(string)
2.2.19. append_branch(branch,qval)
2.2.20. getParsedRURI()
2.3. OpenSER::URI
2.3.1. user()
2.3.2. host()
2.3.3. passwd()
2.3.4. port()
2.3.5. params()
2.3.6. headers()
2.3.7. transport()
2.3.8. ttl()
2.3.9. user_param()
2.3.10. maddr()
2.3.11. method()
2.3.12. lr()
2.3.13. r2()
2.3.14. transport_val()
2.3.15. ttl_val()
2.3.16. user_param_val()
2.3.17. maddr_val()
2.3.18. method_val()
2.3.19. lr_val()
2.3.20. r2_val()
2.4. OpenSER::AVP
2.4.1. add(name,val)
2.4.2. get(name)
2.4.3. destroy(name)
2.5. OpenSER::Utils::PhoneNumbers
2.5.1.
new(publicAccessPrefix,internationalPrefix,lon
gDistancePrefix,countryCode,areaCode,pbxCode
)
2.5.2. canonicalForm( number [, context] )
2.5.3. dialNumber( number [, context] )
2.6. OpenSER::LDAPUtils::LDAPConf
2.6.1. Constructor new()
2.6.2. Method base()
2.6.3. Method host()
2.6.4. Method port()
2.6.5. Method uri()
2.6.6. Method rootbindpw()
2.6.7. Method rootbinddn()
2.6.8. Method binddn()
2.6.9. Method bindpw()
2.7. OpenSER::LDAPUtils::LDAPConnection
2.7.1. Constructor new( [config, [authenticated]] )
2.7.2. Function/Method search( conf, filter, base,
[requested_attributes ...])
2.8. OpenSER::VDB
2.9. OpenSER::Constants
2.10. OpenSER::VDB::Adapter::Speeddial
2.11. OpenSER::VDB::Adapter::Alias
2.11.1. query(conds,retkeys,order)
2.12. OpenSER::VDB::Adapter::AccountingSIPtrace
2.13. OpenSER::VDB::Adapter::Describe
2.14. OpenSER::VDB::Adapter::Auth
2.15. OpenSER::VDB::ReqCond
2.15.1. new(key,op,type,name)
2.15.2. op()
2.16. OpenSER::VDB::Pair
2.16.1. new(key,type,name)
2.16.2. key()
2.17. OpenSER::VDB::VTab
2.17.1. new()
2.17.2. call(op,[args])
2.18. OpenSER::VDB::Value
2.18.1. stringification
2.18.2. new(type,data)
2.18.3. type()
2.18.4. data()
2.19. OpenSER::VDB::Column
2.19.1. Stringification
2.19.2. new(type,name)
2.19.3. type( )
2.19.4. name()
2.19.5. OpenSER::VDB::Result
2.19.6. new(coldefs,[row, row, ...])
2.19.7. coldefs()
2.19.8. rows()
3. Perl samples
3.1. sample directory
3.1.1. Script descriptions
4. Frequently Asked Questions
List of Examples
1.1. Set filename parameter
1.2. Set modpath parameter
1.3. perl_exec_simple() usage
1.4. perl_exec() usage
Chapter 1. Admin Guide
1.1. Overview
The time needed when writing a new Kamailio module
unfortunately is quite high, while the options provided by the
configuration file are limited to the features implemented in
the modules.
With this Perl module, you can easily implement your own
Kamailio extensions in Perl. This allows for simple access to
the full world of CPAN modules. SIP URI rewriting could be
implemented based on regular expressions; accessing arbitrary
data backends, e.g. LDAP or Berkeley DB files, is now extremely
simple.
1.2. Installing the module
This Perl module is loaded in kamailio.cfg (just like all the
other modules) with loadmodule("/path/to/perl.so");.
For the Perl module to compile, you need a reasonably recent
version of perl (tested with 5.8.8) linked dynamically. It is
strongly advised to use a threaded version. The default binary
packages from your favorite Linux distribution should work
fine.
Cross compilation is supported by the Makefile. You need to set
the environment variables PERLLDOPTS, PERLCCOPTS and TYPEMAP to
values similar to the output of
PERLLDOPTS: perl -MExtUtils::Embed -e ldopts
PERLCCOPTS: perl -MExtUtils::Embed -e ccopts
TYPEMAP: echo "`perl -MConfig -e 'print $Config{installprivlib}'`/Ext
Utils/typemap"
The exact position of your (precompiled!) perl libraries
depends on the setup of your environment.
1.3. Using the module
The Perl module has two interfaces: The perl side, and the
Kamailio side. Once a Perl function is defined and loaded via
the module parameters (see below), it may be called in
Kamailio's configuration at an arbitary point. E.g., you could
write a function "ldap_alias" in Perl, and then execute
...
if (perl_exec("ldap_alias")) {
...
}
...
just as you would have done with the current alias_db module.
The functions you can use are listed in the "Exported
Functions" section below.
On the Perl side, there are a number of functions that let you
read and modify the current SIP message, such as the RURI or
the message flags. An introduction to the Perl interface and
the full reference documentation can be found below.
1.4. Dependencies
1.4.1. Kamailio Modules
The following modules must be loaded before this module:
* The "sl" module is needed for sending replies uppon fatal
errors. All other modules can be accessed from the Perl
module, though.
1.4.2. External Libraries or Applications
The following libraries or applications must be installed
before running Kamailio with this module loaded:
* Perl 5.8.x or later
Additionally, a number of perl modules should be installed. The
Kamailio::LDAPUtils package relies on Net::LDAP to be
installed. One of the sample scripts needs IPC::Shareable
This module has been developed and tested with Perl 5.8.8, but
should work with any 5.8.x release. Compilation is possible
with 5.6.x, but its behavior is unsupported. Earlier versions
do not work.
On current Debian systems, at least the following packages
should be installed:
* perl
* perl-base
* perl-modules
* libperl5.8
* libperl-dev
* libnet-ldap-perl
* libipc-shareable-perl
It was reported that other Debian-style distributions (such as
Ubuntu) need the same packages.
On SuSE systems, at least the following packages should be
installed:
* perl
* perl-ldap
* IPC::Shareable perl module from CPAN
Although SuSE delivers a lot of perl modules, others may have
to be fetched from CPAN. Consider using the program "cpan2rpm"
- which, in turn, is available on CPAN. It creates RPM files
from CPAN.
1.5. Exported Parameters
1.5.1. filename (string)
This is the file name of your script. This may be set once
only, but it may include an arbitary number of functions and
"use" as many Perl module as necessary.
May not be empty!
Example 1.1. Set filename parameter
...
modparam("perl", "filename", "/home/john/openser/myperl.pl")
...
1.5.2. modpath (string)
The path to the Perl modules included (Kamailio.pm et.al). It
is not absolutely crucial to set this path, as you may install
the Modules in Perl's standard path, or update the "%INC"
variable from within your script. Using this module parameter
is the standard behavior, though. Multiple paths may be
specified by separating them with a ":" character. The maximum
is 10 paths.
Example 1.2. Set modpath parameter
...
modparam("perl", "modpath", "/usr/local/lib/openser/perl/")
...
1.6. Exported Functions
1.6.1. perl_exec_simple(func, [param])
Calls a perl function without passing it the current SIP
message. May be used for very simple simple requests that do
not have to fiddle with the message themselves, but rather
return information values about the environment.
The first parameter is the function to be called. An arbitrary
string may optionally be passed as a parameter.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
Example 1.3. perl_exec_simple() usage
...
if (method=="INVITE") {
perl_exec_simple("dosomething", "on invite messages");
};
...
1.6.2. perl_exec(func, [param])
Calls a perl function with passing it the current SIP message.
The SIP message is reflected by a Perl module that gives you
access to the information in the current SIP message
(Kamailio::Message).
The first parameter is the function to be called. An arbitrary
string may be passed as a parameter.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
Example 1.4. perl_exec() usage
...
if (perl_exec("ldapalias")) {
...
};
...
Chapter 2. OpenSER Perl API
2.1. OpenSER
This module provides access to a limited number of OpenSER core
functions. As the most interesting functions deal with SIP
messages, they are located in the OpenSER::Message class below.
2.1.1. log(level,message)
Logs the message with OpenSER's logging facility. The logging
level is one of the following:
* L_ALERT
* L_CRIT
* L_ERR
* L_WARN
* L_NOTICE
* L_INFO
* L_DBG
Please note that this method is NOT automatically exported, as
it collides with the perl function log (which calculates the
logarithm). Either explicitly import the function (via use
OpenSER qw ( log );), or call it with its full name:
OpenSER::log(L_INFO, "foobar");
2.2. OpenSER::Message
This package provides access functions for an OpenSER sip_msg
structure and its sub-components. Through its means it is
possible to fully configure alternative routing decisions.
2.2.1. getType()
Returns one of the constants SIP_REQUEST, SIP_REPLY,
SIP_INVALID stating the type of the current message.
2.2.2. getStatus()
Returns the status code of the current Reply message. This
function is invalid in Request context!
2.2.3. getReason()
Returns the reason of the current Reply message. This function
is invalid in Request context!
2.2.4. getVersion()
Returns the version string of the current SIP message.
2.2.5. getRURI()
This function returns the recipient URI of the present SIP
message:
my $ruri = $m->getRURI();
getRURI returns a string. See "getParsedRURI()" below how to
receive a parsed structure.
This function is valid in request messages only.
2.2.6. getMethod()
Returns the current method, such as INVITE, REGISTER, ACK and
so on.
my $method = $m->getMethod();
This function is valid in request messages only.
2.2.7. getFullHeader()
Returns the full message header as present in the current
message. You might use this header to further work with it with
your favorite MIME package.
my $hdr = $m->getFullHeader();
2.2.8. getBody()
Returns the message body.
2.2.9. getMessage()
Returns the whole message including headers and body.
2.2.10. getHeader(name)
Returns the body of the first message header with this name.
print $m->getHeader("To");
"John" <sip:john@doe.example>
2.2.11. getHeaderNames()
Returns an array of all header names. Duplicates possible!
2.2.12. moduleFunction(func,string1,string2)
Search for an arbitrary function in module exports and call it
with the parameters self, string1, string2.
string1 and/or string2 may be omitted.
As this function provides access to the functions that are
exported to the OpenSER configuration file, it is autoloaded
for unknown functions. Instead of writing
$m->moduleFunction("sl_send_reply", "500", "Internal Error");
$m->moduleFunction("xlog", "L_INFO", "foo");
you may as well write
$m->sl_send_reply("500", "Internal Error");
$m->xlog("L_INFO", "foo");
WARNING
In OpenSER 1.2, only a limited subset of module functions is
available. This restriction will be removed in a later version.
Here is a list of functions that are expected to be working
(not claiming completeness):
* alias_db_lookup
* consume_credentials
* is_rpid_user_e164
* append_rpid_hf
* bind_auth
* avp_print
* cpl_process_register
* cpl_process_register_norpl
* load_dlg
* ds_next_dst
* ds_next_domain
* ds_mark_dst
* ds_mark_dst
* is_from_local
* is_uri_host_local
* dp_can_connect
* dp_apply_policy
* enum_query (without parameters)
* enum_fquery (without parameters)
* is_from_user_enum (without parameters)
* i_enum_query (without parameters)
* imc_manager
* jab_* (all functions from the jabber module)
* load_gws (without parameters)
* next_gw
* from_gw (without parameters)
* to_gw (without parameters)
* load_contacts
* next_contacts
* sdp_mangle_ip
* sdp_mangle_port
* encode_contact
* decode_contact
* decode_contact_header
* fix_contact
* use_media_proxy
* end_media_session
* m_store
* m_dump
* fix_nated_contact
* unforce_rtp_proxy
* force_rtp_proxy
* fix_nated_register
* add_rcv_param
* options_reply
* checkospheader
* validateospheader
* requestosprouting
* checkosproute
* prepareosproute
* prepareallosproutes
* checkcallingtranslation
* reportospusage
* mangle_pidf
* mangle_message_cpim
* add_path (without parameters)
* add_path_received (without parameters)
* prefix2domain
* allow_routing (without parameters)
* allow_trusted
* pike_check_req
* handle_publish
* handle_subscribe
* stored_pres_info
* bind_pua
* send_publish
* send_subscribe
* pua_set_publish
* loose_route
* record_route
* load_rr
* sip_trace
* sl_reply_error
* sms_send_msg
* sd_lookup
* sstCheckMin
* append_time
* has_body (without parameters)
* is_peer_verified
* t_newtran
* t_release
* t_relay (without parameters)
* t_flush_flags
* t_check_trans
* t_was_cancelled
* t_load_contacts
* t_next_contacts
* uac_restore_from
* uac_auth
* has_totag
* tel2sip
* check_to
* check_from
* radius_does_uri_exist
* ul_* (All functions exported by the usrloc module for user access)
* xmpp_send_message
2.2.13. log(level,message) (deprecated type)
Logs the message with OpenSER's logging facility. The logging
level is one of the following:
* L_ALERT
* L_CRIT
* L_ERR
* L_WARN
* L_NOTICE
* L_INFO
* L_DBG
The logging function should be accessed via the OpenSER module
variant. This one, located in OpenSER::Message, is deprecated.
2.2.14. rewrite_ruri(newruri)
Sets a new destination (recipient) URI. Useful for rerouting
the current message/call.
if ($m->getRURI() =~ m/\@somedomain.net/) {
$m->rewrite_ruri("sip:dispatcher\@organization.net");
}
2.2.15. setFlag(flag)
Sets a message flag. The constants as known from the C API may
be used, when Constants.pm is included.
2.2.16. resetFlag(flag)
Resets a message flag.
2.2.17. isFlagSet(flag)
Returns whether a message flag is set or not.
2.2.18. pseudoVar(string)
Returns a new string where all pseudo variables are substituted
by their values. Can be used to receive the values of single
variables, too.
Please remember that you need to escape the '$' sign in perl
strings!
2.2.19. append_branch(branch,qval)
Append a branch to current message.
2.2.20. getParsedRURI()
Returns the current destination URI as an OpenSER::URI object.
2.3. OpenSER::URI
This package provides functions for access to sip_uri
structures.
2.3.1. user()
Returns the user part of this URI.
2.3.2. host()
Returns the host part of this URI.
2.3.3. passwd()
Returns the passwd part of this URI.
2.3.4. port()
Returns the port part of this URI.
2.3.5. params()
Returns the params part of this URI.
2.3.6. headers()
Returns the headers part of this URI.
2.3.7. transport()
Returns the transport part of this URI.
2.3.8. ttl()
Returns the ttl part of this URI.
2.3.9. user_param()
Returns the user_param part of this URI.
2.3.10. maddr()
Returns the maddr part of this URI.
2.3.11. method()
Returns the method part of this URI.
2.3.12. lr()
Returns the lr part of this URI.
2.3.13. r2()
Returns the r2 part of this URI.
2.3.14. transport_val()
Returns the transport_val part of this URI.
2.3.15. ttl_val()
Returns the ttl_val part of this URI.
2.3.16. user_param_val()
Returns the user_param_val part of this URI.
2.3.17. maddr_val()
Returns the maddr_val part of this URI.
2.3.18. method_val()
Returns the method_val part of this URI.
2.3.19. lr_val()
Returns the lr_val part of this URI.
2.3.20. r2_val()
Returns the r2_val part of this URI.
2.4. OpenSER::AVP
This package provides access functions for OpenSER's AVPs.
These variables can be created, evaluated, modified and removed
through this package.
Please note that these functions do NOT support the notation
used in the configuration file, but directly work on strings or
numbers. See documentation of add method below.
2.4.1. add(name,val)
Add an AVP.
Add an OpenSER AVP to its environment. name and val may both be
integers or strings; this function will try to guess what is
correct. Please note that
OpenSER::AVP::add("10", "10")
is something different than
OpenSER::AVP::add(10, 10)
due to this evaluation: The first will create _string_ AVPs
with the name 10, while the latter will create a numerical AVP.
You can modify/overwrite AVPs with this function.
2.4.2. get(name)
get an OpenSER AVP:
my $numavp = OpenSER::AVP::get(5);
my $stravp = OpenSER::AVP::get("foo");
2.4.3. destroy(name)
Destroy an AVP.
OpenSER::AVP::destroy(5);
OpenSER::AVP::destroy("foo");
2.5. OpenSER::Utils::PhoneNumbers
OpenSER::Utils::PhoneNumbers - Functions for canonical forms of
phone numbers.
use OpenSER::Utils::PhoneNumbers;
my $phonenumbers = new OpenSER::Utils::PhoneNumbers(
publicAccessPrefix => "0",
internationalPrefix => "+",
longDistancePrefix => "0",
areaCode => "761",
pbxCode => "456842",
countryCode => "49"
);
$canonical = $phonenumbers->canonicalForm("07612034567");
$number = $phonenumbers->dialNumber("+497612034567");
A telphone number starting with a plus sign and containing all
dial prefixes is in canonical form. This is usally not the
number to dial at any location, so the dialing number depends
on the context of the user/system.
The idea to canonicalize numbers were taken from hylafax.
Example: +497614514829 is the canonical form of my phone
number, 829 is the number to dial at Pyramid, 4514829 is the
dialing number from Freiburg are and so on.
To canonicalize any number, we strip off any dial prefix we
find and then add the prefixes for the location. So, when the
user enters the number 04514829 in context pyramid, we remove
the publicAccessPrefix (at Pyramid this is 0) and the pbxPrefix
(4514 here). The result is 829. Then we add all the general
dial prefixes - 49 (country) 761 (area) 4514 (pbx) and 829, the
number itself => +497614514829
To get the dialing number from a canonical phone number, we
substract all general prefixes until we have something
As said before, the interpretation of a phone number depends on
the context of the location. For the functions in this package,
the context is created through the new operator.
The following fields should be set:
'longDistancePrefix'
'areaCode'
'pbxCode'
'internationalPrefix'
'publicAccessPrefix'
'countryCode'
This module exports the following functions when useed:
2.5.1. new(publicAccessPrefix,internationalPrefix,longDistancePrefix,
countryCode,areaCode,pbxCode)
The new operator returns an object of this type and sets its
locational context according to the passed parameters. See
OpenSER::Utils::PhoneNumbers above.
2.5.2. canonicalForm( number [, context] )
Convert a phone number (given as first argument) into its
canonical form. When no context is passed in as the second
argument, the default context from the systems configuration
file is used.
2.5.3. dialNumber( number [, context] )
Convert a canonical phone number (given in the first argument)
into a number to to dial. WHen no context is given in the
second argument, a default context from the systems
configuration is used.
2.6. OpenSER::LDAPUtils::LDAPConf
OpenSER::LDAPUtils::LDAPConf - Read openldap config from
standard config files.
use OpenSER::LDAPUtils::LDAPConf;
my $conf = new OpenSER::LDAPUtils::LDAPConf();
This module may be used to retrieve the global LDAP
configuration as used by other LDAP software, such as
nsswitch.ldap and pam-ldap. The configuration is usualy stored
in /etc/openldap/ldap.conf
When used from an account with sufficient privilegs (e.g.
root), the ldap manager passwort is also retrieved.
2.6.1. Constructor new()
Returns a new, initialized OpenSER::LDAPUtils::LDAPConf object.
2.6.2. Method base()
Returns the servers base-dn to use when doing queries.
2.6.3. Method host()
Returns the ldap host to contact.
2.6.4. Method port()
Returns the ldap servers port.
2.6.5. Method uri()
Returns an uri to contact the ldap server. When there is no
ldap_uri in the configuration file, an ldap: uri is constucted
from host and port.
2.6.6. Method rootbindpw()
Returns the ldap "root" password.
Note that the rootbindpw is only available when the current
account has sufficient privilegs to access
/etc/openldap/ldap.secret.
2.6.7. Method rootbinddn()
Returns the DN to use for "root"-access to the ldap server.
2.6.8. Method binddn()
Returns the DN to use for authentication to the ldap server.
When no bind dn has been specified in the configuration file,
returns the rootbinddn.
2.6.9. Method bindpw()
Returns the password to use for authentication to the ldap
server. When no bind password has been specified, returns the
rootbindpw if any.
2.7. OpenSER::LDAPUtils::LDAPConnection
OpenSER::LDAPUtils::LDAPConnection - Perl module to perform
simple LDAP queries.
OO-Style interface:
use OpenSER::LDAPUtils::LDAPConnection;
my $ldap = new OpenSER::LDAPUtils::LDAPConnection;
my @rows = $ldap-search("uid=andi","ou=people,ou=coreworks,ou=de");
Procedural interface:
use OpenSER::LDAPUtils::LDAPConnection;
my @rows = $ldap->search(
new OpenSER::LDAPUtils::LDAPConfig(), "uid=andi","ou=people,ou=cor
eworks,ou=de");
This perl module offers a somewhat simplified interface to the
Net::LDAP functionality. It is intended for cases where just a
few attributes should be retrieved without the overhead of the
full featured Net::LDAP.
2.7.1. Constructor new( [config, [authenticated]] )
Set up a new LDAP connection.
The first argument, when given, should be a hash reference
pointing to to the connection parameters, possibly an
OpenSER::LDAPUtils::LDAPConfig object. This argument may be
undef in which case a new (default)
OpenSER::LDAPUtils::LDAPConfig object is used.
When the optional second argument is a true value, the
connection will be authenticated. Otherwise an anonymous bind
is done.
On success, a new LDAPConnection object is returned, otherwise
the result is undef.
2.7.2. Function/Method search( conf, filter, base,
[requested_attributes ...])
perform an ldap search, return the dn of the first matching
directory entry, unless a specific attribute has been
requested, in wich case the values(s) fot this attribute are
returned.
When the first argument (conf) is a
OpenSER::LDAPUtils::LDAPConnection, it will be used to perform
the queries. You can pass the first argument implicitly by
using the "method" syntax.
Otherwise the conf argument should be a reference to a hash
containing the connection setup parameters as contained in a
OpenSER::LDAPUtils::LDAPConf object. In this mode, the
OpenSER::LDAPUtils::LDAPConnection from previous queries will
be reused.
2.7.2.1. Arguments:
conf
configuration object, used to find host,port,suffix and
use_ldap_checks
filter
ldap search filter, eg '(mail=some@domain)'
base
search base for this query. If undef use default suffix,
concat base with default suffix if the last char is a
','
requested_attributes
retrieve the given attributes instead of the dn from the
ldap directory.
2.7.2.2. Result:
Without any specific requested_attributes, return the dn of all
matching entries in the LDAP directory.
When some requested_attributes are given, return an array with
those attibutes. When multiple entries match the query, the
attribute lists are concatenated.
2.8. OpenSER::VDB
This package is an (abstract) base class for all virtual
databases. Derived packages can be configured to be used by
OpenSER as a database.
The base class itself should NOT be used in this context, as it
does not provide any functionality.
2.9. OpenSER::Constants
This package provides a number of constants taken from enums
and defines of OpenSER header files. Unfortunately, there is no
mechanism for updating the constants automatically, so check
the values if you are in doubt.
2.10. OpenSER::VDB::Adapter::Speeddial
This adapter can be used with the speeddial module.