/usr/lib/python3/dist-packages/plainbox/impl/secure/providers/v1.py is in python3-plainbox 0.5.3-2.
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 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 | # This file is part of Checkbox.
#
# Copyright 2013 Canonical Ltd.
# Written by:
# Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Checkbox. If not, see <http://www.gnu.org/licenses/>.
"""
:mod:`plainbox.impl.secure.providers.v1` -- Implementation of V1 provider
=========================================================================
"""
import errno
import gettext
import itertools
import logging
import os
from plainbox.abc import IProvider1, IProviderBackend1
from plainbox.i18n import gettext as _
from plainbox.impl.job import JobDefinition
from plainbox.impl.job import ValidationError
from plainbox.impl.secure.config import Config, Variable
from plainbox.impl.secure.config import IValidator
from plainbox.impl.secure.config import NotEmptyValidator
from plainbox.impl.secure.config import NotUnsetValidator
from plainbox.impl.secure.config import PatternValidator
from plainbox.impl.secure.config import Unset
from plainbox.impl.secure.plugins import FsPlugInCollection
from plainbox.impl.secure.plugins import IPlugIn
from plainbox.impl.secure.plugins import PlugInError
from plainbox.impl.secure.qualifiers import WhiteList
from plainbox.impl.secure.rfc822 import FileTextSource
from plainbox.impl.secure.rfc822 import RFC822SyntaxError
from plainbox.impl.secure.rfc822 import load_rfc822_records
logger = logging.getLogger("plainbox.secure.providers.v1")
class WhiteListPlugIn(IPlugIn):
"""
A specialized :class:`plainbox.impl.secure.plugins.IPlugIn` that loads
:class:`plainbox.impl.secure.qualifiers.WhiteList` instances from a file.
"""
def __init__(self, filename, text, implicit_namespace=None):
"""
Initialize the plug-in with the specified name text
"""
try:
self._whitelist = WhiteList.from_string(
text, filename=filename, implicit_namespace=implicit_namespace)
except Exception as exc:
raise PlugInError(
_("Cannot load whitelist {!r}: {}").format(filename, exc))
@property
def plugin_name(self):
"""
plugin name, the name of the WhiteList
"""
return self._whitelist.name
@property
def plugin_object(self):
"""
plugin object, the actual WhiteList instance
"""
return self._whitelist
class JobDefinitionPlugIn(IPlugIn):
"""
A specialized :class:`plainbox.impl.secure.plugins.IPlugIn` that loads a
list of :class:`plainbox.impl.job.JobDefinition` instances from a file.
"""
def __init__(self, filename, text, provider, *,
validate=True, validation_kwargs=None):
"""
Initialize the plug-in with the specified name text
:param filename:
Name of the file with job definitions
:param text:
Full text of the file with job definitions
:param provider:
A provider object to which those jobs belong to
:param validate:
Enable job validation. Incorrect job definitions will not be loaded
and will abort the process of loading of the remainder of the jobs.
This is ON by default to prevent broken job definitions from being
used. This is a keyword-only argument.
:param validation_kwargs:
Keyword arguments to pass to the JobDefinition.validate(). Note,
this is a single argument. This is a keyword-only argument.
"""
self._filename = filename
self._job_list = []
if validation_kwargs is None:
validation_kwargs = {}
logger.debug(_("Loading jobs definitions from %r..."), filename)
try:
records = load_rfc822_records(
text, source=FileTextSource(filename))
except RFC822SyntaxError as exc:
raise PlugInError(
_("Cannot load job definitions from {!r}: {}").format(
filename, exc))
for record in records:
try:
job = JobDefinition.from_rfc822_record(record)
except ValueError as exc:
raise PlugInError(
_("Cannot define job from record {!r}: {}").format(
record, exc))
job._provider = provider
if validate:
try:
job.validate(**validation_kwargs)
except ValidationError as exc:
raise PlugInError(
_("Problem in job definition, field {}: {}").format(
exc.field, exc.problem))
self._job_list.append(job)
logger.debug(_("Loaded %r"), job)
@property
def plugin_name(self):
"""
plugin name, name of the file we loaded jobs from
"""
return self._filename
@property
def plugin_object(self):
"""
plugin object, a list of JobDefinition instances
"""
return self._job_list
class Provider1(IProvider1, IProviderBackend1):
"""
A v1 provider implementation.
A provider is a container of jobs and whitelists. It provides additional
meta-data and knows about location of essential directories to both load
structured data and provide runtime information for job execution.
Providers are normally loaded with :class:`Provider1PlugIn`, due to the
number of fields involved in basic initialization.
"""
def __init__(self, name, version, description, secure, gettext_domain,
jobs_dir, whitelists_dir, data_dir, bin_dir, locale_dir,
base_dir, *, validate=True, validation_kwargs=None):
"""
Initialize a provider with a set of meta-data and directories.
:param name:
provider name / ID
:param version:
provider version
:param description:
provider version
This is the untranslated version of this field. Implementations may
obtain the localized version based on the gettext_domain property.
:param secure:
secure bit
When True jobs from this provider should be available via the
trusted launcher mechanism. It should be set to True for
system-wide installed providers.
:param gettext_domain:
gettext domain that contains translations for this provider
:param jobs_dir:
path of the directory with job definitions
:param whitelists_dir:
path of the directory with whitelists definitions (aka test-plans)
:param data_dir:
path of the directory with files used by jobs at runtime
:param bin_dir:
path of the directory with additional executables
:param locale_dir:
path of the directory with locale database (translation catalogs)
:param base_dir:
path of the directory with (perhaps) all of jobs_dir,
whitelist_dir, data_dir, bin_dir, locale_dir. This may be None.
This is also the effective value of $CHECKBOX_SHARE
:param validate:
Enable job validation. Incorrect job definitions will not be loaded
and will abort the process of loading of the remainder of the jobs.
This is ON by default to prevent broken job definitions from being
used. This is a keyword-only argument.
:param validation_kwargs:
Keyword arguments to pass to the JobDefinition.validate(). Note,
this is a single argument. This is a keyword-only argument.
"""
# Meta-data
self._name = name
self._version = version
self._description = description
self._secure = secure
self._gettext_domain = gettext_domain
# Directories
self._jobs_dir = jobs_dir
self._whitelists_dir = whitelists_dir
self._data_dir = data_dir
self._bin_dir = bin_dir
self._locale_dir = locale_dir
self._base_dir = base_dir
# Loaded data
if self.whitelists_dir is not None:
whitelists_dir_list = [self.whitelists_dir]
else:
whitelists_dir_list = []
self._whitelist_collection = FsPlugInCollection(
whitelists_dir_list, ext=".whitelist", wrapper=WhiteListPlugIn,
implicit_namespace=self.namespace)
if self.jobs_dir is not None:
jobs_dir_list = [self.jobs_dir]
else:
jobs_dir_list = []
self._job_collection = FsPlugInCollection(
jobs_dir_list, ext=(".txt", ".txt.in"),
wrapper=JobDefinitionPlugIn, provider=self,
validate=validate, validation_kwargs=validation_kwargs)
# Setup translations
if gettext_domain and locale_dir:
gettext.bindtextdomain(self._gettext_domain, self._locale_dir)
@classmethod
def from_definition(cls, definition, secure, *, validate=True,
validation_kwargs=None):
"""
Initialize a provider from Provider1Definition object
:param definition:
A Provider1Definition object to use as reference
:param secure:
Value of the secure flag. This cannot be expressed by a definition
object.
:param validate:
Enable job validation. Incorrect job definitions will not be loaded
and will abort the process of loading of the remainder of the jobs.
This is ON by default to prevent broken job definitions from being
used. This is a keyword-only argument.
:param validation_kwargs:
Keyword arguments to pass to the JobDefinition.validate(). Note,
this is a single argument. This is a keyword-only argument.
This method simplifies initialization of a Provider1 object where the
caller already has a Provider1Definition object. Depending on the value
of ``definition.location`` all of the directories are either None or
initialized to a *good* (typical) value relative to *location*
The only value that you may want to adjust, for working with source
providers, is *locale_dir*, by default it would be ``location/locale``
but ``manage.py i18n`` creates ``location/build/mo``
"""
logger.debug("Loading provider from definition %r", definition)
# Initialize the provider object
return cls(
definition.name, definition.version, definition.description,
secure, definition.effective_gettext_domain,
definition.effective_jobs_dir, definition.effective_whitelists_dir,
definition.effective_data_dir, definition.effective_bin_dir,
definition.effective_locale_dir, definition.location or None,
validate=validate, validation_kwargs=validation_kwargs)
def __repr__(self):
return "<{} name:{!r}>".format(self.__class__.__name__, self.name)
@property
def name(self):
"""
name of this provider
"""
return self._name
@property
def namespace(self):
"""
namespace component of the provider name
This property defines the namespace in which all provider jobs are
defined in. Jobs within one namespace do not need to be fully qualified
by prefixing their partial identifier with provider namespace (so all
stays 'as-is'). Jobs that need to interact with other provider
namespaces need to use the fully qualified job identifier instead.
The identifier is defined as the part of the provider name, up to the
colon. This effectively gives organizations flat namespace within one
year-domain pair and allows to create private namespaces by using
sub-domains.
"""
return self._name.split(':', 1)[0]
@property
def version(self):
"""
version of this provider
"""
return self._version
@property
def description(self):
"""
description of this provider
"""
return self._description
def tr_description(self):
"""
Get the translated version of :meth:`description`
"""
return self.get_translated_data(self.description)
@property
def jobs_dir(self):
"""
absolute path of the jobs directory
"""
return self._jobs_dir
@property
def whitelists_dir(self):
"""
absolute path of the whitelist directory
"""
return self._whitelists_dir
@property
def data_dir(self):
"""
absolute path of the data directory
"""
return self._data_dir
@property
def bin_dir(self):
"""
absolute path of the bin directory
.. note::
The programs in that directory may not work without setting
PYTHONPATH and CHECKBOX_SHARE.
"""
return self._bin_dir
@property
def locale_dir(self):
"""
absolute path of the directory with locale data
The value is applicable as argument bindtextdomain()
"""
return self._locale_dir
@property
def base_dir(self):
"""
path of the directory with (perhaps) all of jobs_dir, whitelist_dir,
data_dir, bin_dir, locale_dir. This may be None
"""
return self._base_dir
@property
def build_bin_dir(self):
"""
absolute path of the build/bin directory
This value may be None. It depends on location/base_dir being set.
"""
if self.base_dir is not None:
return os.path.join(self.base_dir, 'build', 'bin')
@property
def src_dir(self):
"""
absolute path of the src/ directory
This value may be None. It depends on location/base_dir set.
"""
if self.base_dir is not None:
return os.path.join(self.base_dir, 'src')
@property
def CHECKBOX_SHARE(self):
"""
required value of CHECKBOX_SHARE environment variable.
.. note::
This variable is only required by one script.
It would be nice to remove this later on.
"""
return self.base_dir
@property
def extra_PYTHONPATH(self):
"""
additional entry for PYTHONPATH, if needed.
This entry is required for CheckBox scripts to import the correct
CheckBox python libraries.
.. note::
The result may be None
"""
return None
@property
def secure(self):
"""
flag indicating that this provider was loaded from the secure portion
of PROVIDERPATH and thus can be used with the
plainbox-trusted-launcher-1.
"""
return self._secure
@property
def gettext_domain(self):
"""
the name of the gettext domain associated with this provider
This value may be empty, in such case provider data cannot be localized
for the user environment.
"""
return self._gettext_domain
def get_builtin_whitelists(self):
"""
Load all the whitelists from :attr:`whitelists_dir` and return them
This method looks at the whitelist directory and loads all files ending
with .whitelist as a WhiteList object.
:returns:
A list of :class:`~plainbox.impl.secure.qualifiers.WhiteList`
objects sorted by
:attr:`plainbox.impl.secure.qualifiers.WhiteList.name`.
:raises IOError, OSError:
if there were any problems accessing files or directories. Note
that OSError is silently ignored when the `whitelists_dir`
directory is missing.
"""
self._whitelist_collection.load()
if self._whitelist_collection.problem_list:
raise self._whitelist_collection.problem_list[0]
else:
return sorted(self._whitelist_collection.get_all_plugin_objects(),
key=lambda whitelist: whitelist.name)
def get_builtin_jobs(self):
"""
Load and parse all of the job definitions of this provider.
:returns:
A sorted list of JobDefinition objects
:raises RFC822SyntaxError:
if any of the loaded files was not valid RFC822
:raises IOError, OSError:
if there were any problems accessing files or directories.
Note that OSError is silently ignored when the `jobs_dir`
directory is missing.
..note::
This method should not be used anymore. Consider transitioning your
code to :meth:`load_all_jobs()` which is more reliable.
"""
job_list, problem_list = self.load_all_jobs()
if problem_list:
raise problem_list[0]
else:
return job_list
def load_all_jobs(self):
"""
Load and parse all of the job definitions of this provider.
Unlike :meth:`get_builtin_jobs()` this method does not stop after the
first problem encountered and instead collects all of the problems into
a list which is returned alongside the job list.
:returns:
Pair (job_list, problem_list) where each job_list is a sorted list
of JobDefinition objects and each item from problem_list is an
exception.
"""
self._job_collection.load()
job_list = sorted(
itertools.chain(
*self._job_collection.get_all_plugin_objects()),
key=lambda job: job.id)
problem_list = self._job_collection.problem_list
return job_list, problem_list
def get_all_executables(self):
"""
Discover and return all executables offered by this provider
:returns:
list of executable names (without the full path)
:raises IOError, OSError:
if there were any problems accessing files or directories. Note
that OSError is silently ignored when the `bin_dir` directory is
missing.
"""
return sorted(
self._get_executables(self.bin_dir) +
self._get_build_bin_executable_list())
def _get_build_bin_executable_list(self):
"""
Discover executables that are a part of the build/bin directory.
The build/bin directory may contain nothing, standalone executables or
a whole mess of build artifacts, only some of which are relevant. This
method implements the following algorithm:
* If the src/EXECUTABLES file exists then it must contain the name
of each executable relative to the build/bin directory (typically
just the name)
* Otherwise all executable files from the build/bin directory are
returned
"""
if self.src_dir is not None:
hint_file = os.path.join(self.src_dir, 'EXECUTABLES')
if os.path.isfile(hint_file):
with open(hint_file, "rt", encoding='UTF-8') as stream:
return [os.path.join(self.build_bin_dir, line.strip())
for line in stream if line.strip()]
return self._get_executables(self.build_bin_dir)
def _get_executables(self, dirname):
executable_list = []
if dirname is None:
return executable_list
try:
items = os.listdir(dirname)
except OSError as exc:
if exc.errno == errno.ENOENT:
items = []
else:
raise
for name in items:
filename = os.path.join(dirname, name)
if os.access(filename, os.F_OK | os.X_OK):
executable_list.append(filename)
return executable_list
def get_translated_data(self, msgid):
"""
Get a localized piece of data
:param msgid:
data to translate
:returns:
translated data obtained from the provider if msgid is not False
(empty string and None both are) and this provider has a
gettext_domain defined for it, msgid itself otherwise.
"""
if msgid and self._gettext_domain:
return gettext.dgettext(self._gettext_domain, msgid)
else:
return msgid
class IQNValidator(PatternValidator):
"""
A validator for provider name.
Provider names use a RFC3720 IQN-like identifiers composed of the follwing
parts:
* year
* (dot separating the next section)
* domain name
* (colon separating the next section)
* identifier
Each of the fields has an informal definition below:
year:
four digit number
domain name:
identifiers separated by dots, at least one dot has to be present
identifier:
`[a-z][a-z0-9-]*`
"""
def __init__(self):
super(IQNValidator, self).__init__(
"^[0-9]{4}\.[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+:[a-z][a-z0-9-]*$")
def __call__(self, variable, new_value):
if super(IQNValidator, self).__call__(variable, new_value):
return _("must look like RFC3720 IQN")
class VersionValidator(PatternValidator):
"""
A validator for provider provider version.
Provider version must be a sequence of non-negative numbers separated by
dots. At most one version number must be present, which may be followed by
any sub-versions.
"""
def __init__(self):
super().__init__("^[0-9]+(\.[0-9]+)*$")
def __call__(self, variable, new_value):
if super().__call__(variable, new_value):
return _("must be a sequence of digits separated by dots")
class ExistingDirectoryValidator(IValidator):
"""
A validator that checks that the value points to an existing directory
"""
def __call__(self, variable, new_value):
if not os.path.isdir(new_value):
return _("no such directory")
class AbsolutePathValidator(IValidator):
"""
A validator that checks that the value is an absolute path
"""
def __call__(self, variable, new_value):
if not os.path.isabs(new_value):
return _("cannot be relative")
class Provider1Definition(Config):
"""
A Config-like class for parsing plainbox provider definition files
.. note::
The location attribute is special, if set, it defines the base
directory of *all* the other directory attributes. If location is
unset, then all the directory attributes default to None (that is,
there is no directory of that type). This is actually a convention that
is implemented in :class:`Provider1PlugIn`. Here, all the attributes
can be Unset and their validators only check values other than Unset.
"""
location = Variable(
section='PlainBox Provider',
help_text=_("Base directory with provider data"),
validator_list=[
# NOTE: it *can* be unset!
NotEmptyValidator(),
AbsolutePathValidator(),
ExistingDirectoryValidator(),
])
name = Variable(
section='PlainBox Provider',
help_text=_("Name of the provider"),
validator_list=[
NotUnsetValidator(),
NotEmptyValidator(),
IQNValidator(),
])
@property
def name_without_colon(self):
return self.name.replace(':', '.')
version = Variable(
section='PlainBox Provider',
help_text=_("Version of the provider"),
validator_list=[
NotUnsetValidator(),
NotEmptyValidator(),
VersionValidator(),
])
description = Variable(
section='PlainBox Provider',
help_text=_("Description of the provider"))
gettext_domain = Variable(
section='PlainBox Provider',
help_text=_("Name of the gettext domain for translations"),
validator_list=[
# NOTE: it *can* be unset!
PatternValidator("[a-z0-9_-]+"),
])
@property
def effective_gettext_domain(self):
"""
effective value of gettext_domian
The effective value is :meth:`gettex_domain` itself, unless it is
Unset. If it is Unset the effective value None.
"""
if self.gettext_domain is not Unset:
return self.gettext_domain
jobs_dir = Variable(
section='PlainBox Provider',
help_text=_("Pathname of the directory with job definitions"),
validator_list=[
# NOTE: it *can* be unset
NotEmptyValidator(),
AbsolutePathValidator(),
ExistingDirectoryValidator(),
])
@property
def implicit_jobs_dir(self):
"""
implicit value of jobs_dir (if Unset)
The implicit value is only defined if location is not Unset. It is the
'jobs' subdirectory of the directory that location points to.
"""
if self.location is not Unset:
return os.path.join(self.location, "jobs")
@property
def effective_jobs_dir(self):
"""
effective value of jobs_dir
The effective value is :meth:`jobs_dir` itself, unless it is Unset. If
it is Unset the effective value is the :meth:`implicit_jobs_dir`, if
that value would be valid. The effective value may be None.
"""
if self.jobs_dir is not Unset:
return self.jobs_dir
implicit = self.implicit_jobs_dir
if implicit is not None and os.path.isdir(implicit):
return implicit
whitelists_dir = Variable(
section='PlainBox Provider',
help_text=_("Pathname of the directory with whitelists definitions"),
validator_list=[
# NOTE: it *can* be unset
NotEmptyValidator(),
AbsolutePathValidator(),
ExistingDirectoryValidator(),
])
@property
def implicit_whitelists_dir(self):
"""
implicit value of whitelists_dir (if Unset)
The implicit value is only defined if location is not Unset. It is the
'whitelists' subdirectory of the directory that location points to.
"""
if self.location is not Unset:
return os.path.join(self.location, "whitelists")
@property
def effective_whitelists_dir(self):
"""
effective value of whitelists_dir
The effective value is :meth:`whitelists_dir` itself, unless it is
Unset. If it is Unset the effective value is the
:meth:`implicit_whitelists_dir`, if that value would be valid. The
effective value may be None.
"""
if self.whitelists_dir is not Unset:
return self.whitelists_dir
implicit = self.implicit_whitelists_dir
if implicit is not None and os.path.isdir(implicit):
return implicit
data_dir = Variable(
section='PlainBox Provider',
help_text=_("Pathname of the directory with provider data"),
validator_list=[
# NOTE: it *can* be unset
NotEmptyValidator(),
AbsolutePathValidator(),
ExistingDirectoryValidator(),
])
@property
def implicit_data_dir(self):
"""
implicit value of data_dir (if Unset)
The implicit value is only defined if location is not Unset. It is the
'data' subdirectory of the directory that location points to.
"""
if self.location is not Unset:
return os.path.join(self.location, "data")
@property
def effective_data_dir(self):
"""
effective value of data_dir
The effective value is :meth:`data_dir` itself, unless it is Unset. If
it is Unset the effective value is the :meth:`implicit_data_dir`, if
that value would be valid. The effective value may be None.
"""
if self.data_dir is not Unset:
return self.data_dir
implicit = self.implicit_data_dir
if implicit is not None and os.path.isdir(implicit):
return implicit
bin_dir = Variable(
section='PlainBox Provider',
help_text=_("Pathname of the directory with provider executables"),
validator_list=[
# NOTE: it *can* be unset
NotEmptyValidator(),
AbsolutePathValidator(),
ExistingDirectoryValidator(),
])
@property
def implicit_bin_dir(self):
"""
implicit value of bin_dir (if Unset)
The implicit value is only defined if location is not Unset. It is the
'bin' subdirectory of the directory that location points to.
"""
if self.location is not Unset:
return os.path.join(self.location, "bin")
@property
def effective_bin_dir(self):
"""
effective value of bin_dir
The effective value is :meth:`bin_dir` itself, unless it is Unset. If
it is Unset the effective value is the :meth:`implicit_bin_dir`, if
that value would be valid. The effective value may be None.
"""
if self.bin_dir is not Unset:
return self.bin_dir
implicit = self.implicit_bin_dir
if implicit is not None and os.path.isdir(implicit):
return implicit
locale_dir = Variable(
section='PlainBox Provider',
help_text=_("Pathname of the directory with locale data"),
validator_list=[
# NOTE: it *can* be unset
NotEmptyValidator(),
AbsolutePathValidator(),
ExistingDirectoryValidator(),
])
@property
def implicit_locale_dir(self):
"""
implicit value of locale_dir (if Unset)
The implicit value is only defined if location is not Unset. It is the
'locale' subdirectory of the directory that location points to.
"""
if self.location is not Unset:
return os.path.join(self.location, "locale")
@property
def implicit_build_locale_dir(self):
"""
implicit value of locale_dir (if Unset) as laid out in the source tree
This value is only applicable to source layouts, where the built
translation catalogs are in the build/mo directory.
"""
if self.location is not Unset:
return os.path.join(self.location, "build", "mo")
@property
def effective_locale_dir(self):
"""
effective value of locale_dir
The effective value is :meth:`locale_dir` itself, unless it is Unset.
If it is Unset the effective value is the :meth:`implicit_locale_dir`,
if that value would be valid. The effective value may be None.
"""
if self.locale_dir is not Unset:
return self.locale_dir
implicit1 = self.implicit_locale_dir
if implicit1 is not None and os.path.isdir(implicit1):
return implicit1
implicit2 = self.implicit_build_locale_dir
if implicit2 is not None and os.path.isdir(implicit2):
return implicit2
class Provider1PlugIn(IPlugIn):
"""
A specialized IPlugIn that loads Provider1 instances from their definition
files
"""
def __init__(self, filename, definition_text):
"""
Initialize the plug-in with the specified name and external object
"""
definition = Provider1Definition()
# Load the provider definition
definition.read_string(definition_text)
# any validation issues prevent plugin from being used
if definition.problem_list:
# take the earliest problem and report it
exc = definition.problem_list[0]
raise PlugInError(
_("Problem in provider definition, field {!a}: {}").format(
exc.variable.name, exc.message))
# Get the secure flag
secure = os.path.dirname(filename) in get_secure_PROVIDERPATH_list()
# Initialize the provider object
self._provider = Provider1.from_definition(definition, secure)
def __repr__(self):
return "<{!s} plugin_name:{!r}>".format(
type(self).__name__, self.plugin_name)
@property
def plugin_name(self):
"""
plugin name, the namespace of the provider
"""
return self._provider.name
@property
def plugin_object(self):
"""
plugin object, the actual Provider1 instance
"""
return self._provider
def get_secure_PROVIDERPATH_list():
"""
Computes the secure value of PROVIDERPATH
This value is used by `plainbox-trusted-launcher-1` executable to discover
all secure providers.
:returns:
A list of two strings:
* `/usr/local/share/plainbox-providers-1`
* `/usr/share/plainbox-providers-1`
"""
return ["/usr/local/share/plainbox-providers-1",
"/usr/share/plainbox-providers-1"]
class SecureProvider1PlugInCollection(FsPlugInCollection):
"""
A collection of v1 provider plugins.
This FsPlugInCollection subclass carries proper, built-in defaults, that
make loading providers easier.
This particular class loads providers from the system-wide managed
locations. This defines the security boundary, as if someone can compromise
those locations then they already own the corresponding system. In
consequence this plug in collection does not respect ``PROVIDERPATH``, it
cannot be customized to load provider definitions from any other location.
This feature is supported by the
:class:`plainbox.impl.providers.v1.InsecureProvider1PlugInCollection`
"""
def __init__(self):
dir_list = get_secure_PROVIDERPATH_list()
super().__init__(dir_list, '.provider', wrapper=Provider1PlugIn)
# Collection of all providers
all_providers = SecureProvider1PlugInCollection()
|