Logger refactor (#451)

* update NFs' hash and config * update test case in test/ (#449) * update webconsole's hash, fix testNon3GPP panic (#450) * update webconsole's hash * fix testNon3GPP panic * update n3iwf module hash * update upf's commit hash --------- Co-authored-by: brianchennn <46628572+brianchennn@users.noreply.github.com> Co-authored-by: Ian Chen <ychen.desl@gmail.com>
free5gc · Jun 8, 2023 · 470b8bf · 470b8bf
1 parent 0263866
commit 470b8bf
Show file tree

Hide file tree

Showing 57 changed files with 1,069 additions and 557 deletions.
diff --git a/NFs/amf b/NFs/amf
diff --git a/NFs/ausf b/NFs/ausf
diff --git a/NFs/n3iwf b/NFs/n3iwf
diff --git a/NFs/nrf b/NFs/nrf
diff --git a/NFs/nssf b/NFs/nssf
diff --git a/NFs/pcf b/NFs/pcf
diff --git a/NFs/smf b/NFs/smf
diff --git a/NFs/udm b/NFs/udm
diff --git a/NFs/udr b/NFs/udr
diff --git a/NFs/upf b/NFs/upf
diff --git a/config/TLS/amf.key → cert/amf.key b/config/TLS/amf.key → cert/amf.key
diff --git a/config/TLS/amf.pem → cert/amf.pem b/config/TLS/amf.pem → cert/amf.pem
diff --git a/config/TLS/ausf.key → cert/ausf.key b/config/TLS/ausf.key → cert/ausf.key
diff --git a/config/TLS/ausf.pem → cert/ausf.pem b/config/TLS/ausf.pem → cert/ausf.pem
diff --git a/config/TLS/n3iwf.key → cert/n3iwf.key b/config/TLS/n3iwf.key → cert/n3iwf.key
diff --git a/config/TLS/n3iwf.pem → cert/n3iwf.pem b/config/TLS/n3iwf.pem → cert/n3iwf.pem
diff --git a/config/TLS/nrf.key → cert/nrf.key b/config/TLS/nrf.key → cert/nrf.key
diff --git a/config/TLS/nrf.pem → cert/nrf.pem b/config/TLS/nrf.pem → cert/nrf.pem
diff --git a/config/TLS/nssf.key → cert/nssf.key b/config/TLS/nssf.key → cert/nssf.key
diff --git a/config/TLS/nssf.pem → cert/nssf.pem b/config/TLS/nssf.pem → cert/nssf.pem
diff --git a/config/TLS/pcf.key → cert/pcf.key b/config/TLS/pcf.key → cert/pcf.key
diff --git a/config/TLS/pcf.pem → cert/pcf.pem b/config/TLS/pcf.pem → cert/pcf.pem
diff --git a/config/TLS/smf.key → cert/smf.key b/config/TLS/smf.key → cert/smf.key
diff --git a/config/TLS/smf.pem → cert/smf.pem b/config/TLS/smf.pem → cert/smf.pem
diff --git a/config/TLS/udm.key → cert/udm.key b/config/TLS/udm.key → cert/udm.key
diff --git a/config/TLS/udm.pem → cert/udm.pem b/config/TLS/udm.pem → cert/udm.pem
diff --git a/config/TLS/udr.key → cert/udr.key b/config/TLS/udr.key → cert/udr.key
diff --git a/config/TLS/udr.pem → cert/udr.pem b/config/TLS/udr.pem → cert/udr.pem
diff --git a/config/amfcfg.yaml b/config/amfcfg.yaml
@@ -1,19 +1,20 @@
 info:
-  version: 1.0.3
+  version: 1.0.9
   description: AMF initial local configuration
 
 configuration:
   amfName: AMF # the name of this AMF
   ngapIpList:  # the IP list of N2 interfaces on this AMF
     - 127.0.0.18
+  ngapPort: 38412 # the SCTP port listened by NGAP
   sbi: # Service-based interface information
     scheme: http # the protocol for sbi (http or https)
     registerIPv4: 127.0.0.18 # IP used to register to NRF
     bindingIPv4: 127.0.0.18  # IP used to bind the service
     port: 8000 # port used to bind the service
     tls: # the local path of TLS key
-      pem: config/TLS/amf.pem # AMF TLS Certificate
-      key: config/TLS/amf.key # AMF TLS Private key
+      pem: cert/amf.pem # AMF TLS Certificate
+      key: cert/amf.key # AMF TLS Private key
   serviceNameList: # the SBI services provided by this AMF, refer to TS 29.518
     - namf-comm # Namf_Communication service
     - namf-evts # Namf_EventExposure service
@@ -30,7 +31,7 @@ configuration:
     - plmnId: # Public Land Mobile Network ID, <PLMN ID> = <MCC><MNC>
         mcc: 208 # Mobile Country Code (3 digits string, digit: 0~9)
         mnc: 93 # Mobile Network Code (2 or 3 digits string, digit: 0~9)
-      tac: 1 # Tracking Area Code (uinteger, range: 0~16777215)
+      tac: 000001 # Tracking Area Code (3 bytes hex string, range: 000000~FFFFFF)
   plmnSupportList: # the PLMNs (Public land mobile network) list supported by this AMF
     - plmnId: # Public Land Mobile Network ID, <PLMN ID> = <MCC><MNC>
         mcc: 208 # Mobile Country Code (3 digits string, digit: 0~9)
@@ -53,20 +54,27 @@ configuration:
   networkName:  # the name of this core network
     full: free5GC
     short: free
-  locality: area1 # Name of the location where a set of AMF, SMF and UPFs are located
-  networkFeatureSupport5GS: # 5gs Network Feature Support IE, refer to TS 24.501
-    enable: true # append this IE in Registration accept or not
-    length: 1 # IE content length (uinteger, range: 1~3)
-    imsVoPS: 0 # IMS voice over PS session indicator (uinteger, range: 0~1)
-    emc: 0 # Emergency service support indicator for 3GPP access (uinteger, range: 0~3)
-    emf: 0 # Emergency service fallback indicator for 3GPP access (uinteger, range: 0~3)
-    iwkN26: 0 # Interworking without N26 interface indicator (uinteger, range: 0~1)
-    mpsi: 0 # MPS indicator (uinteger, range: 0~1)
-    emcN3: 0 # Emergency service support indicator for Non-3GPP access (uinteger, range: 0~1)
-    mcsi: 0 # MCS indicator (uinteger, range: 0~1)
+  ngapIE: # Optional NGAP IEs
+    mobilityRestrictionList: # Mobility Restriction List IE, refer to TS 38.413
+      enable: true # append this IE in related message or not
+    maskedIMEISV: # Masked IMEISV IE, refer to TS 38.413
+      enable: true # append this IE in related message or not
+    redirectionVoiceFallback: # Redirection Voice Fallback IE, refer to TS 38.413
+      enable: false # append this IE in related message or not
+  nasIE: # Optional NAS IEs
+    networkFeatureSupport5GS: # 5gs Network Feature Support IE, refer to TS 24.501
+      enable: true # append this IE in Registration accept or not
+      length: 1 # IE content length (uinteger, range: 1~3)
+      imsVoPS: 0 # IMS voice over PS session indicator (uinteger, range: 0~1)
+      emc: 0 # Emergency service support indicator for 3GPP access (uinteger, range: 0~3)
+      emf: 0 # Emergency service fallback indicator for 3GPP access (uinteger, range: 0~3)
+      iwkN26: 0 # Interworking without N26 interface indicator (uinteger, range: 0~1)
+      mpsi: 0 # MPS indicator (uinteger, range: 0~1)
+      emcN3: 0 # Emergency service support indicator for Non-3GPP access (uinteger, range: 0~1)
+      mcsi: 0 # MCS indicator (uinteger, range: 0~1)
   t3502Value: 720  # timer value (seconds) at UE side
   t3512Value: 3600 # timer value (seconds) at UE side
-  non3gppDeregistrationTimerValue: 3240 # timer value (seconds) at UE side
+  non3gppDeregTimerValue: 3240 # timer value (seconds) at UE side
   # retransmission timer for paging message
   t3513:
     enable: true     # true or false
@@ -97,23 +105,15 @@ configuration:
     enable: true     # true or false
     expireTime: 6s   # default is 6 seconds
     maxRetryTimes: 4 # the max number of retransmission
+  locality: area1 # Name of the location where a set of AMF, SMF, PCF and UPFs are located
+  sctp: # set the sctp server setting <optinal>, once this field is set, please also add maxInputStream, maxOsStream, maxAttempts, maxInitTimeOut
+    numOstreams: 3 # the maximum out streams of each sctp connection
+    maxInstreams: 5 # the maximum in streams of each sctp connection
+    maxAttempts: 2 # the maximum attempts of each sctp connection
+    maxInitTimeout: 2 # the maximum init timeout of each sctp connection
+  defaultUECtxReq: false # the default value of UE Context Request to decide when triggering Initial Context Setup procedure
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  AMF:
-    debugLevel: info
-    ReportCaller: false
-  NAS:
-    debugLevel: info
-    ReportCaller: false
-  FSM:
-    debugLevel: info
-    ReportCaller: false
-  NGAP:
-    debugLevel: info
-    ReportCaller: false
-  Aper:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false
diff --git a/config/ausfcfg.yaml b/config/ausfcfg.yaml
@@ -1,5 +1,5 @@
 info:
-  version: 1.0.2
+  version: 1.0.3
   description: AUSF initial local configuration
 
 configuration:
@@ -9,8 +9,8 @@ configuration:
     bindingIPv4: 127.0.0.9  # IP used to bind the service
     port: 8000 # Port used to bind the service
     tls: # the local path of TLS key
-      pem: config/TLS/ausf.pem # AUSF TLS Certificate
-      key: config/TLS/ausf.key # AUSF TLS Private key
+      pem: cert/ausf.pem # AUSF TLS Certificate
+      key: cert/ausf.key # AUSF TLS Private key
   serviceNameList: # the SBI services provided by this AUSF, refer to TS 29.509
     - nausf-auth # Nausf_UEAuthentication service
   nrfUri: http://127.0.0.10:8000 # a valid URI of NRF
@@ -22,10 +22,7 @@ configuration:
   groupId: ausfGroup001 # ID for the group of the AUSF
   eapAkaSupiImsiPrefix: false # including "imsi-" prefix or not when using the SUPI to do EAP-AKA' authentication
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  AUSF:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false
diff --git a/config/n3iwfcfg.test.yaml b/config/n3iwfcfg.test.yaml
@@ -1,5 +1,5 @@
 info:
-  version: 1.0.4
+  version: 1.0.5
   description: N3IWF initial local configuration
 
 configuration:
@@ -27,9 +27,8 @@ configuration:
   # --- N2 Interfaces ---
   AMFSCTPAddresses: # the IP list of N2 interfaces (SCTP) on AMF when using NGAP
     - IP:
-      - 10.200.200.1
+        - 10.200.200.1
       Port: 38412
-
   NASTCPPort: 20000 # TCP port which the NAS listens on
 
   # --- Nwu Interfaces ---
@@ -45,26 +44,17 @@ configuration:
   FQDN: n3iwf.free5gc.org # FQDN of this N3IWF
 
   # --- Security ---
-  PrivateKey: config/TLS/n3iwf.key # Private key file path
-  CertificateAuthority: config/TLS/n3iwf.pem # Certificate Authority (CA) file path
-  Certificate: config/TLS/n3iwf.pem # Certificate file path
+  PrivateKey: cert/n3iwf.key # Private key file path
+  CertificateAuthority: cert/n3iwf.pem # Certificate Authority (CA) file path
+  Certificate: cert/n3iwf.pem # Certificate file path
 
   # sending dead peer detection message
   LivenessCheck:
     enable: true # true or false
     transFreq: 60s # frequency of transmission
     maxRetryTimes: 4 # the max number of DPD response of UE
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  N3IWF: # The default log level is DEBUG to print SA keys. Please change it to INFO when deployed.
-    debugLevel: debug
-    ReportCaller: false
-  NGAP:
-    debugLevel: info
-    ReportCaller: false
-  Aper:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false
diff --git a/config/n3iwfcfg.yaml b/config/n3iwfcfg.yaml
@@ -1,5 +1,5 @@
 info:
-  version: 1.0.4
+  version: 1.0.5
   description: N3IWF initial local configuration
 
 configuration:
@@ -27,7 +27,7 @@ configuration:
   # --- N2 Interfaces ---
   AMFSCTPAddresses: # the IP list of N2 interfaces (SCTP) on AMF when using NGAP
     - IP:
-      - 127.0.0.18
+        - 127.0.0.18
       Port: 38412
   NASTCPPort: 20000 # TCP port which the NAS listens on
 
@@ -44,26 +44,17 @@ configuration:
   FQDN: n3iwf.free5gc.org # FQDN of this N3IWF
 
   # --- Security ---
-  PrivateKey: config/TLS/n3iwf.key # Private key file path
-  CertificateAuthority: config/TLS/n3iwf.pem # Certificate Authority (CA) file path
-  Certificate: config/TLS/n3iwf.pem # Certificate file path
+  PrivateKey: cert/n3iwf.key # Private key file path
+  CertificateAuthority: cert/n3iwf.pem # Certificate Authority (CA) file path
+  Certificate: cert/n3iwf.pem # Certificate file path
 
   # sending dead peer detection message
   LivenessCheck:
     enable: true # true or false
     transFreq: 60s # frequency of transmission
     maxRetryTimes: 4 # the max number of DPD response of UE
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  N3IWF: # The default log level is DEBUG to print SA keys. Please change it to INFO when deployed.
-    debugLevel: debug
-    ReportCaller: false
-  NGAP:
-    debugLevel: info
-    ReportCaller: false
-  Aper:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false
diff --git a/config/nrfcfg.yaml b/config/nrfcfg.yaml
@@ -10,20 +10,17 @@ configuration:
     registerIPv4: 127.0.0.10 # IP used to serve NFs or register to another NRF
     bindingIPv4: 127.0.0.10  # IP used to bind the service
     port: 8000 # port used to bind the service
-    # cert: config/cert/nrf.pem # NRF Certificate
-    # rootcert: config/cert/root.pem # Root Certificate
-    # oauth: false # OAuth2
+    tls: # the local path of TLS key
+      pem: cert/nrf.pem # NRF TLS Certificate
+      key: cert/nrf.key # NRF TLS Private key
   DefaultPlmnId:
     mcc: 208 # Mobile Country Code (3 digits string, digit: 0~9)
     mnc: 93 # Mobile Network Code (2 or 3 digits string, digit: 0~9)
   serviceNameList: # the SBI services provided by this NRF, refer to TS 29.510
     - nnrf-nfm # Nnrf_NFManagement service
     - nnrf-disc # Nnrf_NFDiscovery service
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  NRF:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false
diff --git a/config/nssfcfg.yaml b/config/nssfcfg.yaml
@@ -1,5 +1,5 @@
 info:
-  version: 1.0.1
+  version: 1.0.2
   description: NSSF initial local configuration
 
 configuration:
@@ -10,8 +10,8 @@ configuration:
     bindingIPv4: 127.0.0.31  # IP used to bind the service
     port: 8000 # Port used to bind the service
     tls: # the local path of TLS key
-      pem: config/TLS/nssf.pem # NSSF TLS Certificate
-      key: config/TLS/nssf.key # NSSF TLS Private key
+      pem: cert/nssf.pem # NSSF TLS Certificate
+      key: cert/nssf.key # NSSF TLS Private key
   serviceNameList: # the SBI services provided by this SMF, refer to TS 29.531
     - nnssf-nsselection # Nnssf_NSSelection service
     - nnssf-nssaiavailability # Nnssf_NSSAIAvailability service
@@ -346,10 +346,7 @@ configuration:
             sst: 1 # Slice/Service Type (uinteger, range: 0~255)
             sd: 000003 # Slice Differentiator (3 bytes hex string, range: 000000~FFFFFF)
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  NSSF:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false
diff --git a/config/pcfcfg.yaml b/config/pcfcfg.yaml
@@ -1,5 +1,5 @@
 info:
-  version: 1.0.1
+  version: 1.0.2
   description: PCF initial local configuration
 
 configuration:
@@ -10,8 +10,8 @@ configuration:
     bindingIPv4: 127.0.0.7  # IP used to bind the service
     port: 8000              # port used to bind the service
     tls: # the local path of TLS key
-      pem: config/TLS/pcf.pem # PCF TLS Certificate
-      key: config/TLS/pcf.key # PCF TLS Private key
+      pem: cert/pcf.pem # PCF TLS Certificate
+      key: cert/pcf.key # PCF TLS Private key
   timeFormat: 2019-01-02 15:04:05 # time format of this PCF
   defaultBdtRefId: BdtPolicyId-   # BDT Reference ID, indicating transfer policies of background data transfer.
   nrfUri: http://127.0.0.10:8000  # a valid URI of NRF
@@ -29,10 +29,7 @@ configuration:
     url: mongodb://localhost:27017 # a valid URL of the mongodb
   locality: area1 # Name of the location where a set of AMF, SMF, PCF and UPFs are located
 
-# the kind of log output
-# debugLevel: how detailed to output, value: trace, debug, info, warn, error, fatal, panic
-# ReportCaller: enable the caller report or not, value: true or false
-logger:
-  PCF:
-    debugLevel: info
-    ReportCaller: false
+logger: # log output setting
+  enable: true # true or false
+  level: info # how detailed to output, value: trace, debug, info, warn, error, fatal, panic
+  reportCaller: false # enable the caller report or not, value: true or false