Add cross-origin resource sharing for Orion (#394)

lets-fiware · Jun 13, 2024 · fe810ab · fe810ab
1 parent 1bc3828
commit fe810ab
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 5 deletions.
diff --git a/.config.sh b/.config.sh
@@ -48,6 +48,9 @@ ORION=orion
 # Expose port 1026 (none, local, all) Default: none
 ORION_EXPOSE_PORT=
 
+# Enable cross-origin resource sharing (CORS) Default: false
+ORION_CORS=
+
 # Docker image for Orion
 IMAGE_ORION=telefonicaiot/fiware-orion:4.0.0
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## FIWARE Big Bang v0.39.0-next
 
+-   Add cross-origin resource sharing for Orion (#394)
 -   Fix maintenance script (#393)
 
 ## FIWARE Big Bang v0.39.0 - 09 June, 2024

diff --git a/config.sh b/config.sh
@@ -48,6 +48,9 @@ ORION=orion
 # Expose port 1026 (none, local, all) Default: none
 ORION_EXPOSE_PORT=
 
+# Enable cross-origin resource sharing (CORS) Default: false
+ORION_CORS=
+
 # Docker image for Orion
 IMAGE_ORION=telefonicaiot/fiware-orion:4.0.0
 

diff --git a/docs/en/installation/orion.md b/docs/en/installation/orion.md
@@ -15,10 +15,11 @@
 
 You can specify configurations by editing the `config.sh` file.
 
-| Variable name       | Description                           | Default value |
-| ------------------- | ------------------------------------- | ------------- |
-| ORION               | A sub-domain name of Orion.           | orion         | 
-| ORION\_EXPOSE\_PORT | Expose port 1026. (none, local, all)  | none          |
+| Variable name       | Description                                 | Default value |
+| ------------------- | ------------------------------------------- | ------------- |
+| ORION               | A sub-domain name of Orion.                 | orion         |
+| ORION\_EXPOSE\_PORT | Expose port 1026. (none, local, all)        | none          |
+| ORION\_CORS         | Enable cross-origin resource sharing (CORS) | false         |
 
 ## How to setup
 

diff --git a/docs/ja/installation/orion.md b/docs/ja/installation/orion.md
@@ -21,6 +21,7 @@
 | ------------------- | ---------------------------------------------------- | ------ |
 | ORION               | Orion のサブドメイン名                               | orion  | 
 | ORION\_EXPOSE\_PORT | Orion のポート 1026 を公開。(none, local または all) | none   |
+| ORION\_CORS         | Cross-origin resource sharing (CORS) を有効化        | false  |
 
 <a name="how-to-setup"></a>
 

diff --git a/lets-fiware.sh b/lets-fiware.sh
@@ -124,6 +124,10 @@ set_default_values() {
     ORION_EXPOSE_PORT=none
   fi
 
+  if [ -z "${ORION_CORS=}" ]; then
+    ORION_CORS=false
+  fi
+
   if [ -z "${ORION_LD_EXPOSE_PORT}" ]; then
     ORION_LD_EXPOSE_PORT=none
   fi
@@ -1958,6 +1962,11 @@ EOF
 
   create_nginx_conf "${ORION}" "nginx-orion"
 
+  if "${ORION_CORS}"; then
+    sed -i "/__NGINX_ORION_CORS_HEADERS__/r ${SETUP_DIR}/template/nginx/nginx-orion-cors-headers" "${NGINX_SITES}/${ORION}"
+    sed -i "/__NGINX_ORION_CORS_REQUEST_METHOD__/r ${SETUP_DIR}/template/nginx/nginx-orion-cors-request-method" "${NGINX_SITES}/${ORION}"
+  fi
+
   add_nginx_depends_on "orion"
 
   add_rsyslog_conf "orion"
@@ -3648,7 +3657,7 @@ setup_end() {
     sed -i -e "/# __NGINX_KEYROCK__/d" "${NGINX_SITES}/${KEYROCK}"
   fi
   if [ -n "${ORION}" ]; then
-    sed -i -e "/# __NGINX_ORION__/d" "${NGINX_SITES}/${ORION}"
+    sed -i -e "/# __NGINX_ORION_/d" "${NGINX_SITES}/${ORION}"
   fi
   if [ -n "${ORION_LD}" ]; then
     sed -i -e "/# __NGINX_ORION_LD__/d" "${NGINX_SITES}/${ORION_LD}"

diff --git a/setup/template/nginx/nginx-orion b/setup/template/nginx/nginx-orion
@@ -31,7 +31,9 @@ server {
   add_header              Front-End-Https   on;
   add_header              Strict-Transport-Security 'max-age=15768000; includeSubdomains; always';
 
+  # __NGINX_ORION_CORS_HEADERS__
   location / {
+    # __NGINX_ORION_CORS_REQUEST_METHOD__
     set $req_uri "$uri";
     auth_request /_check_oauth2_token;
 

diff --git a/setup/template/nginx/nginx-orion-cors-headers b/setup/template/nginx/nginx-orion-cors-headers
@@ -0,0 +1,6 @@
+  # Add CORS Headers
+  add_header 'Access-Control-Allow-Origin' '*' always;
+  add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS, DELETE, PUT, PATCH' always;
+  add_header 'Access-Control-Allow-Headers' 'Origin, Content-Type, Accept, Authorization, X-Requested-With, fiware-service, fiware-servicepath' always;
+  add_header 'Access-Control-Expose-Headers' 'location, fiware-correlator' always;
+
diff --git a/setup/template/nginx/nginx-orion-cors-request-method b/setup/template/nginx/nginx-orion-cors-request-method
@@ -0,0 +1,11 @@
+    if ($request_method = 'OPTIONS') {
+      add_header 'Access-Control-Allow-Origin' '*' always;
+      add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS, DELETE, PUT, PATCH' always;
+      add_header 'Access-Control-Allow-Headers' 'Origin, Content-Type, Accept, Authorization, X-Requested-With, fiware-service, fiware-servicepath' always;
+      add_header 'Access-Control-Expose-Headers' 'location, fiware-correlator' always;
+      add_header 'Access-Control-Max-Age' 1728000;
+      add_header 'Content-Type' 'text/plain charset=UTF-8';
+      add_header 'Content-Length' 0;
+      return 204;
+    }
+
diff --git a/tests/script/coverage.sh b/tests/script/coverage.sh
@@ -253,6 +253,7 @@ install_test1() {
   sudo apt remove -y rsyslog
 
   sed -i -e "s/^\(ORION_EXPOSE_PORT=\).*/\1local/" config.sh
+  sed -i -e "s/^\(ORION_CORS=\).*/\1true/" config.sh
   sed -i -e "s/^\(CYGNUS=\).*/\1cygnus/" config.sh
   sed -i -e "s/^\(COMET=\).*/\1comet/" config.sh
   sed -i -e "s/^\(QUANTUMLEAP=\).*/\1quantumleap/" config.sh