ipaserver.plugins.otptoken.otptoken

class ipaserver.plugins.otptoken.otptoken(api)[source]

Bases: ipaserver.plugins.baseldap.LDAPObject

OTP Token object.

Public Methods:

Inherited from LDAPObject

get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_dn_if_exists(*keys, **kwargs)

get_primary_key_from_dn(dn)

get_ancestor_primary_keys()

has_objectclass(classes, objectclass)

convert_attribute_members(entry_attrs, ...)

get_indirect_members(entry_attrs, attrs_list)

get_memberindirect(group_entry)

Get indirect members

get_memberofindirect(entry)

get_password_attributes(ldap, dn, entry_attrs)

Search on the entry to determine if it has a password or keytab set.

handle_not_found(*keys)

Handle NotFound exception

handle_duplicate_entry(*keys)

__json__()

Inherited from Object

backend

methods

params

primary_key

params_minus_pk

params_minus(*names)

Yield all Param whose name is not in names.

get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_params()

This method gets called by HasParam._create_param_namespace().

__json__()

Inherited from Plugin

__init__(api)

finalize()

Finalize plugin initialization.

ensure_finalized()

Finalize plugin initialization if it has not yet been finalized.

__repr__()

Return 'module_name.class_name()' representation.

Inherited from ReadOnly

__lock__()

Put this instance into a read-only state.

__islocked__()

Return True if instance is locked, otherwise False.

__setattr__(name, value)

If unlocked, set attribute named name to value.

__delattr__(name)

If unlocked, delete attribute named name.

Private Data Attributes:

Inherited from ReadOnly

_ReadOnly__locked

Private Methods:

Inherited from Object

_on_finalize()

Do custom finalization.

_Object__get_attrs(name)

Inherited from HasParam

_get_param_iterable(name[, verb])

Return an iterable of params defined by the attribute named name.

_filter_param_by_context(name[, env])

Filter params on attribute named name by environment env.

_create_param_namespace(name[, env])

Inherited from Plugin

_Plugin__name_getter()

_Plugin__full_name_getter()

_Plugin__bases_getter()

_Plugin__doc_getter()

_Plugin__summary_getter()

_on_finalize()

Do custom finalization.


property Backend
property Command
NO_CLI = False
__annotations__ = {}
__delattr__(name)

If unlocked, delete attribute named name.

If this instance is locked, an AttributeError will be raised.

Parameters

name – Name of attribute to delete.

__dict__ = mappingproxy({'__module__': 'ipaserver.plugins.otptoken', '__doc__': '\n    OTP Token object.\n    ', 'container_dn': ipapython.dn.DN('cn=otp'), 'object_name': Gettext('OTP token', domain='ipa', localedir=None), 'object_name_plural': Gettext('OTP tokens', domain='ipa', localedir=None), 'object_class': ['ipatoken'], 'possible_objectclasses': ['ipatokentotp', 'ipatokenhotp'], 'default_attributes': ['ipatokenuniqueid', 'description', 'ipatokenowner', 'ipatokendisabled', 'ipatokennotbefore', 'ipatokennotafter', 'ipatokenvendor', 'ipatokenmodel', 'ipatokenserial', 'managedby'], 'attribute_members': {'managedby': ['user']}, 'relationships': {'managedby': ('Managed by', 'man_by_', 'not_man_by_')}, 'allow_rename': True, 'label': Gettext('OTP Tokens', domain='ipa', localedir=None), 'label_singular': Gettext('OTP Token', domain='ipa', localedir=None), 'takes_params': (Str('ipatokenuniqueid', cli_name='id', flags=[u'optional_create'], label=Gettext('Unique ID', domain='ipa', localedir=None), primary_key=True), StrEnum('type?', autofill=True, cli_metavar=u"['totp', 'hotp', 'TOTP', 'HOTP']", default=u'totp', doc=Gettext('Type of the token', domain='ipa', localedir=None), flags=[u'no_update', u'virtual_attribute'], label=Gettext('Type', domain='ipa', localedir=None), values=[u'totp', u'hotp', u'TOTP', u'HOTP']), Str('description?', cli_name='desc', doc=Gettext('Token description (informational only)', domain='ipa', localedir=None), label=Gettext('Description', domain='ipa', localedir=None)), Str('ipatokenowner?', cli_name='owner', doc=Gettext('Assigned user of the token (default: self)', domain='ipa', localedir=None), label=Gettext('Owner', domain='ipa', localedir=None)), Str('managedby_user?', doc=Gettext('Assigned manager of the token (default: self)', domain='ipa', localedir=None), flags=[u'no_create', u'no_search', u'no_update'], label=Gettext('Manager', domain='ipa', localedir=None)), Bool('ipatokendisabled?', cli_name='disabled', doc=Gettext('Mark the token as disabled (default: false)', domain='ipa', localedir=None), label=Gettext('Disabled', domain='ipa', localedir=None)), DateTime('ipatokennotbefore?', cli_name='not_before', doc=Gettext('First date/time the token can be used', domain='ipa', localedir=None), label=Gettext('Validity start', domain='ipa', localedir=None)), DateTime('ipatokennotafter?', cli_name='not_after', doc=Gettext('Last date/time the token can be used', domain='ipa', localedir=None), label=Gettext('Validity end', domain='ipa', localedir=None)), Str('ipatokenvendor?', cli_name='vendor', doc=Gettext('Token vendor name (informational only)', domain='ipa', localedir=None), label=Gettext('Vendor', domain='ipa', localedir=None)), Str('ipatokenmodel?', cli_name='model', doc=Gettext('Token model (informational only)', domain='ipa', localedir=None), label=Gettext('Model', domain='ipa', localedir=None)), Str('ipatokenserial?', cli_name='serial', doc=Gettext('Token serial (informational only)', domain='ipa', localedir=None), label=Gettext('Serial', domain='ipa', localedir=None)), OTPTokenKey('ipatokenotpkey?', autofill=True, cli_name='key', default_from=DefaultFrom(), doc=Gettext('Token secret (Base32; default: random)', domain='ipa', localedir=None), flags=[u'no_update', u'no_search', u'no_display'], label=Gettext('Key', domain='ipa', localedir=None), normalizer=<lambda>), StrEnum('ipatokenotpalgorithm?', autofill=True, cli_metavar=u"['sha1', 'sha256', 'sha384', 'sha512']", cli_name='algo', default=u'sha1', doc=Gettext('Token hash algorithm', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Algorithm', domain='ipa', localedir=None), values=[u'sha1', u'sha256', u'sha384', u'sha512']), IntEnum('ipatokenotpdigits?', autofill=True, cli_metavar=u"['6', '8']", cli_name='digits', default=6, doc=Gettext('Number of digits each token code will have', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Digits', domain='ipa', localedir=None), values=[6, 8]), Int('ipatokentotpclockoffset?', autofill=True, cli_name='offset', default=0, doc=Gettext('TOTP token / IPA server time difference', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Clock offset', domain='ipa', localedir=None)), Int('ipatokentotptimestep?', autofill=True, cli_name='interval', default=30, doc=Gettext('Length of TOTP token code validity', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Clock interval', domain='ipa', localedir=None), minvalue=5), Int('ipatokenhotpcounter?', autofill=True, cli_name='counter', default=0, doc=Gettext('Initial counter for the HOTP token', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Counter', domain='ipa', localedir=None), minvalue=0), Str('uri?', flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('URI', domain='ipa', localedir=None))), '__annotations__': {}})
__init__(api)
__islocked__()

Return True if instance is locked, otherwise False.

__json__()
__lock__()

Put this instance into a read-only state.

After the instance has been locked, attempting to set or delete an attribute will raise an AttributeError.

__module__ = 'ipaserver.plugins.otptoken'
__repr__()

Return ‘module_name.class_name()’ representation.

This representation could be used to instantiate this Plugin instance given the appropriate environment.

__setattr__(name, value)

If unlocked, set attribute named name to value.

If this instance is locked, an AttributeError will be raised.

Parameters
  • name – Name of attribute to set.

  • value – Value to assign to attribute.

__weakref__

list of weak references to the object (if defined)

_create_param_namespace(name, env=None)
_filter_param_by_context(name, env=None)

Filter params on attribute named name by environment env.

For example:

>>> from ipalib.config import Env
>>> class Example(HasParam):
...
...     takes_args = (
...         Str('foo_only', include=['foo']),
...         Str('not_bar', exclude=['bar']),
...         'both',
...     )
...
...     def get_args(self):
...         return self._get_param_iterable('args')
...
...
>>> eg = Example()
>>> foo = Env(context='foo')
>>> bar = Env(context='bar')
>>> another = Env(context='another')
>>> (foo.context, bar.context, another.context)
(u'foo', u'bar', u'another')
>>> list(eg._filter_param_by_context('args', foo))
[Str('foo_only', include=['foo']), Str('not_bar', exclude=['bar']), Str('both')]
>>> list(eg._filter_param_by_context('args', bar))
[Str('both')]
>>> list(eg._filter_param_by_context('args', another))
[Str('not_bar', exclude=['bar']), Str('both')]
_get_param_iterable(name, verb='takes')

Return an iterable of params defined by the attribute named name.

A sequence of params can be defined one of three ways: as a tuple; as a callable that returns an iterable; or as a param spec (a Param or str instance). This method returns a uniform iterable regardless of how the param sequence was defined.

For example, when defined with a tuple:

>>> class ByTuple(HasParam):
...     takes_args = (Param('foo'), Param('bar'))
...
>>> by_tuple = ByTuple()
>>> list(by_tuple._get_param_iterable('args'))
[Param('foo'), Param('bar')]

Or you can define your param sequence with a callable when you need to reference attributes on your plugin instance (for validation rules, etc.). For example:

>>> class ByCallable(HasParam):
...     def takes_args(self):
...         yield Param('foo', self.validate_foo)
...         yield Param('bar', self.validate_bar)
...
...     def validate_foo(self, _, value, **kw):
...         if value != 'Foo':
...             return _("must be 'Foo'")
...
...     def validate_bar(self, _, value, **kw):
...         if value != 'Bar':
...             return _("must be 'Bar'")
...
>>> by_callable = ByCallable()
>>> list(by_callable._get_param_iterable('args'))
[Param('foo', validate_foo), Param('bar', validate_bar)]

Lastly, as a convenience for when a param sequence contains a single param, your defining attribute may a param spec (either a Param or an str instance). For example:

>>> class BySpec(HasParam):
...     takes_args = Param('foo')
...     takes_options = 'bar?'
...
>>> by_spec = BySpec()
>>> list(by_spec._get_param_iterable('args'))
[Param('foo')]
>>> list(by_spec._get_param_iterable('options'))
['bar?']

For information on how an str param spec is interpreted, see the create_param() and parse_param_spec() functions in the ipalib.parameters module.

Also see HasParam._filter_param_by_context().

_on_finalize()

Do custom finalization.

This method is called from finalize(). Subclasses can override this method in order to add custom finalization.

allow_rename = True
already_exists_msg = Gettext('%(oname)s with name "%(pkey)s" already exists', domain='ipa', localedir=None)
property api

Return API instance passed to __init__().

attribute_members = {'managedby': ['user']}
backend = None
backend_name = 'ldap2'
bases = (<class 'ipaserver.plugins.baseldap.LDAPObject'>,)
bindable = False
container_dn = ipapython.dn.DN('cn=otp')
container_not_found_msg = Gettext('container entry (%(container)s) not found', domain='ipa', localedir=None)
property context
convert_attribute_members(entry_attrs, *keys, **options)
default_attributes = ['ipatokenuniqueid', 'description', 'ipatokenowner', 'ipatokendisabled', 'ipatokennotbefore', 'ipatokennotafter', 'ipatokenvendor', 'ipatokenmodel', 'ipatokenserial', 'managedby']
disallow_object_classes = []
doc = '\n    OTP Token object.\n    '
ensure_finalized()

Finalize plugin initialization if it has not yet been finalized.

property env
finalize()

Finalize plugin initialization.

This method calls _on_finalize() and locks the plugin object.

Subclasses should not override this method. Custom finalization is done in _on_finalize().

class finalize_attr(name, value=None)

Bases: object

Create a stub object for plugin attribute that isn’t set until the finalization of the plugin initialization.

When the stub object is accessed, it calls ensure_finalized() to make sure the plugin initialization is finalized. The stub object is expected to be replaced with the actual attribute value during the finalization (preferably in _on_finalize()), otherwise an AttributeError is raised.

This is used to implement on-demand finalization of plugin initialization.

__annotations__ = {}
__get__(obj, cls)
__init__(name, value=None)
__module__ = 'ipalib.plugable'
__slots__ = ('name', 'value')
name
value
full_name = 'otptoken/1'
get_ancestor_primary_keys()
get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_dn_if_exists(*keys, **kwargs)
get_indirect_members(entry_attrs, attrs_list)
get_memberindirect(group_entry)

Get indirect members

get_memberofindirect(entry)
get_params()

This method gets called by HasParam._create_param_namespace().

get_password_attributes(ldap, dn, entry_attrs)

Search on the entry to determine if it has a password or keytab set.

A tuple is used to determine which attribute is set in entry_attrs. The value is set to True/False whether a given password type is set.

get_primary_key_from_dn(dn)
handle_duplicate_entry(*keys)
handle_not_found(*keys)

Handle NotFound exception

Must raise errors.NotFound again.

has_objectclass(classes, objectclass)
hidden_attributes = ['objectclass', 'aci']
json_friendly_attributes = ('parent_object', 'container_dn', 'object_name', 'object_name_plural', 'object_class', 'object_class_config', 'default_attributes', 'label', 'label_singular', 'hidden_attributes', 'uuid_attribute', 'attribute_members', 'name', 'takes_params', 'rdn_attribute', 'bindable', 'relationships')
label = Gettext('OTP Tokens', domain='ipa', localedir=None)
label_singular = Gettext('OTP Token', domain='ipa', localedir=None)
limit_object_classes = []
managed_permissions = {}
methods = None
name = 'otptoken'
object_class = ['ipatoken']
object_class_config = None
object_name = Gettext('OTP token', domain='ipa', localedir=None)
object_name_plural = Gettext('OTP tokens', domain='ipa', localedir=None)
object_not_found_msg = Gettext('%(pkey)s: %(oname)s not found', domain='ipa', localedir=None)
params = None
params_minus(*names)

Yield all Param whose name is not in names.

params_minus_pk = None
parent_not_found_msg = Gettext('%(parent)s: %(oname)s not found', domain='ipa', localedir=None)
parent_object = ''
password_attributes = []
permission_filter_objectclasses = None
possible_objectclasses = ['ipatokentotp', 'ipatokenhotp']
primary_key = None
rdn_attribute = ''
relationships = {'managedby': ('Managed by', 'man_by_', 'not_man_by_')}
search_attributes = []
search_attributes_config = None
search_display_attributes = []
summary = 'OTP Token object.'
takes_params = (Str('ipatokenuniqueid', cli_name='id', flags=[u'optional_create'], label=Gettext('Unique ID', domain='ipa', localedir=None), primary_key=True), StrEnum('type?', autofill=True, cli_metavar=u"['totp', 'hotp', 'TOTP', 'HOTP']", default=u'totp', doc=Gettext('Type of the token', domain='ipa', localedir=None), flags=[u'no_update', u'virtual_attribute'], label=Gettext('Type', domain='ipa', localedir=None), values=[u'totp', u'hotp', u'TOTP', u'HOTP']), Str('description?', cli_name='desc', doc=Gettext('Token description (informational only)', domain='ipa', localedir=None), label=Gettext('Description', domain='ipa', localedir=None)), Str('ipatokenowner?', cli_name='owner', doc=Gettext('Assigned user of the token (default: self)', domain='ipa', localedir=None), label=Gettext('Owner', domain='ipa', localedir=None)), Str('managedby_user?', doc=Gettext('Assigned manager of the token (default: self)', domain='ipa', localedir=None), flags=[u'no_create', u'no_search', u'no_update'], label=Gettext('Manager', domain='ipa', localedir=None)), Bool('ipatokendisabled?', cli_name='disabled', doc=Gettext('Mark the token as disabled (default: false)', domain='ipa', localedir=None), label=Gettext('Disabled', domain='ipa', localedir=None)), DateTime('ipatokennotbefore?', cli_name='not_before', doc=Gettext('First date/time the token can be used', domain='ipa', localedir=None), label=Gettext('Validity start', domain='ipa', localedir=None)), DateTime('ipatokennotafter?', cli_name='not_after', doc=Gettext('Last date/time the token can be used', domain='ipa', localedir=None), label=Gettext('Validity end', domain='ipa', localedir=None)), Str('ipatokenvendor?', cli_name='vendor', doc=Gettext('Token vendor name (informational only)', domain='ipa', localedir=None), label=Gettext('Vendor', domain='ipa', localedir=None)), Str('ipatokenmodel?', cli_name='model', doc=Gettext('Token model (informational only)', domain='ipa', localedir=None), label=Gettext('Model', domain='ipa', localedir=None)), Str('ipatokenserial?', cli_name='serial', doc=Gettext('Token serial (informational only)', domain='ipa', localedir=None), label=Gettext('Serial', domain='ipa', localedir=None)), OTPTokenKey('ipatokenotpkey?', autofill=True, cli_name='key', default_from=DefaultFrom(), doc=Gettext('Token secret (Base32; default: random)', domain='ipa', localedir=None), flags=[u'no_update', u'no_search', u'no_display'], label=Gettext('Key', domain='ipa', localedir=None), normalizer=<lambda>), StrEnum('ipatokenotpalgorithm?', autofill=True, cli_metavar=u"['sha1', 'sha256', 'sha384', 'sha512']", cli_name='algo', default=u'sha1', doc=Gettext('Token hash algorithm', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Algorithm', domain='ipa', localedir=None), values=[u'sha1', u'sha256', u'sha384', u'sha512']), IntEnum('ipatokenotpdigits?', autofill=True, cli_metavar=u"['6', '8']", cli_name='digits', default=6, doc=Gettext('Number of digits each token code will have', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Digits', domain='ipa', localedir=None), values=[6, 8]), Int('ipatokentotpclockoffset?', autofill=True, cli_name='offset', default=0, doc=Gettext('TOTP token / IPA server time difference', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Clock offset', domain='ipa', localedir=None)), Int('ipatokentotptimestep?', autofill=True, cli_name='interval', default=30, doc=Gettext('Length of TOTP token code validity', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Clock interval', domain='ipa', localedir=None), minvalue=5), Int('ipatokenhotpcounter?', autofill=True, cli_name='counter', default=0, doc=Gettext('Initial counter for the HOTP token', domain='ipa', localedir=None), flags=[u'no_update'], label=Gettext('Counter', domain='ipa', localedir=None), minvalue=0), Str('uri?', flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('URI', domain='ipa', localedir=None)))
uuid_attribute = ''
version = '1'