mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-01-12 17:21:55 -06:00
414 lines
11 KiB
Python
414 lines
11 KiB
Python
|
#
|
||
|
# 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__ = _("""
|
||
|
HBAC Services
|
||
|
|
||
|
The PAM services that HBAC can control access to. The name used here
|
||
|
must match the service name that PAM is evaluating.
|
||
|
|
||
|
EXAMPLES:
|
||
|
|
||
|
Add a new HBAC service:
|
||
|
ipa hbacsvc-add tftp
|
||
|
|
||
|
Modify an existing HBAC service:
|
||
|
ipa hbacsvc-mod --desc="TFTP service" tftp
|
||
|
|
||
|
Search for HBAC services. This example will return two results, the FTP
|
||
|
service and the newly-added tftp service:
|
||
|
ipa hbacsvc-find ftp
|
||
|
|
||
|
Delete an HBAC service:
|
||
|
ipa hbacsvc-del tftp
|
||
|
""")
|
||
|
|
||
|
register = Registry()
|
||
|
|
||
|
|
||
|
@register()
|
||
|
class hbacsvc(Object):
|
||
|
takes_params = (
|
||
|
parameters.Str(
|
||
|
'cn',
|
||
|
primary_key=True,
|
||
|
label=_(u'Service name'),
|
||
|
doc=_(u'HBAC service'),
|
||
|
),
|
||
|
parameters.Str(
|
||
|
'description',
|
||
|
required=False,
|
||
|
label=_(u'Description'),
|
||
|
doc=_(u'HBAC service description'),
|
||
|
),
|
||
|
parameters.Str(
|
||
|
'memberof_hbacsvcgroup',
|
||
|
required=False,
|
||
|
label=_(u'Member of HBAC service groups'),
|
||
|
),
|
||
|
)
|
||
|
|
||
|
|
||
|
@register()
|
||
|
class hbacsvc_add(Method):
|
||
|
__doc__ = _("Add a new HBAC service.")
|
||
|
|
||
|
takes_args = (
|
||
|
parameters.Str(
|
||
|
'cn',
|
||
|
cli_name='service',
|
||
|
label=_(u'Service name'),
|
||
|
doc=_(u'HBAC service'),
|
||
|
no_convert=True,
|
||
|
),
|
||
|
)
|
||
|
takes_options = (
|
||
|
parameters.Str(
|
||
|
'description',
|
||
|
required=False,
|
||
|
cli_name='desc',
|
||
|
label=_(u'Description'),
|
||
|
doc=_(u'HBAC service description'),
|
||
|
),
|
||
|
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,
|
||
|
),
|
||
|
parameters.Flag(
|
||
|
'no_members',
|
||
|
doc=_(u'Suppress processing of membership attributes.'),
|
||
|
exclude=('webui', 'cli'),
|
||
|
default=False,
|
||
|
autofill=True,
|
||
|
),
|
||
|
)
|
||
|
has_output = (
|
||
|
output.Output(
|
||
|
'summary',
|
||
|
(unicode, type(None)),
|
||
|
doc=_(u'User-friendly description of action performed'),
|
||
|
),
|
||
|
output.Entry(
|
||
|
'result',
|
||
|
),
|
||
|
output.PrimaryKey(
|
||
|
'value',
|
||
|
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||
|
),
|
||
|
)
|
||
|
|
||
|
|
||
|
@register()
|
||
|
class hbacsvc_del(Method):
|
||
|
__doc__ = _("Delete an existing HBAC service.")
|
||
|
|
||
|
takes_args = (
|
||
|
parameters.Str(
|
||
|
'cn',
|
||
|
multivalue=True,
|
||
|
cli_name='service',
|
||
|
label=_(u'Service name'),
|
||
|
doc=_(u'HBAC service'),
|
||
|
no_convert=True,
|
||
|
),
|
||
|
)
|
||
|
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.ListOfPrimaryKeys(
|
||
|
'value',
|
||
|
),
|
||
|
)
|
||
|
|
||
|
|
||
|
@register()
|
||
|
class hbacsvc_find(Method):
|
||
|
__doc__ = _("Search for HBAC services.")
|
||
|
|
||
|
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='service',
|
||
|
label=_(u'Service name'),
|
||
|
doc=_(u'HBAC service'),
|
||
|
no_convert=True,
|
||
|
),
|
||
|
parameters.Str(
|
||
|
'description',
|
||
|
required=False,
|
||
|
cli_name='desc',
|
||
|
label=_(u'Description'),
|
||
|
doc=_(u'HBAC service description'),
|
||
|
),
|
||
|
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(
|
||
|
'no_members',
|
||
|
doc=_(u'Suppress processing of membership attributes.'),
|
||
|
exclude=('webui', 'cli'),
|
||
|
default=False,
|
||
|
autofill=True,
|
||
|
),
|
||
|
parameters.Flag(
|
||
|
'pkey_only',
|
||
|
required=False,
|
||
|
label=_(u'Primary key only'),
|
||
|
doc=_(u'Results should contain primary key attribute only ("service")'),
|
||
|
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 hbacsvc_mod(Method):
|
||
|
__doc__ = _("Modify an HBAC service.")
|
||
|
|
||
|
takes_args = (
|
||
|
parameters.Str(
|
||
|
'cn',
|
||
|
cli_name='service',
|
||
|
label=_(u'Service name'),
|
||
|
doc=_(u'HBAC service'),
|
||
|
no_convert=True,
|
||
|
),
|
||
|
)
|
||
|
takes_options = (
|
||
|
parameters.Str(
|
||
|
'description',
|
||
|
required=False,
|
||
|
cli_name='desc',
|
||
|
label=_(u'Description'),
|
||
|
doc=_(u'HBAC service description'),
|
||
|
),
|
||
|
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.Flag(
|
||
|
'no_members',
|
||
|
doc=_(u'Suppress processing of membership attributes.'),
|
||
|
exclude=('webui', 'cli'),
|
||
|
default=False,
|
||
|
autofill=True,
|
||
|
),
|
||
|
)
|
||
|
has_output = (
|
||
|
output.Output(
|
||
|
'summary',
|
||
|
(unicode, type(None)),
|
||
|
doc=_(u'User-friendly description of action performed'),
|
||
|
),
|
||
|
output.Entry(
|
||
|
'result',
|
||
|
),
|
||
|
output.PrimaryKey(
|
||
|
'value',
|
||
|
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||
|
),
|
||
|
)
|
||
|
|
||
|
|
||
|
@register()
|
||
|
class hbacsvc_show(Method):
|
||
|
__doc__ = _("Display information about an HBAC service.")
|
||
|
|
||
|
takes_args = (
|
||
|
parameters.Str(
|
||
|
'cn',
|
||
|
cli_name='service',
|
||
|
label=_(u'Service name'),
|
||
|
doc=_(u'HBAC service'),
|
||
|
no_convert=True,
|
||
|
),
|
||
|
)
|
||
|
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,
|
||
|
),
|
||
|
parameters.Flag(
|
||
|
'no_members',
|
||
|
doc=_(u'Suppress processing of membership attributes.'),
|
||
|
exclude=('webui', 'cli'),
|
||
|
default=False,
|
||
|
autofill=True,
|
||
|
),
|
||
|
)
|
||
|
has_output = (
|
||
|
output.Output(
|
||
|
'summary',
|
||
|
(unicode, type(None)),
|
||
|
doc=_(u'User-friendly description of action performed'),
|
||
|
),
|
||
|
output.Entry(
|
||
|
'result',
|
||
|
),
|
||
|
output.PrimaryKey(
|
||
|
'value',
|
||
|
doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"),
|
||
|
),
|
||
|
)
|