diff options
author | Nathaniel McCallum <npmccallum@redhat.com> | 2014-11-06 15:19:01 -0500 |
---|---|---|
committer | Petr Vobornik <pvoborni@redhat.com> | 2014-11-13 15:32:52 +0100 |
commit | 93ff9ec087854012d6ccb521d17981f4d25e5c23 (patch) | |
tree | 75b53bbd3097edfbb394dd73e5291a5b3a65ee3b /ipalib | |
parent | b032debd233c70541e52d3ee677cb82f9840b291 (diff) | |
download | freeipa-93ff9ec087854012d6ccb521d17981f4d25e5c23.tar.gz freeipa-93ff9ec087854012d6ccb521d17981f4d25e5c23.tar.xz freeipa-93ff9ec087854012d6ccb521d17981f4d25e5c23.zip |
Improve otptoken help messages
https://fedorahosted.org/freeipa/ticket/4689
Reviewed-By: Petr Vobornik <pvoborni@redhat.com>
Diffstat (limited to 'ipalib')
-rw-r--r-- | ipalib/plugins/otptoken.py | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/ipalib/plugins/otptoken.py b/ipalib/plugins/otptoken.py index 2b5f1c5fb..77366bafe 100644 --- a/ipalib/plugins/otptoken.py +++ b/ipalib/plugins/otptoken.py @@ -153,6 +153,7 @@ class otptoken(LDAPObject): ), StrEnum('type?', label=_('Type'), + doc=_('Type of the token'), default=u'totp', autofill=True, values=tuple(TOKEN_TYPES.keys() + [x.upper() for x in TOKEN_TYPES]), @@ -161,42 +162,52 @@ class otptoken(LDAPObject): Str('description?', cli_name='desc', label=_('Description'), + doc=_('Token description (informational only)'), ), Str('ipatokenowner?', cli_name='owner', label=_('Owner'), + doc=_('Assigned user of the token (default: self)'), ), Str('managedby_user?', label=_('Manager'), + doc=_('Assigned manager of the token (default: self)'), flags=['no_create', 'no_update', 'no_search'], ), Bool('ipatokendisabled?', cli_name='disabled', - label=_('Disabled state') + label=_('Disabled'), + doc=_('Mark the token as disabled (default: false)') ), DateTime('ipatokennotbefore?', cli_name='not_before', label=_('Validity start'), + doc=_('First date/time the token can be used'), ), DateTime('ipatokennotafter?', cli_name='not_after', label=_('Validity end'), + doc=_('Last date/time the token can be used'), ), Str('ipatokenvendor?', cli_name='vendor', label=_('Vendor'), + doc=_('Token vendor name (informational only)'), ), Str('ipatokenmodel?', cli_name='model', label=_('Model'), + doc=_('Token model (informational only)'), ), Str('ipatokenserial?', cli_name='serial', label=_('Serial'), + doc=_('Token serial (informational only)'), ), OTPTokenKey('ipatokenotpkey?', cli_name='key', label=_('Key'), + doc=_('Token secret (Base32; default: random)'), default_from=lambda: os.urandom(KEY_LENGTH), autofill=True, flags=('no_display', 'no_update', 'no_search'), @@ -204,6 +215,7 @@ class otptoken(LDAPObject): StrEnum('ipatokenotpalgorithm?', cli_name='algo', label=_('Algorithm'), + doc=_('Token hash algorithm'), default=u'sha1', autofill=True, flags=('no_update'), @@ -212,6 +224,7 @@ class otptoken(LDAPObject): IntEnum('ipatokenotpdigits?', cli_name='digits', label=_('Digits'), + doc=_('Number of digits each token code will have'), values=(6, 8), default=6, autofill=True, @@ -220,6 +233,7 @@ class otptoken(LDAPObject): Int('ipatokentotpclockoffset?', cli_name='offset', label=_('Clock offset'), + doc=_('TOTP token / FreeIPA server time difference'), default=0, autofill=True, flags=('no_update'), @@ -227,6 +241,7 @@ class otptoken(LDAPObject): Int('ipatokentotptimestep?', cli_name='interval', label=_('Clock interval'), + doc=_('Length of TOTP token code validity'), default=30, autofill=True, minvalue=5, @@ -235,6 +250,7 @@ class otptoken(LDAPObject): Int('ipatokenhotpcounter?', cli_name='counter', label=_('Counter'), + doc=_('Initial counter for the HOTP token'), default=0, autofill=True, minvalue=0, |