c49fbf1c3c227bc635f34408f4a858d6143f4889
[asterisk/asterisk.git] / configs / res_ldap.conf.sample
1 ;
2 ; Configuration file for res_config_ldap
3 ;
4
5 ; Realtime configuration
6 ; ----------------------
7 ; In order to use this module, you start 
8 ; in extconfig.conf with a configuration like this:
9 ;
10 ;       sipusers = ldap,"dc=myDomain,dc=myDomainExt",sip
11 ;       sippeers = ldap,"dc=myDomain,dc=myDomainExt",sip
12 ;       extensions = ldap,"dc=myDomain,dc=myDomainExt",extensions
13 ;       sip.conf = ldap,"dc=myDomain,dc=myDomainExt",config
14 ;
15 ; In the case of LDAP the last keyword in each line above specifies
16 ; a section in this file.
17
18 ; TLS support
19 ; -----------
20 ; Note that you can configure an ldaps: url here to get TLS support.
21 ; Detailed configuration of certificates and supported CAs is done in your 
22 ; ldap.conf file for OpenLDAP clients on your system.
23 ; This requires that you have OpenLDAP libraries compiled with TLS support
24
25 ; *********************************************************************************
26 ; NOTE: res_ldap.conf should be chmod 600 because it contains the plain-text LDAP
27 ;       password to an account with WRITE access to the asterisk configuration. 
28 ; *********************************************************************************
29
30 [_general]
31 ;
32 ; Specify one of either host and port OR url.  URL is preferred, as you can
33 ; use more options.
34 ;host=192.168.1.1                    ; LDAP host
35 ;port=389
36 ;url=ldap://ldap3.mydomain.com:3890
37 ;protocol=3                          ; Version of the LDAP protocol to use; default is 3.
38 ;basedn=dc=example,dc=tld            ; Base DN
39 ;user=cn=asterisk,dc=example,dc=tld  ; Bind DN
40 ;pass=MyPassword                     ; Bind password
41
42 ; Configuration Table
43 [config]
44 ;
45 ; additionalFilter - This specifies an additional set of criteria to be used
46 ; when querying the LDAP server.
47 ;
48 additionalFilter=(objectClass=AstConfig)
49 ;
50 ; Attributes mapping (asterisk variable name = ldap attribute name)
51 ; When Asterisk requests the variable by the name of the value on the left,
52 ; this module will look up the attribute listed on the right.
53 ;
54 filename = AstConfigFilename
55 category = AstConfigCategory
56 variable_name = AstConfigVariableName
57 variable_value = AstConfigVariableValue
58 cat_metric = AstConfigCategoryMetric
59 commented = AstConfigCommented
60
61 ;
62 ; Extensions Table
63 ;
64 [extensions]
65 context  =  AstExtensionContext
66 exten  =  AstExtensionExten
67 priority = AstExtensionPriority
68 app = AstExtensionApplication
69 appdata = AstExtensionApplicationData
70 additionalFilter=(objectClass=AstExtension)
71
72 ;
73 ; Sip Users Table
74 ;
75 [sip]
76 name = cn       ; We use the "cn" as the default value for name on the line above
77                 ; because objectClass=AsteriskSIPUser does not include a uid as an allowed field
78                 ; If your entry combines other objectClasses and uid is available, you may
79                 ; prefer to change the line to be name = uid, especially if your LDAP entries
80                 ; contain spaces in the cn field.
81                 ; You may also find it appropriate to use something completely different.
82                 ; This is possible by changing the line above to name = AstAccountName (or whatever you
83                 ; prefer).
84                 ;
85 amaflags = AstAccountAMAFlags
86 callgroup = AstAccountCallGroup
87 callerid = AstAccountCallerID
88 directmedia = AstAccountDirectMedia
89 context = AstAccountContext
90 dtmfmode = AstAccountDTMFMode
91 fromuser = AstAccountFromUser
92 fromdomain = AstAccountFromDomain
93 fullcontact = AstAccountFullContact
94 fullcontact = gecos
95 host = AstAccountHost
96 insecure = AstAccountInsecure
97 mailbox = AstAccountMailbox
98 md5secret = AstAccountRealmedPassword           ; Must be an MD5 hash. Field value can start with
99                                                 ; {md5} but it is not required.
100                                                 ; Generate the password via the md5sum command, e.g.
101                                                 ; echo "my_password" | md5sum
102 nat = AstAccountNAT
103 deny = AstAccountDeny
104 permit = AstAccountPermit
105 pickupgroup = AstAccountPickupGroup
106 port = AstAccountPort
107 qualify = AstAccountQualify
108 restrictcid = AstAccountRestrictCID
109 rtptimeout = AstAccountRTPTimeout
110 rtpholdtimeout = AstAccountRTPHoldTimeout
111 type = AstAccountType
112 disallow = AstAccountDisallowedCodec
113 allow = AstAccountAllowedCodec
114 MusicOnHold = AstAccountMusicOnHold
115 regseconds = AstAccountExpirationTimestamp
116 regcontext = AstAccountRegistrationContext
117 regexten = AstAccountRegistrationExten
118 CanCallForward = AstAccountCanCallForward
119 ipaddr = AstAccountIPAddress
120 defaultuser = AstAccountDefaultUser
121 regserver = AstAccountRegistrationServer
122 lastms = AstAccountLastQualifyMilliseconds
123 additionalFilter=(objectClass=AsteriskSIPUser)
124
125 ;
126 ; IAX Users Table
127 ;
128 [iax]
129 amaflags = AstAccountAMAFlags
130 callerid = AstAccountCallerID
131 context = AstAccountContext
132 fullcontact = AstAccountFullContact
133 fullcontact = gecos
134 host = AstAccountHost
135 mailbox = AstAccountMailbox
136 md5secret = AstAccountRealmedPassword           ; Must be an MD5 hash. Field value can start with
137                                                 ; {md5} but it is not required.
138                                                 ; Generate the password via the md5sum command, e.g.
139                                                 ; echo "my_password" | md5sum
140 deny = AstAccountDeny
141 permit = AstAccountPermit
142 port = AstAccountPort
143 qualify = AstAccountQualify
144 type = AstAccountType
145 disallow = AstAccountDisallowedCodec
146 allow = AstAccountAllowedCodec
147 regseconds = AstAccountExpirationTimestamp
148 regcontext = AstAccountRegistrationContext
149 regexten = AstAccountRegistrationExten
150 notransfer = AstAccountNoTransfer
151 lastms = AstAccountLastQualifyMilliseconds
152 additionalFilter=(objectClass=AstAccountIAX)
153
154 ;
155 ; A Test Family
156 ;
157 [testfamily]
158 MyUSERID = uid
159 additionalFilter=(objectClass=*)
160
161 [accounts]
162 amaflags = AstAccountAMAFlags
163 callgroup = AstAccountCallGroup
164 callerid = AstAccountCallerID
165 directmedia = AstAccountDirectMedia
166 context = AstAccountContext
167 dtmfmode = AstAccountDTMFMode
168 fromuser = AstAccountFromUser
169 fromdomain = AstAccountFromDomain
170 fullcontact = AstAccountFullContact
171 fullcontact = gecos
172 host = AstAccountHost
173 insecure = AstAccountInsecure
174 mailbox = AstAccountMailbox
175 md5secret = AstAccountRealmedPassword           ; Must be an MD5 hash. Field value can start with
176                                                 ; {md5} but it is not required.
177                                                 ; Generate the password via the md5sum command, e.g.
178                                                 ; echo "my_password" | md5sum
179 nat = AstAccountNAT
180 deny = AstAccountDeny
181 permit = AstAccountPermit
182 pickupgroup = AstAccountPickupGroup
183 port = AstAccountPort
184 qualify = AstAccountQualify
185 restrictcid = AstAccountRestrictCID
186 rtptimeout = AstAccountRTPTimeout
187 rtpholdtimeout = AstAccountRTPHoldTimeout
188 type = AstAccountType
189 disallow = AstAccountDisallowedCodec
190 allow = AstAccountAllowedCodec
191 MusicOnHold = AstAccountMusicOnHold
192 regseconds = AstAccountExpirationTimestamp
193 regcontext = AstAccountRegistrationContext
194 regexten = AstAccountRegistrationExten
195 CanCallForward = AstAccountCanCallForward
196 additionalFilter=(objectClass=AstAccount)
197