comparison: src/server/safs/ldap.h
src/server/safs/ldap.h
- changeset 464
- 0a29110b94ec
- child 465
- d22ff46c171c
equal
deleted
inserted
replaced
| 463:4fd523fff13b | 464:0a29110b94ec |
|---|---|
| 1 /* | |
| 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
| 3 * | |
| 4 * Copyright 2023 Olaf Wintermann. All rights reserved. | |
| 5 * | |
| 6 * Redistribution and use in source and binary forms, with or without | |
| 7 * modification, are permitted provided that the following conditions are met: | |
| 8 * | |
| 9 * 1. Redistributions of source code must retain the above copyright | |
| 10 * notice, this list of conditions and the following disclaimer. | |
| 11 * | |
| 12 * 2. Redistributions in binary form must reproduce the above copyright | |
| 13 * notice, this list of conditions and the following disclaimer in the | |
| 14 * documentation and/or other materials provided with the distribution. | |
| 15 * | |
| 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
| 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
| 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
| 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
| 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
| 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
| 26 * POSSIBILITY OF SUCH DAMAGE. | |
| 27 */ | |
| 28 | |
| 29 #ifndef WS_SAFS_LDAP_H | |
| 30 #define WS_SAFS_LDAP_H | |
| 31 | |
| 32 #include "../public/nsapi.h" | |
| 33 | |
| 34 #include "../daemon/ldap_resource.h" | |
| 35 | |
| 36 #ifdef __cplusplus | |
| 37 extern "C" { | |
| 38 #endif | |
| 39 | |
| 40 #define WS_SAFS_LDAP_DEFAULT_SCOPE LDAP_SCOPE_SUBTREE | |
| 41 #define WS_SAFS_LDAP_DEFAULT_TIMEOUT 30 | |
| 42 #define WS_SAFS_LDAP_DEFAULT_SIZELIMIT 1000 | |
| 43 | |
| 44 #define WS_SAFS_LDAP_MAX_TIMEOUT 32767 | |
| 45 | |
| 46 #define WS_SAFS_LDAP_EMPTY_QUERY_ERROR 404 | |
| 47 #define WS_SAFS_LDAP_EMPTY_RESULT_ERROR 404 | |
| 48 | |
| 49 /* | |
| 50 * ldap-query | |
| 51 * | |
| 52 * Sends an ldap query result as ldif to the client. If no query parameter is | |
| 53 * specified, the SAFs tries to use the "ldap_query" parameter from rq->vars. | |
| 54 * | |
| 55 * required parameters: | |
| 56 * resource name of the ldap resource pool | |
| 57 * basedn ldap basedn | |
| 58 * | |
| 59 * optional parameters: | |
| 60 * binddn bind ldap session to binddn | |
| 61 * bindpw binddn password | |
| 62 * query ldap search query | |
| 63 * scope search scope: base, onelevel, subtree, children | |
| 64 * timeout timeout in seconds default: 30 | |
| 65 * sizelimit maximum number of result entries defazkt: 1000 | |
| 66 * empty_query_error status code if the query is empty/null default: 404 | |
| 67 * empty_result_error status code if the result is empty default: 404 | |
| 68 * | |
| 69 * If the query or result is empty and the status code is 2xx, an empty | |
| 70 * response is sent to the client. | |
| 71 */ | |
| 72 int ldap_query_saf(pblock *pb, Session *sn, Request *rq); | |
| 73 | |
| 74 | |
| 75 #ifdef __cplusplus | |
| 76 } | |
| 77 #endif | |
| 78 | |
| 79 #endif /* WS_SAFS_LDAP_H */ | |
| 80 |
