enum:
PR_MAXNAMELEN
PRGRP
+ PRUSERS
+ PRGROUPS
ANONYMOUSID
+ PR_SF_ALLBITS
+ PR_SF_NGROUPS
+ PR_SF_NUSERS
ctypedef char prname[PR_MAXNAMELEN]
unsigned int namelist_len
prname *namelist_val
+ struct prlist:
+ unsigned int prlist_len
+ afs_int32 *prlist_val
+
struct idlist:
unsigned int idlist_len
afs_int32 *idlist_val
+ struct prcheckentry:
+ afs_int32 flags
+ afs_int32 id
+ afs_int32 owner
+ afs_int32 creator
+ afs_int32 ngroups
+ afs_int32 nusers
+ afs_int32 count
+ char name[PR_MAXNAMELEN]
+
+ struct prlistentries:
+ afs_int32 flags
+ afs_int32 id
+ afs_int32 owner
+ afs_int32 creator
+ afs_int32 ngroups
+ afs_int32 nusers
+ afs_int32 count
+ char name[PR_MAXNAMELEN]
+
+ struct prentries:
+ unsigned int prentries_len
+ prlistentries *prentries_val
+
int ubik_PR_NameToID(ubik_client *, afs_int32, namelist *, idlist *)
int ubik_PR_IDToName(ubik_client *, afs_int32, idlist *, namelist *)
int ubik_PR_INewEntry(ubik_client *, afs_int32, char *, afs_int32, afs_int32)
int ubik_PR_Delete(ubik_client *, afs_int32, afs_int32)
int ubik_PR_AddToGroup(ubik_client *, afs_int32, afs_int32, afs_int32)
int ubik_PR_RemoveFromGroup(ubik_client *, afs_int32, afs_int32, afs_int32)
+ int ubik_PR_ListElements(ubik_client *, afs_int32, afs_int32, prlist *, afs_int32 *)
+ int ubik_PR_ListOwned(ubik_client *, afs_int32, afs_int32, prlist *, afs_int32 *)
+ int ubik_PR_ListEntry(ubik_client *, afs_int32, afs_int32, prcheckentry *)
+ int ubik_PR_ChangeEntry(ubik_client *, afs_int32, afs_int32, char *, afs_int32, afs_int32)
+ int ubik_PR_IsAMemberOf(ubik_client *, afs_int32, afs_int32, afs_int32, afs_int32 *)
+ int ubik_PR_ListMax(ubik_client *, afs_int32, afs_int32 *, afs_int32 *)
+ int ubik_PR_SetMax(ubik_client *, afs_int32, afs_int32, afs_int32)
+ int ubik_PR_ListEntries(ubik_client *, afs_int32, afs_int32, afs_int32, prentries *, afs_int32 *)
+ int ubik_PR_SetFieldsEntry(ubik_client *, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32, afs_int32)
cdef import from "afs/pterror.h":
enum:
PRNOENT
-
- void initialize_PT_error_table()
+ PRTOOMANY
+
+cdef class PTEntry:
+ cdef public afs_int32 flags
+ cdef public afs_int32 id
+ cdef public afs_int32 owner
+ cdef public afs_int32 creator
+ cdef public afs_int32 ngroups
+ cdef public afs_int32 nusers
+ cdef public afs_int32 count
+ cdef public object name
+
+ def __repr__(self):
+ if self.name != '':
+ return '<PTEntry: %s>' % self.name
+ else:
+ return '<PTEntry: PTS ID %s>' % self.id
+
+cdef int _ptentry_from_c(PTEntry p_entry, prcheckentry * c_entry) except -1:
+ if p_entry is None:
+ raise TypeError
+ return -1
+
+ p_entry.flags = c_entry.flags
+ p_entry.id = c_entry.id
+ p_entry.owner = c_entry.owner
+ p_entry.creator = c_entry.creator
+ p_entry.ngroups = c_entry.ngroups
+ p_entry.nusers = c_entry.nusers
+ p_entry.count = c_entry.count
+ p_entry.name = c_entry.name
+ return 0
+
+cdef int _ptentry_to_c(prcheckentry * c_entry, PTEntry p_entry) except -1:
+ if p_entry is None:
+ raise TypeError
+ return -1
+
+ c_entry.flags = p_entry.flags
+ c_entry.id = p_entry.id
+ c_entry.owner = p_entry.owner
+ c_entry.creator = p_entry.creator
+ c_entry.ngroups = p_entry.ngroups
+ c_entry.nusers = p_entry.nusers
+ c_entry.count = p_entry.count
+ strncpy(c_entry.name, p_entry.name, sizeof(c_entry.name))
+ return 0
cdef class PTS:
+ """
+ A PTS object is essentially a handle to talk to the server in a
+ given cell.
+
+ cell defaults to None. If no argument is passed for cell, PTS
+ connects to the home cell.
+
+ sec is the security level, an integer from 0 to 3:
+ - 0: unauthenticated connection
+ - 1: try authenticated, then fall back to unauthenticated
+ - 2: fail if an authenticated connection can't be established
+ - 3: same as 2, plus encrypt all traffic to the protection
+ server
+ """
cdef ubik_client * client
def __cinit__(self, cell=None, sec=1):
- """
- Open a connection to the protection server. A PTS object is
- essentially a handle to talk to the server in a given cell.
-
- cell defaults to None. If no argument is passed for cell, PTS
- connects to the home cell.
-
- sec is the security level, an integer from 0 to 3:
- - 0: unauthenticated connection
- - 1: try authenticated, then fall back to unauthenticated
- - 2: fail if an authenticated connection can't be established
- - 3: same as 2, plus encrypt all traffic to the protection
- server
- """
cdef afs_int32 code
cdef afsconf_dir *cdir
cdef afsconf_cell info
ubik_ClientDestroy(self.client)
rx_Finalize()
+ def NameOrId(self, ident):
+ """
+ Given an identifier, convert it to a PTS ID by looking up the
+ name if it's a string, or otherwise just converting it to an
+ integer.
+ """
+ if isinstance(ident, (str, unicode)):
+ return self.NameToId(ident)
+ else:
+ return int(ident)
+
def NameToId(self, name):
"""
Converts a user or group to an AFS ID.
cdef afs_int32 code, cid
name = name[:PR_MAXNAMELEN].lower()
- oid = self.NameToId(owner)
+ oid = self.NameOrId(owner)
if id is not None:
cid = id
raise Exception("Failed to create group: %s" % afs_error_message(code))
return cid
- def Delete(self, id):
+ def Delete(self, ident):
"""
- Delete the protection database entry with the provided ID.
+ Delete the protection database entry with the provided
+ identifier.
"""
cdef afs_int32 code
+ cdef afs_int32 id = self.NameOrId(ident)
code = ubik_PR_Delete(self.client, 0, id)
if code != 0:
raise Exception("Failed to delete user: %s" % afs_error_message(code))
- def AddToGroup(self, uid, gid):
+ def AddToGroup(self, user, group):
"""
- Add the user with the given ID to the group with the given ID.
+ Add the given user to the given group.
"""
cdef afs_int32 code
+ cdef afs_int32 uid = self.NameOrId(user), gid = self.NameOrId(group)
code = ubik_PR_AddToGroup(self.client, 0, uid, gid)
if code != 0:
raise Exception("Failed to add user to group: %s" % afs_error_message(code))
- def RemoveFromGroup(self, uid, gid):
+ def RemoveFromGroup(self, user, group):
"""
- Remove the user with the given ID from the group with the given ID.
+ Remove the given user from the given group.
"""
cdef afs_int32 code
+ cdef afs_int32 uid = self.NameOrId(user), gid = self.NameOrId(group)
code = ubik_PR_RemoveFromGroup(self.client, 0, uid, gid)
if code != 0:
raise Exception("Failed to remove user from group: %s" % afs_error_message(code))
+
+ def ListMembers(self, ident):
+ """
+ Get the membership of an entity.
+
+ If id is a group, this returns the users that are in that
+ group.
+
+ If id is a user, this returns the list of groups that user is
+ on.
+
+ This returns a list of PTS IDs.
+ """
+ cdef afs_int32 code, over
+ cdef prlist alist
+ cdef int i
+ cdef object members = []
+
+ cdef afs_int32 id = self.NameOrId(ident)
+
+ alist.prlist_len = 0
+ alist.prlist_val = NULL
+
+ code = ubik_PR_ListElements(self.client, 0, id, &alist, &over)
+
+ if alist.prlist_val is not NULL:
+ for i in range(alist.prlist_len):
+ members.append(alist.prlist_val[i])
+ free(alist.prlist_val)
+
+ if over:
+ code = PRTOOMANY
+ if code != 0:
+ raise Exception("Failed to get group membership: %s" % afs_error_message(code))
+
+ return members
+
+ def ListOwned(self, owner):
+ """
+ Get all groups owned by an entity.
+ """
+ cdef afs_int32 code, over
+ cdef prlist alist
+ cdef int i
+ cdef object owned = []
+
+ cdef afs_int32 oid = self.NameOrId(owner)
+
+ alist.prlist_len = 0
+ alist.prlist_val = NULL
+
+ code = ubik_PR_ListOwned(self.client, 0, oid, &alist, &over)
+
+ if alist.prlist_val is not NULL:
+ for i in range(alist.prlist_len):
+ owned.append(alist.prlist_val[i])
+ free(alist.prlist_val)
+
+ if over:
+ code = PRTOOMANY
+ if code != 0:
+ raise Exception("Failed to get owned entities: %s" % afs_error_message(code))
+
+ return owned
+
+ def ListEntry(self, ident):
+ """
+ Load a PTEntry instance with information about the provided
+ entity.
+ """
+ cdef afs_int32 code
+ cdef prcheckentry centry
+ cdef object entry = PTEntry()
+
+ cdef afs_int32 id = self.NameOrId(ident)
+
+ code = ubik_PR_ListEntry(self.client, 0, id, ¢ry)
+ if code != 0:
+ raise Exception("Error getting entity info: %s" % afs_error_message(code))
+
+ _ptentry_from_c(entry, ¢ry)
+ return entry
+
+ def ChangeEntry(self, ident, newname=None, newid=None, newoid=None):
+ """
+ Change the name, ID, and/or owner of a PTS entity.
+
+ For any of newname, newid, and newoid which aren't specified
+ or ar None, the value isn't changed.
+ """
+ cdef afs_int32 code
+ cdef afs_int32 c_newid = 0, c_newoid = 0
+ cdef char * c_newname
+
+ cdef afs_int32 id = self.NameOrId(ident)
+
+ if newname is None:
+ newname = self.IdToName(id)
+ c_newname = newname
+ if newid is not None:
+ c_newid = newid
+ if newoid is not None:
+ c_newoid = newoid
+
+ code = ubik_PR_ChangeEntry(self.client, 0, id, c_newname, c_newoid, c_newid)
+ if code != 0:
+ raise Exception("Error changing entity info: %s" % afs_error_message(code))
+
+ def IsAMemberOf(self, user, group):
+ """
+ Return True if the given user is a member of the given group.
+ """
+ cdef afs_int32 code
+ cdef afs_int32 flag
+
+ cdef afs_int32 uid = self.NameOrId(user), gid = self.NameOrId(group)
+
+ code = ubik_PR_IsAMemberOf(self.client, 0, uid, gid, &flag)
+ if code != 0:
+ raise Exception("Error testing membership: %s" % afs_error_message(code))
+
+ return bool(flag)
+
+ def ListMax(self):
+ """
+ Return a tuple of the maximum user ID and the maximum group
+ ID currently assigned.
+ """
+ cdef afs_int32 code, uid, gid
+
+ code = ubik_PR_ListMax(self.client, 0, &uid, &gid)
+ if code != 0:
+ raise Exception("Error looking up max uid/gid: %s" % afs_error_message(code))
+
+ return (uid, gid)
+
+ def SetMaxUserId(self, id):
+ """
+ Set the maximum currently assigned user ID (the next
+ automatically assigned UID will be id + 1)
+ """
+ cdef afs_int32 code
+
+ code = ubik_PR_SetMax(self.client, 0, id, 0)
+ if code != 0:
+ raise Exception("Error setting max uid: %s" % afs_error_message(code))
+
+ def SetMaxGroupId(self, id):
+ """
+ Set the maximum currently assigned user ID (the next
+ automatically assigned UID will be id + 1)
+ """
+ cdef afs_int32 code
+
+ code = ubik_PR_SetMax(self.client, 0, id, PRGRP)
+ if code != 0:
+ raise Exception("Error setting max gid: %s" % afs_error_message(code))
+
+ def ListEntries(self, users=None, groups=None):
+ """
+ Return a list of PTEntry instances representing all entries in
+ the PRDB.
+
+ Returns just users by default, but can return just users, just
+ groups, or both.
+ """
+ cdef afs_int32 code
+ cdef afs_int32 flag = 0, startindex = 0, nentries, nextstartindex
+ cdef prentries centries
+ cdef unsigned int i
+
+ cdef object entries = []
+
+ if groups is None or users is True:
+ flag |= PRUSERS
+ if groups:
+ flag |= PRGROUPS
+
+ while startindex != -1:
+ centries.prentries_val = NULL
+ centries.prentries_len = 0
+ nextstartindex = -1
+
+ code = ubik_PR_ListEntries(self.client, 0, flag, startindex, ¢ries, &nextstartindex)
+ if centries.prentries_val is not NULL:
+ for i in range(centries.prentries_len):
+ e = PTEntry()
+ _ptentry_from_c(e, <prcheckentry *>¢ries.prentries_val[i])
+ entries.append(e)
+ free(centries.prentries_val)
+ if code != 0:
+ raise Exception("Unable to list entries: %s" % afs_error_message(code))
+
+ startindex = nextstartindex
+
+ return entries
+
+ def SetFields(self, ident, access=None, groups=None, users=None):
+ """
+ Update the fields for an entry.
+
+ Valid fields are the privacy flags (access), the group quota
+ (groups), or the "foreign user quota" (users), which doesn't
+ actually seem to do anything, but is included for
+ completeness.
+ """
+ cdef afs_int32 code
+ cdef afs_int32 mask = 0, flags = 0, nusers = 0, ngroups = 0
+
+ cdef afs_int32 id = self.NameOrId(ident)
+
+ if access is not None:
+ flags = access
+ mask |= PR_SF_ALLBITS
+ if groups is not None:
+ ngroups = groups
+ mask |= PR_SF_NGROUPS
+ if users is not None:
+ nusers = users
+ mask |= PR_SF_NGROUPS
+
+ code = ubik_PR_SetFieldsEntry(self.client, 0, id, mask, flags, ngroups, nusers, 0, 0)
+ if code != 0:
+ raise Exception("Unable to set fields: %s" % afs_error_message(code))
projects / invirt/packages/python-afs.git / blobdiff