Merge remote-tracking branch 'origin/dockerfile' into develop

3gpp_specs/TS29510_Nnrf_AccessToken.yaml

+openapi: 3.0.0
+info:
+  version: '1.0.2'
+  title: 'NRF OAuth2'
+  description: |
+    NRF OAuth2 Authorization.
+    © 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
+    All rights reserved.
+paths:
+  /oauth2/token:
+    post:
+      summary: Access Token Request
+      operationId: AccessTokenRequest
+      tags:
+        - Access Token Request
+      requestBody:
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/AccessTokenReq'
+        required: true
+      responses:
+        '200':
+          description: Successful Access Token Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AccessTokenRsp'
+          headers:
+            Cache-Control:
+              $ref: '#/components/headers/cache-control'
+            Pragma:
+              $ref: '#/components/headers/pragma'
+        '307':
+          description: Temporary Redirect
+        '400':
+          description: Error in the Access Token Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AccessTokenErr'
+          headers:
+            Cache-Control:
+              $ref: '#/components/headers/cache-control'
+            Pragma:
+              $ref: '#/components/headers/pragma'
+        '401':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/401'
+        '403':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/403'
+        '404':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/404'
+        '411':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/411'
+        '413':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/413'
+        '415':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/415'
+        '429':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/429'
+        '500':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/500'
+        '501':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/501'
+        '503':
+          $ref: 'TS29571_CommonData.yaml#/components/responses/503'
+        default:
+          $ref: 'TS29571_CommonData.yaml#/components/responses/default'
+components:
+  headers:
+    cache-control:
+      required: true
+      schema:
+        type: string
+        enum:
+          - no-store
+    pragma:
+      required: true
+      schema:
+        type: string
+        enum:
+          - no-cache
+  schemas:
+    AccessTokenReq:
+      type: object
+      required:
+        - grant_type
+        - nfInstanceId
+        - scope
+      properties:
+        grant_type:
+          type: string
+          enum:
+            - client_credentials
+        nfInstanceId:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
+        nfType:
+          $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
+        targetNfType:
+          $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
+        scope:
+          type: string
+          pattern: '^([a-zA-Z0-9_-]+)( [a-zA-Z0-9_-]+)*$'
+        targetNfInstanceId:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
+        requesterPlmn:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
+        targetPlmn:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
+    AccessTokenRsp:
+      type: object
+      required:
+        - access_token
+        - token_type
+      properties:
+        access_token:
+          type: string
+          description: JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims)
+        token_type:
+          type: string
+          enum:
+            - Bearer
+        expires_in:
+          type: integer
+        scope:
+          type: string
+          pattern: '^([a-zA-Z0-9_-]+)( [a-zA-Z0-9_-]+)*$'
+    AccessTokenClaims:
+      type: object
+      required:
+        - iss
+        - sub
+        - aud
+        - scope
+        - exp
+      properties:
+        iss:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
+        sub:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
+        aud:
+          anyOf:
+            - $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType'
+            - type: array
+              items:
+                $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
+              minItems: 1
+        scope:
+          type: string
+          pattern: '^([a-zA-Z0-9_-]+)( [a-zA-Z0-9_-]+)*$'
+        exp:
+          type: integer
+        consumerPlmnId:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
+        producerPlmnId:
+          $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
+    AccessTokenErr:
+      type: object
+      required:
+        - error
+      properties:
+        error:
+          type: string
+          enum:
+            - invalid_request
+            - invalid_client
+            - invalid_grant
+            - unauthorized_client
+            - unsupported_grant_type
+            - invalid_scope
+        error_description:
+          type: string
+        error_uri:
+          type: string
+externalDocs:
+  description: 3GPP TS 29.510 V15.3.0; 5G System; Network Function Repository Services; Stage 3
+  url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.510/'

3gpp_specs/config.json

+{
+    "modelPackage"   : "oai.nrf.model",
+    "apiPackage"     : "oai.nrf.api"
+}

CHANGELOG.md

 # RELEASE NOTES: #
 
-## vX.X.X -- YYY 2021 ##
+## v1.0.0 -- Jan 2021 ##
 
 * Initial release
 

NOTICE

+NRF is distributed under OAI Public License (Version 1.1).
+
+However, it also includes third party-software indicated below.
+
+#To be updated
\ No newline at end of file

README.md

@@ -59,7 +59,19 @@ The OpenAirInterface CN NRF software is composed of the following parts:
 
 <pre>
 openair-cn5g-nrf
+├── 3gpp-specs:    Directory containing 3GPP specification files (YAML) used to implement NRF network function. 
+├── build:         Build directory, contains targets and object files generated by compilation of network functions. 
+    ├── log:       Directory containing build log files.
+    ├── scripts:   Directory containing scripts for building network functions.
+    └── nrf:       Directory containing CMakefile.txt and object files generated by compilation of NRF network function. 
 ├── ci-scripts:    Directory containing the script files for CI framework.
+├── docs:          Directory containing the documentation files.
+├── etc:           Directory containing the configuration file to be deployed for NRF.
 └── src:           Source files of NRF.
+    ├── api-server: NRF services APIs. 
     ├── common:    Common header files
+    │   └── utils: Common utilities.
+    ├── oai_nrf:   NRF main directory, contains the "main" CMakeLists.txt file.
+    ├── nrf_app:   NRF network functions procedures and contexts.
+    └── test:      Directory containing some example profiles for e.g., AMF, SMF.
 </pre>

build/cmake_modules/FindEvent.cmake

+# Find Libevent
+# http://monkey.org/~provos/libevent/
+#
+# Once done, this will define:
+#
+#  Event_FOUND - system has Event
+#  Event_INCLUDE_DIRS - the Event include directories
+#  Event_LIBRARIES - link these to use Event
+#
+
+if (EVENT_INCLUDE_DIR AND EVENT_LIBRARY)
+  # Already in cache, be silent
+  set(EVENT_FIND_QUIETLY TRUE)
+endif (EVENT_INCLUDE_DIR AND EVENT_LIBRARY)
+
+find_path(EVENT_INCLUDE_DIR event.h
+  PATHS /usr/include
+  PATH_SUFFIXES event
+)
+
+find_library(EVENT_LIBRARY
+  NAMES event
+  PATHS /usr/lib /usr/local/lib
+)
+
+set(EVENT_LIBRARIES ${EVENT_LIBRARY} )
+
+add_definitions(-DLIBNET_LIL_ENDIAN)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(EVENT
+  DEFAULT_MSG
+  EVENT_INCLUDE_DIR
+  EVENT_LIBRARIES
+)
+
+mark_as_advanced(EVENT_INCLUDE_DIR EVENT_LIBRARY)

build/cmake_modules/Kbuild.cmake

+src=${dir}
+obj-m += ${name}.o
+${name}-y += ${objs}
+ccflags-y += ${module_cc_opt}