Merge pull request #208 from Malte96/tud-add_authorization_header

Add authorization field to fiware-header

CHANGELOG.md

@@ -1,3 +1,6 @@
+#### v0.3.1
+- add tutorial for protected endpoint with bearer authentication ([#208](https://github.com/RWTH-EBC/FiLiP/issues/208))
+
 #### v0.3.0
 - fixed inconsistency of `entity_type` as required argument ([#188](https://github.com/RWTH-EBC/FiLiP/issues/188))
 - BREAKING CHANGE: Migration of pydantic v1 to v2 ([#199](https://github.com/RWTH-EBC/FiLiP/issues/199))

examples/basics/e02_baerer_token.py

@@ -0,0 +1,31 @@
+"""
+# Examples for initializing a contextbroker client with authorization via bearer
+token.
+- The authorization key is provided via the FiwareHeaderSecure class.
+- The parameters should be provided via environment variables or a .env file.
+"""
+
+from filip.models.base import FiwareHeaderSecure
+from filip.clients.ngsi_v2 import ContextBrokerClient
+
+# ## Parameters
+# Host address of Context Broker
+CB_URL = "https://localhost:1026"
+# FIWARE-Service
+fiware_service = 'filip'
+# FIWARE-Servicepath
+fiware_service_path = '/example'
+# FIWARE-Bearer token
+# TODO it has to be replaced with the token of your protected endpoint
+fiware_baerer_token = 'BAERER_TOKEN'
+
+if __name__ == '__main__':
+    fiware_header = FiwareHeaderSecure(service=fiware_service,
+                                       service_path=fiware_service_path,
+                                       authorization=f"""Bearer {
+                                       fiware_baerer_token}""")
+    cb_client = ContextBrokerClient(url=CB_URL,
+                                    fiware_header=fiware_header)
+    # query entities from protected orion endpoint
+    entity_list = cb_client.get_entity_list()
+    print(entity_list)

filip/models/base.py

@@ -93,6 +93,21 @@ class FiwareHeader(BaseModel):
         validate_fiware_service_path)
 
 
+class FiwareHeaderSecure(FiwareHeader):
+    """
+    Defines entity service paths and a autorization via Baerer-Token which are supported by the NGSI
+    Context Brokers to support hierarchical scopes:
+    https://fiware-orion.readthedocs.io/en/master/user/service_path/index.html
+    """
+    authorization: str = Field(
+        alias="authorization",
+        default="",
+        max_length=3000,
+        description="authorization key",
+        regex=r".*"
+    )
+
+
 class LogLevel(str, Enum):
     CRITICAL = 'CRITICAL'
     ERROR = 'ERROR'