Class encapulating all LDAP functionality class LdapConnection friend

  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
/** Class encapulating all LDAP functionality */
class LdapConnection
{
friend struct LdapMessageHolder;
public:
/** Default constructor */
LdapConnection(void) : mConnection(NULL),mLdapDefinition() {}
/** Destructor, releases the connection */
~LdapConnection(void) ;
/** Make connection to LDAP server */
void connectSimple(const LdapDefinition& aDefinition)
throw (ldap::LdapConnectionException,
ldap::LdapGenericException);
/**
Gets LdapUserProfile from LDAP repository for specified user
@param aUser name of logged on user
@param aUserProfileMap Map containing LDAP->00o mapping
@param aUserProfile struct for holding OOo values
@throws com::sun::star::ldap::LdapGenericException
if an LDAP error occurs.
*/
void getUserProfile(const OUString& aUser, LdapData * data)
throw (lang::IllegalArgumentException,
ldap::LdapConnectionException,
ldap::LdapGenericException);
/** finds DN of user
@return DN of User
*/
OUString findUserDn(const OUString& aUser)
throw (lang::IllegalArgumentException,
ldap::LdapConnectionException,
ldap::LdapGenericException);
private:
void initConnection()
throw (ldap::LdapConnectionException);
void disconnect();
/**
Indicates whether the connection is in a valid state.
@return sal_True if connection is valid, sal_False otherwise
*/
bool isValid(void) const { return mConnection != NULL ; }
void connectSimple()
throw (ldap::LdapConnectionException,
ldap::LdapGenericException);
/** LDAP connection object */
LDAP* mConnection ;
LdapDefinition mLdapDefinition;
} ;
// -----------------------------------------------------------------------------
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include "ldapaccess.hxx"
#include <boost/noncopyable.hpp>
#include <osl/diagnose.h>
#include <rtl/ustrbuf.hxx>
#include <rtl/strbuf.hxx>
namespace extensions { namespace config { namespace ldap {
typedef int LdapErrCode;
struct LdapMessageHolder: private boost::noncopyable
{
LdapMessageHolder() : msg(0) {}
~LdapMessageHolder()
{
if (msg)
ldap_msgfree(msg);
}
LDAPMessage * msg;
};
LdapConnection::~LdapConnection()
{
if (isValid()) disconnect();
}
void LdapConnection::disconnect()
{
if (mConnection != NULL)
{
ldap_unbind_s(mConnection) ;
mConnection = NULL;
}
}
static void checkLdapReturnCode(const sal_Char *aOperation,
LdapErrCode aRetCode,
LDAP * /*aConnection*/)
{
if (aRetCode == LDAP_SUCCESS) { return ; }
static const sal_Char *kNoSpecificMessage = "No additional information" ;
OUStringBuffer message ;
if (aOperation != NULL)
{
message.appendAscii(aOperation).appendAscii(": ") ;
}
message.appendAscii(ldap_err2string(aRetCode)).appendAscii(" (") ;
sal_Char *stub = NULL ;
#ifndef LDAP_OPT_SIZELIMIT // for use with OpenLDAP
ldap_get_lderrno(aConnection, NULL, &stub) ;
#endif
if (stub != NULL)
{
message.appendAscii(stub) ;
// It would seem the message returned is actually
// not a copy of a string but rather some static
// string itself. At any rate freeing it seems to
// cause some undue problems at least on Windows.
// This call is thus disabled for the moment.
//ldap_memfree(stub) ;
}
else { message.appendAscii(kNoSpecificMessage) ; }
message.appendAscii(")") ;
throw ldap::LdapGenericException(message.makeStringAndClear(),
NULL, aRetCode) ;
}
void LdapConnection::connectSimple(const LdapDefinition& aDefinition)
throw (ldap::LdapConnectionException, ldap::LdapGenericException)
{
OSL_ENSURE(!isValid(), "Recoonecting an LDAP connection that is already established");
if (isValid()) disconnect();
mLdapDefinition = aDefinition;
connectSimple();
}
void LdapConnection::connectSimple()
throw (ldap::LdapConnectionException, ldap::LdapGenericException)
{
if (!isValid())
{
// Connect to the server
initConnection() ;
// Set Protocol V3
int version = LDAP_VERSION3;
ldap_set_option(mConnection,
LDAP_OPT_PROTOCOL_VERSION,
&version);
#ifdef LDAP_X_OPT_CONNECT_TIMEOUT // OpenLDAP doesn't support this and the func
/* timeout is specified in milliseconds -> 4 seconds*/
int timeout = 4000;
#ifdef WNT
ldap_set_optionW( mConnection,
LDAP_X_OPT_CONNECT_TIMEOUT,
&timeout );
#else
ldap_set_option( mConnection,
LDAP_X_OPT_CONNECT_TIMEOUT,
&timeout );
#endif
#endif
// Do the bind
#ifdef WNT
LdapErrCode retCode = ldap_simple_bind_sW(mConnection,
(PWCHAR) mLdapDefinition.mAnonUser.getStr(),
(PWCHAR) mLdapDefinition.mAnonCredentials.getStr() );
#else
LdapErrCode retCode = ldap_simple_bind_s(mConnection,
OUStringToOString( mLdapDefinition.mAnonUser, RTL_TEXTENCODING_UTF8 ).getStr(),
OUStringToOString( mLdapDefinition.mAnonCredentials, RTL_TEXTENCODING_UTF8 ).getStr()) ;
#endif
checkLdapReturnCode("SimpleBind", retCode, mConnection) ;
}
}
void LdapConnection::initConnection()
throw (ldap::LdapConnectionException)
{
if (mLdapDefinition.mServer.isEmpty())
{
OUStringBuffer message ;
message.appendAscii("Cannot initialise connection to LDAP: No server specified.") ;
throw ldap::LdapConnectionException(message.makeStringAndClear()) ;
}
if (mLdapDefinition.mPort == 0) mLdapDefinition.mPort = LDAP_PORT;
#ifdef WNT
mConnection = ldap_initW((PWCHAR) mLdapDefinition.mServer.getStr(),
mLdapDefinition.mPort) ;
#else
mConnection = ldap_init(OUStringToOString( mLdapDefinition.mServer, RTL_TEXTENCODING_UTF8 ).getStr(),
mLdapDefinition.mPort) ;
#endif
if (mConnection == NULL)
{
OUStringBuffer message ;
message.appendAscii("Cannot initialise connection to LDAP server ") ;
message.append(mLdapDefinition.mServer) ;
message.appendAscii(":") ;
message.append(mLdapDefinition.mPort) ;
throw ldap::LdapConnectionException(message.makeStringAndClear());
}
}
void LdapConnection::getUserProfile(
const OUString& aUser, LdapData * data)
throw (lang::IllegalArgumentException,
ldap::LdapConnectionException, ldap::LdapGenericException)
{
OSL_ASSERT(data != 0);
if (!isValid()) { connectSimple(); }
OUString aUserDn =findUserDn( aUser );
LdapMessageHolder result;
#ifdef WNT
LdapErrCode retCode = ldap_search_sW(mConnection,
(PWCHAR) aUserDn.getStr(),
LDAP_SCOPE_BASE,
const_cast<PWCHAR>( L"(objectclass=*)" ),
0,
0, // Attributes + values
&result.msg) ;
#else
LdapErrCode retCode = ldap_search_s(mConnection,
OUStringToOString( aUserDn, RTL_TEXTENCODING_UTF8 ).getStr(),
LDAP_SCOPE_BASE,
"(objectclass=*)",
0,
0, // Attributes + values
&result.msg) ;
#endif
checkLdapReturnCode("getUserProfile", retCode,mConnection) ;
BerElement * ptr;
#ifdef WNT
PWCHAR attr = ldap_first_attributeW(mConnection, result.msg, &ptr);
while (attr) {
PWCHAR * values = ldap_get_valuesW(mConnection, result.msg, attr);
if (values) {
const OUString aAttr( reinterpret_cast<sal_Unicode*>( attr ) );
const OUString aValues( reinterpret_cast<sal_Unicode*>( *values ) );
data->insert(
LdapData::value_type( aAttr, aValues ));
ldap_value_freeW(values);
}
attr = ldap_next_attributeW(mConnection, result.msg, ptr);
#else
char * attr = ldap_first_attribute(mConnection, result.msg, &ptr);
while (attr) {
char ** values = ldap_get_values(mConnection, result.msg, attr);
if (values) {
data->insert(
LdapData::value_type(
OStringToOUString(attr, RTL_TEXTENCODING_ASCII_US),
OStringToOUString(*values, RTL_TEXTENCODING_UTF8)));
ldap_value_free(values);
}
attr = ldap_next_attribute(mConnection, result.msg, ptr);
#endif
}
}
OUString LdapConnection::findUserDn(const OUString& aUser)
throw (lang::IllegalArgumentException,
ldap::LdapConnectionException, ldap::LdapGenericException)
{
if (!isValid()) { connectSimple(); }
if (aUser.isEmpty())
{
throw lang::IllegalArgumentException(
"LdapConnection::findUserDn -User id is empty",
NULL, 0) ;
}
OUStringBuffer filter( "(&(objectclass=" );
filter.append( mLdapDefinition.mUserObjectClass ).append(")(") ;
filter.append( mLdapDefinition.mUserUniqueAttr ).append("=").append(aUser).append("))") ;
LdapMessageHolder result;
#ifdef WNT
PWCHAR attributes [2] = { const_cast<PWCHAR>( L"1.1" ), NULL };
LdapErrCode retCode = ldap_search_sW(mConnection,
(PWCHAR) mLdapDefinition.mBaseDN.getStr(),
LDAP_SCOPE_SUBTREE,
(PWCHAR) filter.makeStringAndClear().getStr(), attributes, 0, &result.msg) ;
#else
sal_Char * attributes [2] = { const_cast<sal_Char *>(LDAP_NO_ATTRS), NULL };
LdapErrCode retCode = ldap_search_s(mConnection,
OUStringToOString( mLdapDefinition.mBaseDN, RTL_TEXTENCODING_UTF8 ).getStr(),
LDAP_SCOPE_SUBTREE,
OUStringToOString( filter.makeStringAndClear(), RTL_TEXTENCODING_UTF8 ).getStr(), attributes, 0, &result.msg) ;
#endif
checkLdapReturnCode("FindUserDn", retCode,mConnection) ;
OUString userDn ;
LDAPMessage *entry = ldap_first_entry(mConnection, result.msg) ;
if (entry != NULL)
{
#ifdef WNT
PWCHAR charsDn = ldap_get_dnW(mConnection, entry) ;
userDn = OUString( reinterpret_cast<const sal_Unicode*>( charsDn ) );
ldap_memfreeW(charsDn) ;
#else
sal_Char *charsDn = ldap_get_dn(mConnection, entry) ;
userDn = OStringToOUString( charsDn, RTL_TEXTENCODING_UTF8 );
ldap_memfree(charsDn) ;
#endif
}
else
{
OSL_FAIL( "LdapConnection::findUserDn-could not get DN for User ");
}
return userDn ;
}
} } } // extensions.config.ldap
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */