Skip to content

Commit

Permalink
Apply gofmt to all files and add GO report card (#255)
Browse files Browse the repository at this point in the history
* Add GO report card

* Apply `gofmt` to all files
  • Loading branch information
gab-arrobo authored May 31, 2024
1 parent deafc7c commit 55e20ca
Show file tree
Hide file tree
Showing 16 changed files with 39 additions and 37 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,34 @@ SPDX-FileCopyrightText: 2021 Open Networking Foundation <[email protected]
Copyright 2019 free5GC.org
SPDX-License-Identifier: Apache-2.0
-->
# amf
[![Go Report Card](https://goreportcard.com/badge/github.com/omec-project/amf)](https://goreportcard.com/report/github.com/omec-project/amf)

It is a control plane function in the 5G core network. AMF supports termination of NAS signalling,
NAS ciphering & integrity protection, registration management, connection management, mobility
management, access authentication and authorization, security context management.
# amf
It is a control plane function in the 5G core network. AMF supports termination
of NAS signalling, NAS ciphering & integrity protection, registration
management, connection management, mobility management, access authentication
and authorization, security context management.

## AMF Block Diagram
![AMF Block Diagram](/docs/images/README-AMF.png)

AMF takes configuration from Configuration Service. Configuration is handled at Network Slice level.
Configuration (Network Slices) can be added, removed & deleted. AMF has prometheus interface to export
metrics. Metrics include connected gNodeB's and its status.

## The SD-Core AMF currently supports the following functionalities :
- Termination of RAN CP interface (N2).
- Termination of NAS (N1), NAS ciphering and integrity protection.
- Registration management.
- Connection management.
- Reachability management.
- Mobility Management.
- Provide transport for SM messages between UE and SMF.
- Transparent proxy for routing SM messages.
- Access Authentication.
- Access Authorization.
AMF takes configuration from Configuration Service. Configuration is handled at
Network Slice level. Configuration (Network Slices) can be added, removed and
deleted. AMF has prometheus interface to export metrics. Metrics include
connected gNodeB's and its status.

## The SD-Core AMF currently supports the following functionalities:
- Termination of RAN CP interface (N2)
- Termination of NAS (N1), NAS ciphering and integrity protection
- Registration management
- Connection management
- Reachability management
- Mobility Management
- Provide transport for SM messages between UE and SMF
- Transparent proxy for routing SM messages
- Access Authentication
- Access Authorization

## Supported Procedures:
- Registration/Deregistration
Expand All @@ -45,9 +47,9 @@ metrics. Metrics include connected gNodeB's and its status.



Compliance of the 5G Network functions can be found at [5G Compliance ](https://docs.sd-core.opennetworking.org/master/overview/3gpp-compliance-5g.html)
Compliance of the 5G Network functions can be found at [5G Compliance](https://docs.sd-core.opennetworking.org/master/overview/3gpp-compliance-5g.html)

## Reach out to us thorugh
## Reach out to us thorugh

1. #sdcore-dev channel in [ONF Community Slack](https://onf-community.slack.com/)
2. Raise Github issues
2 changes: 1 addition & 1 deletion communication/api_individual_subscription_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// AMFStatusChangeSubscribeModify - Namf_Communication AMF Status Change Subscribe Modify service Operation
Expand Down
2 changes: 1 addition & 1 deletion communication/api_individual_ue_context_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// CreateUEContext - Namf_Communication CreateUEContext service Operation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// N1N2MessageUnSubscribe - Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation
Expand Down
2 changes: 1 addition & 1 deletion communication/api_n1_n2_message_collection_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// N1N2MessageTransfer - Namf_Communication N1N2 Message Transfer (UE Specific) service Operation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

func HTTPN1N2MessageSubscribe(c *gin.Context) {
Expand Down
2 changes: 1 addition & 1 deletion communication/api_subscriptions_collection_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// AMFStatusChangeSubscribe - Namf_Communication AMF Status Change Subscribe service Operation
Expand Down
2 changes: 1 addition & 1 deletion eventexposure/api_individual_subscription_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// DeleteSubscription - Namf_EventExposure Unsubscribe service Operation
Expand Down
2 changes: 1 addition & 1 deletion eventexposure/api_subscriptions_collection_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// CreateSubscription - Namf_EventExposure Subscribe service Operation
Expand Down
2 changes: 1 addition & 1 deletion httpcallback/api_am_policy_control_update_notify.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

func HTTPAmPolicyControlUpdateNotifyUpdate(c *gin.Context) {
Expand Down
2 changes: 1 addition & 1 deletion httpcallback/api_n1_message_notify.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

func HTTPN1MessageNotify(c *gin.Context) {
Expand Down
2 changes: 1 addition & 1 deletion httpcallback/api_nf_subscribe_notify.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
"github.com/omec-project/openapi/models"

"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/util/httpwrapper"
)

func HTTPNfSubscriptionStatusNotify(c *gin.Context) {
Expand Down
2 changes: 1 addition & 1 deletion httpcallback/api_sm_context_status_notify.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

func HTTPSmContextStatusNotify(c *gin.Context) {
Expand Down
2 changes: 1 addition & 1 deletion location/api_individual_ue_context_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// ProvideLocationInfo - Namf_Location ProvideLocationInfo service Operation
Expand Down
2 changes: 1 addition & 1 deletion mt/api_ue_context_document.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

// ProvideDomainSelectionInfo - Namf_MT Provide Domain Selection Info service Operation
Expand Down
2 changes: 1 addition & 1 deletion oam/api_registered_ue_context.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import (

"github.com/omec-project/amf/logger"
"github.com/omec-project/amf/producer"
"github.com/omec-project/util/httpwrapper"
"github.com/omec-project/openapi"
"github.com/omec-project/openapi/models"
"github.com/omec-project/util/httpwrapper"
)

func setCorsHeader(c *gin.Context) {
Expand Down

0 comments on commit 55e20ca

Please sign in to comment.