CAPIF Go clients including admin, provider, and invoker clients

                                 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 (C) 2024, Nemergent Solutions SL

   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.

# clients-go

# CAPIF Go Clients

This repo groups together CAPIF clients implemented in Go by [Nemergent Solutions SL](https://nemergent-solutions.com/). CAPIF clients include:

- CAPIF admin client

- CAPIF provider client

- CAPIF invoker client

## Getting started

## Project structure

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

Folder _cmd_ includes code related to the different CAPIF clients.

Folder _internal_ includes the implementation of the different 5G APIs needed for the clients.

The corresponding executable files are included in the root folder of the project, along with some additional useful files, including:

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)!

- Example _config.yaml_ for configuring clients' execution

- Example *ServiceAPIDescription_SS_UserProfileRetrieval_example_localhost.json* Service API Description json file that can be published to CAPIF with the provider client

## Add your files

## Prerequisites

- [ ] [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/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:

Before being able to make use of the clients successfully, it is necessary to be able to interact with an instance of CAPIF.

In order to achieve that, it is possible to [launch an OpenCAPIF instance yourself](https://ocf.etsi.org/documentation/latest/gettingstarted/howtorun/), but it is also possible to [obtain access to OpenCAPIF sandbox](https://ocf.etsi.org/documentation/latest/sandbox/sandbox/).

The existence of a configuration file including the configuration to interact with the corresponding CAPIF instance is also needed for the execution of the clients. An example named _config.yaml_ is included as part of the repository.

```

cd existing_repo

git remote add origin https://labs.etsi.org/rep/ocf/example-clients/clients-go.git

git branch -M main

git push -uf origin main

```

## Set Up

## Integrate with your tools

In order to build the clients, the following command can be used from the root folder of the repository:

- [ ] [Set up project integrations](https://labs.etsi.org/rep/ocf/example-clients/clients-go/-/settings/integrations)

    go build -o invoker_example_client ./cmd/go_capif_invoker_client/invoker_client.go

## Collaborate with your team

In order to run the clients, the following command can be used from the root folder of the repository:

- [ ] [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/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

    ./invoker_menu -f <config_file>

## Test and Deploy

In case of building the code, it is necessary to have [Go installed in the system](https://go.dev/doc/install).

Use the built-in continuous integration in GitLab.

## Execution of clients

- [ ] [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)

All the clients start their execution showing a menu with all the different commands that can be run, along with a description of what each command does. In order to execute a command, the user must write the name of the command and press Enter. The command _menu_ is a common one present in all the clients, which prints again the menu listing the available commands.

***

### CAPIF Admin client

# Editing this README

This client offers functionality related with managing CAPIF users.

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.

    ./admin_client -f config.yaml                                       

    *    Command           Description                                                                         

    *    login             Login as administrator in CAPIF and obtain the tokens required for admin operations 

    *    refreshAdminToken Refresh the tokend of the administrator user                                        

    *    createUser        Register a new user into CAPIF                                                      

    *    getUsers          List information of all te users registered in CAPIF                                

    *    deleteUser        Remove a previously registered user from CAPIF                                      

## Suggestions for a good README

    'menu' for help >

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.

### CAPIF Provider client

## Name

Choose a self-explaining name for your project.

This client offers functionality as Provider, allowing ultimately to publish API definitions to CAPIF.

## 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.

    ./provider_client -f config.yaml 

    *    Command          Description                                                                                                    

    *    getauth          Authenticate with a CAPIF user, and gather the necessary token and certificate to perform provider onboarding 

    *    onboardProvider  Onboard as a provider into CAPIF                                                                               

    *    offboardProvider Offboard a provider from CAPIF                                                                                 

    *    publishAPIs      Publish a Service API Description to CAPIF                                                                     

    *    unpublishAPI     Remove a Service API Description from CAPIF                                                                    

## 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.

    'menu' for help >

## 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.

### CAPIF Invoker client

## 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.

This client offers functionality as Invoker, allowing ultimately to discover API definitions from CAPIF.

## 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.

    ./invoker_client -f config.yaml 

    *    Command               Description                                                                                                  

    *    getauth               Authenticate with a CAPIF user, and gather the necessary token and certificate to perform invoker onboarding 

    *    onboardInvoker        Onboard as an invoker into CAPIF                                                                             

    *    offboardInvoker       Offboard an invoker from CAPIF                                                                               

    *    discoverAPIs          Discover published Service API Descriptions from CAPIF                                                       

    *    createSecurityContext Request the creation of a security context needed to consume a published API                                 

    *    accessTokenRequest    Request the creation of the token necessary to consume a published API                                       

    *    callServiceAPI        Perform a call to a published API                                                                            

## 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.

    'menu' for help >

## Roadmap

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

## 3GPP OpenAPI Specification for 5G APIs

## Contributing

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

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.

## Authors and acknowledgment

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

## License

For open source projects, say how it is licensed.

## 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.

As previously mentioned, folder _internal_ includes the implementation of the different 5G APIs needed for the clients. The OpenAPI Specification Files for 3GPP 5G Core Network available at [the corresponding 3GPP repository](https://forge.3gpp.org/rep/all/5G_APIs) have been used as a baseline for the APIs implementation. In order to generate the code, the [OpenAPI Generator project](https://openapi-generator.tech/) has been used.

 No newline at end of file

{

  "apiName" : "ss-upr",

  "aefProfiles": [

    {

      "aefId": "Identifier of the API exposing function",

      "versions": [

        {

          "apiVersion": "v1",

          "expiry": "2026-11-30T10:32:02.004Z",

          "resources": [

            {

              "resourceName": "VAL services endpoint",

              "commType": "REQUEST_RESPONSE",

              "uri": "/val-services",

              "operations": [

                "GET"

              ],

              "description": "Retrieve VAL User or VAL UE profile information"

            }

          ]

        }

      ],

      "protocol": "HTTP_1_1",

      "dataFormat": "JSON",

      "securityMethods": ["Oauth"],

      "interfaceDescriptions": [

        {

          "ipv4Addr": "localhost",

          "port": 8085,

          "securityMethods": ["Oauth"]

        }

      ]

    }

  ],

  "description": "API for SEAL User Profile Retrieval",

  "supportedFeatures": "0",

  "shareableInfo": {

    "isShareable": true,

    "capifProvDoms": [

      "List of CAPIF provider domains to which the service API information to be shared"

    ]

  },

  "serviceAPICategory": "string",

  "apiSuppFeats": "fffff",

  "pubApiPath": {

    "ccfIds": [

      "List of CCF identifiers where the service API is already published"

    ]

  },

  "ccfId": "CAPIF core function identifier"

}