chore: Copy http2_util, logger_conf and logger_util to util project

http2_util/server.go

@@ -0,0 +1,50 @@
+// Copyright 2019 Communication Service/Software Laboratory, National Chiao Tung University (free5gc.org)
+//
+// SPDX-License-Identifier: Apache-2.0
+
+//go:build !debug
+// +build !debug
+
+package http2_util
+
+import (
+	"crypto/tls"
+	"fmt"
+	"net/http"
+	"os"
+	"time"
+
+	"github.com/pkg/errors"
+	"golang.org/x/net/http2"
+	"golang.org/x/net/http2/h2c"
+)
+
+// NewServer returns a server instance with HTTP/2.0 and HTTP/2.0 cleartext support
+// If this function cannot open or create the secret log file,
+// **it still returns server instance** but without the secret log and error indication
+func NewServer(bindAddr string, preMasterSecretLogPath string, handler http.Handler) (server *http.Server, err error) {
+	if handler == nil {
+		return nil, errors.New("server needs handler to handle request")
+	}
+
+	h2Server := &http2.Server{
+		// TODO: extends the idle time after re-use openapi client
+		IdleTimeout: 1 * time.Millisecond,
+	}
+	server = &http.Server{
+		Addr:    bindAddr,
+		Handler: h2c.NewHandler(handler, h2Server),
+	}
+
+	if preMasterSecretLogPath != "" {
+		preMasterSecretFile, err := os.OpenFile(preMasterSecretLogPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
+		if err != nil {
+			return server, fmt.Errorf("create pre-master-secret log [%s] fail: %s", preMasterSecretLogPath, err)
+		}
+		server.TLSConfig = &tls.Config{
+			KeyLogWriter: preMasterSecretFile,
+		}
+	}
+
+	return
+}

http2_util/server_debug.go

@@ -0,0 +1,42 @@
+// Copyright 2019 Communication Service/Software Laboratory, National Chiao Tung University (free5gc.org)
+//
+// SPDX-License-Identifier: Apache-2.0
+
+//+build debug
+
+package http2_util
+
+import (
+	"crypto/tls"
+	"github.com/pkg/errors"
+	"net/http"
+	"os"
+)
+
+type ZeroSource struct{}
+
+func (ZeroSource) Read(b []byte) (n int, err error) {
+	for i := range b {
+		b[i] = 0
+	}
+	return len(b), nil
+}
+
+func NewServer(bindAddr string, tlskeylog string, handler http.Handler) (server *http.Server, err error) {
+	keylogFile, err := os.OpenFile(tlskeylog, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
+	if err != nil {
+		return nil, err
+	}
+	if handler == nil {
+		return nil, errors.New("server need handler")
+	}
+	server = &http.Server{
+		Addr: bindAddr,
+		TLSConfig: &tls.Config{
+			KeyLogWriter: keylogFile,
+			Rand:         ZeroSource{},
+		},
+		Handler: handler,
+	}
+	return
+}

logger_conf/conf.go

@@ -0,0 +1,65 @@
+// Copyright 2019 Communication Service/Software Laboratory, National Chiao Tung University (free5gc.org)
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package logger_conf
+
+import (
+	"log"
+	"os"
+	"strconv"
+
+	"github.com/omec-project/util/path_util"
+)
+
+var Free5gcLogDir string = path_util.Free5gcPath("free5gc/log") + "/"
+var LibLogDir string = Free5gcLogDir + "lib/"
+var NfLogDir string = Free5gcLogDir + "nf/"
+
+var Free5gcLogFile string = Free5gcLogDir + "free5gc.log"
+
+func init() {
+	if err := os.MkdirAll(LibLogDir, 0775); err != nil {
+		log.Printf("Mkdir %s failed: %+v", LibLogDir, err)
+	}
+	if err := os.MkdirAll(NfLogDir, 0775); err != nil {
+		log.Printf("Mkdir %s failed: %+v", NfLogDir, err)
+	}
+
+	// Create log file or if it already exist, check if user can access it
+	f, fileOpenErr := os.OpenFile(Free5gcLogFile, os.O_CREATE|os.O_APPEND|os.O_RDWR, 0666)
+	if fileOpenErr != nil {
+		// user cannot access it.
+		log.Printf("Cannot Open %s\n", Free5gcLogFile)
+	} else {
+		// user can access it
+		if err := f.Close(); err != nil {
+			log.Printf("File %s cannot been closed\n", Free5gcLogFile)
+		}
+	}
+
+	sudoUID, errUID := strconv.Atoi(os.Getenv("SUDO_UID"))
+	sudoGID, errGID := strconv.Atoi(os.Getenv("SUDO_GID"))
+
+	if errUID == nil && errGID == nil {
+		// if using sudo to run the program, errUID will be nil and sudoUID will get the uid who run sudo
+		// else errUID will not be nil and sudoUID will be nil
+		// If user using sudo to run the program and create log file, log will own by root,
+		// here we change own to user so user can view and reuse the file
+		if err := os.Chown(Free5gcLogDir, sudoUID, sudoGID); err != nil {
+			log.Printf("Dir %s chown to %d:%d error: %v\n", Free5gcLogDir, sudoUID, sudoGID, err)
+		}
+		if err := os.Chown(LibLogDir, sudoUID, sudoGID); err != nil {
+			log.Printf("Dir %s chown to %d:%d error: %v\n", LibLogDir, sudoUID, sudoGID, err)
+		}
+		if err := os.Chown(NfLogDir, sudoUID, sudoGID); err != nil {
+			log.Printf("Dir %s chown to %d:%d error: %v\n", NfLogDir, sudoUID, sudoGID, err)
+		}
+
+		if fileOpenErr == nil {
+			if err := os.Chown(Free5gcLogFile, sudoUID, sudoGID); err != nil {
+				log.Printf("File %s chown to %d:%d error: %v\n", Free5gcLogFile, sudoUID, sudoGID, err)
+			}
+		}
+	}
+}

logger_util/log_level.go

@@ -0,0 +1,80 @@
+// Copyright 2019 Communication Service/Software Laboratory, National Chiao Tung University (free5gc.org)
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package logger_util
+
+import (
+	"reflect"
+
+	"github.com/asaskevich/govalidator"
+)
+
+type Logger struct {
+	AMF   *LogSetting `yaml:"AMF" valid:"optional"`
+	AUSF  *LogSetting `yaml:"AUSF" valid:"optional"`
+	N3IWF *LogSetting `yaml:"N3IWF" valid:"optional"`
+	NRF   *LogSetting `yaml:"NRF" valid:"optional"`
+	NSSF  *LogSetting `yaml:"NSSF" valid:"optional"`
+	PCF   *LogSetting `yaml:"PCF" valid:"optional"`
+	SMF   *LogSetting `yaml:"SMF" valid:"optional"`
+	UDM   *LogSetting `yaml:"UDM" valid:"optional"`
+	UDR   *LogSetting `yaml:"UDR" valid:"optional"`
+	UPF   *LogSetting `yaml:"UPF" valid:"optional"`
+	NEF   *LogSetting `yaml:"NEF" valid:"optional"`
+	WEBUI *LogSetting `yaml:"WEBUI" valid:"optional"`
+
+	Aper                         *LogSetting `yaml:"Aper" valid:"optional"`
+	CommonConsumerTest           *LogSetting `yaml:"CommonConsumerTest" valid:"optional"`
+	FSM                          *LogSetting `yaml:"FSM" valid:"optional"`
+	MongoDBLibrary               *LogSetting `yaml:"MongoDBLibrary" valid:"optional"`
+	NAS                          *LogSetting `yaml:"NAS" valid:"optional"`
+	NGAP                         *LogSetting `yaml:"NGAP" valid:"optional"`
+	OpenApi                      *LogSetting `yaml:"OpenApi" valid:"optional"`
+	NamfCommunication            *LogSetting `yaml:"NamfCommunication" valid:"optional"`
+	NamfEventExposure            *LogSetting `yaml:"NamfEventExposure" valid:"optional"`
+	NnssfNSSAIAvailability       *LogSetting `yaml:"NnssfNSSAIAvailability" valid:"optional"`
+	NnssfNSSelection             *LogSetting `yaml:"NnssfNSSelection" valid:"optional"`
+	NsmfEventExposure            *LogSetting `yaml:"NsmfEventExposure" valid:"optional"`
+	NsmfPDUSession               *LogSetting `yaml:"NsmfPDUSession" valid:"optional"`
+	NudmEventExposure            *LogSetting `yaml:"NudmEventExposure" valid:"optional"`
+	NudmParameterProvision       *LogSetting `yaml:"NudmParameterProvision" valid:"optional"`
+	NudmSubscriberDataManagement *LogSetting `yaml:"NudmSubscriberDataManagement" valid:"optional"`
+	NudmUEAuthentication         *LogSetting `yaml:"NudmUEAuthentication" valid:"optional"`
+	NudmUEContextManagement      *LogSetting `yaml:"NudmUEContextManagement" valid:"optional"`
+	NudrDataRepository           *LogSetting `yaml:"NudrDataRepository" valid:"optional"`
+	PathUtil                     *LogSetting `yaml:"PathUtil" valid:"optional"`
+	PFCP                         *LogSetting `yaml:"PFCP" valid:"optional"`
+}
+
+func (l *Logger) Validate() (bool, error) {
+	logger := reflect.ValueOf(l).Elem()
+	for i := 0; i < logger.NumField(); i++ {
+		if logSetting := logger.Field(i).Interface().(*LogSetting); logSetting != nil {
+			result, err := logSetting.validate()
+			return result, err
+		}
+	}
+
+	result, err := govalidator.ValidateStruct(l)
+	return result, err
+}
+
+type LogSetting struct {
+	DebugLevel   string `yaml:"debugLevel" valid:"debugLevel"`
+	ReportCaller bool   `yaml:"ReportCaller" valid:"type(bool)"`
+}
+
+func (l *LogSetting) validate() (bool, error) {
+	govalidator.TagMap["debugLevel"] = govalidator.Validator(func(str string) bool {
+		if str == "panic" || str == "fatal" || str == "error" || str == "warn" ||
+			str == "info" || str == "debug" || str == "trace" {
+			return true
+		} else {
+			return false
+		}
+	})
+
+	result, err := govalidator.ValidateStruct(l)
+	return result, err
+}