Add credentials for REST API call node

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/credentials/AnonymousCredentials.java

@@ -0,0 +1,22 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.credentials;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AnonymousCredentials {
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/credentials/BasicCredentials.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.credentials;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import lombok.Data;
+
+@Data
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class BasicCredentials {
+    private String username;
+    private String password;
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/CertPemClientCredentials.java → rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/credentials/CertPemCredentials.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.thingsboard.rule.engine.mqtt.credentials;
+package org.thingsboard.rule.engine.credentials;
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import io.netty.handler.ssl.ClientAuth;
@@ -55,8 +55,7 @@ import java.util.Optional;
 @Data
 @Slf4j
 @JsonIgnoreProperties(ignoreUnknown = true)
-public class CertPemClientCredentials implements MqttClientCredentials {
-
+public class CertPemCredentials {
     private static final String TLS_VERSION = "TLSv1.2";
 
     private String caCert;
@@ -64,7 +63,6 @@ public class CertPemClientCredentials implements MqttClientCredentials {
     private String privateKey;
     private String password;
 
-    @Override
     public Optional<SslContext> initSslContext() {
         try {
             Security.addProvider(new BouncyCastleProvider());

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/TbMqttNodeConfiguration.java

@@ -17,7 +17,7 @@ package org.thingsboard.rule.engine.mqtt;
 
 import lombok.Data;
 import org.thingsboard.rule.engine.api.NodeConfiguration;
-import org.thingsboard.rule.engine.mqtt.credentials.AnonymousCredentials;
+import org.thingsboard.rule.engine.mqtt.credentials.MqttAnonymousCredentials;
 import org.thingsboard.rule.engine.mqtt.credentials.MqttClientCredentials;
 
 @Data
@@ -42,7 +42,7 @@ public class TbMqttNodeConfiguration implements NodeConfiguration<TbMqttNodeConf
         configuration.setConnectTimeoutSec(10);
         configuration.setCleanSession(true);
         configuration.setSsl(false);
-        configuration.setCredentials(new AnonymousCredentials());
+        configuration.setCredentials(new MqttAnonymousCredentials());
         return configuration;
     }
 

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/azure/TbAzureIotHubNode.java

@@ -27,7 +27,7 @@ import org.thingsboard.rule.engine.api.TbNodeException;
 import org.thingsboard.rule.engine.api.util.TbNodeUtils;
 import org.thingsboard.rule.engine.mqtt.TbMqttNode;
 import org.thingsboard.rule.engine.mqtt.TbMqttNodeConfiguration;
-import org.thingsboard.rule.engine.mqtt.credentials.CertPemClientCredentials;
+import org.thingsboard.rule.engine.mqtt.credentials.MqttCertPemCredentials;
 import org.thingsboard.rule.engine.mqtt.credentials.MqttClientCredentials;
 import org.thingsboard.server.common.data.plugin.ComponentType;
 
@@ -59,8 +59,8 @@ public class TbAzureIotHubNode extends TbMqttNode {
                         if (sasCredentials.getCaCert() == null || sasCredentials.getCaCert().isEmpty()) {
                             sasCredentials.setCaCert(AzureIotHubUtil.getDefaultCaCert());
                         }
-                    } else if (credentials instanceof CertPemClientCredentials) {
-                        CertPemClientCredentials pemCredentials = (CertPemClientCredentials) credentials;
+                    } else if (credentials instanceof MqttCertPemCredentials) {
+                        MqttCertPemCredentials pemCredentials = (MqttCertPemCredentials) credentials;
                         if (pemCredentials.getCaCert() == null || pemCredentials.getCaCert().isEmpty()) {
                             pemCredentials.setCaCert(AzureIotHubUtil.getDefaultCaCert());
                         }

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/azure/TbAzureIotHubNodeConfiguration.java

@@ -16,10 +16,7 @@
 package org.thingsboard.rule.engine.mqtt.azure;
 
 import lombok.Data;
-import org.thingsboard.rule.engine.api.NodeConfiguration;
 import org.thingsboard.rule.engine.mqtt.TbMqttNodeConfiguration;
-import org.thingsboard.rule.engine.mqtt.credentials.AnonymousCredentials;
-import org.thingsboard.rule.engine.mqtt.credentials.MqttClientCredentials;
 
 @Data
 public class TbAzureIotHubNodeConfiguration extends TbMqttNodeConfiguration {

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/AnonymousCredentials.java → rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/MqttAnonymousCredentials.java

@@ -15,15 +15,7 @@
  */
 package org.thingsboard.rule.engine.mqtt.credentials;
 
-import io.netty.handler.ssl.SslContext;
+import org.thingsboard.rule.engine.credentials.AnonymousCredentials;
 
-import java.util.Optional;
-
-public class AnonymousCredentials implements MqttClientCredentials {
-
-    @Override
-    public Optional<SslContext> initSslContext() {
-        return Optional.empty();
-    }
+public class MqttAnonymousCredentials extends AnonymousCredentials implements MqttClientCredentials {
 }
-

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/BasicCredentials.java → rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/MqttBasicCredentials.java

@@ -15,28 +15,13 @@
  */
 package org.thingsboard.rule.engine.mqtt.credentials;
 
-import io.netty.handler.ssl.SslContext;
-import lombok.Data;
 import org.thingsboard.mqtt.MqttClientConfig;
+import org.thingsboard.rule.engine.credentials.BasicCredentials;
 
-import java.util.Optional;
-
-@Data
-public class BasicCredentials implements MqttClientCredentials {
-
-    private String username;
-    private String password;
-
-    @Override
-    public Optional<SslContext> initSslContext() {
-        return Optional.empty();
-    }
-
+public class MqttBasicCredentials extends BasicCredentials implements MqttClientCredentials {
     @Override
     public void configure(MqttClientConfig config) {
-        config.setUsername(username);
-        config.setPassword(password);
+        config.setUsername(getUsername());
+        config.setPassword(getPassword());
     }
-
 }
-

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/MqttCertPemCredentials.java

@@ -0,0 +1,21 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.mqtt.credentials;
+
+import org.thingsboard.rule.engine.credentials.CertPemCredentials;
+
+public class MqttCertPemCredentials extends CertPemCredentials implements MqttClientCredentials {
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/mqtt/credentials/MqttClientCredentials.java

@@ -23,18 +23,16 @@ import org.thingsboard.rule.engine.mqtt.azure.AzureIotHubSasCredentials;
 
 import java.util.Optional;
 
-@JsonTypeInfo(
-        use = JsonTypeInfo.Id.NAME,
-        include = JsonTypeInfo.As.PROPERTY,
-        property = "type")
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
 @JsonSubTypes({
-        @JsonSubTypes.Type(value = AnonymousCredentials.class, name = "anonymous"),
-        @JsonSubTypes.Type(value = BasicCredentials.class, name = "basic"),
+        @JsonSubTypes.Type(value = MqttAnonymousCredentials.class, name = "anonymous"),
+        @JsonSubTypes.Type(value = MqttBasicCredentials.class, name = "basic"),
         @JsonSubTypes.Type(value = AzureIotHubSasCredentials.class, name = "sas"),
-        @JsonSubTypes.Type(value = CertPemClientCredentials.class, name = "cert.PEM")})
+        @JsonSubTypes.Type(value = MqttCertPemCredentials.class, name = "cert.PEM")})
 public interface MqttClientCredentials {
-
-    Optional<SslContext> initSslContext();
+    default Optional<SslContext> initSslContext() {
+        return Optional.empty();
+    }
 
     default void configure(MqttClientConfig config) {
     }

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/rest/TbHttpClient.java

@@ -17,6 +17,7 @@ package org.thingsboard.rule.engine.rest;
 
 import io.netty.channel.EventLoopGroup;
 import io.netty.channel.nio.NioEventLoopGroup;
+import io.netty.handler.ssl.SslContext;
 import io.netty.handler.ssl.SslContextBuilder;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
@@ -133,7 +134,7 @@ public class TbHttpClient {
             } else {
                 this.eventLoopGroup = new NioEventLoopGroup();
                 Netty4ClientHttpRequestFactory nettyFactory = new Netty4ClientHttpRequestFactory(this.eventLoopGroup);
-                nettyFactory.setSslContext(SslContextBuilder.forClient().build());
+                nettyFactory.setSslContext(initSslContext());
                 nettyFactory.setReadTimeout(config.getReadTimeoutMs());
                 httpClient = new AsyncRestTemplate(nettyFactory);
             }
@@ -142,6 +143,11 @@ public class TbHttpClient {
         }
     }
 
+    private SslContext initSslContext() throws SSLException {
+        return this.config.getCredentials().initSslContext()
+                .orElse(SslContextBuilder.forClient().build());
+    }
+
     private void checkSystemProxyProperties() throws TbNodeException {
         boolean useHttpProxy = !StringUtils.isEmpty(System.getProperty("http.proxyHost")) && !StringUtils.isEmpty(System.getProperty("http.proxyPort"));
         boolean useHttpsProxy = !StringUtils.isEmpty(System.getProperty("https.proxyHost")) && !StringUtils.isEmpty(System.getProperty("https.proxyPort"));
@@ -226,6 +232,7 @@ public class TbHttpClient {
     private HttpHeaders prepareHeaders(TbMsgMetaData metaData) {
         HttpHeaders headers = new HttpHeaders();
         config.getHeaders().forEach((k, v) -> headers.add(TbNodeUtils.processPattern(k, metaData), TbNodeUtils.processPattern(v, metaData)));
+        config.getCredentials().getBasicAuthHeaderValue().ifPresent(v -> headers.add("Authorization", v));
         return headers;
     }
 

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/rest/TbRestApiCallNodeConfiguration.java

@@ -18,6 +18,8 @@ package org.thingsboard.rule.engine.rest;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import lombok.Data;
 import org.thingsboard.rule.engine.api.NodeConfiguration;
+import org.thingsboard.rule.engine.rest.credentials.HttpAnonymousCredentials;
+import org.thingsboard.rule.engine.rest.credentials.HttpClientCredentials;
 
 import java.util.Collections;
 import java.util.Map;
@@ -42,6 +44,7 @@ public class TbRestApiCallNodeConfiguration implements NodeConfiguration<TbRestA
     private String proxyUser;
     private String proxyPassword;
     private String proxyScheme;
+    private HttpClientCredentials credentials;
 
     @Override
     public TbRestApiCallNodeConfiguration defaultConfiguration() {
@@ -55,6 +58,7 @@ public class TbRestApiCallNodeConfiguration implements NodeConfiguration<TbRestA
         configuration.setUseRedisQueueForMsgPersistence(false);
         configuration.setTrimQueue(false);
         configuration.setEnableProxy(false);
+        configuration.setCredentials(new HttpAnonymousCredentials());
         return configuration;
     }
 }

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/rest/credentials/HttpAnonymousCredentials.java

@@ -0,0 +1,21 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.rest.credentials;
+
+import org.thingsboard.rule.engine.credentials.AnonymousCredentials;
+
+public class HttpAnonymousCredentials extends AnonymousCredentials implements HttpClientCredentials {
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/rest/credentials/HttpBasicCredentials.java

@@ -0,0 +1,31 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.rest.credentials;
+
+import org.apache.commons.codec.binary.Base64;
+import org.thingsboard.rule.engine.credentials.BasicCredentials;
+
+import java.nio.charset.StandardCharsets;
+import java.util.Optional;
+
+public class HttpBasicCredentials extends BasicCredentials implements HttpClientCredentials {
+    @Override
+    public Optional<String> getBasicAuthHeaderValue() {
+        String authString = getUsername() + ":" + getPassword();
+        String encodedAuthString = new String(Base64.encodeBase64(authString.getBytes(StandardCharsets.UTF_8)));
+        return Optional.of("Basic " + encodedAuthString);
+    }
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/rest/credentials/HttpCertPemCredentials.java

@@ -0,0 +1,21 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.rest.credentials;
+
+import org.thingsboard.rule.engine.credentials.CertPemCredentials;
+
+public class HttpCertPemCredentials extends CertPemCredentials implements HttpClientCredentials {
+}

rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/rest/credentials/HttpClientCredentials.java

@@ -0,0 +1,38 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.rest.credentials;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import io.netty.handler.ssl.SslContext;
+
+import java.util.Optional;
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
+@JsonSubTypes({
+        @JsonSubTypes.Type(value = HttpAnonymousCredentials.class, name = "anonymous"),
+        @JsonSubTypes.Type(value = HttpBasicCredentials.class, name = "basic"),
+        @JsonSubTypes.Type(value = HttpCertPemCredentials.class, name = "cert.PEM")})
+public interface HttpClientCredentials {
+    default Optional<SslContext> initSslContext() {
+        return Optional.empty();
+    }
+
+    default Optional<String> getBasicAuthHeaderValue() {
+        return Optional.empty();
+    }
+}
+

rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/rest/credentials/HttpBasicCredentialsTest.java

@@ -0,0 +1,34 @@
+/**
+ * Copyright © 2016-2020 The Thingsboard Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.thingsboard.rule.engine.rest.credentials;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.Optional;
+
+public class HttpBasicCredentialsTest {
+    @Test
+    public void getBasicAuthHeaderValueTest() {
+        HttpBasicCredentials credentials = new HttpBasicCredentials();
+        credentials.setUsername("testUser");
+        credentials.setPassword("testPwd");
+        Optional<String> actualHeaderValue = credentials.getBasicAuthHeaderValue();
+        Optional<String> expectedHeaderValue = Optional.of("Basic dGVzdFVzZXI6dGVzdFB3ZA==");
+
+        Assert.assertEquals(expectedHeaderValue, actualHeaderValue);
+    }
+}