magpie.services¶

Attributes¶

`LOGGER`
`SERVICE_TYPES`
`SERVICE_TYPE_DICT`

Classes¶

`ServiceMeta`
`ServiceInterface`	Initialize the service.
`ServiceOWS`	Generic request-to-permission interpretation method of various `OGC Web Service` (OWS) implementations.
`ServiceWPS`	Service that represents a `Web Processing Service` endpoint.
`ServiceBaseWMS`	Service that represents basic capabilities of a `Web Map Service` endpoint.
`ServiceNCWMS2`	Service that represents a `Web Map Service` endpoint with functionalities specific to `ncWMS2` .
`ServiceGeoserverBase`	Provides basic configuration parameters and functionalities shared by Geoserver implementations.
`ServiceGeoserverWMS`	Service that represents a Web Map Service endpoint with functionalities specific to Geoserver.
`ServiceAccess`	Initialize the service.
`ServiceAPI`	Service that provides resources per individual request path segments.
`ServiceWFS`	Service that represents a Web Feature Service endpoint.
`ServiceGeoserverWFS`	Service that represents a Web Feature Service endpoint with functionalities specific to Geoserver.
`ServiceTHREDDS`	Service that represents a THREDDS Data Server endpoint.
`ServiceGeoserverWPS`	Service that represents a Web Processing Service under a Geoserver instance.
`ServiceGeoserverAPI`	Service that represents a generic REST API under a Geoserver instance.
`ServiceGeoserver`	Service that encapsulates the multiple OWS endpoints from Geoserver services.

Functions¶

`service_factory`(→ ServiceInterface)	Retrieve the specific service class from the provided database service entry.
`get_resource_child_allowed`(→ bool)	Verifies if the specified resource allows nesting children resources under it considering its specific type.
`invalidate_service`(→ None)	Invalidates any caching reference to the specified service name.

Module Contents¶

magpie.services.LOGGER[source]¶

class magpie.services.ServiceMeta[source]¶

Bases: type

property resource_types: List[Type[magpie.models.Resource]][source]¶: Allowed resources type classes under the service.

property resource_type_names: List[magpie.typedefs.Str][source]¶: Allowed resources type names under the service.

property child_resource_allowed: bool[source]¶: Lists all resources allowed somewhere within its resource hierarchy under the service.

Note

Resources are not necessarily all allowed directly under the service. This depends on whether ServiceInterface.child_structure_allowed is defined or not. If not defined, resources are applicable anywhere. Otherwise, they must respect the explicit structure definitions.

See also

Use ServiceInterface.nested_resource_allowed() to obtain only scoped types allowed under a given resource considering allowed path structures.

class magpie.services.ServiceInterface(service: magpie.models.Service, request: pyramid.request.Request | None)[source]¶

Bases: object

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

property service_type: magpie.typedefs.Str | None[source]¶

Abstractmethod:

Service type identifier (required, unique across implementation).

permissions: List[magpie.permissions.Permission] = [][source]¶: Permission allowed directly on the service as top-level resource.

resource_types_permissions: magpie.typedefs.ResourceTypePermissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

child_structure_allowed: Dict[Type[magpie.typedefs.ServiceOrResourceType], List[Type[magpie.models.Resource]]][source]¶

Control mapping of resource types limiting the allowed structure of nested children resources.

When not defined, any nested resource type combination is allowed if they themselves allow children resources. Otherwise, nested child resource under the service can only be created at specific positions within the hierarchy that matches exactly one of the defined control conditions.

For example, the below definition allows only resources typed route directly under the service. The following nested resource under that first-level route can then be either another route followed by a child process or directly a process. Because process type doesn’t allow any children resource (see models.Process.child_resource_allowed), those are the only allowed combinations (cannot further nest resources under the final process resource).

child_structure_allowed = {
    models.Service: [models.Route],
    models.Route: [models.Route, models.Process],
    models.Process: [],
}

See also

Validation of allowed nested children resource insertion of a given type under a parent resource is provided by ServiceInterface.validate_nested_resource_type() that employs child_structure_allowed.
Listing of allowed resource types scoped under a given child resource within the hierarchy is provided by ServiceInterface.nested_resource_allowed().

_config: magpie.typedefs.ServiceConfiguration | None = None[source]¶

configurable = False[source]¶: Indicates if the service supports custom configuration.

service: magpie.models.Service[source]¶

request: pyramid.request.Request[source]¶

_flag_acl_cached: Dict[Tuple[magpie.typedefs.Str, magpie.typedefs.Str, magpie.typedefs.Str, int | None], bool][source]¶

__str__()[source]¶

abstract permission_requested() → magpie.typedefs.PermissionRequested[source]¶

Defines how to interpret the incoming request into Permission definitions for the given service.

Each service must implement its own definition. The method must specifically define how to convert generic request path, query, etc. elements into permissions that match the service and its children resources.

If None is returned, the ACL will effectively be resolved to denied access. Otherwise, one or more returned Permission will indicate which permissions should be looked for to resolve the ACL of the authenticated user and its groups.

If the request cannot be parsed for any reason to retrieve needed parameters (e.g.: Bad Request), the :exception:`HTTPBadRequest` can be raised to indicate specifically the cause, which will help magpie.adapter.magpieowssecurity.MagpieOWSSecurity create a better response with the relevant error details.

abstract resource_requested() → magpie.typedefs.MultiResourceRequested[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

user_requested()[source]¶: Obtain the User that was identified to obtain protected Resource access.

property __acl__: magpie.typedefs.AccessControlListType[source]¶

Access Control List (ACL) formed of ACE defining combinations rules to grant or refuse access.

Each ACE is defined as (outcome, user/group, permission) tuples. Called by the configured Pyramid pyramid.authorization.ACLAuthorizationPolicy.

Caching is automatically handled according to configured application settings and whether the specific ACL combination being requested was already processed recently.

_get_acl_cached(service_name: magpie.typedefs.Str, request_method: magpie.typedefs.Str, request_path: magpie.typedefs.Str, user_id: int | None) → magpie.typedefs.AccessControlListType[source]¶

Cache this method with beaker based on the provided caching key parameters.

If the cache is not hit (expired timeout or new key entry), calls ServiceInterface.get_acl() to retrieve effective permissions of the requested resource and specific permission for the applicable service and user executing the request.

Note

Function arguments are required to generate caching keys by which cached elements will be retrieved. Actual arguments are not needed as we employ stored objects in the instance.

Warning

Anything within this method or any underlying calls that can potentially retrieve database contents, whether for direct object or dynamically generated relationships (eg: user.groups) must attempt to reestablish any detached or invalid session/transaction due to the potentially desynchronized references between objects before/after both incoming service and this acl cache regions.

See also

ServiceInterface.permission_requested()
ServiceInterface.resource_requested()
ServiceInterface.user_requested()

_get_acl(user: magpie.models.User, resources: magpie.typedefs.MultiResourceRequested, permissions: Collection[magpie.permissions.Permission]) → magpie.typedefs.AccessControlListType[source]¶

Resolves resource-tree and user/group inherited permissions into simplified ACL of requested resources.

Contrary to effective_permissions() that can be resolved only for individual Resource, ACL is involved during actual request access, which could refer to multiple Resource references or distinct Permission names if the identified parent Service supports it.

When more than one item is specified for validation (any combination of Resource or Permission), ALL of them must be granted access to resolve as Access.ALLOW. Any denied access blocks the whole set of requested elements.

See also

Core Permission resolution rules of a single Resource using effective_permissions().
Support of multi-Resource references defined by returned values of resource_requested() for individual ServiceInterface implementations.

_get_connected_object(obj: magpie.typedefs.ServiceOrResourceType | magpie.models.User) → magpie.typedefs.ServiceOrResourceType | None[source]¶

Retrieve the object with an active session and attached state by refreshing connection with request session.

This operation is required mostly in cases of mismatching references between cached and active objects obtained according to timing of requests and whether caching took placed between them, and for different caching region levels (service, ACL or both). It also attempts to correct and encountered problems due to concurrent requests.

_get_request_path_parts() → List[magpie.typedefs.Str] | None[source]¶: Obtain the request path parts stripped of anything prior to the referenced service name.

get_config() → magpie.typedefs.ServiceConfiguration[source]¶: Obtains the custom configuration of the registered service.

classmethod get_resource_permissions(resource_type_name: magpie.typedefs.Str) → List[magpie.permissions.Permission][source]¶: Obtains the allowed permissions of the service’s child resource fetched by resource type name.

classmethod validate_nested_resource_type(parent_resource: magpie.typedefs.ServiceOrResourceType, child_resource_type: magpie.typedefs.Str) → bool[source]¶

Validate whether a new child resource type is allowed under the parent resource under the service.

Parameters:

parent_resource – Parent under which the new resource must be validated. This can be the service itself.
child_resource_type – Type to validate at the position defined under the parent resource.

Returns:

status indicating if insertion is allowed for this type and at this parent position.

classmethod nested_resource_allowed(parent_resource: magpie.typedefs.ServiceOrResourceType) → List[Type[magpie.models.Resource]][source]¶: Obtain the nested resource types allowed as children resource within structure definitions.

allowed_permissions(resource: magpie.typedefs.ServiceOrResourceType) → List[magpie.permissions.Permission][source]¶: Obtains the allowed permissions for or under the service according to provided service or resource.

effective_permissions(user: magpie.models.User, resource: magpie.typedefs.ServiceOrResourceType, permissions: Collection[magpie.permissions.Permission] | None = None, allow_match: bool = True) → List[magpie.permissions.PermissionSet][source]¶

Obtains the Effective Resolution of permissions the user has over the specified resource.

Recursively rewinds the resource tree from the specified resource up to the top-most parent service the resource resides under (or directly if the resource is the service) and retrieve permissions along the way that should be applied to children when using scoped-resource inheritance. Rewinding of the tree can terminate earlier when permissions can be immediately resolved such as when more restrictive conditions enforce denied access.

Both user and group permission inheritance is resolved simultaneously to tree hierarchy with corresponding allow and deny conditions. User Direct Permissions have priority over all its groups Inherited Permissions, and denied permissions have priority over allowed access ones.

All applicable permissions on the resource (as defined by allowed_permissions()) will have their resolution (Allow/Deny) provided as output, unless a specific subset of permissions is requested using permissions. Other permissions are ignored in this case to only resolve requested ones. For example, this parameter can be used to request only ACL resolution from specific permissions applicable for a given request, as obtained by permission_requested().

Permissions scoped as match can be ignored using allow_match, such as when the targeted resource does not exist.

See also

ServiceInterface.resource_requested()

Parameters:

user – User for which to perform Effective Resolution.
resource – Resource onto which access must be resolved.
permissions – List of Permission for which to perform the resolution.
allow_match – Indicate if the specific Resource was matched to allow Scope.MATCH handling.

Returns:

Resolved set Effective Permission for specified parameter combinations.

class magpie.services.ServiceOWS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceInterface

Generic request-to-permission interpretation method of various OGC Web Service (OWS) implementations.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

params_expected: List[magpie.typedefs.Str] = [][source]¶: Request query parameters that are expected and should be preprocessed by parsing the submitted request.

_request = None[source]¶

parser = None[source]¶

_get_request() → pyramid.request.Request[source]¶

_set_request(request: pyramid.request.Request) → None[source]¶

request[source]¶

abstract resource_requested() → magpie.typedefs.MultiResourceRequested[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

permission_requested() → magpie.typedefs.PermissionRequested[source]¶

Defines how to interpret the incoming request into Permission definitions for the given service.

Each service must implement its own definition. The method must specifically define how to convert generic request path, query, etc. elements into permissions that match the service and its children resources.

If None is returned, the ACL will effectively be resolved to denied access. Otherwise, one or more returned Permission will indicate which permissions should be looked for to resolve the ACL of the authenticated user and its groups.

If the request cannot be parsed for any reason to retrieve needed parameters (e.g.: Bad Request), the :exception:`HTTPBadRequest` can be raised to indicate specifically the cause, which will help magpie.adapter.magpieowssecurity.MagpieOWSSecurity create a better response with the relevant error details.

class magpie.services.ServiceWPS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceOWS

Service that represents a Web Processing Service endpoint.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_type = 'wps'[source]¶: Service type identifier (required, unique across implementation).

permissions[source]¶: Permission allowed directly on the service as top-level resource.

params_expected = ['service', 'request', 'version', 'identifier'][source]¶: Request query parameters that are expected and should be preprocessed by parsing the submitted request.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

resource_requested() → Tuple[magpie.typedefs.ServiceOrResourceType, bool] | None[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

class magpie.services.ServiceBaseWMS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceOWS

Service that represents basic capabilities of a Web Map Service endpoint.

See also

https://www.ogc.org/standards/wms (OpenGIS WMS 1.3.0 implementation)

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

abstract resource_requested()[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

permissions[source]¶: Permission allowed directly on the service as top-level resource.

params_expected = ['service', 'request', 'version', 'layers', 'layername', 'dataset'][source]¶: Request query parameters that are expected and should be preprocessed by parsing the submitted request.

class magpie.services.ServiceNCWMS2(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceBaseWMS

Service that represents a Web Map Service endpoint with functionalities specific to ncWMS2 .

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_type = 'ncwms'[source]¶: Service type identifier (required, unique across implementation).

permissions[source]¶: Permission allowed directly on the service as top-level resource.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

resource_requested() → Tuple[magpie.typedefs.ServiceOrResourceType, bool] | None[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

class magpie.services.ServiceGeoserverBase(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceOWS

Provides basic configuration parameters and functionalities shared by Geoserver implementations.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

property service_base: magpie.typedefs.Str[source]¶

Abstractmethod:

Name of the base OWS functionality serviced by Geoserver.

property resource_scoped: bool[source]¶

Classmethod:
Abstractmethod:

Indicates if the Service is allowed to employ scoped models.Workspace naming.

When allowed, the models.Workspace can be inferred from the request parameter defined by resource_param to retrieve scoped name as <WORKSPACE>:<RESOURCE>. When not allowed, the resource name is left untouched and Magpie will not attempt to infer any models.Workspace from it. In that case, models.Workspace can only be specified in the request path for isolated Resource references.

Note

When this parameter is False for a given Service implementation, children Resources can still be named in a similar <namespace>:<element> fashion. The only distinction is that the full Resource should include this complete definition instead of nesting <namespace> and <element> into two distinct Resources.

property resource_multi: bool[source]¶

Abstractmethod:

Indicates if the Service supports multiple simultaneous Resource references.

When supported, the value retrieved from resource_param can be comma-separated to represent multiple Resource of the same nature, which can all be retrieved with the same request. Otherwise, single value only is considered by default.

Note

Permission modifier Access.ALLOW will have to be resolved for all those Resource references for the request to be granted access.

property resource_param: magpie.typedefs.Str | List[magpie.typedefs.Str][source]¶

Abstractmethod:

Name of the request query parameter(s) to access requested leaf children resource.

If a single string is defined, the parameter must be equal to this value (case insensitive). When using a list, any specified name combination will be resolved as the same parameter.

Note

The resulting parameter(s) are automatically added to params_expected() to ensure they are always retrieved in the parser from the request query parameters.

See also

resource_param_requested() to obtain the resolved parameter considering any applicable combination.

property resource_types_permissions: magpie.typedefs.ResourceTypePermissions[source]¶

Abstractmethod:

Explicit permissions provided for resources for a given OWS implementation.

property params_expected: List[magpie.typedefs.Str][source]¶

Specify typical Geoserver request query parameters expected for any sub-service implementation.

The resource_param is also added to ensure it is always parsed based on the derived implementation.

resource_param_requested() → List[magpie.typedefs.Str][source]¶: Obtain the resolved value(s) of the resource query parameter from OWS parser applied onto the request.

resource_requested() → magpie.typedefs.MultiResourceRequested[source]¶: Parse the requested resource down to the applicable models.Workspace.

Note

Further child resource processing must be accomplished by the derived implementation as needed.

class magpie.services.ServiceGeoserverWMS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceGeoserverBase, ServiceBaseWMS

Service that represents a Web Map Service endpoint with functionalities specific to Geoserver.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_base = 'wms'[source]¶: Name of the base OWS functionality serviced by Geoserver.

service_type = 'geoserverwms'[source]¶: Service type identifier (required, unique across implementation).

resource_scoped = True[source]¶

Indicates if the Service is allowed to employ scoped models.Workspace naming.

When allowed, the models.Workspace can be inferred from the request parameter defined by resource_param to retrieve scoped name as <WORKSPACE>:<RESOURCE>. When not allowed, the resource name is left untouched and Magpie will not attempt to infer any models.Workspace from it. In that case, models.Workspace can only be specified in the request path for isolated Resource references.

Note

When this parameter is False for a given Service implementation, children Resources can still be named in a similar <namespace>:<element> fashion. The only distinction is that the full Resource should include this complete definition instead of nesting <namespace> and <element> into two distinct Resources.

resource_multi = True[source]¶

Indicates if the Service supports multiple simultaneous Resource references.

When supported, the value retrieved from resource_param can be comma-separated to represent multiple Resource of the same nature, which can all be retrieved with the same request. Otherwise, single value only is considered by default.

Note

Permission modifier Access.ALLOW will have to be resolved for all those Resource references for the request to be granted access.

resource_param = 'layers'[source]¶

Name of the request query parameter(s) to access requested leaf children resource.

If a single string is defined, the parameter must be equal to this value (case insensitive). When using a list, any specified name combination will be resolved as the same parameter.

Note

The resulting parameter(s) are automatically added to params_expected() to ensure they are always retrieved in the parser from the request query parameters.

See also

resource_param_requested() to obtain the resolved parameter considering any applicable combination.

permissions[source]¶: Permission allowed directly on the service as top-level resource.

child_structure_allowed[source]¶

Control mapping of resource types limiting the allowed structure of nested children resources.

When not defined, any nested resource type combination is allowed if they themselves allow children resources. Otherwise, nested child resource under the service can only be created at specific positions within the hierarchy that matches exactly one of the defined control conditions.

For example, the below definition allows only resources typed route directly under the service. The following nested resource under that first-level route can then be either another route followed by a child process or directly a process. Because process type doesn’t allow any children resource (see models.Process.child_resource_allowed), those are the only allowed combinations (cannot further nest resources under the final process resource).

child_structure_allowed = {
    models.Service: [models.Route],
    models.Route: [models.Route, models.Process],
    models.Process: [],
}

See also

Validation of allowed nested children resource insertion of a given type under a parent resource is provided by ServiceInterface.validate_nested_resource_type() that employs child_structure_allowed.
Listing of allowed resource types scoped under a given child resource within the hierarchy is provided by ServiceInterface.nested_resource_allowed().

resource_types_permissions[source]¶: Explicit permissions provided for resources for a given OWS implementation.

class magpie.services.ServiceAccess(service: magpie.models.Service, request: pyramid.request.Request | None)[source]¶

Bases: ServiceInterface

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_type = 'access'[source]¶: Service type identifier (required, unique across implementation).

permissions[source]¶: Permission allowed directly on the service as top-level resource.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

resource_requested() → magpie.typedefs.TargetResourceRequested[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

permission_requested() → magpie.typedefs.PermissionRequested[source]¶

Defines how to interpret the incoming request into Permission definitions for the given service.

Each service must implement its own definition. The method must specifically define how to convert generic request path, query, etc. elements into permissions that match the service and its children resources.

If None is returned, the ACL will effectively be resolved to denied access. Otherwise, one or more returned Permission will indicate which permissions should be looked for to resolve the ACL of the authenticated user and its groups.

If the request cannot be parsed for any reason to retrieve needed parameters (e.g.: Bad Request), the :exception:`HTTPBadRequest` can be raised to indicate specifically the cause, which will help magpie.adapter.magpieowssecurity.MagpieOWSSecurity create a better response with the relevant error details.

class magpie.services.ServiceAPI(service: magpie.models.Service, request: pyramid.request.Request | None)[source]¶

Bases: ServiceInterface

Service that provides resources per individual request path segments.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_type = 'api'[source]¶: Service type identifier (required, unique across implementation).

permissions[source]¶: Permission allowed directly on the service as top-level resource.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

child_structure_allowed[source]¶

Control mapping of resource types limiting the allowed structure of nested children resources.

When not defined, any nested resource type combination is allowed if they themselves allow children resources. Otherwise, nested child resource under the service can only be created at specific positions within the hierarchy that matches exactly one of the defined control conditions.

For example, the below definition allows only resources typed route directly under the service. The following nested resource under that first-level route can then be either another route followed by a child process or directly a process. Because process type doesn’t allow any children resource (see models.Process.child_resource_allowed), those are the only allowed combinations (cannot further nest resources under the final process resource).

child_structure_allowed = {
    models.Service: [models.Route],
    models.Route: [models.Route, models.Process],
    models.Process: [],
}

See also

Validation of allowed nested children resource insertion of a given type under a parent resource is provided by ServiceInterface.validate_nested_resource_type() that employs child_structure_allowed.
Listing of allowed resource types scoped under a given child resource within the hierarchy is provided by ServiceInterface.nested_resource_allowed().

resource_requested() → magpie.typedefs.TargetResourceRequested[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

permission_requested() → magpie.typedefs.PermissionRequested[source]¶

Defines how to interpret the incoming request into Permission definitions for the given service.

Each service must implement its own definition. The method must specifically define how to convert generic request path, query, etc. elements into permissions that match the service and its children resources.

If None is returned, the ACL will effectively be resolved to denied access. Otherwise, one or more returned Permission will indicate which permissions should be looked for to resolve the ACL of the authenticated user and its groups.

If the request cannot be parsed for any reason to retrieve needed parameters (e.g.: Bad Request), the :exception:`HTTPBadRequest` can be raised to indicate specifically the cause, which will help magpie.adapter.magpieowssecurity.MagpieOWSSecurity create a better response with the relevant error details.

class magpie.services.ServiceWFS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceOWS

Service that represents a Web Feature Service endpoint.

See also

https://www.ogc.org/standards/wfs (OpenGIS WFS 2.0.0 implementation)

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_type = 'wfs'[source]¶: Service type identifier (required, unique across implementation).

permissions[source]¶: Permission allowed directly on the service as top-level resource.

params_expected = ['service', 'request', 'version', 'typenames'][source]¶: Request query parameters that are expected and should be preprocessed by parsing the submitted request.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

resource_requested() → magpie.typedefs.TargetResourceRequested[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

class magpie.services.ServiceGeoserverWFS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceGeoserverBase, ServiceWFS

Service that represents a Web Feature Service endpoint with functionalities specific to Geoserver.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_base = 'wfs'[source]¶: Name of the base OWS functionality serviced by Geoserver.

service_type = 'geoserverwfs'[source]¶: Service type identifier (required, unique across implementation).

resource_scoped = True[source]¶

Indicates if the Service is allowed to employ scoped models.Workspace naming.

When allowed, the models.Workspace can be inferred from the request parameter defined by resource_param to retrieve scoped name as <WORKSPACE>:<RESOURCE>. When not allowed, the resource name is left untouched and Magpie will not attempt to infer any models.Workspace from it. In that case, models.Workspace can only be specified in the request path for isolated Resource references.

Note

When this parameter is False for a given Service implementation, children Resources can still be named in a similar <namespace>:<element> fashion. The only distinction is that the full Resource should include this complete definition instead of nesting <namespace> and <element> into two distinct Resources.

resource_multi = True[source]¶

Indicates if the Service supports multiple simultaneous Resource references.

When supported, the value retrieved from resource_param can be comma-separated to represent multiple Resource of the same nature, which can all be retrieved with the same request. Otherwise, single value only is considered by default.

Note

Permission modifier Access.ALLOW will have to be resolved for all those Resource references for the request to be granted access.

resource_param = ['typenames', 'typename'][source]¶

Name of the request query parameter(s) to access requested leaf children resource.

If a single string is defined, the parameter must be equal to this value (case insensitive). When using a list, any specified name combination will be resolved as the same parameter.

Note

The resulting parameter(s) are automatically added to params_expected() to ensure they are always retrieved in the parser from the request query parameters.

See also

resource_param_requested() to obtain the resolved parameter considering any applicable combination.

permissions[source]¶: Permission allowed directly on the service as top-level resource.

resource_types_permissions[source]¶: Explicit permissions provided for resources for a given OWS implementation.

child_structure_allowed[source]¶

Control mapping of resource types limiting the allowed structure of nested children resources.

When not defined, any nested resource type combination is allowed if they themselves allow children resources. Otherwise, nested child resource under the service can only be created at specific positions within the hierarchy that matches exactly one of the defined control conditions.

For example, the below definition allows only resources typed route directly under the service. The following nested resource under that first-level route can then be either another route followed by a child process or directly a process. Because process type doesn’t allow any children resource (see models.Process.child_resource_allowed), those are the only allowed combinations (cannot further nest resources under the final process resource).

child_structure_allowed = {
    models.Service: [models.Route],
    models.Route: [models.Route, models.Process],
    models.Process: [],
}

See also

Validation of allowed nested children resource insertion of a given type under a parent resource is provided by ServiceInterface.validate_nested_resource_type() that employs child_structure_allowed.
Listing of allowed resource types scoped under a given child resource within the hierarchy is provided by ServiceInterface.nested_resource_allowed().

class magpie.services.ServiceTHREDDS(service: magpie.models.Service, request: pyramid.request.Request | None)[source]¶

Bases: ServiceInterface

Service that represents a THREDDS Data Server endpoint.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_type = 'thredds'[source]¶: Service type identifier (required, unique across implementation).

permissions[source]¶: Permission allowed directly on the service as top-level resource.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

child_structure_allowed[source]¶

Control mapping of resource types limiting the allowed structure of nested children resources.

When not defined, any nested resource type combination is allowed if they themselves allow children resources. Otherwise, nested child resource under the service can only be created at specific positions within the hierarchy that matches exactly one of the defined control conditions.

For example, the below definition allows only resources typed route directly under the service. The following nested resource under that first-level route can then be either another route followed by a child process or directly a process. Because process type doesn’t allow any children resource (see models.Process.child_resource_allowed), those are the only allowed combinations (cannot further nest resources under the final process resource).

child_structure_allowed = {
    models.Service: [models.Route],
    models.Route: [models.Route, models.Process],
    models.Process: [],
}

See also

Validation of allowed nested children resource insertion of a given type under a parent resource is provided by ServiceInterface.validate_nested_resource_type() that employs child_structure_allowed.
Listing of allowed resource types scoped under a given child resource within the hierarchy is provided by ServiceInterface.nested_resource_allowed().

configurable = True[source]¶: Indicates if the service supports custom configuration.

get_config() → magpie.typedefs.ServiceConfiguration[source]¶: Obtains the custom configuration of the registered service.

get_path_parts() → List[magpie.typedefs.Str] | None[source]¶

_get_path_prefix_permission(path_parts: List[str]) → Tuple[magpie.typedefs.Str | None, magpie.typedefs.PermissionRequested][source]¶

static is_match(value: magpie.typedefs.Str, pattern: magpie.typedefs.Str) → magpie.typedefs.Str | None[source]¶

resource_requested() → magpie.typedefs.TargetResourceRequested[source]¶

Defines how to interpret the incoming request into the targeted model.Resource for the given service.

Each service must implement its own definition.

The expected return value must be either of the following:

- List<(target-resource, target?)>  When multiple resources need validation ('target?' as below for each).
- (target-resource, True)           when the exact resource is found according to request parsing.
- (parent-resource, False)          when any parent of the resource is found according to request parsing.
- None                              when invalid request or not found resource.

The parent-resource should indicate the closest higher-level resource in the hierarchy that would nest the otherwise desired target-resource. The idea behind this is that Magpie will be able to resolve the effective recursive scoped permission even if not all corresponding resources were explicitly defined in the database.

For example, if the request would be interpreted with the following hierarchy after service-specific resolution:

ServiceA
    Resource1         <== closest *existing* parent resource
        [Resource2]   <== target (according to service/request resolution), but not existing in database

A permission defined as Allow/Recursive on Resource1 should normally allow access to Resource2. If Resource2 is not present in the database though, it cannot be looked for, and the corresponding ACL cannot be generated. Because the (real) protected service using Magpie can have a large and dynamic hierarchy, it is not convenient to enforce perpetual sync between it and its resource representation in Magpie. Using (parent-resource, False) will allow resolution of permission from the closest available parent.

Note

In case of parent-resource returned, only recursive-scoped permissions will be considered, since the missing target-resource is the only one that should be checked for match-scoped permissions. For this reason, the service-specific implementation should preferably return the explicit target resource whenever possible.

If the returned resource is None, the ACL will effectively be resolved to denied access. This can be used to indicate failure to retrieve the expected resource or that corresponding resource does not exist. Otherwise, this method implementation should convert any request path, query parameters, etc. into an existing resource.

If a list of (target-resource, target?) is returned, all of those resources should individually perform Effective Resolution and should ALL simultaneously be granted access to let the request through. This can be used to resolve ambiguous or equivalent parameter combinations from parsing the request, or to validate access to parameters that allow multi-resource references using some kind of list value representation.

See also

_get_acl() for Effective Resolution of over multiple Resource references.
effective_permissions() for Effective Resolution of a single Resource.

Returns:: One or many tuple of reference resource (target/parent), and explicit match status of the corresponding resource (True/False)

permission_requested() → magpie.typedefs.PermissionRequested[source]¶

Defines how to interpret the incoming request into Permission definitions for the given service.

Each service must implement its own definition. The method must specifically define how to convert generic request path, query, etc. elements into permissions that match the service and its children resources.

If None is returned, the ACL will effectively be resolved to denied access. Otherwise, one or more returned Permission will indicate which permissions should be looked for to resolve the ACL of the authenticated user and its groups.

If the request cannot be parsed for any reason to retrieve needed parameters (e.g.: Bad Request), the :exception:`HTTPBadRequest` can be raised to indicate specifically the cause, which will help magpie.adapter.magpieowssecurity.MagpieOWSSecurity create a better response with the relevant error details.

class magpie.services.ServiceGeoserverWPS(service: magpie.models.Service, request: pyramid.request.Request)[source]¶

Bases: ServiceGeoserverBase, ServiceWPS

Service that represents a Web Processing Service under a Geoserver instance.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_base = 'wps'[source]¶: Name of the base OWS functionality serviced by Geoserver.

service_type = 'geoserverwps'[source]¶: Service type identifier (required, unique across implementation).

resource_scoped = False[source]¶

Indicates if the Service is allowed to employ scoped models.Workspace naming.

When allowed, the models.Workspace can be inferred from the request parameter defined by resource_param to retrieve scoped name as <WORKSPACE>:<RESOURCE>. When not allowed, the resource name is left untouched and Magpie will not attempt to infer any models.Workspace from it. In that case, models.Workspace can only be specified in the request path for isolated Resource references.

Note

When this parameter is False for a given Service implementation, children Resources can still be named in a similar <namespace>:<element> fashion. The only distinction is that the full Resource should include this complete definition instead of nesting <namespace> and <element> into two distinct Resources.

resource_multi = True[source]¶

Indicates if the Service supports multiple simultaneous Resource references.

When supported, the value retrieved from resource_param can be comma-separated to represent multiple Resource of the same nature, which can all be retrieved with the same request. Otherwise, single value only is considered by default.

Note

Permission modifier Access.ALLOW will have to be resolved for all those Resource references for the request to be granted access.

resource_param = 'identifier'[source]¶

Name of the request query parameter(s) to access requested leaf children resource.

If a single string is defined, the parameter must be equal to this value (case insensitive). When using a list, any specified name combination will be resolved as the same parameter.

Note

The resulting parameter(s) are automatically added to params_expected() to ensure they are always retrieved in the parser from the request query parameters.

See also

resource_param_requested() to obtain the resolved parameter considering any applicable combination.

resource_types_permissions[source]¶: Explicit permissions provided for resources for a given OWS implementation.

child_structure_allowed[source]¶

Control mapping of resource types limiting the allowed structure of nested children resources.

When not defined, any nested resource type combination is allowed if they themselves allow children resources. Otherwise, nested child resource under the service can only be created at specific positions within the hierarchy that matches exactly one of the defined control conditions.

For example, the below definition allows only resources typed route directly under the service. The following nested resource under that first-level route can then be either another route followed by a child process or directly a process. Because process type doesn’t allow any children resource (see models.Process.child_resource_allowed), those are the only allowed combinations (cannot further nest resources under the final process resource).

child_structure_allowed = {
    models.Service: [models.Route],
    models.Route: [models.Route, models.Process],
    models.Process: [],
}

See also

Validation of allowed nested children resource insertion of a given type under a parent resource is provided by ServiceInterface.validate_nested_resource_type() that employs child_structure_allowed.
Listing of allowed resource types scoped under a given child resource within the hierarchy is provided by ServiceInterface.nested_resource_allowed().

class magpie.services.ServiceGeoserverAPI(service: magpie.models.Service, request: pyramid.request.Request | None)[source]¶

Bases: ServiceAPI, ServiceGeoserverBase

Service that represents a generic REST API under a Geoserver instance.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_base = 'api'[source]¶: Name of the base OWS functionality serviced by Geoserver.

service_type = 'geoserverapi'[source]¶: Service type identifier (required, unique across implementation).

resource_scoped = False[source]¶

Indicates if the Service is allowed to employ scoped models.Workspace naming.

When allowed, the models.Workspace can be inferred from the request parameter defined by resource_param to retrieve scoped name as <WORKSPACE>:<RESOURCE>. When not allowed, the resource name is left untouched and Magpie will not attempt to infer any models.Workspace from it. In that case, models.Workspace can only be specified in the request path for isolated Resource references.

Note

When this parameter is False for a given Service implementation, children Resources can still be named in a similar <namespace>:<element> fashion. The only distinction is that the full Resource should include this complete definition instead of nesting <namespace> and <element> into two distinct Resources.

resource_multi = False[source]¶

Indicates if the Service supports multiple simultaneous Resource references.

When supported, the value retrieved from resource_param can be comma-separated to represent multiple Resource of the same nature, which can all be retrieved with the same request. Otherwise, single value only is considered by default.

Note

Permission modifier Access.ALLOW will have to be resolved for all those Resource references for the request to be granted access.

resource_param = None[source]¶

Name of the request query parameter(s) to access requested leaf children resource.

If a single string is defined, the parameter must be equal to this value (case insensitive). When using a list, any specified name combination will be resolved as the same parameter.

Note

The resulting parameter(s) are automatically added to params_expected() to ensure they are always retrieved in the parser from the request query parameters.

See also

resource_param_requested() to obtain the resolved parameter considering any applicable combination.

resource_types_permissions[source]¶: Mapping of resource types to lists of permissions defining allowed children resource permissions under the service.

class magpie.services.ServiceGeoserver(service: magpie.models.Service, request: pyramid.request.Request | None)[source]¶

Bases: ServiceGeoserverBase

Service that encapsulates the multiple OWS endpoints from Geoserver services.

Initialize the service.

Parameters:

service – Base service resource that must be handled by this service implementation.
request – Active request to handle requested resources, permissions and effective access. The request can be omitted if basic service definition details are to be retrieved. It is mandatory for any requested or effective component that should be resolved.

service_base = None[source]¶: Name of the base OWS functionality serviced by Geoserver.

service_type = 'geoserver'[source]¶: Service type identifier (required, unique across implementation).

service_map[source]¶

property service_supported: Set[Type[ServiceGeoserverBase]][source]¶

child_structure_allowed[source]¶: Allowed children resource structure for Geoserver.

Note

In the context of Geoserver, WPS are applied on available resources (WFS, WMS, etc.). For this reason, the models.Process also needs to be scoped under models.Workspace in order to grant access to those resources to work on them, but the models.Workspace name MUST be in the path (i.e.: identifier=<WORKSPACE>:<PROCESS_ID> request parameter does not work). Without the models.Workspace scope in the path, identifier parameter fails to be resolved by Geoserver, as if it was unspecified. Attribute ServiceGeoserverWPS.resource_scoped controls the behaviour of splitting the defined resource_param into models.Workspace and child components.

Note

The models.Route is allowed at the root of the service and for any nested models.Route resource to support various endpoints such as the /web user interface, or the REST interface for the new generation of OGC API services typically on /ogc/{features|maps|processes} endpoints. No special logic is applied for the different services nested under those endpoints. All of them are handled as typical RESTful APIs, for which permissions and appropriate sub-paths should be defined accordingly with their respective specifications and schema.

configurable = True[source]¶: Indicates if the service supports custom configuration.

get_config() → magpie.typedefs.ServiceConfiguration[source]¶

Obtain the configuration defining which OWS services are enabled under this instance.

Should provide a mapping of all OWS service type names to enabled boolean status.

property params_expected: List[magpie.typedefs.Str][source]¶

Specify typical Geoserver request query parameters expected for any sub-service implementation.

The resource_param is also added to ensure it is always parsed based on the derived implementation.

property permissions: List[magpie.permissions.Permission][source]¶: Permission allowed directly on the service as top-level resource.

property resource_types_permissions: magpie.typedefs.ResourceTypePermissions[source]¶: Explicit permissions provided for resources for a given OWS implementation.

_service_requested = None[source]¶

_set_request(request: pyramid.request.Request) → None[source]¶

service_requested() → Type[ServiceGeoserverBase] | None[source]¶: Obtain the applicable OWS implementation according to parsed request parameters.

property resource_scoped: bool[source]¶

Indicates if the Service is allowed to employ scoped models.Workspace naming.

When allowed, the models.Workspace can be inferred from the request parameter defined by resource_param to retrieve scoped name as <WORKSPACE>:<RESOURCE>. When not allowed, the resource name is left untouched and Magpie will not attempt to infer any models.Workspace from it. In that case, models.Workspace can only be specified in the request path for isolated Resource references.

Note

When this parameter is False for a given Service implementation, children Resources can still be named in a similar <namespace>:<element> fashion. The only distinction is that the full Resource should include this complete definition instead of nesting <namespace> and <element> into two distinct Resources.

property resource_multi: bool[source]¶

Indicates if the Service supports multiple simultaneous Resource references.

When supported, the value retrieved from resource_param can be comma-separated to represent multiple Resource of the same nature, which can all be retrieved with the same request. Otherwise, single value only is considered by default.

Note

Permission modifier Access.ALLOW will have to be resolved for all those Resource references for the request to be granted access.

property resource_param: magpie.typedefs.Str | List[magpie.typedefs.Str][source]¶

Name of the request query parameter(s) to access requested leaf children resource.

If a single string is defined, the parameter must be equal to this value (case insensitive). When using a list, any specified name combination will be resolved as the same parameter.

Note

The resulting parameter(s) are automatically added to params_expected() to ensure they are always retrieved in the parser from the request query parameters.

See also

resource_param_requested() to obtain the resolved parameter considering any applicable combination.

resource_requested() → magpie.typedefs.MultiResourceRequested[source]¶: Parse the requested resource down to the applicable models.Workspace.

Note

Further child resource processing must be accomplished by the derived implementation as needed.

permission_requested() → magpie.typedefs.PermissionRequested[source]¶

Defines how to interpret the incoming request into Permission definitions for the given service.

Each service must implement its own definition. The method must specifically define how to convert generic request path, query, etc. elements into permissions that match the service and its children resources.

If None is returned, the ACL will effectively be resolved to denied access. Otherwise, one or more returned Permission will indicate which permissions should be looked for to resolve the ACL of the authenticated user and its groups.

If the request cannot be parsed for any reason to retrieve needed parameters (e.g.: Bad Request), the :exception:`HTTPBadRequest` can be raised to indicate specifically the cause, which will help magpie.adapter.magpieowssecurity.MagpieOWSSecurity create a better response with the relevant error details.

magpie.services.SERVICE_TYPES[source]¶

magpie.services.SERVICE_TYPE_DICT[source]¶

magpie.services.service_factory(service: magpie.models.Service, request: pyramid.request.Request) → ServiceInterface[source]¶: Retrieve the specific service class from the provided database service entry.

magpie.services.get_resource_child_allowed(resource: magpie.typedefs.ServiceOrResourceType) → bool[source]¶

Verifies if the specified resource allows nesting children resources under it considering its specific type.

Makes sure to obtain the specific Service or Resource implementation to verify children support. If this is not accomplished, the default attribute of base Service or Resource would erroneously indicate that children are allowed.

Parameters:: resource – Item for which to verify if children resources are allowed.
Returns:: Whether the resource can nest more resources or not.

magpie.services.invalidate_service(service_name: magpie.typedefs.Str) → None[source]¶: Invalidates any caching reference to the specified service name.

magpie.services¶

Attributes¶

Classes¶

Functions¶

Module Contents¶

Table of Contents

Previous topic

Next topic

This Page