mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-01-12 09:11:55 -06:00
2cf7c7b4ac
Bundle remote plugin interface definitions for servers which lack API schema support. These server API versions are included: * 2.49: IPA 3.1.0 on RHEL/CentOS 6.5+, * 2.114: IPA 4.1.4 on Fedora 22, * 2.156: IPA 4.2.0 on RHEL/CentOS 7.2 and IPA 4.2.4 on Fedora 23, * 2.164: IPA 4.3.1 on Fedora 23. For servers with other API versions, the closest lower API version is used. https://fedorahosted.org/freeipa/ticket/4739 Reviewed-By: David Kupka <dkupka@redhat.com>
894 lines
25 KiB
Python
894 lines
25 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__ = _("""
|
|
OTP Tokens
|
|
|
|
Manage OTP tokens.
|
|
|
|
IPA supports the use of OTP tokens for multi-factor authentication. This
|
|
code enables the management of OTP tokens.
|
|
|
|
EXAMPLES:
|
|
|
|
Add a new token:
|
|
ipa otptoken-add --type=totp --owner=jdoe --desc="My soft token"
|
|
|
|
Examine the token:
|
|
ipa otptoken-show a93db710-a31a-4639-8647-f15b2c70b78a
|
|
|
|
Change the vendor:
|
|
ipa otptoken-mod a93db710-a31a-4639-8647-f15b2c70b78a --vendor="Red Hat"
|
|
|
|
Delete a token:
|
|
ipa otptoken-del a93db710-a31a-4639-8647-f15b2c70b78a
|
|
""")
|
|
|
|
register = Registry()
|
|
|
|
|
|
@register()
|
|
class otptoken(Object):
|
|
takes_params = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
primary_key=True,
|
|
label=_(u'Unique ID'),
|
|
),
|
|
parameters.Str(
|
|
'type',
|
|
required=False,
|
|
label=_(u'Type'),
|
|
doc=_(u'Type of the token'),
|
|
),
|
|
parameters.Str(
|
|
'description',
|
|
required=False,
|
|
label=_(u'Description'),
|
|
doc=_(u'Token description (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenowner',
|
|
required=False,
|
|
label=_(u'Owner'),
|
|
doc=_(u'Assigned user of the token (default: self)'),
|
|
),
|
|
parameters.Str(
|
|
'managedby_user',
|
|
required=False,
|
|
label=_(u'Manager'),
|
|
doc=_(u'Assigned manager of the token (default: self)'),
|
|
),
|
|
parameters.Bool(
|
|
'ipatokendisabled',
|
|
required=False,
|
|
label=_(u'Disabled'),
|
|
doc=_(u'Mark the token as disabled (default: false)'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotbefore',
|
|
required=False,
|
|
label=_(u'Validity start'),
|
|
doc=_(u'First date/time the token can be used'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotafter',
|
|
required=False,
|
|
label=_(u'Validity end'),
|
|
doc=_(u'Last date/time the token can be used'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenvendor',
|
|
required=False,
|
|
label=_(u'Vendor'),
|
|
doc=_(u'Token vendor name (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenmodel',
|
|
required=False,
|
|
label=_(u'Model'),
|
|
doc=_(u'Token model (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenserial',
|
|
required=False,
|
|
label=_(u'Serial'),
|
|
doc=_(u'Token serial (informational only)'),
|
|
),
|
|
parameters.Bytes(
|
|
'ipatokenotpkey',
|
|
required=False,
|
|
label=_(u'Key'),
|
|
doc=_(u'Token secret (Base32; default: random)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenotpalgorithm',
|
|
required=False,
|
|
label=_(u'Algorithm'),
|
|
doc=_(u'Token hash algorithm'),
|
|
),
|
|
parameters.Int(
|
|
'ipatokenotpdigits',
|
|
required=False,
|
|
label=_(u'Digits'),
|
|
doc=_(u'Number of digits each token code will have'),
|
|
),
|
|
parameters.Int(
|
|
'ipatokentotpclockoffset',
|
|
required=False,
|
|
label=_(u'Clock offset'),
|
|
doc=_(u'TOTP token / FreeIPA server time difference'),
|
|
),
|
|
parameters.Int(
|
|
'ipatokentotptimestep',
|
|
required=False,
|
|
label=_(u'Clock interval'),
|
|
doc=_(u'Length of TOTP token code validity'),
|
|
),
|
|
parameters.Int(
|
|
'ipatokenhotpcounter',
|
|
required=False,
|
|
label=_(u'Counter'),
|
|
doc=_(u'Initial counter for the HOTP token'),
|
|
),
|
|
)
|
|
|
|
|
|
@register()
|
|
class otptoken_add(Method):
|
|
__doc__ = _("Add a new OTP token.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
required=False,
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
)
|
|
takes_options = (
|
|
parameters.Str(
|
|
'type',
|
|
required=False,
|
|
cli_metavar="['totp', 'hotp', 'TOTP', 'HOTP']",
|
|
label=_(u'Type'),
|
|
doc=_(u'Type of the token'),
|
|
default=u'totp',
|
|
autofill=True,
|
|
),
|
|
parameters.Str(
|
|
'description',
|
|
required=False,
|
|
cli_name='desc',
|
|
label=_(u'Description'),
|
|
doc=_(u'Token description (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenowner',
|
|
required=False,
|
|
cli_name='owner',
|
|
label=_(u'Owner'),
|
|
doc=_(u'Assigned user of the token (default: self)'),
|
|
),
|
|
parameters.Bool(
|
|
'ipatokendisabled',
|
|
required=False,
|
|
cli_name='disabled',
|
|
label=_(u'Disabled'),
|
|
doc=_(u'Mark the token as disabled (default: false)'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotbefore',
|
|
required=False,
|
|
cli_name='not_before',
|
|
label=_(u'Validity start'),
|
|
doc=_(u'First date/time the token can be used'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotafter',
|
|
required=False,
|
|
cli_name='not_after',
|
|
label=_(u'Validity end'),
|
|
doc=_(u'Last date/time the token can be used'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenvendor',
|
|
required=False,
|
|
cli_name='vendor',
|
|
label=_(u'Vendor'),
|
|
doc=_(u'Token vendor name (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenmodel',
|
|
required=False,
|
|
cli_name='model',
|
|
label=_(u'Model'),
|
|
doc=_(u'Token model (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenserial',
|
|
required=False,
|
|
cli_name='serial',
|
|
label=_(u'Serial'),
|
|
doc=_(u'Token serial (informational only)'),
|
|
),
|
|
parameters.Bytes(
|
|
'ipatokenotpkey',
|
|
required=False,
|
|
cli_name='key',
|
|
label=_(u'Key'),
|
|
doc=_(u'Token secret (Base32; default: random)'),
|
|
default_from=DefaultFrom(lambda : None),
|
|
# FIXME:
|
|
# lambda: os.urandom(KEY_LENGTH)
|
|
autofill=True,
|
|
),
|
|
parameters.Str(
|
|
'ipatokenotpalgorithm',
|
|
required=False,
|
|
cli_name='algo',
|
|
cli_metavar="['sha1', 'sha256', 'sha384', 'sha512']",
|
|
label=_(u'Algorithm'),
|
|
doc=_(u'Token hash algorithm'),
|
|
default=u'sha1',
|
|
autofill=True,
|
|
),
|
|
parameters.Int(
|
|
'ipatokenotpdigits',
|
|
required=False,
|
|
cli_name='digits',
|
|
cli_metavar="['6', '8']",
|
|
label=_(u'Digits'),
|
|
doc=_(u'Number of digits each token code will have'),
|
|
default=6,
|
|
autofill=True,
|
|
),
|
|
parameters.Int(
|
|
'ipatokentotpclockoffset',
|
|
required=False,
|
|
cli_name='offset',
|
|
label=_(u'Clock offset'),
|
|
doc=_(u'TOTP token / FreeIPA server time difference'),
|
|
default=0,
|
|
autofill=True,
|
|
),
|
|
parameters.Int(
|
|
'ipatokentotptimestep',
|
|
required=False,
|
|
cli_name='interval',
|
|
label=_(u'Clock interval'),
|
|
doc=_(u'Length of TOTP token code validity'),
|
|
default=30,
|
|
autofill=True,
|
|
),
|
|
parameters.Int(
|
|
'ipatokenhotpcounter',
|
|
required=False,
|
|
cli_name='counter',
|
|
label=_(u'Counter'),
|
|
doc=_(u'Initial counter for the HOTP token'),
|
|
default=0,
|
|
autofill=True,
|
|
),
|
|
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(
|
|
'qrcode',
|
|
required=False,
|
|
label=_(u'(deprecated)'),
|
|
exclude=('cli', 'webui'),
|
|
default=False,
|
|
autofill=True,
|
|
),
|
|
parameters.Flag(
|
|
'no_qrcode',
|
|
label=_(u'Do not display QR code'),
|
|
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 otptoken_add_managedby(Method):
|
|
__doc__ = _("Add users that can manage this token.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
)
|
|
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.Flag(
|
|
'no_members',
|
|
doc=_(u'Suppress processing of membership attributes.'),
|
|
exclude=('webui', 'cli'),
|
|
default=False,
|
|
autofill=True,
|
|
),
|
|
parameters.Str(
|
|
'user',
|
|
required=False,
|
|
multivalue=True,
|
|
cli_name='users',
|
|
label=_(u'member user'),
|
|
doc=_(u'users 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 otptoken_del(Method):
|
|
__doc__ = _("Delete an OTP token.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
multivalue=True,
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
)
|
|
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 otptoken_find(Method):
|
|
__doc__ = _("Search for OTP token.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'criteria',
|
|
required=False,
|
|
doc=_(u'A string searched in all relevant object attributes'),
|
|
),
|
|
)
|
|
takes_options = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
required=False,
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
parameters.Str(
|
|
'type',
|
|
required=False,
|
|
cli_metavar="['totp', 'hotp', 'TOTP', 'HOTP']",
|
|
label=_(u'Type'),
|
|
doc=_(u'Type of the token'),
|
|
default=u'totp',
|
|
),
|
|
parameters.Str(
|
|
'description',
|
|
required=False,
|
|
cli_name='desc',
|
|
label=_(u'Description'),
|
|
doc=_(u'Token description (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenowner',
|
|
required=False,
|
|
cli_name='owner',
|
|
label=_(u'Owner'),
|
|
doc=_(u'Assigned user of the token (default: self)'),
|
|
),
|
|
parameters.Bool(
|
|
'ipatokendisabled',
|
|
required=False,
|
|
cli_name='disabled',
|
|
label=_(u'Disabled'),
|
|
doc=_(u'Mark the token as disabled (default: false)'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotbefore',
|
|
required=False,
|
|
cli_name='not_before',
|
|
label=_(u'Validity start'),
|
|
doc=_(u'First date/time the token can be used'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotafter',
|
|
required=False,
|
|
cli_name='not_after',
|
|
label=_(u'Validity end'),
|
|
doc=_(u'Last date/time the token can be used'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenvendor',
|
|
required=False,
|
|
cli_name='vendor',
|
|
label=_(u'Vendor'),
|
|
doc=_(u'Token vendor name (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenmodel',
|
|
required=False,
|
|
cli_name='model',
|
|
label=_(u'Model'),
|
|
doc=_(u'Token model (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenserial',
|
|
required=False,
|
|
cli_name='serial',
|
|
label=_(u'Serial'),
|
|
doc=_(u'Token serial (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenotpalgorithm',
|
|
required=False,
|
|
cli_name='algo',
|
|
cli_metavar="['sha1', 'sha256', 'sha384', 'sha512']",
|
|
label=_(u'Algorithm'),
|
|
doc=_(u'Token hash algorithm'),
|
|
default=u'sha1',
|
|
),
|
|
parameters.Int(
|
|
'ipatokenotpdigits',
|
|
required=False,
|
|
cli_name='digits',
|
|
cli_metavar="['6', '8']",
|
|
label=_(u'Digits'),
|
|
doc=_(u'Number of digits each token code will have'),
|
|
default=6,
|
|
),
|
|
parameters.Int(
|
|
'ipatokentotpclockoffset',
|
|
required=False,
|
|
cli_name='offset',
|
|
label=_(u'Clock offset'),
|
|
doc=_(u'TOTP token / FreeIPA server time difference'),
|
|
default=0,
|
|
),
|
|
parameters.Int(
|
|
'ipatokentotptimestep',
|
|
required=False,
|
|
cli_name='interval',
|
|
label=_(u'Clock interval'),
|
|
doc=_(u'Length of TOTP token code validity'),
|
|
default=30,
|
|
),
|
|
parameters.Int(
|
|
'ipatokenhotpcounter',
|
|
required=False,
|
|
cli_name='counter',
|
|
label=_(u'Counter'),
|
|
doc=_(u'Initial counter for the HOTP token'),
|
|
default=0,
|
|
),
|
|
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 ("id")'),
|
|
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 otptoken_mod(Method):
|
|
__doc__ = _("Modify a OTP token.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
)
|
|
takes_options = (
|
|
parameters.Str(
|
|
'description',
|
|
required=False,
|
|
cli_name='desc',
|
|
label=_(u'Description'),
|
|
doc=_(u'Token description (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenowner',
|
|
required=False,
|
|
cli_name='owner',
|
|
label=_(u'Owner'),
|
|
doc=_(u'Assigned user of the token (default: self)'),
|
|
),
|
|
parameters.Bool(
|
|
'ipatokendisabled',
|
|
required=False,
|
|
cli_name='disabled',
|
|
label=_(u'Disabled'),
|
|
doc=_(u'Mark the token as disabled (default: false)'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotbefore',
|
|
required=False,
|
|
cli_name='not_before',
|
|
label=_(u'Validity start'),
|
|
doc=_(u'First date/time the token can be used'),
|
|
),
|
|
parameters.DateTime(
|
|
'ipatokennotafter',
|
|
required=False,
|
|
cli_name='not_after',
|
|
label=_(u'Validity end'),
|
|
doc=_(u'Last date/time the token can be used'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenvendor',
|
|
required=False,
|
|
cli_name='vendor',
|
|
label=_(u'Vendor'),
|
|
doc=_(u'Token vendor name (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenmodel',
|
|
required=False,
|
|
cli_name='model',
|
|
label=_(u'Model'),
|
|
doc=_(u'Token model (informational only)'),
|
|
),
|
|
parameters.Str(
|
|
'ipatokenserial',
|
|
required=False,
|
|
cli_name='serial',
|
|
label=_(u'Serial'),
|
|
doc=_(u'Token serial (informational only)'),
|
|
),
|
|
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,
|
|
),
|
|
parameters.Str(
|
|
'rename',
|
|
required=False,
|
|
label=_(u'Rename'),
|
|
doc=_(u'Rename the OTP token object'),
|
|
),
|
|
)
|
|
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 otptoken_remove_managedby(Method):
|
|
__doc__ = _("Remove hosts that can manage this host.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
)
|
|
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.Flag(
|
|
'no_members',
|
|
doc=_(u'Suppress processing of membership attributes.'),
|
|
exclude=('webui', 'cli'),
|
|
default=False,
|
|
autofill=True,
|
|
),
|
|
parameters.Str(
|
|
'user',
|
|
required=False,
|
|
multivalue=True,
|
|
cli_name='users',
|
|
label=_(u'member user'),
|
|
doc=_(u'users 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 otptoken_show(Method):
|
|
__doc__ = _("Display information about an OTP token.")
|
|
|
|
takes_args = (
|
|
parameters.Str(
|
|
'ipatokenuniqueid',
|
|
cli_name='id',
|
|
label=_(u'Unique ID'),
|
|
),
|
|
)
|
|
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"),
|
|
),
|
|
)
|