ipaserver.plugins.group.group

class ipaserver.plugins.group.group(api)[source]

Bases: ipaserver.plugins.baseldap.LDAPObject

Group object.

Public Methods:

Inherited from LDAPObject

get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_dn_if_exists(*keys, **kwargs)

get_primary_key_from_dn(dn)

get_ancestor_primary_keys()

has_objectclass(classes, objectclass)

convert_attribute_members(entry_attrs, ...)

get_indirect_members(entry_attrs, attrs_list)

get_memberindirect(group_entry)

Get indirect members

get_memberofindirect(entry)

get_password_attributes(ldap, dn, entry_attrs)

Search on the entry to determine if it has a password or keytab set.

handle_not_found(*keys)

Handle NotFound exception

handle_duplicate_entry(*keys)

__json__()

Inherited from Object

backend

methods

params

primary_key

params_minus_pk

params_minus(*names)

Yield all Param whose name is not in names.

get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_params()

This method gets called by HasParam._create_param_namespace().

__json__()

Inherited from Plugin

__init__(api)

finalize()

Finalize plugin initialization.

ensure_finalized()

Finalize plugin initialization if it has not yet been finalized.

__repr__()

Return 'module_name.class_name()' representation.

Inherited from ReadOnly

__lock__()

Put this instance into a read-only state.

__islocked__()

Return True if instance is locked, otherwise False.

__setattr__(name, value)

If unlocked, set attribute named name to value.

__delattr__(name)

If unlocked, delete attribute named name.

Private Data Attributes:

Inherited from ReadOnly

_ReadOnly__locked

Private Methods:

Inherited from Object

_on_finalize()

Do custom finalization.

_Object__get_attrs(name)

Inherited from HasParam

_get_param_iterable(name[, verb])

Return an iterable of params defined by the attribute named name.

_filter_param_by_context(name[, env])

Filter params on attribute named name by environment env.

_create_param_namespace(name[, env])

Inherited from Plugin

_Plugin__name_getter()

_Plugin__full_name_getter()

_Plugin__bases_getter()

_Plugin__doc_getter()

_Plugin__summary_getter()

_on_finalize()

Do custom finalization.


property Backend
property Command
NO_CLI = False
__annotations__ = {}
__delattr__(name)

If unlocked, delete attribute named name.

If this instance is locked, an AttributeError will be raised.

Parameters

name – Name of attribute to delete.

__dict__ = mappingproxy({'__module__': 'ipaserver.plugins.group', '__doc__': '\n    Group object.\n    ', 'container_dn': ipapython.dn.DN('cn=groups,cn=accounts'), 'object_name': Gettext('group', domain='ipa', localedir=None), 'object_name_plural': Gettext('groups', domain='ipa', localedir=None), 'object_class': ['ipausergroup'], 'object_class_config': 'ipagroupobjectclasses', 'possible_objectclasses': ['posixGroup', 'mepManagedEntry', 'ipaExternalGroup'], 'permission_filter_objectclasses': ['posixgroup', 'ipausergroup'], 'permission_filter_objectclasses_string': '(|(objectclass=ipausergroup)(objectclass=posixgroup))', 'search_attributes_config': 'ipagroupsearchfields', 'default_attributes': ['cn', 'description', 'gidnumber', 'member', 'memberof', 'memberindirect', 'memberofindirect', 'ipaexternalmember', 'membermanager'], 'uuid_attribute': 'ipauniqueid', 'attribute_members': {'member': ['user', 'group', 'service', 'idoverrideuser'], 'membermanager': ['user', 'group'], 'memberof': ['group', 'netgroup', 'role', 'hbacrule', 'sudorule'], 'memberindirect': ['user', 'group', 'service', 'idoverrideuser'], 'memberofindirect': ['group', 'netgroup', 'role', 'hbacrule', 'sudorule']}, 'allow_rename': True, 'managed_permissions': {'System: Read Groups': {'replaces_global_anonymous_aci': True, 'ipapermbindruletype': 'anonymous', 'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'objectclass', 'gidnumber', 'membermanager', 'ou', 'owner', 'ipauniqueid', 'ipantsecurityidentifier', 'ipaexternalmember', 'businesscategory', 'description', 'cn', 'seealso', 'o', 'mepmanagedby'}}, 'System: Read Group Membership': {'replaces_global_anonymous_aci': True, 'ipapermbindruletype': 'all', 'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'memberuid', 'memberof', 'memberhost', 'member', 'memberuser'}}, 'System: Read External Group Membership': {'ipapermbindruletype': 'all', 'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'ipaexternalmember'}}, 'System: Add Groups': {'ipapermright': {'add'}, 'replaces': ['(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Add Groups";allow (add) groupdn = "ldap:///cn=Add Groups,cn=permissions,cn=pbac,$SUFFIX";)'], 'default_privileges': {'Group Administrators'}}, 'System: Modify Group Membership': {'ipapermright': {'write'}, 'ipapermtargetfilter': ['(objectclass=ipausergroup)', '(!(cn=admins))'], 'ipapermdefaultattr': {'member'}, 'replaces': ['(targetattr = "member")(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Modify Group membership";allow (write) groupdn = "ldap:///cn=Modify Group membership,cn=permissions,cn=pbac,$SUFFIX";)', '(targetfilter = "(!(cn=admins))")(targetattr = "member")(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Modify Group membership";allow (write) groupdn = "ldap:///cn=Modify Group membership,cn=permissions,cn=pbac,$SUFFIX";)'], 'default_privileges': {'Group Administrators', 'Modify Group membership'}}, 'System: Modify External Group Membership': {'ipapermright': {'write'}, 'ipapermtargetfilter': ['(objectclass=ipaexternalgroup)'], 'ipapermdefaultattr': {'ipaexternalmember'}, 'default_privileges': {'Group Administrators', 'Modify Group membership'}}, 'System: Modify Groups': {'ipapermright': {'write'}, 'ipapermtargetfilter': ['(|(objectclass=ipausergroup)(objectclass=posixgroup))', '(!(cn=admins))'], 'ipapermdefaultattr': {'objectclass', 'gidnumber', 'membermanager', 'description', 'cn', 'ipauniqueid', 'mepmanagedby'}, 'replaces': ['(targetattr = "cn || description || gidnumber || objectclass || mepmanagedby || ipauniqueid")(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Modify Groups";allow (write) groupdn = "ldap:///cn=Modify Groups,cn=permissions,cn=pbac,$SUFFIX";)'], 'default_privileges': {'Group Administrators'}}, 'System: Remove Groups': {'ipapermright': {'delete'}, 'ipapermtargetfilter': ['(|(objectclass=ipausergroup)(objectclass=posixgroup))', '(!(|(cn=admins)(cn=trust admins)(cn=default smb group)))'], 'replaces': ['(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Remove Groups";allow (delete) groupdn = "ldap:///cn=Remove Groups,cn=permissions,cn=pbac,$SUFFIX";)'], 'default_privileges': {'Group Administrators'}}, 'System: Read Group Compat Tree': {'non_object': True, 'ipapermbindruletype': 'anonymous', 'ipapermlocation': ipapython.dn.DN('dc=ipa,dc=example'), 'ipapermtarget': ipapython.dn.DN('cn=groups,cn=compat,dc=ipa,dc=example'), 'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'objectclass', 'memberuid', 'gidnumber', 'cn'}}, 'System: Read Group Views Compat Tree': {'non_object': True, 'ipapermbindruletype': 'anonymous', 'ipapermlocation': ipapython.dn.DN('dc=ipa,dc=example'), 'ipapermtarget': ipapython.dn.DN('cn=groups,cn=*,cn=views,cn=compat,dc=ipa,dc=example'), 'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'objectclass', 'memberuid', 'gidnumber', 'cn'}}}, 'label': Gettext('User Groups', domain='ipa', localedir=None), 'label_singular': Gettext('User Group', domain='ipa', localedir=None), 'takes_params': (Str('cn', cli_name='group_name', label=Gettext('Group name', domain='ipa', localedir=None), maxlength=255, normalizer=<lambda>, pattern=u'(?!^[0-9]+$)^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*[a-zA-Z0-9_.$-]?$', pattern_errmsg=u'may only include letters, numbers, _, -, . and $', primary_key=True), Str('description?', cli_name='desc', doc=Gettext('Group description', domain='ipa', localedir=None), label=Gettext('Description', domain='ipa', localedir=None)), Int('gidnumber?', cli_name='gid', doc=Gettext('GID (use this option to set it manually)', domain='ipa', localedir=None), label=Gettext('GID', domain='ipa', localedir=None), minvalue=1), Str('ipaexternalmember*', cli_name='external', doc=Gettext('Members of a trusted domain in DOM\\name or name@domain form', domain='ipa', localedir=None), flags=[u'no_create', u'no_search', u'no_update'], label=Gettext('External member', domain='ipa', localedir=None))), '__annotations__': {}})
__init__(api)
__islocked__()

Return True if instance is locked, otherwise False.

__json__()
__lock__()

Put this instance into a read-only state.

After the instance has been locked, attempting to set or delete an attribute will raise an AttributeError.

__module__ = 'ipaserver.plugins.group'
__repr__()

Return ‘module_name.class_name()’ representation.

This representation could be used to instantiate this Plugin instance given the appropriate environment.

__setattr__(name, value)

If unlocked, set attribute named name to value.

If this instance is locked, an AttributeError will be raised.

Parameters
  • name – Name of attribute to set.

  • value – Value to assign to attribute.

__weakref__

list of weak references to the object (if defined)

_create_param_namespace(name, env=None)
_filter_param_by_context(name, env=None)

Filter params on attribute named name by environment env.

For example:

>>> from ipalib.config import Env
>>> class Example(HasParam):
...
...     takes_args = (
...         Str('foo_only', include=['foo']),
...         Str('not_bar', exclude=['bar']),
...         'both',
...     )
...
...     def get_args(self):
...         return self._get_param_iterable('args')
...
...
>>> eg = Example()
>>> foo = Env(context='foo')
>>> bar = Env(context='bar')
>>> another = Env(context='another')
>>> (foo.context, bar.context, another.context)
(u'foo', u'bar', u'another')
>>> list(eg._filter_param_by_context('args', foo))
[Str('foo_only', include=['foo']), Str('not_bar', exclude=['bar']), Str('both')]
>>> list(eg._filter_param_by_context('args', bar))
[Str('both')]
>>> list(eg._filter_param_by_context('args', another))
[Str('not_bar', exclude=['bar']), Str('both')]
_get_param_iterable(name, verb='takes')

Return an iterable of params defined by the attribute named name.

A sequence of params can be defined one of three ways: as a tuple; as a callable that returns an iterable; or as a param spec (a Param or str instance). This method returns a uniform iterable regardless of how the param sequence was defined.

For example, when defined with a tuple:

>>> class ByTuple(HasParam):
...     takes_args = (Param('foo'), Param('bar'))
...
>>> by_tuple = ByTuple()
>>> list(by_tuple._get_param_iterable('args'))
[Param('foo'), Param('bar')]

Or you can define your param sequence with a callable when you need to reference attributes on your plugin instance (for validation rules, etc.). For example:

>>> class ByCallable(HasParam):
...     def takes_args(self):
...         yield Param('foo', self.validate_foo)
...         yield Param('bar', self.validate_bar)
...
...     def validate_foo(self, _, value, **kw):
...         if value != 'Foo':
...             return _("must be 'Foo'")
...
...     def validate_bar(self, _, value, **kw):
...         if value != 'Bar':
...             return _("must be 'Bar'")
...
>>> by_callable = ByCallable()
>>> list(by_callable._get_param_iterable('args'))
[Param('foo', validate_foo), Param('bar', validate_bar)]

Lastly, as a convenience for when a param sequence contains a single param, your defining attribute may a param spec (either a Param or an str instance). For example:

>>> class BySpec(HasParam):
...     takes_args = Param('foo')
...     takes_options = 'bar?'
...
>>> by_spec = BySpec()
>>> list(by_spec._get_param_iterable('args'))
[Param('foo')]
>>> list(by_spec._get_param_iterable('options'))
['bar?']

For information on how an str param spec is interpreted, see the create_param() and parse_param_spec() functions in the ipalib.parameters module.

Also see HasParam._filter_param_by_context().

_on_finalize()

Do custom finalization.

This method is called from finalize(). Subclasses can override this method in order to add custom finalization.

allow_rename = True
already_exists_msg = Gettext('%(oname)s with name "%(pkey)s" already exists', domain='ipa', localedir=None)
property api

Return API instance passed to __init__().

attribute_members = {'member': ['user', 'group', 'service', 'idoverrideuser'], 'memberindirect': ['user', 'group', 'service', 'idoverrideuser'], 'membermanager': ['user', 'group'], 'memberof': ['group', 'netgroup', 'role', 'hbacrule', 'sudorule'], 'memberofindirect': ['group', 'netgroup', 'role', 'hbacrule', 'sudorule']}
backend = None
backend_name = 'ldap2'
bases = (<class 'ipaserver.plugins.baseldap.LDAPObject'>,)
bindable = False
container_dn = ipapython.dn.DN('cn=groups,cn=accounts')
container_not_found_msg = Gettext('container entry (%(container)s) not found', domain='ipa', localedir=None)
property context
convert_attribute_members(entry_attrs, *keys, **options)
default_attributes = ['cn', 'description', 'gidnumber', 'member', 'memberof', 'memberindirect', 'memberofindirect', 'ipaexternalmember', 'membermanager']
disallow_object_classes = []
doc = '\n    Group object.\n    '
ensure_finalized()

Finalize plugin initialization if it has not yet been finalized.

property env
finalize()

Finalize plugin initialization.

This method calls _on_finalize() and locks the plugin object.

Subclasses should not override this method. Custom finalization is done in _on_finalize().

class finalize_attr(name, value=None)

Bases: object

Create a stub object for plugin attribute that isn’t set until the finalization of the plugin initialization.

When the stub object is accessed, it calls ensure_finalized() to make sure the plugin initialization is finalized. The stub object is expected to be replaced with the actual attribute value during the finalization (preferably in _on_finalize()), otherwise an AttributeError is raised.

This is used to implement on-demand finalization of plugin initialization.

__annotations__ = {}
__get__(obj, cls)
__init__(name, value=None)
__module__ = 'ipalib.plugable'
__slots__ = ('name', 'value')
name
value
full_name = 'group/1'
get_ancestor_primary_keys()
get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_dn_if_exists(*keys, **kwargs)
get_indirect_members(entry_attrs, attrs_list)
get_memberindirect(group_entry)

Get indirect members

get_memberofindirect(entry)
get_params()

This method gets called by HasParam._create_param_namespace().

get_password_attributes(ldap, dn, entry_attrs)

Search on the entry to determine if it has a password or keytab set.

A tuple is used to determine which attribute is set in entry_attrs. The value is set to True/False whether a given password type is set.

get_primary_key_from_dn(dn)
handle_duplicate_entry(*keys)
handle_not_found(*keys)

Handle NotFound exception

Must raise errors.NotFound again.

has_objectclass(classes, objectclass)
hidden_attributes = ['objectclass', 'aci']
json_friendly_attributes = ('parent_object', 'container_dn', 'object_name', 'object_name_plural', 'object_class', 'object_class_config', 'default_attributes', 'label', 'label_singular', 'hidden_attributes', 'uuid_attribute', 'attribute_members', 'name', 'takes_params', 'rdn_attribute', 'bindable', 'relationships')
label = Gettext('User Groups', domain='ipa', localedir=None)
label_singular = Gettext('User Group', domain='ipa', localedir=None)
limit_object_classes = []
managed_permissions = {'System: Add Groups': {'default_privileges': {'Group Administrators'}, 'ipapermright': {'add'}, 'replaces': ['(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Add Groups";allow (add) groupdn = "ldap:///cn=Add Groups,cn=permissions,cn=pbac,$SUFFIX";)']}, 'System: Modify External Group Membership': {'default_privileges': {'Group Administrators', 'Modify Group membership'}, 'ipapermdefaultattr': {'ipaexternalmember'}, 'ipapermright': {'write'}, 'ipapermtargetfilter': ['(objectclass=ipaexternalgroup)']}, 'System: Modify Group Membership': {'default_privileges': {'Group Administrators', 'Modify Group membership'}, 'ipapermdefaultattr': {'member'}, 'ipapermright': {'write'}, 'ipapermtargetfilter': ['(objectclass=ipausergroup)', '(!(cn=admins))'], 'replaces': ['(targetattr = "member")(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Modify Group membership";allow (write) groupdn = "ldap:///cn=Modify Group membership,cn=permissions,cn=pbac,$SUFFIX";)', '(targetfilter = "(!(cn=admins))")(targetattr = "member")(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Modify Group membership";allow (write) groupdn = "ldap:///cn=Modify Group membership,cn=permissions,cn=pbac,$SUFFIX";)']}, 'System: Modify Groups': {'default_privileges': {'Group Administrators'}, 'ipapermdefaultattr': {'cn', 'description', 'gidnumber', 'ipauniqueid', 'membermanager', 'mepmanagedby', 'objectclass'}, 'ipapermright': {'write'}, 'ipapermtargetfilter': ['(|(objectclass=ipausergroup)(objectclass=posixgroup))', '(!(cn=admins))'], 'replaces': ['(targetattr = "cn || description || gidnumber || objectclass || mepmanagedby || ipauniqueid")(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Modify Groups";allow (write) groupdn = "ldap:///cn=Modify Groups,cn=permissions,cn=pbac,$SUFFIX";)']}, 'System: Read External Group Membership': {'ipapermbindruletype': 'all', 'ipapermdefaultattr': {'ipaexternalmember'}, 'ipapermright': {'compare', 'read', 'search'}}, 'System: Read Group Compat Tree': {'ipapermbindruletype': 'anonymous', 'ipapermdefaultattr': {'cn', 'gidnumber', 'memberuid', 'objectclass'}, 'ipapermlocation': ipapython.dn.DN('dc=ipa,dc=example'), 'ipapermright': {'compare', 'read', 'search'}, 'ipapermtarget': ipapython.dn.DN('cn=groups,cn=compat,dc=ipa,dc=example'), 'non_object': True}, 'System: Read Group Membership': {'ipapermbindruletype': 'all', 'ipapermdefaultattr': {'member', 'memberhost', 'memberof', 'memberuid', 'memberuser'}, 'ipapermright': {'compare', 'read', 'search'}, 'replaces_global_anonymous_aci': True}, 'System: Read Group Views Compat Tree': {'ipapermbindruletype': 'anonymous', 'ipapermdefaultattr': {'cn', 'gidnumber', 'memberuid', 'objectclass'}, 'ipapermlocation': ipapython.dn.DN('dc=ipa,dc=example'), 'ipapermright': {'compare', 'read', 'search'}, 'ipapermtarget': ipapython.dn.DN('cn=groups,cn=*,cn=views,cn=compat,dc=ipa,dc=example'), 'non_object': True}, 'System: Read Groups': {'ipapermbindruletype': 'anonymous', 'ipapermdefaultattr': {'businesscategory', 'cn', 'description', 'gidnumber', 'ipaexternalmember', 'ipantsecurityidentifier', 'ipauniqueid', 'membermanager', 'mepmanagedby', 'o', 'objectclass', 'ou', 'owner', 'seealso'}, 'ipapermright': {'compare', 'read', 'search'}, 'replaces_global_anonymous_aci': True}, 'System: Remove Groups': {'default_privileges': {'Group Administrators'}, 'ipapermright': {'delete'}, 'ipapermtargetfilter': ['(|(objectclass=ipausergroup)(objectclass=posixgroup))', '(!(|(cn=admins)(cn=trust admins)(cn=default smb group)))'], 'replaces': ['(target = "ldap:///cn=*,cn=groups,cn=accounts,$SUFFIX")(version 3.0;acl "permission:Remove Groups";allow (delete) groupdn = "ldap:///cn=Remove Groups,cn=permissions,cn=pbac,$SUFFIX";)']}}
methods = None
name = 'group'
object_class = ['ipausergroup']
object_class_config = 'ipagroupobjectclasses'
object_name = Gettext('group', domain='ipa', localedir=None)
object_name_plural = Gettext('groups', domain='ipa', localedir=None)
object_not_found_msg = Gettext('%(pkey)s: %(oname)s not found', domain='ipa', localedir=None)
params = None
params_minus(*names)

Yield all Param whose name is not in names.

params_minus_pk = None
parent_not_found_msg = Gettext('%(parent)s: %(oname)s not found', domain='ipa', localedir=None)
parent_object = ''
password_attributes = []
permission_filter_objectclasses = ['posixgroup', 'ipausergroup']
permission_filter_objectclasses_string = '(|(objectclass=ipausergroup)(objectclass=posixgroup))'
possible_objectclasses = ['posixGroup', 'mepManagedEntry', 'ipaExternalGroup']
primary_key = None
rdn_attribute = ''
relationships = {'member': ('Member', '', 'no_'), 'memberindirect': ('Indirect Member', None, 'no_indirect_'), 'membermanager': ('Group membership managed by', 'membermanager_', 'not_membermanager_'), 'memberof': ('Member Of', 'in_', 'not_in_'), 'memberofindirect': ('Indirect Member Of', None, 'not_in_indirect_')}
search_attributes = []
search_attributes_config = 'ipagroupsearchfields'
search_display_attributes = []
summary = 'Group object.'
takes_params = (Str('cn', cli_name='group_name', label=Gettext('Group name', domain='ipa', localedir=None), maxlength=255, normalizer=<lambda>, pattern=u'(?!^[0-9]+$)^[a-zA-Z0-9_.][a-zA-Z0-9_.-]*[a-zA-Z0-9_.$-]?$', pattern_errmsg=u'may only include letters, numbers, _, -, . and $', primary_key=True), Str('description?', cli_name='desc', doc=Gettext('Group description', domain='ipa', localedir=None), label=Gettext('Description', domain='ipa', localedir=None)), Int('gidnumber?', cli_name='gid', doc=Gettext('GID (use this option to set it manually)', domain='ipa', localedir=None), label=Gettext('GID', domain='ipa', localedir=None), minvalue=1), Str('ipaexternalmember*', cli_name='external', doc=Gettext('Members of a trusted domain in DOM\\name or name@domain form', domain='ipa', localedir=None), flags=[u'no_create', u'no_search', u'no_update'], label=Gettext('External member', domain='ipa', localedir=None)))
uuid_attribute = 'ipauniqueid'
version = '1'