File: Ldap.html

package info (click to toggle)
ldap-account-manager 3.7-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 34,660 kB
  • sloc: php: 49,813; perl: 305; makefile: 169; sh: 156; pascal: 132; xml: 111
file content (497 lines) | stat: -rw-r--r-- 16,434 bytes parent folder | download
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
<html>
<head>
<title>Docs For Class Ldap</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">LDAP</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                                                                                                                                                                                                                                                                                                                                
                                                                                                                                                                                                                                                                                                                                          		  [ <a href="../classtrees_LDAP.html" class="menu">class tree: LDAP</a> ]
		  [ <a href="../elementindex_LDAP.html" class="menu">index: LDAP</a> ]
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
	<div id="ric">
					<p><a href="../ric_README.html">README</a></p>
			</div>
	<div id="todolist">
			<p><a href="../todolist.html">Todo List</a></p>
	</div>
      <b>Packages:</b><br />
              <a href="../li_main.html">main</a><br />
              <a href="../li_configuration.html">configuration</a><br />
              <a href="../li_Crypt_AES.html">Crypt_AES</a><br />
              <a href="../li_Crypt_DES.html">Crypt_DES</a><br />
              <a href="../li_Crypt_Hash.html">Crypt_Hash</a><br />
              <a href="../li_Crypt_Random.html">Crypt_Random</a><br />
              <a href="../li_Crypt_RC4.html">Crypt_RC4</a><br />
              <a href="../li_Crypt_Rijndael.html">Crypt_Rijndael</a><br />
              <a href="../li_Crypt_RSA.html">Crypt_RSA</a><br />
              <a href="../li_Crypt_TerraDES.html">Crypt_TerraDES</a><br />
              <a href="../li_Crypt_TripleDES.html">Crypt_TripleDES</a><br />
              <a href="../li_default.html">default</a><br />
              <a href="../li_Help.html">Help</a><br />
              <a href="../li_horde-cipher.html">horde-cipher</a><br />
              <a href="../li_lam.html">lam</a><br />
              <a href="../li_LDAP.html">LDAP</a><br />
              <a href="../li_lib.html">lib</a><br />
              <a href="../li_lists.html">lists</a><br />
              <a href="../li_Math_BigInteger.html">Math_BigInteger</a><br />
              <a href="../li_metaHTML.html">metaHTML</a><br />
              <a href="../li_modules.html">modules</a><br />
              <a href="../li_Net_SFTP.html">Net_SFTP</a><br />
              <a href="../li_Net_SSH1.html">Net_SSH1</a><br />
              <a href="../li_Net_SSH2.html">Net_SSH2</a><br />
              <a href="../li_PDF.html">PDF</a><br />
              <a href="../li_phpLDAPadmin.html">phpLDAPadmin</a><br />
              <a href="../li_PHP_Compat.html">PHP_Compat</a><br />
              <a href="../li_profiles.html">profiles</a><br />
              <a href="../li_selfService.html">selfService</a><br />
              <a href="../li_tools.html">tools</a><br />
              <a href="../li_types.html">types</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../LDAP/_lib---ldap.inc.html">		ldap.inc
		</a><br>
	  </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../LDAP/Ldap.html">Ldap</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: Ldap</h1>
Source Location: /lib/ldap.inc<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Ldap manages connection to LDAP and includes several helper functions.</div><br /><br />






        
</td>



<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../LDAP/Ldap.html#method__construct">__construct</a></li>
    <li><a href="../LDAP/Ldap.html#methodclose">close</a></li>
    <li><a href="../LDAP/Ldap.html#methodconnect">connect</a></li>
    <li><a href="../LDAP/Ldap.html#methoddecrypt">decrypt</a></li>
    <li><a href="../LDAP/Ldap.html#methoddecrypt_login">decrypt_login</a></li>
    <li><a href="../LDAP/Ldap.html#methoddestroy">destroy</a></li>
    <li><a href="../LDAP/Ldap.html#methodencrypt">encrypt</a></li>
    <li><a href="../LDAP/Ldap.html#methodencrypt_login">encrypt_login</a></li>
    <li><a href="../LDAP/Ldap.html#methodnew_rand">new_rand</a></li>
    <li><a href="../LDAP/Ldap.html#methodserver">server</a></li>
    <li><a href="../LDAP/Ldap.html#method__sleep">__sleep</a></li>
    <li><a href="../LDAP/Ldap.html#method__wakeup">__wakeup</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 50]<br />
Ldap manages connection to LDAP and includes several helper functions.<br /><br /></div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />


<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methoddecrypt"></a>
	<h3>static method decrypt <span class="smalllinenumber">[line 236]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>static string decrypt(
object
$data, [string
$prefix = ''])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Decrypts a string<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>decrypted string</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$data</b>&nbsp;&nbsp;</td>
        <td>string to decrypt</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$prefix</b>&nbsp;&nbsp;</td>
        <td>prefix for cookie names</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodencrypt"></a>
	<h3>static method encrypt <span class="smalllinenumber">[line 209]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>static object encrypted encrypt(
string
$data, [string
$prefix = ''])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Encrypts a string<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>string</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$data</b>&nbsp;&nbsp;</td>
        <td>string to encrypt</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$prefix</b>&nbsp;&nbsp;</td>
        <td>prefix for cookie names</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>

  <hr />
	<a name="method__construct"></a>
	<h3>constructor __construct <span class="smalllinenumber">[line 71]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>Ldap __construct(
object
$config)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$config</b>&nbsp;&nbsp;</td>
        <td>an object of class Config</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodclose"></a>
	<h3>method close <span class="smalllinenumber">[line 124]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void close(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Closes connection to server<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodconnect"></a>
	<h3>method connect <span class="smalllinenumber">[line 88]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>mixed connect(
string
$user, string
$passwd, [boolean
$allowAnonymous = false])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Connects to the server using the given username and password<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>if connect succeeds the server handle is returned, else false</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$user</b>&nbsp;&nbsp;</td>
        <td>user name</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$passwd</b>&nbsp;&nbsp;</td>
        <td>password</td>
      </tr>
          <tr>
        <td class="type">boolean&nbsp;&nbsp;</td>
        <td><b>$allowAnonymous</b>&nbsp;&nbsp;</td>
        <td>specifies if anonymous binds are allowed</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddecrypt_login"></a>
	<h3>method decrypt_login <span class="smalllinenumber">[line 275]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>array decrypt_login(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Decrypts username and password<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>array(user name, password)</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methoddestroy"></a>
	<h3>method destroy <span class="smalllinenumber">[line 284]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void destroy(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Closes connection to LDAP server and deletes encrypted username/password<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodencrypt_login"></a>
	<h3>method encrypt_login <span class="smalllinenumber">[line 264]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void encrypt_login(
string
$username, string
$password)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Encrypts username and password<br /><br /><br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$username</b>&nbsp;&nbsp;</td>
        <td>LDAP user name</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$password</b>&nbsp;&nbsp;</td>
        <td>LDAP password</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodnew_rand"></a>
	<h3>method new_rand <span class="smalllinenumber">[line 194]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>int new_rand(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Calculates a new value for rand<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>New random value</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodserver"></a>
	<h3>method server <span class="smalllinenumber">[line 135]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object connection server(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns the LDAP connection handle<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>handle</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method__sleep"></a>
	<h3>method __sleep <span class="smalllinenumber">[line 145]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void __sleep(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Closes connection to LDAP server before serialization<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="method__wakeup"></a>
	<h3>method __wakeup <span class="smalllinenumber">[line 152]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void __wakeup(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Reconnects to LDAP server when deserialized<br /><br /><br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 25 Mar 2012 19:35:45 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>