/usr/lib/python3/dist-packages/lib389/plugins.py is in python3-lib389 1.3.7.10-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 | # --- BEGIN COPYRIGHT BLOCK ---
# Copyright (C) 2015 Red Hat, Inc.
# All rights reserved.
#
# License: GPL (version 3 or any later version).
# See LICENSE for details.
# --- END COPYRIGHT BLOCK ---
import ldap
import copy
import os.path
from lib389 import tasks
from lib389._mapped_object import DSLdapObjects, DSLdapObject
from lib389.exceptions import Error
from lib389.lint import DSRILE0001
from lib389._constants import DN_PLUGIN
from lib389.properties import (
PLUGINS_OBJECTCLASS_VALUE, PLUGIN_PROPNAME_TO_ATTRNAME,
PLUGINS_ENABLE_ON_VALUE, PLUGINS_ENABLE_OFF_VALUE, PLUGIN_ENABLE
)
class Plugin(DSLdapObject):
_plugin_properties = {
'nsslapd-pluginEnabled' : 'off'
}
def __init__(self, instance, dn=None, batch=False):
super(Plugin, self).__init__(instance, dn, batch)
self._rdn_attribute = 'cn'
self._must_attributes = [
'nsslapd-pluginEnabled',
'nsslapd-pluginPath',
'nsslapd-pluginInitfunc',
'nsslapd-pluginType',
'nsslapd-pluginId',
'nsslapd-pluginVendor',
'nsslapd-pluginVersion',
'nsslapd-pluginDescription',
]
self._create_objectclasses = ['top', 'nsslapdplugin']
# We'll mark this protected, and people can just disable the plugins.
self._protected = True
def enable(self):
self.set('nsslapd-pluginEnabled', 'on')
def disable(self):
self.set('nsslapd-pluginEnabled', 'off')
def status(self):
return self.get_attr_val_utf8('nsslapd-pluginEnabled') == 'on'
def create(self, rdn=None, properties=None, basedn=None):
# When we create plugins, we don't want people to have to consider all
# the little details. Plus, the server during creation needs to be able
# to create these from nothing.
# As a result, all the named plugins carry a default properties
# dictionary that can be used.
# Copy the plugin internal properties.
internal_properties = copy.deepcopy(self._plugin_properties)
if properties is not None:
internal_properties.update(properties)
return super(Plugin, self).create(rdn, internal_properties, basedn)
class AddnPlugin(Plugin):
def __init__(self, instance, dn="cn=addn,cn=plugins,cn=config", batch=False):
super(AddnPlugin, self).__init__(instance, dn, batch)
# Need to add wrappers to add domains to this.
class AttributeUniquenessPlugin(Plugin):
def __init__(self, instance, dn="cn=attribute uniqueness,cn=plugins,cn=config", batch=False):
super(AttributeUniquenessPlugin, self).__init__(instance, dn, batch)
## These are some wrappers to the important attributes
# This plugin will be "tricky" in that it can have "many" instance
# of the plugin, rather than many configs.
def add_unique_attribute(self, attr):
self.add('uniqueness-attribute-name', attr)
def remove_unique_attribute(self, attr):
self.remove('uniqueness-attribute-name', attr)
def add_unique_subtree(self, basedn):
self.add('uniqueness-subtrees', basedn)
def remove_unique_subtree(self, basedn):
self.remove('uniqueness-subtrees', basedn)
def enable_all_subtrees(self):
self.set('uniqueness-across-all-subtrees', 'on')
def disable_all_subtrees(self):
self.set('uniqueness-across-all-subtrees', 'off')
class LdapSSOTokenPlugin(Plugin):
_plugin_properties = {
'cn' : 'ldapssotoken',
'nsslapd-pluginEnabled' : 'off',
'nsslapd-pluginPath' : 'liblst-plugin',
'nsslapd-pluginInitfunc' : 'lst_init',
'nsslapd-pluginType' : 'extendedop',
'nsslapd-pluginId' : 'ldapssotoken-plugin',
'nsslapd-pluginVendor' : '389 Project',
'nsslapd-pluginVersion' : '1.3.6',
'nsslapd-pluginDescription' : 'Ldap SSO Token Sasl Mech - draft-wibrown-ldapssotoken',
}
def __init__(self, instance, dn="cn=ldapssotoken,cn=plugins,cn=config", batch=False):
super(LdapSSOTokenPlugin, self).__init__(instance, dn, batch)
class ManagedEntriesPlugin(Plugin):
def __init__(self, instance, dn="cn=managed entries,cn=plugins,cn=config", batch=False):
super(ManagedEntriesPlugin, self).__init__(instance, dn, batch)
# This will likely need to be a bit like both the DSLdapObjects AND the object.
# Because there are potentially many MEP configs.
class ReferentialIntegrityPlugin(Plugin):
_plugin_properties = {
'cn' : 'referential integrity postoperation',
'nsslapd-pluginEnabled': 'off',
'nsslapd-pluginPath': 'libreferint-plugin',
'nsslapd-pluginInitfunc': 'referint_postop_init',
'nsslapd-pluginType': 'betxnpostoperation',
'nsslapd-pluginprecedence': '40',
'nsslapd-plugin-depends-on-type': 'database',
'referint-update-delay': '0',
'referint-membership-attr': ['member', 'uniquemember', 'owner', 'seeAlso',],
'nsslapd-pluginId' : 'referint',
'nsslapd-pluginVendor' : '389 Project',
'nsslapd-pluginVersion' : '1.3.7.0',
'nsslapd-pluginDescription' : 'referential integrity plugin',
}
def __init__(self, instance, dn="cn=referential integrity postoperation,cn=plugins,cn=config", batch=False):
super(ReferentialIntegrityPlugin, self).__init__(instance, dn, batch)
self._create_objectclasses.extend(['extensibleObject'])
self._must_attributes.extend([
'referint-update-delay',
'referint-logfile',
'referint-membership-attr',
])
self._lint_functions = [self._lint_update_delay]
def create(self, rdn=None, properties=None, basedn=None):
referint_log = os.path.join(self._instance.ds_paths.log_dir, "referint")
if properties is None:
properties = {'referint-logfile': referint_log}
else:
properties['referint-logfile'] = referint_log
return super(ReferentialIntegrityPlugin, self).create(rdn, properties, basedn)
def _lint_update_delay(self):
if self.status():
delay = self.get_attr_val_int("referint-update-delay")
if delay is not None and delay != 0:
return DSRILE0001
def get_update_delay(self):
return self.get_attr_val_int('referint-update-delay')
def get_update_delay_formatted(self):
return self.display_attr('referint-update-delay')
def set_update_delay(self, value):
self.set('referint-update-delay', str(value))
def get_membership_attr(self, formatted=False):
return self.get_attr_vals_utf8('referint-membership-attr')
def get_membership_attr_formatted(self):
return self.display_attr('referint-membership-attr')
def add_membership_attr(self, attr):
self.add('referint-membership-attr', attr)
def remove_membership_attr(self, attr):
self.remove('referint-membership-attr', attr)
def get_entryscope(self, formatted=False):
return self.get_attr_vals_utf8('nsslapd-pluginentryscope')
def get_entryscope_formatted(self):
return self.display_attr('nsslapd-pluginentryscope')
def add_entryscope(self, attr):
self.add('nsslapd-pluginentryscope', attr)
def remove_entryscope(self, attr):
self.remove('nsslapd-pluginentryscope', attr)
def remove_all_entryscope(self):
self.remove_all('nsslapd-pluginentryscope')
def get_excludescope(self):
return self.get_attr_vals_ut8('nsslapd-pluginexcludeentryscope')
def get_excludescope_formatted(self):
return self.display_attr('nsslapd-pluginexcludeentryscope')
def add_excludescope(self, attr):
self.add('nsslapd-pluginexcludeentryscope', attr)
def remove_excludescope(self, attr):
self.remove('nsslapd-pluginexcludeentryscope', attr)
def remove_all_excludescope(self):
self.remove_all('nsslapd-pluginexcludeentryscope')
def get_container_scope(self):
return self.get_attr_vals_ut8('nsslapd-plugincontainerscope')
def get_container_scope_formatted(self):
return self.display_attr('nsslapd-plugincontainerscope')
def add_container_scope(self, attr):
self.add('nsslapd-plugincontainerscope', attr)
def remove_container_scope(self, attr):
self.remove('nsslapd-plugincontainerscope', attr)
def remove_all_container_scope(self):
self.remove_all('nsslapd-plugincontainerscope')
class SyntaxValidationPlugin(Plugin):
def __init__(self, instance, dn="cn=Syntax Validation Task,cn=plugins,cn=config", batch=False):
super(SyntaxValidationPlugin, self).__init__(instance, dn, batch)
class SchemaReloadPlugin(Plugin):
def __init__(self, instance, dn="cn=Schema Reload,cn=plugins,cn=config", batch=False):
super(SchemaReloadPlugin, self).__init__(instance, dn, batch)
class StateChangePlugin(Plugin):
def __init__(self, instance, dn="cn=State Change Plugin,cn=plugins,cn=config", batch=False):
super(StateChangePlugin, self).__init__(instance, dn, batch)
class ACLPlugin(Plugin):
def __init__(self, instance, dn="cn=ACL Plugin,cn=plugins,cn=config", batch=False):
super(ACLPlugin, self).__init__(instance, dn, batch)
class ACLPreoperationPlugin(Plugin):
def __init__(self, instance, dn="cn=ACL preoperation,cn=plugins,cn=config", batch=False):
super(ACLPreoperationPlugin, self).__init__(instance, dn, batch)
class RolesPlugin(Plugin):
def __init__(self, instance, dn="cn=Roles Plugin,cn=plugins,cn=config", batch=False):
super(RolesPlugin, self).__init__(instance, dn, batch)
class MemberOfPlugin(Plugin):
_plugin_properties = {
'cn' : 'MemberOf Plugin',
'nsslapd-pluginEnabled' : 'off',
'nsslapd-pluginPath' : 'libmemberof-plugin',
'nsslapd-pluginInitfunc' : 'memberof_postop_init',
'nsslapd-pluginType' : 'betxnpostoperation',
'nsslapd-plugin-depends-on-type' : 'database',
'nsslapd-pluginId' : 'memberof',
'nsslapd-pluginVendor' : '389 Project',
'nsslapd-pluginVersion' : '1.3.7.0',
'nsslapd-pluginDescription' : 'memberof plugin',
'memberOfGroupAttr' : 'member',
'memberOfAttr' : 'memberOf',
}
def __init__(self, instance, dn="cn=MemberOf Plugin,cn=plugins,cn=config", batch=False):
super(MemberOfPlugin, self).__init__(instance, dn, batch)
self._create_objectclasses.extend(['extensibleObject'])
self._must_attributes.extend(['memberOfGroupAttr', 'memberOfAttr'])
def get_attr(self):
return self.get_attr_val('memberofattr')
def get_attr_formatted(self):
return self.display_attr('memberofattr')
def set_attr(self, attr):
self.set('memberofattr', attr)
def get_groupattr(self):
return self.get_attr_vals('memberofgroupattr')
def get_groupattr_formatted(self):
return self.display_attr('memberofgroupattr')
def add_groupattr(self, attr):
self.add('memberofgroupattr', attr)
def remove_groupattr(self, attr):
self.remove('memberofgroupattr', attr)
def get_allbackends(self):
return self.get_attr_val('memberofallbackends')
def get_allbackends_formatted(self):
return self.display_attr('memberofallbackends')
def enable_allbackends(self):
self.set('memberofallbackends', 'on')
def disable_allbackends(self):
self.set('memberofallbackends', 'off')
def get_skipnested(self):
return self.get_attr_val('memberofskipnested')
def get_skipnested_formatted(self):
return self.display_attr('memberofskipnested')
def enable_skipnested(self):
self.set('memberofskipnested', 'on')
def disable_skipnested(self):
self.set('memberofskipnested', 'off')
def get_autoaddoc(self):
return self.get_attr_val('memberofautoaddoc')
def get_autoaddoc_formatted(self):
return self.display_attr('memberofautoaddoc')
def set_autoaddoc(self, object_class):
self.set('memberofautoaddoc', object_class)
def remove_autoaddoc(self):
self.remove_all('memberofautoaddoc')
def get_entryscope(self, formatted=False):
return self.get_attr_vals('memberofentryscope')
def get_entryscope_formatted(self):
return self.display_attr('memberofentryscope')
def add_entryscope(self, attr):
self.add('memberofentryscope', attr)
def remove_entryscope(self, attr):
self.remove('memberofentryscope', attr)
def remove_all_entryscope(self):
self.remove_all('memberofentryscope')
def get_excludescope(self):
return self.get_attr_vals('memberofentryscopeexcludesubtree')
def get_excludescope_formatted(self):
return self.display_attr('memberofentryscopeexcludesubtree')
def add_excludescope(self, attr):
self.add('memberofentryscopeexcludesubtree', attr)
def remove_excludescope(self, attr):
self.remove('memberofentryscopeexcludesubtree', attr)
def remove_all_excludescope(self):
self.remove_all('memberofentryscopeexcludesubtree')
def fixup(self, basedn, _filter=None):
task = tasks.MemberOfFixupTask(self._instance)
task_properties = {'basedn': basedn}
if _filter is not None:
task_properties['filter'] = _filter
task.create(properties=task_properties)
return task
class RetroChangelogPlugin(Plugin):
def __init__(self, instance, dn="cn=Retro Changelog Plugin,cn=plugins,cn=config", batch=False):
super(RetroChangelogPlugin, self).__init__(instance, dn, batch)
class ClassOfServicePlugin(Plugin):
def __init__(self, instance, dn="cn=Class of Service,cn=plugins,cn=config", batch=False):
super(ClassOfServicePlugin, self).__init__(instance, dn, batch)
class ViewsPlugin(Plugin):
def __init__(self, instance, dn="cn=Views,cn=plugins,cn=config", batch=False):
super(ViewsPlugin, self).__init__(instance, dn, batch)
class SevenBitCheckPlugin(Plugin):
def __init__(self, instance, dn="cn=7-bit check,cn=plugins,cn=config", batch=False):
super(SevenBitCheckPlugin, self).__init__(instance, dn, batch)
class AccountUsabilityPlugin(Plugin):
def __init__(self, instance, dn="cn=Account Usability Plugin,cn=plugins,cn=config", batch=False):
super(AccountUsabilityPlugin, self).__init__(instance, dn, batch)
class AutoMembershipPlugin(Plugin):
def __init__(self, instance, dn="cn=Auto Membership Plugin,cn=plugins,cn=config", batch=False):
super(AutoMembershipPlugin, self).__init__(instance, dn, batch)
class ContentSynchronizationPlugin(Plugin):
def __init__(self, instance, dn="cn=Content Synchronization,cn=plugins,cn=config", batch=False):
super(ContentSynchronizationPlugin, self).__init__(instance, dn, batch)
class DereferencePlugin(Plugin):
def __init__(self, instance, dn="cn=deref,cn=plugins,cn=config", batch=False):
super(DereferencePlugin, self).__init__(instance, dn, batch)
class HTTPClientPlugin(Plugin):
def __init__(self, instance, dn="cn=HTTP Client,cn=plugins,cn=config", batch=False):
super(HTTPClientPlugin, self).__init__(instance, dn, batch)
class LinkedAttributesPlugin(Plugin):
def __init__(self, instance, dn="cn=Linked Attributes,cn=plugins,cn=config", batch=False):
super(LinkedAttributesPlugin, self).__init__(instance, dn, batch)
class PassThroughAuthenticationPlugin(Plugin):
def __init__(self, instance, dn="cn=Pass Through Authentication,cn=plugins,cn=config", batch=False):
super(PassThroughAuthenticationPlugin, self).__init__(instance, dn, batch)
class USNPlugin(Plugin):
_plugin_properties = {
'cn' : 'USN',
'nsslapd-pluginEnabled': 'off',
'nsslapd-pluginPath': 'libusn-plugin',
'nsslapd-pluginInitfunc': 'usn_init',
'nsslapd-pluginType': 'object',
'nsslapd-pluginbetxn': 'on',
'nsslapd-plugin-depends-on-type': 'database',
'nsslapd-pluginId': 'USN',
'nsslapd-pluginVendor': '389 Project',
'nsslapd-pluginVersion': '1.3.7.0',
'nsslapd-pluginDescription': 'USN (Update Sequence Number) plugin',
}
def __init__(self, instance, dn="cn=USN,cn=plugins,cn=config", batch=False):
super(USNPlugin, self).__init__(instance, dn, batch)
self._create_objectclasses.extend(['extensibleObject'])
def is_global_mode_set(self):
"""Return True if global mode is enabled, else False."""
return self._instance.config.get_attr_val_utf8('nsslapd-entryusn-global') == 'on'
def enable_global_mode(self):
self._instance.config.set('nsslapd-entryusn-global', 'on')
def disable_global_mode(self):
self._instance.config.set('nsslapd-entryusn-global', 'off')
def cleanup(self, suffix=None, backend=None, max_usn=None):
task = tasks.USNTombstoneCleanupTask(self._instance)
task_properties = {}
if suffix is not None:
task_properties['suffix'] = suffix
if backend is not None:
task_properties['backend'] = backend
if max_usn is not None:
task_properties['maxusn_to_delete'] = str(max_usn)
task.create(properties=task_properties)
return task
class WhoamiPlugin(Plugin):
_plugin_properties = {
'cn' : 'whoami',
'nsslapd-pluginEnabled' : 'on',
'nsslapd-pluginPath' : 'libwhoami-plugin',
'nsslapd-pluginInitfunc' : 'whoami_init',
'nsslapd-pluginType' : 'extendedop',
'nsslapd-plugin-depends-on-type' : 'database',
'nsslapd-pluginId' : 'ldapwhoami-plugin',
'nsslapd-pluginVendor' : '389 Project',
'nsslapd-pluginVersion' : '1.3.6',
'nsslapd-pluginDescription' : 'Provides whoami extended operation',
}
def __init__(self, instance, dn="cn=whoami,cn=plugins,cn=config", batch=False):
super(WhoamiPlugin, self).__init__(instance, dn, batch)
class RootDNAccessControlPlugin(Plugin):
_plugin_properties = {
'cn' : 'RootDN Access Control',
'nsslapd-pluginEnabled' : 'off',
'nsslapd-pluginPath' : 'librootdn-access-plugin',
'nsslapd-pluginInitfunc' : 'rootdn_init',
'nsslapd-pluginType' : 'internalpreoperation',
'nsslapd-plugin-depends-on-type' : 'database',
'nsslapd-pluginId' : 'RootDN Access Control',
'nsslapd-pluginVendor' : '389 Project',
'nsslapd-pluginVersion' : '1.3.6',
'nsslapd-pluginDescription' : 'RootDN Access Control plugin',
}
def __init__(self, instance, dn="cn=RootDN Access Control,cn=plugins,cn=config", batch=False):
super(RootDNAccessControlPlugin, self).__init__(instance, dn, batch)
self._create_objectclasses.extend(['rootDNPluginConfig'])
def get_open_time(self):
return self.get_attr_val_utf8('rootdn-open-time')
def get_open_time_formatted(self):
return self.display_attr('rootdn-open-time')
def set_open_time(self, attr):
self.set('rootdn-open-time', attr)
def remove_open_time(self):
self.remove_all('rootdn-open-time')
def get_close_time(self):
return self.get_attr_val_utf8('rootdn-close-time')
def get_close_time_formatted(self):
return self.display_attr('rootdn-close-time')
def set_close_time(self, attr):
self.set('rootdn-close-time', attr)
def remove_close_time(self):
self.remove_all('rootdn-close-time')
def get_days_allowed(self):
return self.get_attr_val_utf8('rootdn-days-allowed')
def get_days_allowed_formatted(self):
return self.display_attr('rootdn-days-allowed')
def set_days_allowed(self, attr):
self.set('rootdn-days-allowed', attr)
def remove_days_allowed(self):
self.remove_all('rootdn-days-allowed')
def add_allow_day(self, day):
days = self.get_days_allowed()
if days is None:
days = ""
days = self.add_day_to_days(days, day)
if days:
self.set_days_allowed(days)
else:
self.remove_days_allowed()
def remove_allow_day(self, day):
days = self.get_days_allowed()
if days is None:
days = ""
days = self.remove_day_from_days(days, day)
if days:
self.set_days_allowed(days)
else:
self.remove_days_allowed()
def get_allow_host(self):
return self.get_attr_val_utf8('rootdn-allow-host')
def get_allow_host_formatted(self):
return self.display_attr('rootdn-allow-host')
def add_allow_host(self, attr):
self.add('rootdn-allow-host', attr)
def remove_allow_host(self, attr):
self.remove('rootdn-allow-host', attr)
def remove_all_allow_host(self):
self.remove_all('rootdn-allow-host')
def get_deny_host(self):
return self.get_attr_val_utf8('rootdn-deny-host')
def get_deny_host_formatted(self):
return self.display_attr('rootdn-deny-host')
def add_deny_host(self, attr):
self.add('rootdn-deny-host', attr)
def remove_deny_host(self, attr):
self.remove('rootdn-deny-host', attr)
def remove_all_deny_host(self):
self.remove_all('rootdn-deny-host')
def get_allow_ip(self):
return self.get_attr_val_utf8('rootdn-allow-ip')
def get_allow_ip_formatted(self):
return self.display_attr('rootdn-allow-ip')
def add_allow_ip(self, attr):
self.add('rootdn-allow-ip', attr)
def remove_allow_ip(self, attr):
self.remove('rootdn-allow-ip', attr)
def remove_all_allow_ip(self):
self.remove_all('rootdn-allow-ip')
def get_deny_ip(self):
return self.get_attr_val_utf8('rootdn-deny-ip')
def get_deny_ip_formatted(self):
return self.display_attr('rootdn-deny-ip')
def add_deny_ip(self, attr):
self.add('rootdn-deny-ip', attr)
def remove_deny_ip(self, attr):
self.remove('rootdn-deny-ip', attr)
def remove_all_deny_ip(self):
self.remove_all('rootdn-deny-ip')
@staticmethod
def add_day_to_days(string_of_days, day):
"""
Append a day in a string of comma seperated days and return the string.
If day already exists in the string, return processed string.
Keyword arguments:
string_of_days -- a string of comma seperated days
examples:
Mon
Tue, Wed, Thu
day -- a day, e.g. Mon, Tue, etc.
"""
days = [i.strip() for i in string_of_days.split(',') if i]
if not day in days:
days.append(day)
return ", ".join(days)
@staticmethod
def remove_day_from_days(string_of_days, day):
"""
Remove a day from a string of comma seperated days and return the string.
If day does not exists in the string, return processed string.
Keyword arguments:
string_of_days -- a string of comma seperated days
examples:
Mon
Tue, Wed, Thu
day -- a day, e.g. Mon, Tue, etc.
"""
days = [i.strip() for i in string_of_days.split(',') if i]
if day in days:
days.remove(day)
return ", ".join(days)
class LDBMBackendPlugin(Plugin):
def __init__(self, instance, dn="cn=ldbm database,cn=plugins,cn=config", batch=False):
super(LDBMBackendPlugin, self).__init__(instance, dn, batch)
class ChainingBackendPlugin(Plugin):
def __init__(self, instance, dn="cn=chaining database,cn=plugins,cn=config", batch=False):
super(ChainingBackendPlugin, self).__init__(instance, dn, batch)
class AccountPolicyPlugin(Plugin):
def __init__(self, instance, dn="cn=Account Policy Plugin,cn=plugins,cn=config", batch=False):
super(AccountPolicyPlugin, self).__init__(instance, dn, batch)
class Plugins(DSLdapObjects):
# This is a map of plugin to type, so when we
# do a get / list / create etc, we can map to the correct
# instance.
def __init__(self, instance, batch=False):
super(Plugins, self).__init__(instance=instance, batch=batch)
self._objectclasses = ['top', 'nsslapdplugin']
self._filterattrs = ['cn', 'nsslapd-pluginPath']
self._childobject = Plugin
self._basedn = 'cn=plugins,cn=config'
# This is used to allow entry to instance to work
self._list_attrlist = ['dn', 'nsslapd-pluginPath']
# This may not work for attr unique which can have many instance ....
# Should we be doing this from the .so name?
self._pluginmap = {
'libaddn-plugin' : AddnPlugin,
'libattr-unique-plugin' : AttributeUniquenessPlugin,
'liblst-plugin' : LdapSSOTokenPlugin,
'libmanagedentries-plugin' : ManagedEntriesPlugin,
'libreferint-plugin' : ReferentialIntegrityPlugin,
}
def _entry_to_instance(self, dn=None, entry=None):
# If dn in self._pluginmap
if entry['nsslapd-pluginPath'] in self._pluginmap:
return self._pluginmap[entry['nsslapd-pluginPath']](self._instance, dn=dn, batch=self._batch)
else:
return super(Plugins, self)._entry_to_instance(dn)
# To maintain compat with pluginslegacy, here are some helpers.
def enable(self, name=None, plugin_dn=None):
if plugin_dn is not None:
raise ValueError('You should swap to the new Plugin API!')
if name is None:
raise ldap.NO_SUCH_OBJECT('Must provide a selector for name')
plugin = self.get(selector=name)
plugin.enable()
def disable(self, name=None, plugin_dn=None):
if plugin_dn is not None:
raise ValueError('You should swap to the new Plugin API!')
if name is None:
raise ldap.NO_SUCH_OBJECT('Must provide a selector for name')
plugin = self.get(selector=name)
plugin.disable()
class PluginsLegacy(object):
proxied_methods = 'search_s getEntry'.split()
def __init__(self, conn):
"""@param conn - a DirSrv instance"""
self.conn = conn
self.log = conn.log
def __getattr__(self, name):
if name in Plugins.proxied_methods:
from lib389 import DirSrv
return DirSrv.__getattr__(self.conn, name)
def list(self, name=None):
'''
Returns a search result of the plugins entries with all their
attributes
If 'name' is not specified, it returns all the plugins, else it
returns the plugin matching ('cn=<name>, DN_PLUGIN')
@param name - name of the plugin
@return plugin entries
@raise None
'''
if name:
filt = "(objectclass=%s)" % PLUGINS_OBJECTCLASS_VALUE
base = "cn=%s,%s" % (name, DN_PLUGIN)
scope = ldap.SCOPE_BASE
else:
filt = "(objectclass=%s)" % PLUGINS_OBJECTCLASS_VALUE
base = DN_PLUGIN
scope = ldap.SCOPE_ONELEVEL
ents = self.conn.search_s(base, scope, filt)
return ents
def enable(self, name=None, plugin_dn=None):
'''
Enable a plugin
If 'plugin_dn' and 'name' are provided, plugin_dn is used and
'name' is not considered
@param name - name of the plugin
@param plugin_dn - DN of the plugin
@return None
@raise ValueError - if 'name' or 'plugin_dn' lead to unknown plugin
InvalidArgumentError - if 'name' and 'plugin_dn' are missing
'''
dn = plugin_dn or "cn=%s,%s" % (name, DN_PLUGIN)
filt = "(objectclass=%s)" % PLUGINS_OBJECTCLASS_VALUE
if not dn:
from lib389 import InvalidArgumentError
raise InvalidArgumentError("'name' and 'plugin_dn' are missing")
ents = self.conn.search_s(dn, ldap.SCOPE_BASE, filt)
if len(ents) != 1:
raise ValueError("%s is unknown")
self.conn.modify_s(dn, [(ldap.MOD_REPLACE,
PLUGIN_PROPNAME_TO_ATTRNAME[PLUGIN_ENABLE],
PLUGINS_ENABLE_ON_VALUE)])
def disable(self, name=None, plugin_dn=None):
'''
Disable a plugin
If 'plugin_dn' and 'name' are provided, plugin_dn is used and
'name' is not considered
@param name - name of the plugin
@param plugin_dn - DN of the plugin
@return None
@raise ValueError - if 'name' or 'plugin_dn' lead to unknown plugin
InvalidArgumentError - if 'name' and 'plugin_dn' are missing
'''
dn = plugin_dn or "cn=%s,%s" % (name, DN_PLUGIN)
filt = "(objectclass=%s)" % PLUGINS_OBJECTCLASS_VALUE
if not dn:
from lib389 import InvalidArgumentError
raise InvalidArgumentError("'name' and 'plugin_dn' are missing")
ents = self.conn.search_s(dn, ldap.SCOPE_BASE, filt)
if len(ents) != 1:
raise ValueError("%s is unknown")
self.conn.modify_s(dn, [(ldap.MOD_REPLACE,
PLUGIN_PROPNAME_TO_ATTRNAME[PLUGIN_ENABLE],
PLUGINS_ENABLE_OFF_VALUE)])
|