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 | -- --
-- package Copyright (c) Dmitry A. Kazakov --
-- GNAT.Sockets.Connection_State_Machine. Luebeck --
-- LDAP.Server Summer, 2019 --
-- Interface --
-- Last revision : 18:41 01 Aug 2019 --
-- --
-- This library is free software; you can redistribute it and/or --
-- modify it under the terms of the GNU General Public License as --
-- published by the Free Software Foundation; either version 2 of --
-- the License, or (at your option) any later version. This library --
-- is distributed in the hope that it will be useful, but WITHOUT --
-- ANY WARRANTY; without even the implied warranty of --
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU --
-- General Public License for more details. You should have --
-- received a copy of the GNU General Public License along with --
-- this library; if not, write to the Free Software Foundation, --
-- Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. --
-- --
-- As a special exception, if other files instantiate generics from --
-- this unit, or you link this unit with other files to produce an --
-- executable, this unit does not by itself cause the resulting --
-- executable to be covered by the GNU General Public License. This --
-- exception does not however invalidate any other reasons why the --
-- executable file might be covered by the GNU Public License. --
--____________________________________________________________________--
with Ada.Task_Identification; use Ada.Task_Identification;
package GNAT.Sockets.Connection_State_Machine.LDAP.Server is
--
-- LDAP_Server -- LDAP server
--
-- Listener - The connection object
-- Message_Length - The maximum output LDAP message length
-- Incoming_Data_Size - The arena pool size to allocate incoming
-- dynamic LDAP objects and string bodies
-- Outgoing_Data_Size - The arena pool size for outgoing LDAP objects
-- Input_Size - The input buffer size
-- Output_Size - The output buffer size
--
-- Message_Length must be larger than the encoded length of any outgoing
-- LDAP message. Outgoing_Data_Size determines the size of the arena
-- pool where are variable-length values allocated. This includes LDAP
-- objects defined recursively or as variable-sized sets and sequences.
-- The arena must accommodate data for any outgoing LDAP message built
-- there before getting encoded. Incoming_Data_Size determines the size
-- of the arena pool for the incoming LDAP message.
--
type LDAP_Server is new LDAP_Peer with private;
--
-- The server must implement the callbacks to the client requests. The
-- callback parameters are decoded when they are straightforward.
-- Otherwise the request object is passed without decoding to reduce the
-- overhead.
--
-- Receive_Abandon_Request -- Received abandon request callback
--
-- Server - The LDAP server
-- ID - The ID of the message to abandon
--
-- The default implementation does nothing.
--
procedure Receive_Abandon_Request
( Server : in out LDAP_Server;
ID : Integer_32
);
--
-- Receive_Add_Request -- Received add request callback
--
-- Server - The LDAP server
-- Request - The add request
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Add_Request
( Server : in out LDAP_Server;
Request : LDAP_Add_Request
);
--
-- Receive_Bind_Request -- Received bind request callback
--
-- Server - The LDAP server
-- Name - The name to bind
-- Password - The password
-- Credentials - The credentials
--
-- This procedure is called to perform simple authentication. The
-- implementation responds with Auth_Method_Not_Supported_Code.
--
procedure Receive_Bind_Request
( Server : in out LDAP_Server;
Name : Distinguished_Name;
Password : String
);
--
-- Receive_Bind_Request -- Received bind request callback
--
-- Server - The LDAP server
-- Name - The name to bind to
-- Mechanism - The authentication mechanism
-- Credentials - The credentials
--
-- This procedure is called to perform SASL authentication . The
-- implementation responds with Auth_Method_Not_Supported_Code.
--
procedure Receive_Bind_Request
( Server : in out LDAP_Server;
Name : Distinguished_Name;
Mechanism : String;
Credentials : String
);
--
-- Receive_Compare_Request -- Received compare request callback
--
-- Server - The LDAP server
-- Request - The compare request
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Compare_Request
( Server : in out LDAP_Server;
Request : LDAP_Compare_Request
);
--
-- Receive_Delete_Request -- Received delete request callback
--
-- Server - The LDAP server
-- Name - The name to delete
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Delete_Request
( Server : in out LDAP_Server;
Name : Distinguished_Name
);
--
-- Receive_Extended_Request -- Received extended request callback
--
-- Server - The LDAP server
-- Name - The object identifier
-- Value - The value
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Extended_Request
( Server : in out LDAP_Server;
Name : Object_Identifier;
Value : String
);
--
-- Receive_Modify_Request -- Received modify request callback
--
-- Server - The LDAP server
-- Request - The modify request
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Modify_Request
( Server : in out LDAP_Server;
Request : LDAP_Modify_Request
);
--
-- Receive_Modify_DN_Request -- Received modify DN request callback
--
-- Server - The LDAP server
-- Request - The modify DN request
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Modify_DN_Request
( Server : in out LDAP_Server;
Request : LDAP_Modify_DN_Request
);
--
-- Receive_Search_Request -- Received search request callback
--
-- Server - The LDAP server
-- Request - The search request
--
-- The default implementation responds with Unwilling_To_Perform_Code.
--
procedure Receive_Search_Request
( Server : in out LDAP_Server;
Request : LDAP_Search_Request
);
--
-- Receive_Unbind_Request -- Received unbind request callback
--
-- Server - The LDAP server
--
-- The default implementation does nothing.
--
procedure Receive_Unbind_Request
( Server : in out LDAP_Server
);
--
-- Reply_Add -- Reply to an add request
--
-- Server - The LDAP server
-- Result - The result code
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Add
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Bind -- Reply to a bind request
--
-- Server - The LDAP server
-- Result - The result code
-- [ Credentials ] - The SASL challenge
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Bind
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
procedure Reply_Bind
( Server : in out LDAP_Server;
Result : Result_Code;
Credentials : String;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Compare -- Reply to a compare request
--
-- Server - The LDAP server
-- Result - The result code
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Compare
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Delete -- Reply to a delete request
--
-- Server - The LDAP server
-- Result - The result code
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Delete
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Extended -- Reply using extended response
--
-- Server - The LDAP server
-- Name - The object identifier
-- Value - The value
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Extended
( Server : in out LDAP_Server;
Result : Result_Code;
Name : Object_Identifier;
Value : String;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Intermediate -- Reply using intermediate response
--
-- Server - The LDAP server
-- Name - The object identifier
-- Value - The value
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Intermediate
( Server : in out LDAP_Server;
Name : Object_Identifier;
Value : String
);
--
-- Reply_Modify -- Reply to a modify request
--
-- Server - The LDAP server
-- Result - The result code
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Modify
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Modify_DN -- Reply to a modify DN request
--
-- Server - The LDAP server
-- Result - The result code
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Modify_DN
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Search_Done -- Last reply to a search request
--
-- Server - The LDAP server
-- Result - The result code
-- Matched - The matched name
-- Message - The diagnostic message
-- Referral - The referral list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Search_Done
( Server : in out LDAP_Server;
Result : Result_Code;
Matched : Distinguished_Name := Null_Name;
Message : String := "";
Referral : Values_List := Empty
);
--
-- Reply_Search_Entry -- Partial reply to a search request
--
-- Server - The LDAP server
-- Name - Found distinguished name
-- Attributes - Found attributes
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Search_Entry
( Server : in out LDAP_Server;
Name : Distinguished_Name;
Attributes : Attributes_List
);
--
-- Reply_Search_Reference -- Partial reply to a search request
--
-- Server - The LDAP server
-- URIs - The references list
--
-- Exceptions :
--
-- Socket_Error - I/O error
-- Status_Error - The connection is down
-- Data_Error - Protocol errors
-- LDAP_Error - Execution error
--
procedure Reply_Search_Reference
( Server : in out LDAP_Server;
URIs : Values_List
);
--
-- Trace -- Tracing
--
-- Server - The LDAP server
-- Message - To write into the trace
--
procedure Trace
( Server : in out LDAP_Server;
Message : String
);
private
type LDAP_Server is new LDAP_Peer with null record;
procedure Process_Packet (Server : in out LDAP_Server);
end GNAT.Sockets.Connection_State_Machine.LDAP.Server;
|