529 lines
14 KiB
C
529 lines
14 KiB
C
|
/*
|
||
|
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
|
||
|
* Copyright (C) 2003 Match Grun
|
||
|
*
|
||
|
* This program 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 program 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 program; if not, write to the Free Software
|
||
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||
|
*/
|
||
|
|
||
|
/*
|
||
|
* Functions for LDAP control data.
|
||
|
*/
|
||
|
|
||
|
#ifdef HAVE_CONFIG_H
|
||
|
# include "config.h"
|
||
|
#endif
|
||
|
|
||
|
#ifdef USE_LDAP
|
||
|
|
||
|
#include <glib.h>
|
||
|
#include <sys/time.h>
|
||
|
#include <string.h>
|
||
|
|
||
|
#include "ldapctrl.h"
|
||
|
#include "mgutils.h"
|
||
|
|
||
|
/**
|
||
|
* Create new LDAP control block object.
|
||
|
* \return Initialized control object.
|
||
|
*/
|
||
|
LdapControl *ldapctl_create( void ) {
|
||
|
LdapControl *ctl;
|
||
|
|
||
|
ctl = g_new0( LdapControl, 1 );
|
||
|
ctl->hostName = NULL;
|
||
|
ctl->port = LDAPCTL_DFL_PORT;
|
||
|
ctl->baseDN = NULL;
|
||
|
ctl->bindDN = NULL;
|
||
|
ctl->bindPass = NULL;
|
||
|
ctl->listCriteria = NULL;
|
||
|
ctl->attribEMail = g_strdup( LDAPCTL_ATTR_EMAIL );
|
||
|
ctl->attribCName = g_strdup( LDAPCTL_ATTR_COMMONNAME );
|
||
|
ctl->attribFName = g_strdup( LDAPCTL_ATTR_GIVENNAME );
|
||
|
ctl->attribLName = g_strdup( LDAPCTL_ATTR_SURNAME );
|
||
|
ctl->maxEntries = LDAPCTL_MAX_ENTRIES;
|
||
|
ctl->timeOut = LDAPCTL_DFL_TIMEOUT;
|
||
|
ctl->maxQueryAge = LDAPCTL_DFL_QUERY_AGE;
|
||
|
|
||
|
/* Mutex to protect control block */
|
||
|
ctl->mutexCtl = g_malloc0( sizeof( pthread_mutex_t ) );
|
||
|
pthread_mutex_init( ctl->mutexCtl, NULL );
|
||
|
|
||
|
return ctl;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify hostname to be used.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Host name.
|
||
|
*/
|
||
|
void ldapctl_set_host( LdapControl* ctl, const gchar *value ) {
|
||
|
ctl->hostName = mgu_replace_string( ctl->hostName, value );
|
||
|
g_strstrip( ctl->hostName );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify port to be used.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Port.
|
||
|
*/
|
||
|
void ldapctl_set_port( LdapControl* ctl, const gint value ) {
|
||
|
if( value > 0 ) {
|
||
|
ctl->port = value;
|
||
|
}
|
||
|
else {
|
||
|
ctl->port = LDAPCTL_DFL_PORT;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify base DN to be used.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Base DN.
|
||
|
*/
|
||
|
void ldapctl_set_base_dn( LdapControl* ctl, const gchar *value ) {
|
||
|
ctl->baseDN = mgu_replace_string( ctl->baseDN, value );
|
||
|
g_strstrip( ctl->baseDN );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify bind DN to be used.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Bind DN.
|
||
|
*/
|
||
|
void ldapctl_set_bind_dn( LdapControl* ctl, const gchar *value ) {
|
||
|
ctl->bindDN = mgu_replace_string( ctl->bindDN, value );
|
||
|
g_strstrip( ctl->bindDN );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify bind password to be used.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Password.
|
||
|
*/
|
||
|
void ldapctl_set_bind_password( LdapControl* ctl, const gchar *value ) {
|
||
|
ctl->bindPass = mgu_replace_string( ctl->bindPass, value );
|
||
|
g_strstrip( ctl->bindPass );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify maximum number of entries to retrieve.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Maximum entries.
|
||
|
*/
|
||
|
void ldapctl_set_max_entries( LdapControl* ctl, const gint value ) {
|
||
|
if( value > 0 ) {
|
||
|
ctl->maxEntries = value;
|
||
|
}
|
||
|
else {
|
||
|
ctl->maxEntries = LDAPCTL_MAX_ENTRIES;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify timeout value for LDAP operation (in seconds).
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Timeout.
|
||
|
*/
|
||
|
void ldapctl_set_timeout( LdapControl* ctl, const gint value ) {
|
||
|
if( value > 0 ) {
|
||
|
ctl->timeOut = value;
|
||
|
}
|
||
|
else {
|
||
|
ctl->timeOut = LDAPCTL_DFL_TIMEOUT;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify maximum age of query (in seconds) before query is retired.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param value Maximum age.
|
||
|
*/
|
||
|
void ldapctl_set_max_query_age( LdapControl* ctl, const gint value ) {
|
||
|
if( value > LDAPCTL_MAX_QUERY_AGE ) {
|
||
|
ctl->maxQueryAge = LDAPCTL_MAX_QUERY_AGE;
|
||
|
}
|
||
|
else if( value < 1 ) {
|
||
|
ctl->maxQueryAge = LDAPCTL_DFL_QUERY_AGE;
|
||
|
}
|
||
|
else {
|
||
|
ctl->maxQueryAge = value;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Specify search criteria list to be used.
|
||
|
* \param ctl Control data object.
|
||
|
* \param value Linked list of LDAP attribute names to use for search.
|
||
|
*/
|
||
|
void ldapctl_set_criteria_list( LdapControl* ctl, GList *value ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
mgu_free_dlist( ctl->listCriteria );
|
||
|
ctl->listCriteria = value;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Return search criteria list.
|
||
|
* \param ctl Control data object.
|
||
|
* \return Linked list of character strings containing LDAP attribute names to
|
||
|
* use for a search. This should not be modified directly. Use the
|
||
|
* <code>ldapctl_set_criteria_list()</code>,
|
||
|
* <code>ldapctl_criteria_list_clear()</code> and
|
||
|
* <code>ldapctl_criteria_list_add()</code> functions for this purpose.
|
||
|
*/
|
||
|
GList *ldapctl_get_criteria_list( const LdapControl* ctl ) {
|
||
|
g_return_val_if_fail( ctl != NULL, NULL );
|
||
|
return ctl->listCriteria;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Clear list of LDAP search attributes.
|
||
|
* \param ctl Control data object.
|
||
|
*/
|
||
|
void ldapctl_criteria_list_clear( LdapControl *ctl ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
mgu_free_dlist( ctl->listCriteria );
|
||
|
ctl->listCriteria = NULL;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Add LDAP attribute to criteria list.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param attr Attribute name to append. If not NULL and unique, a copy will
|
||
|
* be appended to the list.
|
||
|
*/
|
||
|
void ldapctl_criteria_list_add( LdapControl *ctl, gchar *attr ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
if( attr != NULL ) {
|
||
|
if( mgu_list_test_unq_nc( ctl->listCriteria, attr ) ) {
|
||
|
ctl->listCriteria = g_list_append(
|
||
|
ctl->listCriteria, g_strdup( attr ) );
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Build criteria list using default attributes.
|
||
|
* \param ctl Control object to process.
|
||
|
*/
|
||
|
void ldapctl_default_attributes( LdapControl *ctl ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
|
||
|
ldapctl_criteria_list_clear( ctl );
|
||
|
ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_COMMONNAME );
|
||
|
ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_GIVENNAME );
|
||
|
ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_SURNAME );
|
||
|
ldapctl_criteria_list_add( ctl, LDAPCTL_ATTR_EMAIL );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Clear LDAP server member variables.
|
||
|
* \param ctl Control object to clear.
|
||
|
*/
|
||
|
void ldapctl_clear( LdapControl *ctl ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
|
||
|
/* Free internal stuff */
|
||
|
g_free( ctl->hostName );
|
||
|
g_free( ctl->baseDN );
|
||
|
g_free( ctl->bindDN );
|
||
|
g_free( ctl->bindPass );
|
||
|
g_free( ctl->attribEMail );
|
||
|
g_free( ctl->attribCName );
|
||
|
g_free( ctl->attribFName );
|
||
|
g_free( ctl->attribLName );
|
||
|
|
||
|
ldapctl_criteria_list_clear( ctl );
|
||
|
|
||
|
/* Clear pointers */
|
||
|
ctl->hostName = NULL;
|
||
|
ctl->port = 0;
|
||
|
ctl->baseDN = NULL;
|
||
|
ctl->bindDN = NULL;
|
||
|
ctl->bindPass = NULL;
|
||
|
ctl->attribEMail = NULL;
|
||
|
ctl->attribCName = NULL;
|
||
|
ctl->attribFName = NULL;
|
||
|
ctl->attribLName = NULL;
|
||
|
ctl->maxEntries = 0;
|
||
|
ctl->timeOut = 0;
|
||
|
ctl->maxQueryAge = 0;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Free up LDAP server interface object by releasing internal memory.
|
||
|
* \param ctl Control object to free.
|
||
|
*/
|
||
|
void ldapctl_free( LdapControl *ctl ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
|
||
|
/* Free internal stuff */
|
||
|
ldapctl_clear( ctl );
|
||
|
|
||
|
/* Free the mutex */
|
||
|
pthread_mutex_destroy( ctl->mutexCtl );
|
||
|
g_free( ctl->mutexCtl );
|
||
|
ctl->mutexCtl = NULL;
|
||
|
|
||
|
/* Now release LDAP control object */
|
||
|
g_free( ctl );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Setup default (empty) values for specified object.
|
||
|
* \param ctl Control object to process.
|
||
|
*/
|
||
|
void ldapctl_default_values( LdapControl *ctl ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
|
||
|
/* Clear our destination */
|
||
|
ldapctl_clear( ctl );
|
||
|
|
||
|
/* Copy strings */
|
||
|
ctl->hostName = g_strdup( "" );
|
||
|
ctl->baseDN = g_strdup( "" );
|
||
|
ctl->bindDN = g_strdup( "" );
|
||
|
ctl->bindPass = g_strdup( "" );
|
||
|
ctl->port = LDAPCTL_DFL_PORT;
|
||
|
ctl->maxEntries = LDAPCTL_MAX_ENTRIES;
|
||
|
ctl->timeOut = LDAPCTL_DFL_TIMEOUT;
|
||
|
ctl->maxQueryAge = LDAPCTL_DFL_QUERY_AGE;
|
||
|
|
||
|
ldapctl_default_attributes( ctl );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Display object to specified stream.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param stream Output stream.
|
||
|
*/
|
||
|
void ldapctl_print( const LdapControl *ctl, FILE *stream ) {
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
|
||
|
pthread_mutex_lock( ctl->mutexCtl );
|
||
|
fprintf( stream, "LdapControl:\n" );
|
||
|
fprintf( stream, "host name: '%s'\n", ctl->hostName );
|
||
|
fprintf( stream, " port: %d\n", ctl->port );
|
||
|
fprintf( stream, " base dn: '%s'\n", ctl->baseDN );
|
||
|
fprintf( stream, " bind dn: '%s'\n", ctl->bindDN );
|
||
|
fprintf( stream, "bind pass: '%s'\n", ctl->bindPass );
|
||
|
fprintf( stream, "attr mail: '%s'\n", ctl->attribEMail );
|
||
|
fprintf( stream, "attr comn: '%s'\n", ctl->attribCName );
|
||
|
fprintf( stream, "attr frst: '%s'\n", ctl->attribFName );
|
||
|
fprintf( stream, "attr last: '%s'\n", ctl->attribLName );
|
||
|
fprintf( stream, "max entry: %d\n", ctl->maxEntries );
|
||
|
fprintf( stream, " timeout: %d\n", ctl->timeOut );
|
||
|
fprintf( stream, " max age: %d\n", ctl->maxQueryAge );
|
||
|
fprintf( stream, "crit list:\n" );
|
||
|
if( ctl->listCriteria ) {
|
||
|
mgu_print_dlist( ctl->listCriteria, stream );
|
||
|
}
|
||
|
else {
|
||
|
fprintf( stream, "\t!!!none!!!\n" );
|
||
|
}
|
||
|
pthread_mutex_unlock( ctl->mutexCtl );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Copy member variables to specified object. Mutex lock object is
|
||
|
* not copied.
|
||
|
* \param ctlFrom Object to copy from.
|
||
|
* \param ctlTo Destination object.
|
||
|
*/
|
||
|
void ldapctl_copy( const LdapControl *ctlFrom, LdapControl *ctlTo ) {
|
||
|
GList *node;
|
||
|
|
||
|
g_return_if_fail( ctlFrom != NULL );
|
||
|
g_return_if_fail( ctlTo != NULL );
|
||
|
|
||
|
/* Lock both objects */
|
||
|
pthread_mutex_lock( ctlFrom->mutexCtl );
|
||
|
pthread_mutex_lock( ctlTo->mutexCtl );
|
||
|
|
||
|
/* Clear our destination */
|
||
|
ldapctl_clear( ctlTo );
|
||
|
|
||
|
/* Copy strings */
|
||
|
ctlTo->hostName = g_strdup( ctlFrom->hostName );
|
||
|
ctlTo->baseDN = g_strdup( ctlFrom->baseDN );
|
||
|
ctlTo->bindDN = g_strdup( ctlFrom->bindDN );
|
||
|
ctlTo->bindPass = g_strdup( ctlFrom->bindPass );
|
||
|
ctlTo->attribEMail = g_strdup( ctlFrom->attribEMail );
|
||
|
ctlTo->attribCName = g_strdup( ctlFrom->attribCName );
|
||
|
ctlTo->attribFName = g_strdup( ctlFrom->attribFName );
|
||
|
ctlTo->attribLName = g_strdup( ctlFrom->attribLName );
|
||
|
|
||
|
/* Copy search criteria */
|
||
|
node = ctlFrom->listCriteria;
|
||
|
while( node ) {
|
||
|
ctlTo->listCriteria = g_list_append(
|
||
|
ctlTo->listCriteria, g_strdup( node->data ) );
|
||
|
node = g_list_next( node );
|
||
|
}
|
||
|
|
||
|
/* Copy other members */
|
||
|
ctlTo->port = ctlFrom->port;
|
||
|
ctlTo->maxEntries = ctlFrom->maxEntries;
|
||
|
ctlTo->timeOut = ctlFrom->timeOut;
|
||
|
ctlTo->maxQueryAge = ctlFrom->maxQueryAge;
|
||
|
|
||
|
/* Unlock */
|
||
|
pthread_mutex_unlock( ctlTo->mutexCtl );
|
||
|
pthread_mutex_unlock( ctlFrom->mutexCtl );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Build a formatted LDAP search criteria string from criteria list.
|
||
|
* \param ctl Control object to process.
|
||
|
* \param searchVal Value to search for.
|
||
|
* \return Formatted string. Should be g_free() when done.
|
||
|
*/
|
||
|
gchar *ldapctl_format_criteria( LdapControl *ctl, const gchar *searchVal ) {
|
||
|
GList *node;
|
||
|
gchar *p1, *p2, *retVal;
|
||
|
|
||
|
g_return_val_if_fail( ctl != NULL, NULL );
|
||
|
|
||
|
/* p1 contains previous formatted criteria */
|
||
|
/* p2 contains next formatted criteria */
|
||
|
retVal = p1 = p2 = NULL;
|
||
|
node = ctl->listCriteria;
|
||
|
while( node ) {
|
||
|
gchar *attr, *tmp;
|
||
|
|
||
|
attr = node->data;
|
||
|
node = g_list_next( node );
|
||
|
|
||
|
/* Switch pointers */
|
||
|
tmp = p1; p1 = p2; p2 = tmp;
|
||
|
|
||
|
if( p1 ) {
|
||
|
/* Subsequent time through */
|
||
|
gchar *crit;
|
||
|
|
||
|
/* Format query criteria */
|
||
|
crit = g_strdup_printf( "(%s=%s*)", attr, searchVal );
|
||
|
|
||
|
/* Append to existing criteria */
|
||
|
g_free( p2 );
|
||
|
p2 = g_strdup_printf( "(|%s%s)", p1, crit );
|
||
|
|
||
|
g_free( crit );
|
||
|
}
|
||
|
else {
|
||
|
/* First time through - Format query criteria */
|
||
|
p2 = g_strdup_printf( "(%s=%s*)", attr, searchVal );
|
||
|
}
|
||
|
}
|
||
|
|
||
|
if( p2 == NULL ) {
|
||
|
/* Nothing processed - format a default attribute */
|
||
|
retVal = g_strdup_printf( "(%s=*)", LDAPCTL_ATTR_EMAIL );
|
||
|
}
|
||
|
else {
|
||
|
/* We have something - free up previous result */
|
||
|
retVal = p2;
|
||
|
g_free( p1 );
|
||
|
}
|
||
|
return retVal;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Return array of pointers to attributes for LDAP query.
|
||
|
* \param ctl Control object to process.
|
||
|
* \return NULL terminated list.
|
||
|
*/
|
||
|
char **ldapctl_attribute_array( LdapControl *ctl ) {
|
||
|
char **ptrArray;
|
||
|
GList *node;
|
||
|
gint cnt, i;
|
||
|
g_return_val_if_fail( ctl != NULL, NULL );
|
||
|
|
||
|
cnt = g_list_length( ctl->listCriteria );
|
||
|
ptrArray = g_new0( char *, 1 + cnt );
|
||
|
i = 0;
|
||
|
node = ctl->listCriteria;
|
||
|
while( node ) {
|
||
|
ptrArray[ i++ ] = node->data;
|
||
|
node = g_list_next( node );
|
||
|
}
|
||
|
ptrArray[ i ] = NULL;
|
||
|
return ptrArray;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Free array of pointers allocated by ldapctl_criteria_array().
|
||
|
* param ptrArray Array to clear.
|
||
|
*/
|
||
|
void ldapctl_free_attribute_array( char **ptrArray ) {
|
||
|
gint i;
|
||
|
|
||
|
/* Clear array to NULL's */
|
||
|
for( i = 0; ptrArray[i] != NULL; i++ ) {
|
||
|
ptrArray[i] = NULL;
|
||
|
}
|
||
|
g_free( ptrArray );
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Parse LDAP search string, building list of LDAP criteria attributes. This
|
||
|
* may be used to convert an old style Sylpheed LDAP search criteria to the
|
||
|
* new format. The old style uses a standard LDAP search string, for example:
|
||
|
* <pre>
|
||
|
* (&(mail=*)(cn=%s*))
|
||
|
* </pre>
|
||
|
* This function extracts the two LDAP attributes <code>mail</code> and
|
||
|
* <code>cn</code>, adding each to a list.
|
||
|
*
|
||
|
* \param ctl Control object to process.
|
||
|
* \param criteria LDAP search criteria string.
|
||
|
*/
|
||
|
void ldapctl_parse_ldap_search( LdapControl *ctl, gchar *criteria ) {
|
||
|
gchar *ptr;
|
||
|
gchar *pFrom;
|
||
|
gchar *attrib;
|
||
|
gint iLen;
|
||
|
|
||
|
g_return_if_fail( ctl != NULL );
|
||
|
|
||
|
ldapctl_criteria_list_clear( ctl );
|
||
|
if( criteria == NULL ) return;
|
||
|
|
||
|
pFrom = NULL;
|
||
|
ptr = criteria;
|
||
|
while( *ptr ) {
|
||
|
if( *ptr == '(' ) {
|
||
|
pFrom = 1 + ptr;
|
||
|
}
|
||
|
if( *ptr == '=' ) {
|
||
|
if( pFrom ) {
|
||
|
iLen = ptr - pFrom;
|
||
|
attrib = g_strndup( pFrom, iLen );
|
||
|
g_strstrip( attrib );
|
||
|
ldapctl_criteria_list_add( ctl, attrib );
|
||
|
g_free( attrib );
|
||
|
}
|
||
|
pFrom = NULL;
|
||
|
}
|
||
|
ptr++;
|
||
|
}
|
||
|
}
|
||
|
|
||
|
#endif /* USE_LDAP */
|
||
|
|
||
|
/*
|
||
|
* End of Source.
|
||
|
*/
|
||
|
|