summaryrefslogtreecommitdiffstats
path: root/ipa-python/ipaclient.py
blob: dc8e1dc9bad730d2aa458a18c78e1cf02f67bb7a (plain)
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
#! /usr/bin/python -E
# Authors: Rob Crittenden <rcritten@redhat.com>
#
# Copyright (C) 2007    Red Hat
# see file 'COPYING' for use and warranty information
#
# 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; version 2 or later
#
# 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
#

#!/usr/bin/python

import sys
sys.path.append("/usr/share/ipa")

from ipaserver import funcs
import ipa.rpcclient as rpcclient
import user
import ipa
import config

def cidict_to_dict(cid):
    """Convert a cidict to a standard dict for sending across the wire"""
    newdict = {}
    kindex = cid.keys()
    for dkey in kindex:
        newdict[dkey] = cid[dkey]
    return newdict

class IPAClient:

    def __init__(self,local=None):
        self.local = local
        ipa.config.init_config()
        if local:
            self.transport = funcs.IPAServer()
            # client needs to call set_principal(user@REALM)
        else:
            self.transport = rpcclient.RPCClient()

    def set_principal(self,princ):
        """Set the name of the principal that will be used for
           LDAP proxy authentication"""
        if self.local:
            self.transport.set_principal(princ)

    def get_user_by_uid(self,uid,sattrs=None):
        """Get a specific user by uid. If sattrs is set then only those
           attributes will be returned."""
        result = self.transport.get_user_by_uid(uid,sattrs)
        return user.User(result)

    def get_user_by_dn(self,dn,sattrs=None):
        """Get a specific user by uid. If sattrs is set then only those
           attributes will be returned."""
        result = self.transport.get_user_by_dn(dn,sattrs)
        return user.User(result)

    def add_user(self,user,user_container=None):
        """Add a user. user is a ipa.user object"""

        realm = config.config.get_realm()

        user_dict = user.toDict()

        # dn is set on the server-side
        del user_dict['dn']

        # convert to a regular dict before sending
        result = self.transport.add_user(user_dict, user_container)
        return result

    def get_all_users(self):
        """Get as a list of User objects all users in the directory"""
        result = self.transport.get_all_users()

        all_users = []
        for (attrs) in result:
            if attrs is not None:
                all_users.append(user.User(attrs))

        return all_users

    def get_add_schema(self):
        """Prototype for the GUI. Specify in the directory fields to
           be displayed and what data to get for new users."""
        result = self.transport.get_add_schema()
        return result

    def find_users(self, criteria, sattrs=None, user_container=None):
        """Find users whose uid matches the criteria. Wildcards are 
           acceptable. Returns a list of User objects."""
        result = self.transport.find_users(criteria, sattrs, user_container)

        users = []
        for (attrs) in result:
            if attrs is not None:
                users.append(user.User(attrs))

        return users

    def update_user(self,user):
        """Update a user entry."""

        realm = config.config.get_realm()

        result = self.transport.update_user(user.origDataDict(), user.toDict())
        return result

    def mark_user_deleted(self,uid):
        """Set a user as inactive by uid."""

        realm = config.config.get_realm()

        result = self.transport.mark_user_deleted(uid)
        return result