rucio 37.0.0rc1__py3-none-any.whl

rucio/web/rest/flaskapi/v1/templates/auth_crash.html

@@ -0,0 +1,80 @@
+<!--
+ Copyright 2019-2021 CERN
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Authors:
+ - Jaroslav Guenther <jaroslav.guenther@cern.ch>, 2019
+ - Benedikt Ziemons <benedikt.ziemons@cern.ch>, 2021
+-->
+
+<style>
+
+    table {
+        text-align: center;
+        background-color: white;
+        vertical-align: center;
+        border-spacing: 5px 15px;
+        font-family: sans-serif;
+        font-size: 18px;
+    }
+
+    td th {
+        text-align: center;
+        border: 0 solid transparent;
+    }
+
+    div {
+        left: 50%;
+        top: 50%;
+        width: 600px;
+        margin: 0 auto;
+    }
+
+    img {
+        width: 350px;
+    }
+
+</style>
+
+
+<div>
+    <table>
+        <tbody>
+        <tr>
+            <!-- Logo placeholder - possible only after Rucio Auth
+                  servers are configured to serve media files
+                  <th> <img src="/media/logo.png"> </th> -->
+            <th> RUCIO</th>
+        </tr>
+        <tr>
+            <th> SCIENTIFIC DATA MANAGEMENT</th>
+        </tr>
+        <tr>
+            <td> Rucio authentication server could not
+                {% if crashtype == "no_result" %}
+                finalize your token request, no authorization content returned from the auth server.
+                {% elif crashtype == "contact" %}
+                authorize your access, please check your access credentials.
+                {% elif crashtype == "bad_request" %}
+                recognize and process your request.
+                {% elif crashtype == "unknown_identity" %}
+                find your OIDC identity linked to any Rucio account.
+                {% else %}
+                process your request due to internal error.
+                {% endif %}
+            </td>
+        </tr>
+        </tbody>
+    </table>
+</div>

rucio/web/rest/flaskapi/v1/templates/auth_granted.html

@@ -0,0 +1,82 @@
+<!--
+ Copyright 2019-2021 CERN
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ Authors:
+ - Jaroslav Guenther <jaroslav.guenther@cern.ch>, 2019
+ - Benedikt Ziemons <benedikt.ziemons@cern.ch>, 2021
+-->
+
+<style>
+
+    table {
+        text-align: center;
+        background-color: white;
+        vertical-align: center;
+        border-spacing: 5px 15px;
+        font-family: sans-serif;
+        font-size: 18px;
+    }
+
+    td th {
+        text-align: center;
+        border: 0px solid transparent;
+    }
+
+    div {
+        left: 50%;
+        top: 50%;
+        width: 600px;
+        margin: 0 auto;
+    }
+
+    img {
+        width: 350px;
+    }
+
+</style>
+
+
+<div>
+    <table>
+        <tbody>
+        <tr>
+            <!-- Logo placeholder - possible only after Rucio Auth
+                  servers are configured to serve media files
+                  <th> <img src="/media/logo.png"> </th> -->
+            <th> RUCIO</th>
+        </tr>
+        <tr>
+            <th> SCIENTIFIC DATA MANAGEMENT</th>
+        </tr>
+        {% if authcode == "allok" %}
+        <tr>
+            <td>
+                Rucio authorization server has been granted access to your information.
+                Rucio Client should now be able to fetch your token automatically.
+            </td>
+        </tr>
+        {% else %}
+        <tr>
+            <td>Please copy-paste the following code to the open terminal session with Rucio Client in order to get your access token:</td>
+        </tr>
+        <tr>
+            <td style="border: #0033A0 solid 2px">
+                <b>{{ authcode }}</b>
+            </td>
+        </tr>
+        {% endif %}
+        </tbody>
+    </table>
+</div>

rucio/web/rest/flaskapi/v1/traces.py

@@ -0,0 +1,137 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+import datetime
+import json
+import uuid
+from typing import TYPE_CHECKING, Union
+
+from flask import Blueprint, Flask, request
+from werkzeug.datastructures import Headers
+
+from rucio.core.trace import trace
+from rucio.web.rest.flaskapi.v1.common import ErrorHandlingMethodView, response_headers
+
+if TYPE_CHECKING:
+    from typing import Optional
+
+    from rucio.web.rest.flaskapi.v1.types import HeadersType
+
+
+class Trace(ErrorHandlingMethodView):
+
+    def __handle_payload_item(self, payload: dict) -> None:
+        """
+        Handles and processes a single trace payload item by adding various trace information.
+
+        Args:
+          payload (dict): The payload dictionary to be processed.
+
+        Modifies:
+          payload (dict): Adds the following keys to the payload:
+            - 'traceTimeentry': The current UTC timestamp.
+            - 'traceTimeentryUnix': The Unix timestamp with microsecond precision.
+            - 'traceIp': The client's IP address, either from 'X-Forwarded-For' header or remote address.
+            - 'traceId': A unique identifier for the trace, generated as a UUID without hyphens.
+
+        Calls:
+          trace(payload): A function to handle the processed payload.
+        """
+        # generate entry timestamp
+        payload["traceTimeentry"] = datetime.datetime.now(datetime.timezone.utc)
+        payload["traceTimeentryUnix"] = payload["traceTimeentry"].timestamp()
+
+        # guess client IP
+        payload["traceIp"] = request.headers.get(
+            "X-Forwarded-For", default=request.remote_addr
+        )
+
+        # generate unique ID
+        payload["traceId"] = str(uuid.uuid4()).replace("-", "").lower()
+        trace(payload=payload)
+
+    def get_headers(self) -> "Optional[HeadersType]":
+        headers = Headers()
+        headers.set('Content-Type', 'application/octet-stream')
+        headers.set('Access-Control-Allow-Origin', request.environ.get('HTTP_ORIGIN'))
+        headers.set('Access-Control-Allow-Headers', request.environ.get('HTTP_ACCESS_CONTROL_REQUEST_HEADERS'))
+        headers.set('Access-Control-Allow-Methods', '*')
+        headers.set('Access-Control-Allow-Credentials', 'true')
+        return headers
+
+    def post(self):
+        """
+        ---
+        summary: Trace
+        description: Trace endpoint used by the pilot and CLI clients to post data access information.
+        tags:
+          - Trace
+        parameters:
+        - name: X-Forwarded-For
+          in: header
+          schema:
+            type: string
+        requestBody:
+          content:
+            application/json:
+              schema:
+          oneOf:
+            - type: object
+              description: A single trace object.
+            - type: array
+              items:
+                type: object
+              description: A list of trace objects.
+        responses:
+          201:
+            description: OK
+          400:
+            description: Cannot decode json data.
+        """
+        headers = self.get_headers()
+        req_body: str = request.get_data(as_text=True)
+        payload: Union[list, dict, None] = json.loads(req_body) if req_body else None
+
+        if payload is None:
+            return (
+                "Invalid JSON data. Please provide a single trace as a JSON object or a list of trace objects.",
+                400,
+                headers,
+            )
+
+        if isinstance(payload, list):
+            for item in payload:
+                self.__handle_payload_item(item)
+        else:
+            self.__handle_payload_item(payload)
+
+        return "Created", 201, headers
+
+
+def blueprint():
+    bp = Blueprint('traces', __name__, url_prefix='/traces')
+
+    trace_view = Trace.as_view('trace')
+    bp.add_url_rule('/', view_func=trace_view, methods=['post', ])
+
+    bp.after_request(response_headers)
+    return bp
+
+
+def make_doc():
+    """ Only used for sphinx documentation """
+    doc_app = Flask(__name__)
+    doc_app.register_blueprint(blueprint())
+    return doc_app

rucio/web/rest/flaskapi/v1/types.py

@@ -0,0 +1,20 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from collections.abc import Sequence
+from typing import Union
+
+from werkzeug.datastructures import Headers
+
+HeadersType = Union[Headers, dict[str, str], Sequence[tuple[str, str]]]

rucio/web/rest/flaskapi/v1/vos.py

@@ -0,0 +1,278 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from flask import Flask, request
+
+from rucio.common.exception import AccessDenied, AccountNotFound, Duplicate, UnsupportedOperation, VONotFound
+from rucio.common.utils import render_json
+from rucio.gateway.vo import add_vo, list_vos, recover_vo_root_identity, update_vo
+from rucio.web.rest.flaskapi.authenticated_bp import AuthenticatedBlueprint
+from rucio.web.rest.flaskapi.v1.common import ErrorHandlingMethodView, check_accept_header_wrapper_flask, generate_http_error_flask, json_parameters, param_get, response_headers, try_stream
+
+
+class VOs(ErrorHandlingMethodView):
+    """ List all the VOs in the database. """
+
+    @check_accept_header_wrapper_flask(['application/x-json-stream'])
+    def get(self):
+        """
+        ---
+        summary: List VOs
+        tags:
+          - VO
+        responses:
+          200:
+            description: OK
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      vo:
+                        description: The vo.
+                        type: string
+                      description:
+                        description: The description of the vo.
+                        type: string
+                      email:
+                        description: The email for the vo.
+                        type: string
+                      created_at:
+                        description: The date the vo was created.
+                        type: string
+                        format: date-time
+                      updated_at:
+                        description: The date the vo was updated.
+                        type: string
+                        format: date-time
+
+          406:
+            description: Not Acceptable
+          401:
+            description: Invalid Auth Token
+          409:
+            description: Unsupported operation.
+        """
+        try:
+            def generate(issuer, vo):
+                for vo in list_vos(issuer=issuer, vo=vo):
+                    yield render_json(**vo) + '\n'
+
+            return try_stream(generate(issuer=request.environ.get('issuer'), vo=request.environ.get('vo')))
+        except AccessDenied as error:
+            return generate_http_error_flask(401, error)
+        except UnsupportedOperation as error:
+            return generate_http_error_flask(409, error)
+
+
+class VO(ErrorHandlingMethodView):
+    """ Add and update a VO. """
+
+    def post(self, vo):
+        """
+        ---
+        summary: Add VO
+        tags:
+          - VO
+        parameters:
+        - name: vo
+          in: path
+          description: The vo to add.
+          schema:
+            type: string
+          style: simple
+        requestBody:
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  description:
+                    description: The description of the VO.
+                    type: string
+                  email:
+                    description: The admin email associated with the VO.
+                    type: string
+        responses:
+          201:
+            description: OK
+          401:
+            description: Invalid Auth Token
+          409:
+            description: Unsupported operation.
+        """
+        parameters = json_parameters(optional=True)
+        kwargs = {'description': None, 'email': None}
+        for keyword in kwargs.keys():
+            kwargs[keyword] = param_get(parameters, keyword, default=kwargs[keyword])
+        kwargs['issuer'] = request.environ.get('issuer')
+        kwargs['vo'] = request.environ.get('vo')
+
+        try:
+            add_vo(new_vo=vo, **kwargs)
+        except AccessDenied as error:
+            return generate_http_error_flask(401, error)
+        except (UnsupportedOperation, Duplicate) as error:
+            return generate_http_error_flask(409, error)
+
+        return 'Created', 201
+
+    def put(self, vo):
+        """
+        ---
+        summary: Update VO
+        tags:
+          - VO
+        parameters:
+        - name: vo
+          in: path
+          description: The vo to add.
+          schema:
+            type: string
+          style: simple
+        requestBody:
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  description:
+                    description: The description of the VO.
+                    type: string
+                  email:
+                    description: The admin email associated with the VO.
+                    type: string
+        responses:
+          200:
+            description: OK
+          401:
+            description: Invalid Auth Token
+          404:
+            description: VO not found.
+          409:
+            description: Unsupported operation.
+        """
+        parameters = json_parameters()
+        try:
+            update_vo(updated_vo=vo, parameters=parameters, issuer=request.environ.get('issuer'), vo=request.environ.get('vo'))
+        except AccessDenied as error:
+            return generate_http_error_flask(401, error)
+        except VONotFound as error:
+            return generate_http_error_flask(404, error)
+        except UnsupportedOperation as error:
+            return generate_http_error_flask(409, error)
+
+        return '', 200
+
+
+class RecoverVO(ErrorHandlingMethodView):
+    """ Recover root identity for a VO. """
+
+    def post(self, vo):
+        """
+        ---
+        summary: Recover Root Identity
+        tags:
+          - VO
+        parameters:
+        - name: vo
+          in: path
+          description: The vo to add.
+          schema:
+            type: string
+          style: simple
+        requestBody:
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                - identity
+                - authtype
+                - email
+                properties:
+                  identity:
+                    description: Identity key to use.
+                    type: string
+                  authtype:
+                    description: The authtype of the account.
+                    type: string
+                  email:
+                    description: The admin email for the vo.
+                    type: string
+                  password:
+                    description: Password for identity.
+                    type: string
+                  default:
+                    description: Whether to use identity as account default.
+                    type: boolean
+        responses:
+          201:
+            description: OK
+          401:
+            description: Invalid Auth Token
+          404:
+            description: Account not found.
+          409:
+            description: Unsupported operation.
+        """
+        parameters = json_parameters()
+        identity = param_get(parameters, 'identity')
+        authtype = param_get(parameters, 'authtype')
+        email = param_get(parameters, 'email')
+        password = param_get(parameters, 'password', default=None)
+        default = param_get(parameters, 'default', default=False)
+
+        try:
+            recover_vo_root_identity(
+                root_vo=vo,
+                identity_key=identity,
+                id_type=authtype,
+                email=email,
+                password=password,
+                default=default,
+                issuer=request.environ.get('issuer'),
+                vo=request.environ.get('vo'),
+            )
+        except AccessDenied as error:
+            return generate_http_error_flask(401, error)
+        except AccountNotFound as error:
+            return generate_http_error_flask(404, error)
+        except Duplicate as error:
+            return generate_http_error_flask(409, error)
+
+        return 'Created', 201
+
+
+def blueprint():
+    bp = AuthenticatedBlueprint('vos', __name__, url_prefix='/vos')
+
+    recover_view = RecoverVO.as_view('recover')
+    bp.add_url_rule('/<vo>/recover', view_func=recover_view, methods=['post', ])
+    vo_view = VO.as_view('vo')
+    bp.add_url_rule('/<vo>', view_func=vo_view, methods=['put', 'post'])
+    vos_view = VOs.as_view('vos')
+    bp.add_url_rule('/', view_func=vos_view, methods=['get', ])
+
+    bp.after_request(response_headers)
+    return bp
+
+
+def make_doc():
+    """ Only used for sphinx documentation """
+    doc_app = Flask(__name__)
+    doc_app.register_blueprint(blueprint())
+    return doc_app

rucio/web/rest/main.py

@@ -0,0 +1,18 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from rucio.web.rest.flaskapi.v1.main import application
+
+if __name__ == '__main__':
+    application.run()

rucio/web/rest/metrics.py

@@ -0,0 +1,27 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from flask import Flask
+
+from rucio.common.logging import setup_logging
+from rucio.web.rest.flaskapi.v1.metrics import blueprint as metrics_blueprint
+
+# Allow to run the /metrics endpoint as a separate application on a separate PORT
+
+setup_logging()
+application = Flask(__name__)
+application.register_blueprint(metrics_blueprint(standalone=True))
+
+if __name__ == '__main__':
+    application.run()

rucio/web/rest/ping.py

@@ -0,0 +1,27 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from flask import Flask
+
+from rucio.common.logging import setup_logging
+from rucio.web.rest.flaskapi.v1.ping import blueprint as metrics_blueprint
+
+# Allow to run the /ping endpoint as a separate application on a separate PORT
+
+setup_logging()
+application = Flask(__name__)
+application.register_blueprint(metrics_blueprint(standalone=True))
+
+if __name__ == '__main__':
+    application.run()