diff options
Diffstat (limited to 'ipaclient/remote_plugins/2_164/otpconfig.py')
| -rw-r--r-- | ipaclient/remote_plugins/2_164/otpconfig.py | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/ipaclient/remote_plugins/2_164/otpconfig.py b/ipaclient/remote_plugins/2_164/otpconfig.py new file mode 100644 index 000000000..1aceb903e --- /dev/null +++ b/ipaclient/remote_plugins/2_164/otpconfig.py @@ -0,0 +1,206 @@ +# +# 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 configuration + +Manage the default values that IPA uses for OTP tokens. + +EXAMPLES: + + Show basic OTP configuration: + ipa otpconfig-show + + Show all OTP configuration options: + ipa otpconfig-show --all + + Change maximum TOTP authentication window to 10 minutes: + ipa otpconfig-mod --totp-auth-window=600 + + Change maximum TOTP synchronization window to 12 hours: + ipa otpconfig-mod --totp-sync-window=43200 + + Change maximum HOTP authentication window to 5: + ipa hotpconfig-mod --hotp-auth-window=5 + + Change maximum HOTP synchronization window to 50: + ipa hotpconfig-mod --hotp-sync-window=50 +""") + +register = Registry() + + +@register() +class otpconfig(Object): + takes_params = ( + parameters.Int( + 'ipatokentotpauthwindow', + label=_(u'TOTP authentication Window'), + doc=_(u'TOTP authentication time variance (seconds)'), + ), + parameters.Int( + 'ipatokentotpsyncwindow', + label=_(u'TOTP Synchronization Window'), + doc=_(u'TOTP synchronization time variance (seconds)'), + ), + parameters.Int( + 'ipatokenhotpauthwindow', + label=_(u'HOTP Authentication Window'), + doc=_(u'HOTP authentication skip-ahead'), + ), + parameters.Int( + 'ipatokenhotpsyncwindow', + label=_(u'HOTP Synchronization Window'), + doc=_(u'HOTP synchronization skip-ahead'), + ), + ) + + +@register() +class otpconfig_mod(Method): + __doc__ = _("Modify OTP configuration options.") + + takes_options = ( + parameters.Int( + 'ipatokentotpauthwindow', + required=False, + cli_name='totp_auth_window', + label=_(u'TOTP authentication Window'), + doc=_(u'TOTP authentication time variance (seconds)'), + ), + parameters.Int( + 'ipatokentotpsyncwindow', + required=False, + cli_name='totp_sync_window', + label=_(u'TOTP Synchronization Window'), + doc=_(u'TOTP synchronization time variance (seconds)'), + ), + parameters.Int( + 'ipatokenhotpauthwindow', + required=False, + cli_name='hotp_auth_window', + label=_(u'HOTP Authentication Window'), + doc=_(u'HOTP authentication skip-ahead'), + ), + parameters.Int( + 'ipatokenhotpsyncwindow', + required=False, + cli_name='hotp_sync_window', + label=_(u'HOTP Synchronization Window'), + doc=_(u'HOTP synchronization skip-ahead'), + ), + 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, + ), + ) + 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 otpconfig_show(Method): + __doc__ = _("Show the current OTP configuration.") + + 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.PrimaryKey( + 'value', + doc=_(u"The primary_key value of the entry, e.g. 'jdoe' for a user"), + ), + ) |