Merge branch '1-new-opencapif-provider-gw' into 'main'

provider_gw_sample/provider_gw/*

provider_gw_sample/logs

provider_gw/__pycache__

.flake8

dist

build

provider_gw.egg-info

pyproject.toml

 No newline at end of file

image: python:3.12

stages:

  - build

  - publish

# Job 1: construir las distribuciones (sdist/wheel)

build_release:

  stage: build

  rules:

    # Solo ejecuta cuando es un tag (similar a "release published")

    - if: '$CI_COMMIT_TAG'

  script:

    - python -m pip install --upgrade pip

    - python -m pip install build

    - python -m build

  artifacts:

    paths:

      - dist/

    expire_in: 1 week

# Job 2: publicar en PyPI

pypi_publish:

  stage: publish

  needs:

    - build_release

  rules:

    - if: '$CI_COMMIT_TAG'

  # Usa un token de PyPI almacenado en variables de CI/CD

  variables:

    TWINE_USERNAME: "__token__"

    TWINE_PASSWORD: "$PYPI_API_TOKEN"

  script:

    - python -m pip install --upgrade pip

    - python -m pip install twine

    - twine upload dist/*

  environment:

    name: pypi

    url: "https://pypi.org/project/provider-gw/$CI_COMMIT_TAG"

                                 Apache License

                           Version 2.0, January 2004

                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,

      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by

      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all

      other entities that control, are controlled by, or are under common

      control with that entity. For the purposes of this definition,

      "control" means (i) the power, direct or indirect, to cause the

      direction or management of such entity, whether by contract or

      otherwise, or (ii) ownership of fifty percent (50%) or more of the

      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity

      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,

      including but not limited to software source code, documentation

      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical

      transformation or translation of a Source form, including but

      not limited to compiled object code, generated documentation,

      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or

      Object form, made available under the License, as indicated by a

      copyright notice that is included in or attached to the work

      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object

      form, that is based on (or derived from) the Work and for which the

      editorial revisions, annotations, elaborations, or other modifications

      represent, as a whole, an original work of authorship. For the purposes

      of this License, Derivative Works shall not include works that remain

      separable from, or merely link (or bind by name) to the interfaces of,

      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including

      the original version of the Work and any modifications or additions

      to that Work or Derivative Works thereof, that is intentionally

      submitted to Licensor for inclusion in the Work by the copyright owner

      or by an individual or Legal Entity authorized to submit on behalf of

      the copyright owner. For the purposes of this definition, "submitted"

      means any form of electronic, verbal, or written communication sent

      to the Licensor or its representatives, including but not limited to

      communication on electronic mailing lists, source code control systems,

      and issue tracking systems that are managed by, or on behalf of, the

      Licensor for the purpose of discussing and improving the Work, but

      excluding communication that is conspicuously marked or otherwise

      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity

      on behalf of whom a Contribution has been received by Licensor and

      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      copyright license to reproduce, prepare Derivative Works of,

      publicly display, publicly perform, sublicense, and distribute the

      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of

      this License, each Contributor hereby grants to You a perpetual,

      worldwide, non-exclusive, no-charge, royalty-free, irrevocable

      (except as stated in this section) patent license to make, have made,

      use, offer to sell, sell, import, and otherwise transfer the Work,

      where such license applies only to those patent claims licensable

      by such Contributor that are necessarily infringed by their

      Contribution(s) alone or by combination of their Contribution(s)

      with the Work to which such Contribution(s) was submitted. If You

      institute patent litigation against any entity (including a

      cross-claim or counterclaim in a lawsuit) alleging that the Work

      or a Contribution incorporated within the Work constitutes direct

      or contributory patent infringement, then any patent licenses

      granted to You under this License for that Work shall terminate

      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the

      Work or Derivative Works thereof in any medium, with or without

      modifications, and in Source or Object form, provided that You

      meet the following conditions:

      (a) You must give any other recipients of the Work or

          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices

          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works

          that You distribute, all copyright, patent, trademark, and

          attribution notices from the Source form of the Work,

          excluding those notices that do not pertain to any part of

          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its

          distribution, then any Derivative Works that You distribute must

          include a readable copy of the attribution notices contained

          within such NOTICE file, excluding those notices that do not

          pertain to any part of the Derivative Works, in at least one

          of the following places: within a NOTICE text file distributed

          as part of the Derivative Works; within the Source form or

          documentation, if provided along with the Derivative Works; or,

          within a display generated by the Derivative Works, if and

          wherever such third-party notices normally appear. The contents

          of the NOTICE file are for informational purposes only and

          do not modify the License. You may add Your own attribution

          notices within Derivative Works that You distribute, alongside

          or as an addendum to the NOTICE text from the Work, provided

          that such additional attribution notices cannot be construed

          as modifying the License.

      You may add Your own copyright statement to Your modifications and

      may provide additional or different license terms and conditions

      for use, reproduction, or distribution of Your modifications, or

      for any such Derivative Works as a whole, provided Your use,

      reproduction, and distribution of the Work otherwise complies with

      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,

      any Contribution intentionally submitted for inclusion in the Work

      by You to the Licensor shall be under the terms and conditions of

      this License, without any additional terms or conditions.

      Notwithstanding the above, nothing herein shall supersede or modify

      the terms of any separate license agreement you may have executed

      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade

      names, trademarks, service marks, or product names of the Licensor,

      except as required for reasonable and customary use in describing the

      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or

      agreed to in writing, Licensor provides the Work (and each

      Contributor provides its Contributions) on an "AS IS" BASIS,

      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

      implied, including, without limitation, any warranties or conditions

      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

      PARTICULAR PURPOSE. You are solely responsible for determining the

      appropriateness of using or redistributing the Work and assume any

      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,

      whether in tort (including negligence), contract, or otherwise,

      unless required by applicable law (such as deliberate and grossly

      negligent acts) or agreed to in writing, shall any Contributor be

      liable to You for damages, including any direct, indirect, special,

      incidental, or consequential damages of any character arising as a

      result of this License or out of the use or inability to use the

      Work (including but not limited to damages for loss of goodwill,

      work stoppage, computer failure or malfunction, or any and all

      other commercial damages or losses), even if such Contributor

      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing

      the Work or Derivative Works thereof, You may choose to offer,

      and charge a fee for, acceptance of support, warranty, indemnity,

      or other liability obligations and/or rights consistent with this

      License. However, in accepting such obligations, You may act only

      on Your own behalf and on Your sole responsibility, not on behalf

      of any other Contributor, and only if You agree to indemnify,

      defend, and hold each Contributor harmless for any liability

      incurred by, or claims asserted against, such Contributor by reason

      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following

      boilerplate notice, with the fields enclosed by brackets "[]"

      replaced with your own identifying information. (Don't include

      the brackets!)  The text should be enclosed in the appropriate

      comment syntax for the file format. We also recommend that a

      file or class name and description of purpose be included on the

      same "printed page" as the copyright notice for easier

      identification within third-party archives.

   Copyright 2025 Telefónica Innovación Digital and ETSI.

   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.

# provider-gateway

# PROVIDER_GW

[![PyPI version](https://img.shields.io/pypi/v/provider-gw.svg)](https://pypi.org/project/provider-gw/) ![Python](https://img.shields.io/badge/python-v3.12+-blue.svg) 

PROVIDER_GW is a gateway component designed to bridge legacy systems with the **Common API Framework (CAPIF)**. It simplifies the integration process, enabling legacy systems to interact seamlessly with CAPIF and adopt modern APIs without extensive modifications.

## Getting started

The component leverages the [Opencapif_sdk](https://labs.etsi.org/rep/ocf/sdk) to manage the interactions between systems and CAPIF effectively.

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

---

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!

## Overview of PROVIDER_GW

## Add your files

PROVIDER_GW acts as an intermediary, translating and exposing APIs from legacy systems in a format compatible with CAPIF. It manages communication between the **Southbound interface** (legacy systems) and the **Northbound interface** (CAPIF), ensuring secure, reliable, and flexible API interaction.

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files

- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:

![PROVIDER_GW Schema](./docs/provider_gw_schema.png)

```

cd existing_repo

git remote add origin https://labs.etsi.org/rep/ocf/provider-gateway.git

git branch -M main

git push -uf origin main

```

---

## Integrate with your tools

## Getting Started

- [ ] [Set up project integrations](https://labs.etsi.org/rep/ocf/provider-gateway/-/settings/integrations)

### Prerequisites

## Collaborate with your team

To use PROVIDER_GW, you need:

1. A registered user account in the CAPIF instance.

   - Contact your CAPIF administrator to obtain the necessary credentials (CAPIF username and password).

2. The following software dependencies:

   - Python 3.12+

   - `pipenv` or `virtualenv` for managing Python environments.

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)

- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)

- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)

- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)

- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)

### Installation Steps

## Test and Deploy

1. **Set up a virtual environment:**

   ```bash

   python -m venv venv

   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

   ```

Use the built-in continuous integration in GitLab.

2. **Install PROVIDER_GW:**

   ```bash

   pip install provider_gw

   ```

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)

- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)

- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)

- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)

- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

---

## Configuration

PROVIDER_GW requires two YAML configuration files:

1. **Northbound (`northbound.yaml`)**: Defines interaction with CAPIF. [**EXAMPLE**](./example_files/northbound.yaml)

2. **Southbound (`southbound.yaml`)**: Specifies communication with legacy systems. [**EXAMPLE**](./example_files/southbound.yaml)

### 1. Northbound Configuration

The `northbound.yaml` file defines the integration with CAPIF, including API specifications and OpenCapif SDK settings.

#### Key Fields

- **`ip`**: The IP address to expose.

- **`port`**: The port to expose.

- **`opencapif_sdk_configuration`**: Configures the OpenCapif SDK.

- **`openapi`**: Specifies the API exposed to CAPIF.

#### OpenCapif SDK Configuration

Here are the required fields for the `opencapif_sdk_configuration`:

- `capif_host`: CAPIF server domain.

- `register_host`: Registration server domain.

- `capif_https_port`: CAPIF server HTTPS port.

- `capif_register_port`: Registration server port.

- `capif_username`: CAPIF username.

- `capif_password`: CAPIF password.

- `debug_mode`: Enables detailed logs (`True` or `False`).

- `provider`: Specific fields of the provider(`cert_generation`,`supported_features`,`apiSuppFeats`)

**Example of a opencapif_sdk_configuration settings:**

```yaml

opencapif_sdk_configuration:

  capif_host: "capifcore"

  register_host: "register.capif"

  capif_https_port: "443"

  capif_register_port: "8004"

  capif_username: "echeva_0"

  capif_password: "excalibur"

  debug_mode: "True"

  provider:

    cert_generation:

      csr_common_name: "provider"

      csr_organizational_unit: "discovery"

      csr_organization: "telefonica"

      csr_locality: "madrid"

      csr_state_or_province_name: "madrid"

      csr_country_name: "ES"

      csr_email_address: "hola@gmail.com"

    supported_features: "0"

    apiSuppFeats: "0"

```

***

#### OpenAPI Configuration

The `openapi` field must adhere to the [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3). Use tools like [Swagger Editor](https://editor.swagger.io/) to validate the configuration.

**Example Configuration:**

```yaml

openapi:

  openapi: 3.0.0

  info:

    title: My API

    description: Example API for demonstration

    version: 1.0.0

  paths:

    /greet:

      get:

        summary: Say hello

        description: Returns a greeting message.

        responses:

          '200':

            description: Success

            content:

              application/json:

                schema:

                  type: object

                  properties:

                    message:

                      type: string

                      example: "Hello!"

```

---

# Editing this README

### 2. Southbound Configuration

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.

The `southbound.yaml` file defines how PROVIDER_GW interacts with legacy systems.

## Suggestions for a good README

#### Key Fields

- **`ip`**: The IP address to expose.

- **`port`**: The port to expose.

- **`type`**: The type of endpoint (`REST` is currently supported).

- **`authentication_method`**: Authentication options:

  - `HTTP Basic Authentication`

  - `JWT Bearer Token`

- **`credentials`**:

  - For HTTP Basic Authentication:

    ```yaml

    username: "admin"

    password: "password123"

    ```

  - For JWT Bearer Token:

    ```yaml

    jwt: "your-token"

    ```

- **`paths`**: Maps Northbound API paths to Southbound API paths, including HTTP methods and parameter mappings.

**Example Configuration:**

```yaml

southbound:

  ip: 0.0.0.0

  port: 8000

  type: REST

  authentication_method: "JWT Bearer Token"

  credentials:

    jwt: "example-token"

  paths:

    - northbound_path: "/greet"

      southbound_path: "/hello"

      method: GET

    - northbound_path: "/greet/{name}"

      southbound_path: "/hello/{person}"

      method: GET

      parameters:

        - name: person

```

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

---

## Name

Choose a self-explaining name for your project.

## Usage

## Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

1. Place the `northbound.yaml` and `southbound.yaml` configuration files in a working directory.

2. Use the following commands to interact with PROVIDER_GW:

## Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

- **Start the gateway (first-time setup):**

  ```bash

  cd ./directory/with/configuration/files

  provider_gw start

  ```

## Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

- **Run the gateway (after initial setup):**

  ```bash

  cd ./directory/with/configuration/files

  provider_gw run

  ```

## Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

- **Remove the gateway interface:**

  ```bash

  cd ./directory/with/configuration/files

  provider_gw remove

  ```

## Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

---

## Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

### Adding a New Endpoint

## Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

To add a new API endpoint:

## Contributing

State if you are open to contributions and what your requirements are for accepting them.

1. Update `northbound.yaml` to define the endpoint.

2. Map the corresponding route in `southbound.yaml`.

3. Start the gateway with:

   ```bash

   cd ./directory/with/configuration/files

   provider_gw start

   ```

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

---

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

### Refreshing the Southbound JWT Token

## Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

To refresh the Southbound JWT token:

## License

For open source projects, say how it is licensed.

1. Update the `jwt` field in the `southbound.yaml` file.

2. Apply the changes with:

   ```bash

   cd ./directory/with/configuration/files

   provider_gw refresh

   ```

## Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

This ensures the new token is applied seamlessly.