:mod:`magpie.permissions` ========================= .. py:module:: magpie.permissions Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: magpie.permissions.Permission magpie.permissions.PermissionType magpie.permissions.Access magpie.permissions.Scope magpie.permissions.PermissionSet Functions ~~~~~~~~~ .. autoapisummary:: magpie.permissions.format_permissions .. data:: PERMISSION_REASON_DEFAULT :annotation: = no-permission .. data:: PERMISSION_REASON_MULTIPLE :annotation: = multiple .. data:: PERMISSION_REASON_ADMIN :annotation: = administrator .. class:: Permission Bases: :class:`magpie.utils.ExtendedEnum` Applicable :term:`Permission` values (names) under certain :term:`Service` and :term:`Resource`. .. attribute:: READ :annotation: = read .. attribute:: WRITE :annotation: = write .. attribute:: ACCESS :annotation: = access .. attribute:: BROWSE :annotation: = browse .. attribute:: GET_CAPABILITIES :annotation: = getcapabilities .. attribute:: GET_MAP :annotation: = getmap .. attribute:: GET_FEATURE_INFO :annotation: = getfeatureinfo .. attribute:: GET_LEGEND_GRAPHIC :annotation: = getlegendgraphic .. attribute:: GET_METADATA :annotation: = getmetadata .. attribute:: GET_FEATURE :annotation: = getfeature .. attribute:: DESCRIBE_FEATURE_TYPE :annotation: = describefeaturetype .. attribute:: DESCRIBE_PROCESS :annotation: = describeprocess .. attribute:: EXECUTE :annotation: = execute .. attribute:: LOCK_FEATURE :annotation: = lockfeature .. attribute:: TRANSACTION :annotation: = transaction .. class:: PermissionType Bases: :class:`magpie.utils.ExtendedEnum` Applicable types of :term:`Permission` according to context. .. attribute:: ACCESS :annotation: = access .. attribute:: ALLOWED :annotation: = allowed .. attribute:: APPLIED :annotation: = applied .. attribute:: DIRECT :annotation: = direct .. attribute:: INHERITED :annotation: = inherited .. attribute:: EFFECTIVE :annotation: = effective .. attribute:: OWNED :annotation: = owned .. class:: Access Bases: :class:`magpie.utils.ExtendedEnum` Applicable access modifier of :term:`Permission` values. .. attribute:: ALLOW :annotation: = allow .. attribute:: DENY :annotation: = deny .. class:: Scope Bases: :class:`magpie.utils.ExtendedEnum` Applicable access modifier of :term:`Permission` values. .. attribute:: MATCH :annotation: = match .. attribute:: RECURSIVE :annotation: = recursive .. class:: PermissionSet(permission: magpie.typedefs.AnyPermissionType, access: Optional[Union[Access, Str]] = None, scope: Optional[Union[Scope, Str]] = None, typ: Optional[PermissionType] = None, reason: Optional[Str] = None) Bases: :class:`object` Explicit definition of a :class:`Permission` with applicable :class:`Access` and :class:`Scope` to resolve it. The :class:`Permission` is the *name* of the applicable permission on the :class:`magpie.models.Resource`. The :class:`Scope` defines how the :class:`Permission` should impact the resolution of the perceived :term:`Effective Permissions` over a :class:`magpie.models.Resource` tree hierarchy. The :class:`Access` defines how the :class:`Permission` access should be interpreted (granted or denied). Optionally, a :class:`PermissionType` can be provided to specifically indicate which kind of permission this set represents. This type is only for informative purposes, and is not saved to database nor displayed by the explicit string representation. It is returned within JSON representation and can be employed by :term:`Effective Permissions` resolution to be more verbose about returned results. On missing :class:`Access` or :class:`Scope` specifications, they default to :attr:`Access.ALLOW` and :attr:`Scope.RECURSIVE` to handle backward compatible naming convention of plain ``permission_name``. Initializes the permission definition, possibly using required conversion from other implementations. :param permission: Name of the permission, or any other implementation from which the name can be inferred. :param access: Effective behaviour of the permissions. Generally, grant or deny the specified permission. :param scope: Scope for which the permission affects hierarchical resources. Important for effective resolution. :param typ: Type of permission being represented. Informative only, does not impact behavior if omitted. :param reason: Slightly more indicative information on why the current permission-type has this value. Value should be either explicitly provided or will be inferred if converted from input PermissionTuple. .. seealso:: :meth:`PermissionSet._convert` .. attribute:: __slots__ :annotation: = ['_name', '_access', '_scope', '_tuple', '_type', '_reason'] .. attribute:: permission .. method:: __eq__(self: Any, other) -> bool Return self==value. .. method:: __ne__(self: Any, other) -> bool Return self!=value. .. method:: __lt__(self: Any, other) -> bool Ascending sort of permission according to their name, access and scope modifiers. First sort by permission name alphabetically, followed by increasing *restrictive access* and increasing *range of scoped resources*. Using this sorting methodology, similar permissions by name are grouped together first, and permissions of same name with modifiers are then ordered, the first having less priority when selecting a single item to display with conflicting possibilities. Respecting :attr:`Access.DENY` is more important than :attr:`Access.ALLOW` (to protect the :term:`Resource`), and :attr:`Scope.MATCH` is *closer* to the actual :term:`Resource` than :attr:`Scope.RECURSIVE` permission received from a *farther* parent in the hierarchy. Explicitly, sorted explicit string representation becomes:: [name1]-[allow]-[match] [name1]-[allow]-[recursive] [name1]-[deny]-[match] [name1]-[deny]-[recursive] [name2]-[allow]-[match] [name2]-[allow]-[recursive] [name2]-[deny]-[match] [name2]-[deny]-[recursive] ... We then obtain two **crucial** ordering results: 1. We can easily pick the last sorted item with highest resolution priority to find the final result of corresponding permissions. (note: final result for same user or group, their direct/inherited resolution is not considered here). 2. Picking the first element with lowest priority also displays the permission that impacts the widest range of resources. For instance in Magpie UI, indicating that a permission as :attr:`Scope.RECURSIVE` is more verbose as it tell other resources under it are also receive the specified :class:`Access` modifier rather than only the punctual resource. .. warning:: Alphabetically sorting permissions by string representation (implicit/explicit) is not equivalent to sorting them according to :term:`Permission` priority according to how modifiers are resolved. To obtain the prioritized sorting as strings, a list of :class:`PermissionSet` (with the strings as input) should be used to convert and correctly interpreted the raw strings, and then be converted back after sorting. .. code-block:: python # valid priority-sorted strings [str(perm) for perm in sorted(PermissionSet(p) for p in permission_strings)] # not equivalent to raw sorting list(sorted(permission_strings)) .. method:: __hash__(self) -> int Return hash(self). .. method:: __str__(self) -> magpie.typedefs.Str Obtains the compound literal representation of the :class:`PermissionSet`. Employed for database storage supporting ``ziggurat`` format. .. method:: __repr__(self) -> magpie.typedefs.Str Obtains the visual representation of the :class:`PermissionSet`. .. method:: like(self, other) Evaluates if one permission is *similar* to another permission definition regardless of *modifiers*. This is different than ``==`` operator which will evaluate *exactly* equal permission definitions. .. method:: json(self) -> magpie.typedefs.PermissionObject Obtains the JSON representation of this :class:`PermissionSet`. .. method:: ace(self: Optional[Union[models.User, models.Group]], user_or_group) -> magpie.typedefs.AccessControlEntryType Converts the :class:`PermissionSet` into an :term:`ACE` that :mod:`pyramid` can understand. .. method:: reason(self) -> Optional[Str] :property: Indicative reason of the returned value defined by :meth:`type` or inferred by the :class:`PermissionTuple`. .. seealso:: :meth:`combine` :returns: Single string that describes the reason (source) of the permission, or multiple strings if updated by combination of multiple permissions. .. method:: resolve(cls, permission1: magpie.typedefs.ResolvablePermissionType, permission2: magpie.typedefs.ResolvablePermissionType, context: magpie.permissions.PermissionType = PermissionType.INHERITED, multiple_choice: Optional[ResolvablePermissionType] = None) -> magpie.typedefs.ResolvablePermissionType :classmethod: Resolves provided permissions into a single one considering various modifiers and groups for a resource. Permissions **MUST** have the same :term:`Permission` name. By default (using :paramref:`same_resources`), the associated :term:`Resource` on which the two compared permissions are applied on should also be the same (especially during local :term:`Inherited Permissions` resolution). This safeguard must be disabled for :term:`Effective Permissions` that specifically handles multi-level :term:`Resource` resolution. The comparison considers both the :class:`Access` and :class:`Scope` of :term:`Inherited Permissions` of the :term:`User`, as well as its :term:`Group` memberships sorted by their priority. .. seealso:: - :meth:`magpie.services.ServiceInterface.effective_permissions` - :func:`magpie.api.management.users.user_utils.combine_user_group_permissions` - :meth:`PermissionSet.__lt__` .. method:: group_priority(self) -> Optional[GroupPriority] :property: Priority accessor in case of group inherited permission resolved by :class:`PermissionTuple`. .. method:: perm_tuple(self) -> Optional[PermissionTuple] :property: Get the original :class:`PermissionTuple` if available (:class:`PermissionSet` must have been created by one). .. method:: implicit_permission(self) -> Optional[Str] :property: Obtain the implicit string representation of the :class:`PermissionSet` as plain :class:`Permission` name. This representation is backward compatible with prior versions of `Magpie` where explicit representation of permission names in the database did not exist. If the contained modifiers of the :class:`PermissionSet` (notably the :attr:`Access.DENY`) result in a string representation that is *not possible* according to non existing permissions for older `Magpie` instances, the returned value will be ``None``. .. seealso:: - :meth:`explicit_permission` for the new representation. .. method:: explicit_permission(self) -> magpie.typedefs.Str :property: Obtain the explicit string representation of the :class:`PermissionSet`. This format is always guaranteed to be completely defined contrary to :meth:`implicit_permission`. .. seealso:: - :meth:`__str__` (default string value). - :meth:`implicit_permission` for the old representation. .. method:: name(self) -> magpie.permissions.Permission :property: .. method:: access(self) -> magpie.permissions.Access :property: .. method:: scope(self) -> magpie.permissions.Scope :property: .. method:: type(self) -> Optional[PermissionType] :property: .. method:: _convert(cls: magpie.typedefs.AnyPermissionType, permission) -> Optional[PermissionSet] :classmethod: Converts any permission representation to the :class:`PermissionSet` with applicable enum members. Supports older :class:`Permission` representation such that implicit conversion of permission name without :attr:`access` and :attr:`scope` values are padded with defaults. Also, pre-defined partial or full definition from literal string representation are parsed to generate the :class:`PermissionSet` instance. :param permission: implicit or explicit permission name string, or any other known permission implementation :raises ValueError: when the permission name cannot be identified or parsed .. function:: format_permissions(permissions: Optional[Collection[AnyPermissionType]], permission_type: Optional[PermissionType] = None, force_unique: bool = True) -> Dict[(Str, Union[List[Str], PermissionObject, Str])] Obtains the formatted permission representations after validation that each of their name is a known member of :class:`Permission` enum, and optionally with modifiers as defined by :class:`PermissionSet`. The returned lists are sorted alphabetically by permission *name*, and then in order of resolution priority (from highest to lowest) for each subset or corresponding *name*. The permissions are cleaned from any duplicate entries, unless :paramref:`force_unique` is specified to allow it. If no or empty :paramref:`permissions` is provided, empty lists are returned. .. note:: Field ``permission_names`` provides both the *older* implicit permission names and the *newer* explicit name representation. For this reason, there will be semantically "duplicate" permissions in that list, but there will not be any literal string duplicates. Implicit names are immediately followed by their explicit name, unless implicit names do not apply for the given permission (e.g.: when :attr:`Access.DENY` did not exist). Only detailed and explicit JSON representations are provided in the ``permissions`` list. When :paramref:`permission_type` is equal to :attr:`PermissionType.ALLOWED`, the collection of every applicable :class:`PermissionSet` is automatically generated by expanding all combinations of :class:`Access` and :class:`Scope` with every provided :class:`Permission` name in :paramref:`permissions`. This allows more concise definition of allowed permissions under :class:`magpie.services.Services` and their children :term:`Resource` by only defining :class:`Permission` names without manually listing all variations of :class:`PermissionSet`. For other :paramref:`permission_type` values, which represent :term:`Applied Permissions` only explicitly provided :paramref:`permissions` are returned, to effectively return the collection of *active* permissions. :param permissions: multiple permissions of any implementation and type, to be rendered both as names and JSON. :param permission_type: indication of the represented permissions to be formatted, for informative indication. :param force_unique: whether to remove duplicate entries by association of name, access and scope or not. :returns: JSON with the permissions listed as implicit+explicit names, as permission set objects, and their type.