LdapAgent.h

Go to the documentation of this file.

/* ------------------------------------------------------------------------------
 * Copyright (c) 2006-2012 Novell, Inc. All Rights Reserved.
 *
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of version 2 of the GNU General Public License as published by the
 * Free Software Foundation.
 *
 * 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, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may find
 * current contact information at www.novell.com.
 * ------------------------------------------------------------------------------
 */

/* LdapAgent.h
 *
 * Ldap agent implementation
 *
 * Authors: Jiri Suchomel <jsuchome@suse.cz>
 *
 * $Id: LdapAgent.h 67263 2012-01-24 16:12:02Z jsuchome $
 */

#ifndef _LdapAgent_h
#define _LdapAgent_h

#include <Y2.h>
#include <scr/SCRAgent.h>

#include <LDAPConnection.h>
#include <LDAPException.h>
#include <LDAPAttributeList.h>
#include <LDAPAttribute.h>

#include <LDAPSchema.h>

#define DEFAULT_PORT 389
#define ANSWER  42
#define MAX_LENGTH_ID 5

class LdapAgent : public SCRAgent
{
private:
    int port;
    string hostname;
    string bind_dn;
    string bind_pw;
    string ldap_error;
    string server_error;
    bool tls_error;

    int ldap_error_code;
    bool ldap_initialized;

    string userpw_hash;

    LDAPConnection *ldap;
    LDAPConstraints *cons;
    LDAPSchema *schema;

    YCPMap  users,
            users_by_name,
            users_by_uidnumber,
            usernames,
            userdns,
            uids,
            homes,
            user_items,
            groups,
            groups_by_name,
            groups_by_gidnumber,
            groupnames,
            gids,
            group_items;

    string getValue ( const YCPMap map, const string key);

    int getIntValue ( const YCPMap map, const string key, int deflt);
    
    bool getBoolValue (const YCPMap map, const string key);

    YCPList getListValue (const YCPMap map, const string key);

    StringList ycplist2stringlist (YCPList l);
    
    YCPList stringlist2ycplist (StringList sl);

    YCPList stringlist2ycplist_low (StringList sl);

    YCPMap getGroupEntry (LDAPEntry *entry, string member_attribute);

    YCPMap getUserEntry (LDAPEntry *entry);

    YCPMap getSearchedEntry (LDAPEntry *entry, bool sinlge_value);

    YCPMap getObjectAttributes (string dn);

    YCPBoolean deleteSubTree (string dn);

    YCPBoolean moveWithSubtree (string dn, string new_dn, string parent_dn);
    
    YCPBoolean copyOneEntry (string dn, string new_dn);
 
    void debug_exception (LDAPException e, string action);
    
    void debug_referral (LDAPReferralException e, string action);

    void set_tls_options (YCPMap args, string tls);

    void generate_attr_list (LDAPAttributeList* attrs, YCPMap map);

    void generate_mod_list (LDAPModList* modlist, YCPMap map, YCPValue attrs);

public:
    LdapAgent();

    virtual ~LdapAgent();

    virtual YCPValue Read ( const YCPPath &path,
                            const YCPValue& arg = YCPNull(),
                            const YCPValue& opt = YCPNull());

    virtual YCPBoolean Write(const YCPPath &path,
                           const YCPValue& arg,
                           const YCPValue& arg2 = YCPNull());

    virtual YCPValue Execute(const YCPPath &path,
                             const YCPValue& arg = YCPNull(),
                             const YCPValue& arg2 = YCPNull());

    virtual YCPList Dir(const YCPPath& path);

    virtual YCPValue otherCommand(const YCPTerm& term);
};

#endif /* _LdapAgent_h */