Imported Upstream version 4.6.2
This commit is contained in:
Mario Fetka
682
ipaclient/remote_plugins/2_49/role.py
Normal file
682
ipaclient/remote_plugins/2_49/role.py
Normal file
@@ -0,0 +1,682 @@
|
||||
#
|
||||
# Copyright (C) 2016 FreeIPA Contributors see COPYING for license
|
||||
#
|
||||
|
||||
# pylint: disable=unused-import
|
||||
import six
|
||||
|
||||
from . import Command, Method, Object
|
||||
from ipalib import api, parameters, output
|
||||
from ipalib.parameters import DefaultFrom
|
||||
from ipalib.plugable import Registry
|
||||
from ipalib.text import _
|
||||
from ipapython.dn import DN
|
||||
from ipapython.dnsutil import DNSName
|
||||
|
||||
if six.PY3:
|
||||
unicode = str
|
||||
|
||||
__doc__ = _("""
|
||||
Roles
|
||||
|
||||
A role is used for fine-grained delegation. A permission grants the ability
|
||||
to perform given low-level tasks (add a user, modify a group, etc.). A
|
||||
privilege combines one or more permissions into a higher-level abstraction
|
||||
such as useradmin. A useradmin would be able to add, delete and modify users.
|
||||
|
||||
Privileges are assigned to Roles.
|
||||
|
||||
Users, groups, hosts and hostgroups may be members of a Role.
|
||||
|
||||
Roles can not contain other roles.
|
||||
|
||||
EXAMPLES:
|
||||
|
||||
Add a new role:
|
||||
ipa role-add --desc="Junior-level admin" junioradmin
|
||||
|
||||
Add some privileges to this role:
|
||||
ipa role-add-privilege --privileges=addusers junioradmin
|
||||
ipa role-add-privilege --privileges=change_password junioradmin
|
||||
ipa role-add-privilege --privileges=add_user_to_default_group junioradmin
|
||||
|
||||
Add a group of users to this role:
|
||||
ipa group-add --desc="User admins" useradmins
|
||||
ipa role-add-member --groups=useradmins junioradmin
|
||||
|
||||
Display information about a role:
|
||||
ipa role-show junioradmin
|
||||
|
||||
The result of this is that any users in the group 'junioradmin' can
|
||||
add users, reset passwords or add a user to the default IPA user group.
|
||||
""")
|
||||
|
||||
register = Registry()
|
||||
|
||||
|
||||
@register()
|
||||
class role(Object):
|
||||
takes_params = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
primary_key=True,
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
parameters.Str(
|
||||
'description',
|
||||
label=_(u'Description'),
|
||||
doc=_(u'A description of this role-group'),
|
||||
),
|
||||
parameters.Str(
|
||||
'member_user',
|
||||
required=False,
|
||||
label=_(u'Member users'),
|
||||
),
|
||||
parameters.Str(
|
||||
'member_group',
|
||||
required=False,
|
||||
label=_(u'Member groups'),
|
||||
),
|
||||
parameters.Str(
|
||||
'member_host',
|
||||
required=False,
|
||||
label=_(u'Member hosts'),
|
||||
),
|
||||
parameters.Str(
|
||||
'member_hostgroup',
|
||||
required=False,
|
||||
label=_(u'Member host-groups'),
|
||||
),
|
||||
parameters.Str(
|
||||
'memberof_privilege',
|
||||
required=False,
|
||||
label=_(u'Privileges'),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_add(Method):
|
||||
__doc__ = _("Add a new role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Str(
|
||||
'description',
|
||||
cli_name='desc',
|
||||
label=_(u'Description'),
|
||||
doc=_(u'A description of this role-group'),
|
||||
),
|
||||
parameters.Str(
|
||||
'setattr',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
doc=_(u'Set an attribute to a name/value pair. Format is attr=value.\nFor multi-valued attributes, the command replaces the values already present.'),
|
||||
exclude=('webui',),
|
||||
),
|
||||
parameters.Str(
|
||||
'addattr',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
doc=_(u'Add an attribute/value pair. Format is attr=value. The attribute\nmust be part of the schema.'),
|
||||
exclude=('webui',),
|
||||
),
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Output(
|
||||
'summary',
|
||||
(unicode, type(None)),
|
||||
doc=_(u'User-friendly description of action performed'),
|
||||
),
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'value',
|
||||
unicode,
|
||||
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_add_member(Method):
|
||||
__doc__ = _("Add members to a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'user',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='users',
|
||||
label=_(u'member user'),
|
||||
doc=_(u'comma-separated list of users to add'),
|
||||
alwaysask=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'group',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='groups',
|
||||
label=_(u'member group'),
|
||||
doc=_(u'comma-separated list of groups to add'),
|
||||
alwaysask=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'host',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='hosts',
|
||||
label=_(u'member host'),
|
||||
doc=_(u'comma-separated list of hosts to add'),
|
||||
alwaysask=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'hostgroup',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='hostgroups',
|
||||
label=_(u'member host group'),
|
||||
doc=_(u'comma-separated list of host groups to add'),
|
||||
alwaysask=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'failed',
|
||||
dict,
|
||||
doc=_(u'Members that could not be added'),
|
||||
),
|
||||
output.Output(
|
||||
'completed',
|
||||
int,
|
||||
doc=_(u'Number of members added'),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_add_privilege(Method):
|
||||
__doc__ = _("Add privileges to a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'privilege',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='privileges',
|
||||
label=_(u'privilege'),
|
||||
doc=_(u'comma-separated list of privileges'),
|
||||
alwaysask=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'failed',
|
||||
dict,
|
||||
doc=_(u'Members that could not be added'),
|
||||
),
|
||||
output.Output(
|
||||
'completed',
|
||||
int,
|
||||
doc=_(u'Number of privileges added'),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_del(Method):
|
||||
__doc__ = _("Delete a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
multivalue=True,
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Flag(
|
||||
'continue',
|
||||
doc=_(u"Continuous mode: Don't stop on errors."),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Output(
|
||||
'summary',
|
||||
(unicode, type(None)),
|
||||
doc=_(u'User-friendly description of action performed'),
|
||||
),
|
||||
output.Output(
|
||||
'result',
|
||||
dict,
|
||||
doc=_(u'List of deletions that failed'),
|
||||
),
|
||||
output.Output(
|
||||
'value',
|
||||
unicode,
|
||||
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_find(Method):
|
||||
__doc__ = _("Search for roles.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'criteria',
|
||||
required=False,
|
||||
doc=_(u'A string searched in all relevant object attributes'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
required=False,
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
parameters.Str(
|
||||
'description',
|
||||
required=False,
|
||||
cli_name='desc',
|
||||
label=_(u'Description'),
|
||||
doc=_(u'A description of this role-group'),
|
||||
),
|
||||
parameters.Int(
|
||||
'timelimit',
|
||||
required=False,
|
||||
label=_(u'Time Limit'),
|
||||
doc=_(u'Time limit of search in seconds'),
|
||||
),
|
||||
parameters.Int(
|
||||
'sizelimit',
|
||||
required=False,
|
||||
label=_(u'Size Limit'),
|
||||
doc=_(u'Maximum number of entries returned'),
|
||||
),
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'pkey_only',
|
||||
required=False,
|
||||
label=_(u'Primary key only'),
|
||||
doc=_(u'Results should contain primary key attribute only ("name")'),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Output(
|
||||
'summary',
|
||||
(unicode, type(None)),
|
||||
doc=_(u'User-friendly description of action performed'),
|
||||
),
|
||||
output.ListOfEntries(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'count',
|
||||
int,
|
||||
doc=_(u'Number of entries returned'),
|
||||
),
|
||||
output.Output(
|
||||
'truncated',
|
||||
bool,
|
||||
doc=_(u'True if not all results were returned'),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_mod(Method):
|
||||
__doc__ = _("Modify a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Str(
|
||||
'description',
|
||||
required=False,
|
||||
cli_name='desc',
|
||||
label=_(u'Description'),
|
||||
doc=_(u'A description of this role-group'),
|
||||
),
|
||||
parameters.Str(
|
||||
'setattr',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
doc=_(u'Set an attribute to a name/value pair. Format is attr=value.\nFor multi-valued attributes, the command replaces the values already present.'),
|
||||
exclude=('webui',),
|
||||
),
|
||||
parameters.Str(
|
||||
'addattr',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
doc=_(u'Add an attribute/value pair. Format is attr=value. The attribute\nmust be part of the schema.'),
|
||||
exclude=('webui',),
|
||||
),
|
||||
parameters.Str(
|
||||
'delattr',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
doc=_(u'Delete an attribute/value pair. The option will be evaluated\nlast, after all sets and adds.'),
|
||||
exclude=('webui',),
|
||||
),
|
||||
parameters.Flag(
|
||||
'rights',
|
||||
label=_(u'Rights'),
|
||||
doc=_(u'Display the access rights of this entry (requires --all). See ipa man page for details.'),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'rename',
|
||||
required=False,
|
||||
label=_(u'Rename'),
|
||||
doc=_(u'Rename the role object'),
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Output(
|
||||
'summary',
|
||||
(unicode, type(None)),
|
||||
doc=_(u'User-friendly description of action performed'),
|
||||
),
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'value',
|
||||
unicode,
|
||||
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_remove_member(Method):
|
||||
__doc__ = _("Remove members from a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'user',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='users',
|
||||
label=_(u'member user'),
|
||||
doc=_(u'comma-separated list of users to remove'),
|
||||
alwaysask=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'group',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='groups',
|
||||
label=_(u'member group'),
|
||||
doc=_(u'comma-separated list of groups to remove'),
|
||||
alwaysask=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'host',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='hosts',
|
||||
label=_(u'member host'),
|
||||
doc=_(u'comma-separated list of hosts to remove'),
|
||||
alwaysask=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'hostgroup',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='hostgroups',
|
||||
label=_(u'member host group'),
|
||||
doc=_(u'comma-separated list of host groups to remove'),
|
||||
alwaysask=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'failed',
|
||||
dict,
|
||||
doc=_(u'Members that could not be removed'),
|
||||
),
|
||||
output.Output(
|
||||
'completed',
|
||||
int,
|
||||
doc=_(u'Number of members removed'),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_remove_privilege(Method):
|
||||
__doc__ = _("Remove privileges from a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Str(
|
||||
'privilege',
|
||||
required=False,
|
||||
multivalue=True,
|
||||
cli_name='privileges',
|
||||
label=_(u'privilege'),
|
||||
doc=_(u'comma-separated list of privileges'),
|
||||
alwaysask=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'failed',
|
||||
dict,
|
||||
doc=_(u'Members that could not be added'),
|
||||
),
|
||||
output.Output(
|
||||
'completed',
|
||||
int,
|
||||
doc=_(u'Number of privileges removed'),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
@register()
|
||||
class role_show(Method):
|
||||
__doc__ = _("Display information about a role.")
|
||||
|
||||
takes_args = (
|
||||
parameters.Str(
|
||||
'cn',
|
||||
cli_name='name',
|
||||
label=_(u'Role name'),
|
||||
),
|
||||
)
|
||||
takes_options = (
|
||||
parameters.Flag(
|
||||
'rights',
|
||||
label=_(u'Rights'),
|
||||
doc=_(u'Display the access rights of this entry (requires --all). See ipa man page for details.'),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'all',
|
||||
doc=_(u'Retrieve and print all attributes from the server. Affects command output.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
parameters.Flag(
|
||||
'raw',
|
||||
doc=_(u'Print entries as stored on the server. Only affects output format.'),
|
||||
exclude=('webui',),
|
||||
default=False,
|
||||
autofill=True,
|
||||
),
|
||||
)
|
||||
has_output = (
|
||||
output.Output(
|
||||
'summary',
|
||||
(unicode, type(None)),
|
||||
doc=_(u'User-friendly description of action performed'),
|
||||
),
|
||||
output.Entry(
|
||||
'result',
|
||||
),
|
||||
output.Output(
|
||||
'value',
|
||||
unicode,
|
||||
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||||
),
|
||||
)
|
||||
Reference in New Issue
Block a user