From 1f33860bfcd353c472881a8db513ec956ed43193 Mon Sep 17 00:00:00 2001 From: Alvaro Vega Date: Tue, 18 Jun 2024 10:07:40 +0200 Subject: [PATCH 1/4] update mongo sink adding ssl options --- .../backends/mongo/MongoBackendImpl.java | 18 ++++++++++-- .../backends/mongo/MongoBackendImplTest.java | 14 ++++----- .../iot/cygnus/sinks/NGSIMongoBaseSink.java | 29 ++++++++++++++++++- 3 files changed, 50 insertions(+), 11 deletions(-) diff --git a/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java b/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java index 9b263e01e..d5de16376 100644 --- a/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java +++ b/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java @@ -60,6 +60,8 @@ public enum Resolution { SECOND, MINUTE, HOUR, DAY, MONTH } private final String mongoPassword; private final String mongoAuthSource; private final String mongoReplicaSet; + private final Boolean sslEnabled; + private final Boolean sslInvalidHostNameAllowed; private final DataModel dataModel; private static final CygnusLogger LOGGER = new CygnusLogger(MongoBackendImpl.class); @@ -73,13 +75,16 @@ public enum Resolution { SECOND, MINUTE, HOUR, DAY, MONTH } * @param dataModel */ public MongoBackendImpl(String mongoHosts, String mongoUsername, String mongoPassword, - String mongoAuthSource, String mongoReplicaSet, DataModel dataModel) { + String mongoAuthSource, String mongoReplicaSet, DataModel dataModel, + Boolean sslEnabled, Boolean sslInvalidHostNameAllowed) { client = null; this.mongoHosts = mongoHosts; this.mongoUsername = mongoUsername; this.mongoPassword = mongoPassword; this.mongoAuthSource = mongoAuthSource; this.mongoReplicaSet = mongoReplicaSet; + this.sslEnabled = sslEnabled; + this.sslInvalidHostNameAllowed = sslInvalidHostNameAllowed; this.dataModel = dataModel; } // MongoBackendImpl @@ -592,6 +597,7 @@ private MongoDatabase getDatabase(String dbName) { } MongoCredential credential = MongoCredential.createCredential(mongoUsername, authSource, mongoPassword.toCharArray()); + /**** // This constructor is deprecated see Mongo Client API documentation // @deprecated Prefer {@link #MongoClient(List, MongoCredential, MongoClientOptions)} @@ -599,9 +605,15 @@ private MongoDatabase getDatabase(String dbName) { ****/ if ((mongoReplicaSet!= null) && !mongoReplicaSet.isEmpty()) { client = new MongoClient(servers, credential, new MongoClientOptions.Builder(). - requiredReplicaSetName(mongoReplicaSet).build()); + requiredReplicaSetName(mongoReplicaSet). + sslEnabled(sslEnabled). + sslInvalidHostNameAllowed(sslInvalidHostNameAllowed). + build()); } else { - client = new MongoClient(servers, credential, new MongoClientOptions.Builder().build()); + client = new MongoClient(servers, credential, new MongoClientOptions.Builder(). + sslEnabled(sslEnabled). + sslInvalidHostNameAllowed(sslInvalidHostNameAllowed). + build()); } } else { client = new MongoClient(servers); diff --git a/cygnus-common/src/test/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImplTest.java b/cygnus-common/src/test/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImplTest.java index 594c986cc..435c9a761 100644 --- a/cygnus-common/src/test/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImplTest.java +++ b/cygnus-common/src/test/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImplTest.java @@ -53,7 +53,7 @@ public MongoBackendImplTest() { public void testGetRange() { System.out.println(getTestTraceHead("[MongoBackendImpl.getRange]") + "-------- Given a resolution, its related range is correctly returned"); - MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null); + MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null, false, false); try { @@ -115,7 +115,7 @@ public void testGetRange() { public void testGetOrigin() { System.out.println(getTestTraceHead("[MongoBackendImpl.getOrigin]") + "-------- Given a calendar and a resolution, its related origin is correctly returned"); - MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null); + MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null, false, false); GregorianCalendar calendar = new GregorianCalendar(2017, 4, 5, 11, 46, 13); try { @@ -198,7 +198,7 @@ public void testGetOrigin() { public void testGetOffset() { System.out.println(getTestTraceHead("[MongoBackendImpl.getOffset]") + "-------- Given a calendar and a resolution, its related offset is correctly returned"); - MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null); + MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null, false, false); GregorianCalendar calendar = new GregorianCalendar(2017, 3, 5, 11, 46, 13); // month 3 is April try { @@ -266,7 +266,7 @@ public void testBuildQueryForInsertAggregated() { String entityType = "someType"; String attrName = "someName"; GregorianCalendar calendar = new GregorianCalendar(2017, 3, 5, 11, 46, 13); // month 3 is April - MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, DataModel.DMBYSERVICEPATH); + MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, DataModel.DMBYSERVICEPATH, false, false); String queryForInsertAggregated = "{\"_id\": {\"entityId\": \"someId\", \"entityType\": \"someType\", " + "\"attrName\": \"someName\", \"origin\": {\"$date\": 1491392760000}, " + "\"resolution\": \"second\", \"range\": \"minute\"}, \"points.offset\": 13}"; @@ -353,7 +353,7 @@ public void testBuildQueryForInsertAggregated() { throw e; } // try catch - backend = new MongoBackendImpl(null, null, null, null, null, DataModel.DMBYENTITY); + backend = new MongoBackendImpl(null, null, null, null, null, DataModel.DMBYENTITY, false, false); queryForInsertAggregated = "{\"_id\": {\"attrName\": \"someName\", " + "\"origin\": {\"$date\": 1491392760000}, \"resolution\": \"second\", " @@ -457,7 +457,7 @@ public void testBuildUpdateForUpdateNumerical() { double sum2 = 200; int numSamples = 2; GregorianCalendar calendar = new GregorianCalendar(2017, 3, 5, 11, 46, 13); // month 3 is April - MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null,null); + MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null, false, false); String updateForUpdate = "{\"$set\": {\"attrType\": \"someType\"}, " + "\"$inc\": {\"points.$.samples\": 2, \"points.$.sum\": 20.0, \"points.$.sum2\": 200.0}, " + "\"$min\": {\"points.$.min\": 0.0}, \"$max\": {\"points.$.max\": 10.0}}"; @@ -489,7 +489,7 @@ public void testBuildUpdateForUpdateString() { String value = "someString"; int count = 2; GregorianCalendar calendar = new GregorianCalendar(2017, 3, 5, 11, 46, 13); // month 3 is April - MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null); + MongoBackendImpl backend = new MongoBackendImpl(null, null, null, null, null, null, false, false); String updateForUpdate = "{\"$set\": {\"attrType\": \"someType\"}, " + "\"$inc\": {\"points.13.samples\": 2, \"points.13.occur.someString\": 2}}"; diff --git a/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java b/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java index deb1995ab..a3f115fbb 100644 --- a/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java +++ b/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java @@ -39,6 +39,8 @@ public abstract class NGSIMongoBaseSink extends NGSISink { protected String mongoPassword; protected String mongoAuthSource; protected String mongoReplicaSet; + protected Boolean sslEnabled; + protected Boolean sslInvalidHostNameAllowed; protected String dbPrefix; protected String collectionPrefix; protected MongoBackendImpl backend; @@ -169,12 +171,37 @@ public void configure(Context context) { LOGGER.warn("[" + this.getName() + "] Invalid configuration (ignore_white_spaces=" + ignoreWhiteSpacesStr + ") -- Must be 'true' or 'false'"); } // if else + + String sslEnabledStr = context.getString("sslEnabled", "true"); + if (sslEnabledStr.equals("true") || sslEnabledStr.equals("false")) { + sslEnabled = Boolean.valueOf(sslEnabledStr); + LOGGER.debug("[" + this.getName() + "] Reading configuration (sslEnabled=" + + sslEnabledStr + ")"); + } else { + invalidConfiguration = true; + LOGGER.warn("[" + this.getName() + "] Invalid configuration (sslEnabled=" + + sslEnabledStr + ") -- Must be 'true' or 'false'"); + } // if else + + String sslInvalidHostNameAllowedStr = context.getString("sslInvalidHostNameAllowed", "true"); + if (sslInvalidHostNameAllowedStr.equals("true") || sslInvalidHostNameAllowedStr.equals("false")) { + sslInvalidHostNameAllowed = Boolean.valueOf(sslInvalidHostNameAllowedStr); + LOGGER.debug("[" + this.getName() + "] Reading configuration (sslInvalidHostNameAllowed=" + + sslInvalidHostNameAllowedStr + ")"); + } else { + invalidConfiguration = true; + LOGGER.warn("[" + this.getName() + "] Invalid configuration (sslInvalidHostNameAllowed=" + + sslInvalidHostNameAllowedStr + ") -- Must be 'true' or 'false'"); + } // if else + } // configure @Override public void start() { try { - backend = new MongoBackendImpl(mongoHosts, mongoUsername, mongoPassword, mongoAuthSource, mongoReplicaSet, dataModel); + backend = new MongoBackendImpl(mongoHosts, mongoUsername, mongoPassword, + mongoAuthSource, mongoReplicaSet, dataModel, + sslEnabled, sslInvalidHostNameAllowed); LOGGER.debug("[" + this.getName() + "] MongoDB persistence backend created"); } catch (Exception e) { LOGGER.error("Error while creating the MongoDB persistence backend. Details=" From aa3f058b1ea0ad0d553fda33bedac2ea72b310d2 Mon Sep 17 00:00:00 2001 From: Alvaro Vega Date: Tue, 18 Jun 2024 10:27:49 +0200 Subject: [PATCH 2/4] update doc --- .../iot/cygnus/sinks/NGSIMongoBaseSink.java | 12 ++++++------ .../flume_extensions_catalogue/ngsi_mongo_sink.md | 2 ++ 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java b/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java index a3f115fbb..0bf9045e3 100644 --- a/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java +++ b/cygnus-ngsi/src/main/java/com/telefonica/iot/cygnus/sinks/NGSIMongoBaseSink.java @@ -172,25 +172,25 @@ public void configure(Context context) { + ignoreWhiteSpacesStr + ") -- Must be 'true' or 'false'"); } // if else - String sslEnabledStr = context.getString("sslEnabled", "true"); + String sslEnabledStr = context.getString("mongo_ssl", "false"); if (sslEnabledStr.equals("true") || sslEnabledStr.equals("false")) { sslEnabled = Boolean.valueOf(sslEnabledStr); - LOGGER.debug("[" + this.getName() + "] Reading configuration (sslEnabled=" + LOGGER.debug("[" + this.getName() + "] Reading configuration (mongo_ssl=" + sslEnabledStr + ")"); } else { invalidConfiguration = true; - LOGGER.warn("[" + this.getName() + "] Invalid configuration (sslEnabled=" + LOGGER.warn("[" + this.getName() + "] Invalid configuration (mongo_ssl=" + sslEnabledStr + ") -- Must be 'true' or 'false'"); } // if else - String sslInvalidHostNameAllowedStr = context.getString("sslInvalidHostNameAllowed", "true"); + String sslInvalidHostNameAllowedStr = context.getString("mongo_ssl_invalid_host_allowed", "false"); if (sslInvalidHostNameAllowedStr.equals("true") || sslInvalidHostNameAllowedStr.equals("false")) { sslInvalidHostNameAllowed = Boolean.valueOf(sslInvalidHostNameAllowedStr); - LOGGER.debug("[" + this.getName() + "] Reading configuration (sslInvalidHostNameAllowed=" + LOGGER.debug("[" + this.getName() + "] Reading configuration (mongo_ssl_invalid_host_allowed=" + sslInvalidHostNameAllowedStr + ")"); } else { invalidConfiguration = true; - LOGGER.warn("[" + this.getName() + "] Invalid configuration (sslInvalidHostNameAllowed=" + LOGGER.warn("[" + this.getName() + "] Invalid configuration (mongo_ssl_invalid_host_allowed=" + sslInvalidHostNameAllowedStr + ") -- Must be 'true' or 'false'"); } // if else diff --git a/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_mongo_sink.md b/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_mongo_sink.md index 6f99b5948..189576133 100644 --- a/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_mongo_sink.md +++ b/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_mongo_sink.md @@ -320,6 +320,8 @@ When datamodel changes Cygnus tries to recreate index (delete current and create | mongo\_auth_source | no | empty | Auth source database use to authenticate the user. Usually could be `admin`. | | mongo\_replica_set | no | empty | Replica Set name. Note that this parameter is optional because Cygnus is able to connect to a MongoDB replica set without needing to specify its name.| | db\_prefix | no | sth_ || +| mongo\_ssl | no | false | Enable SSL in mongodb connection | +| mongo\_ssl\_invalid\_host\_allowed | no | false | Allow invalid host name in mongo SSL connections | | collection\_prefix | no | sth_ | `system.` is not accepted. | | batch\_size | no | 1 | Number of events accumulated before persistence. | | batch\_timeout | no | 30 | Number of seconds the batch will be building before it is persisted as it is. | From 489c578840d45fd89f0bb66a2ae25ab7dcb30a50 Mon Sep 17 00:00:00 2001 From: Alvaro Vega Date: Tue, 18 Jun 2024 10:30:27 +0200 Subject: [PATCH 3/4] update CNR --- CHANGES_NEXT_RELEASE | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGES_NEXT_RELEASE b/CHANGES_NEXT_RELEASE index e69de29bb..b6aedbd95 100644 --- a/CHANGES_NEXT_RELEASE +++ b/CHANGES_NEXT_RELEASE @@ -0,0 +1,2 @@ +[cygnus-ngsi] [mongo-sink] Add mongo_ssl and mongo_ssl_invalid_host_allowed options for mongoDB connections +[cygnus-common] [mongo-backend] Use sslEnabled and sslInvalidHostNameAllowed options for mongoDB connections From 6b46e17c20e4489ae667b10e8d31474d100e6aa1 Mon Sep 17 00:00:00 2001 From: Alvaro Vega Date: Tue, 18 Jun 2024 11:36:55 +0200 Subject: [PATCH 4/4] add missed MongoClientOptions --- .../iot/cygnus/backends/mongo/MongoBackendImpl.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java b/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java index d5de16376..6e24e0793 100644 --- a/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java +++ b/cygnus-common/src/main/java/com/telefonica/iot/cygnus/backends/mongo/MongoBackendImpl.java @@ -616,7 +616,11 @@ private MongoDatabase getDatabase(String dbName) { build()); } } else { - client = new MongoClient(servers); + MongoClientOptions options = MongoClientOptions.builder() + .sslEnabled(sslEnabled) + .sslInvalidHostNameAllowed(sslInvalidHostNameAllowed) + .build(); + client = new MongoClient(servers, options); } // if else } // if