Merge pull request #1 from usmanTheCoder/bsf_v1

feat(BSF): Complete BSF implementation with 3GPP TS 29.521 compliance

Author: ianchen0119

.github/copilot-instructions.md

@@ -0,0 +1,6 @@
+<!-- Auto-generated todo section -->
+<todos title="Todos" rule="Review steps frequently throughout the conversation and DO NOT stop between steps unless they explicitly require it.">
+- No current todos
+</todos>
+
+<!-- Add your custom Copilot instructions below -->

.gitignore

@@ -2,6 +2,7 @@
 # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
 #
 # Binaries for programs and plugins
+bin/
 *.exe
 *.exe~
 *.dll
@@ -11,22 +12,37 @@
 # Test binary, built with `go test -c`
 *.test
 
-# Code coverage profiles and other test artifacts
+# Output of the go coverage tool
 *.out
 coverage.*
 *.coverprofile
 profile.cov
 
-# Dependency directories (remove the comment below to include it)
-# vendor/
+# Logs
+*.log
+
+# Dependency directories
+vendor/
 
 # Go workspace file
 go.work
 go.work.sum
 
-# env file
+# Environment file
 .env
 
-# Editor/IDE
-# .idea/
-# .vscode/
+# IDE/Editor
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

cmd/main.go

@@ -0,0 +1,127 @@
+/*
+ * Nbsf_Management Service API
+ *
+ * Binding Support Management Service API.
+ * © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
+ * All rights reserved.
+ *
+ * API version: 1.5.0
+ */
+
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"os/signal"
+	"path/filepath"
+	"runtime/debug"
+	"syscall"
+
+	"github.com/urfave/cli/v2"
+
+	"github.com/free5gc/bsf/internal/logger"
+	"github.com/free5gc/bsf/pkg/factory"
+	"github.com/free5gc/bsf/pkg/service"
+	logger_util "github.com/free5gc/util/logger"
+	"github.com/free5gc/util/version"
+)
+
+var BSF *service.BsfApp
+
+func main() {
+	defer func() {
+		if p := recover(); p != nil {
+			// Print stack for panic to log. Fatalf() will let program exit.
+			logger.MainLog.Fatalf("panic: %v\n%s", p, string(debug.Stack()))
+		}
+	}()
+
+	app := cli.NewApp()
+	app.Name = "bsf"
+	app.Usage = "5G Binding Support Function (BSF)"
+	app.Action = action
+	app.Flags = []cli.Flag{
+		&cli.StringFlag{
+			Name:    "config",
+			Aliases: []string{"c"},
+			Usage:   "Load configuration from `FILE`",
+		},
+		&cli.StringSliceFlag{
+			Name:    "log",
+			Aliases: []string{"l"},
+			Usage:   "Output NF log to `FILE`",
+		},
+	}
+	if err := app.Run(os.Args); err != nil {
+		fmt.Printf("BSF Run Error: %v\n", err)
+	}
+}
+
+func action(cliCtx *cli.Context) error {
+	tlsKeyLogPath, err := initLogFile(cliCtx.StringSlice("log"))
+	if err != nil {
+		return err
+	}
+
+	logger.MainLog.Infoln(cliCtx.App.Name)
+	logger.MainLog.Infoln("BSF version: ", version.GetVersion())
+
+	ctx, cancel := context.WithCancel(context.Background())
+	sigCh := make(chan os.Signal, 1)
+	signal.Notify(sigCh, os.Interrupt, syscall.SIGTERM)
+
+	go func() {
+		<-sigCh  // Wait for interrupt signal to gracefully shutdown BSF
+		cancel() // Notify each goroutine and wait them stopped
+		if BSF != nil {
+			BSF.Terminate()
+		}
+	}()
+
+	cfg, err := factory.ReadConfig(cliCtx.String("config"))
+	if err != nil {
+		sigCh <- nil
+		return err
+	}
+	factory.BsfConfig = cfg
+
+	bsf, err := service.NewApp(ctx, cfg, tlsKeyLogPath)
+	if err != nil {
+		sigCh <- nil
+		return err
+	}
+	BSF = bsf
+	if bsf == nil {
+		logger.MainLog.Infoln("bsf is nil")
+	}
+	bsf.Start()
+
+	return nil
+}
+
+func initLogFile(logNfPath []string) (string, error) {
+	logTlsKeyPath := ""
+
+	for _, path := range logNfPath {
+		if err := logger_util.LogFileHook(logger.Log, path); err != nil {
+			return "", err
+		}
+
+		if logTlsKeyPath != "" {
+			continue
+		}
+
+		nfDir, _ := filepath.Split(path)
+		tmpDir := filepath.Join(nfDir, "key")
+		if err := os.MkdirAll(tmpDir, 0o775); err != nil {
+			logger.InitLog.Errorf("Make directory %s failed: %+v", tmpDir, err)
+			return "", err
+		}
+		_, name := filepath.Split(factory.BsfDefaultTLSKeyLogPath)
+		logTlsKeyPath = filepath.Join(tmpDir, name)
+	}
+
+	return logTlsKeyPath, nil
+}

go.mod

@@ -0,0 +1,85 @@
+module github.com/free5gc/bsf
+
+go 1.24
+
+require (
+	github.com/free5gc/openapi v1.2.0
+	github.com/free5gc/util v1.3.0
+	github.com/gin-contrib/cors v1.6.0
+	github.com/gin-gonic/gin v1.10.0
+	github.com/google/uuid v1.4.0
+	github.com/sirupsen/logrus v1.9.3
+	github.com/stretchr/testify v1.11.0
+	github.com/urfave/cli/v2 v2.27.7
+	go.mongodb.org/mongo-driver v1.17.1
+	gopkg.in/yaml.v2 v2.4.0
+)
+
+require github.com/google/go-cmp v0.7.0 // indirect
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/bytedance/sonic v1.11.6 // indirect
+	github.com/bytedance/sonic/loader v0.1.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/cloudwego/base64x v0.1.4 // indirect
+	github.com/cloudwego/iasm v0.2.0 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.7 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/free5gc/aper v1.0.6-0.20250102035630-3ddc831eed6a // indirect
+	github.com/free5gc/nas v1.2.0 // indirect
+	github.com/free5gc/ngap v1.1.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.3 // indirect
+	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/go-logr/logr v1.4.1 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.20.0 // indirect
+	github.com/goccy/go-json v0.10.2 // indirect
+	github.com/golang-jwt/jwt/v5 v5.2.2 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/h2non/gock v1.2.0 // indirect
+	github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.18.0 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/montanaflynn/stats v0.7.1 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/prometheus/client_golang v1.21.0 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.62.0 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/tim-ywliu/nested-logrus-formatter v1.3.2 // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.12 // indirect
+	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
+	github.com/xdg-go/scram v1.1.2 // indirect
+	github.com/xdg-go/stringprep v1.0.4 // indirect
+	github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
+	github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace v0.49.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
+	go.opentelemetry.io/otel v1.24.0 // indirect
+	go.opentelemetry.io/otel/metric v1.24.0 // indirect
+	go.opentelemetry.io/otel/trace v1.24.0 // indirect
+	golang.org/x/arch v0.8.0 // indirect
+	golang.org/x/crypto v0.38.0 // indirect
+	golang.org/x/net v0.40.0 // indirect
+	golang.org/x/oauth2 v0.30.0 // indirect
+	golang.org/x/sync v0.14.0 // indirect
+	golang.org/x/sys v0.33.0 // indirect
+	golang.org/x/text v0.25.0 // indirect
+	google.golang.org/protobuf v1.36.6 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)