HTTP BASIC authentication (prometheus#801)

* HTTP Basic authentication Signed-off-by: dhoard <doug.hoard@gmail.com>
dhoard · Jun 20, 2023 · 1d1f1a2 · 1d1f1a2
1 parent 733633c
commit 1d1f1a2
Show file tree

Hide file tree

Showing 203 changed files with 4,542 additions and 1,662 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -15,6 +15,7 @@ jobs:
       - checkout
       - restore_cache:
           key: maven-dependencies-{{ checksum "pom.xml" }}
+      - run: ./integration_test_suite/docker-pull-images.smoke-test.sh
       - run: ./mvnw clean install
       - run: ./mvnw javadoc:jar
       - save_cache:

diff --git a/MAINTAINER_NOTES.md b/MAINTAINER_NOTES.md
@@ -24,15 +24,13 @@ Download the artifacts from the staging repository [https://oss.sonatype.org/#st
 /usr/lib/jvm/java-8-openjdk/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent-0.18.0.jar=12345:./integration_tests/smoke_tests/src/request/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
 /usr/lib/jvm/java-11-openjdk/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent-0.18.0.jar=12345:./integration_tests/smoke_tests/src/request/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
 /usr/lib/jvm/java-17-openjdk/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent-0.18.0.jar=12345:./integration_tests/smoke_tests/src/request/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
-/usr/lib/jvm/jre1.6.0_45/bin/java -javaagent:/home/fabian/Downloads/jmx_prometheus_javaagent_java6-0.18.0.jar=12345:./integration_tests/smoke_tests/src/request/resources/config.yml -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
 
 # standalone
 java -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -jar integration_tests/jmx_example_application/target/jmx_example_application.jar
 
 /usr/lib/jvm/java-8-openjdk/bin/java -jar ~/Downloads/jmx_prometheus_httpserver-0.18.0.jar 9000 ./integration_tests/smoke_tests/src/request/resources/config-httpserver.yml
 /usr/lib/jvm/java-11-openjdk/bin/java -jar ~/Downloads/jmx_prometheus_httpserver-0.18.0.jar 9000 ./integration_tests/smoke_tests/src/request/resources/config-httpserver.yml
 /usr/lib/jvm/java-17-openjdk/bin/java -jar ~/Downloads/jmx_prometheus_httpserver-0.18.0.jar 9000 ./integration_tests/smoke_tests/src/request/resources/config-httpserver.yml
-/usr/lib/jvm/jre1.6.0_45/bin/java -jar ~/Downloads/jmx_prometheus_httpserver_java6-0.18.0.jar 9000 ./integration_tests/smoke_tests/src/request/resources/config-httpserver.yml
 ```
 
 If everything looks good, click `Close` to trigger Sonatype's verification, then click `Release`.
diff --git a/NOTICE b/NOTICE
@@ -3,3 +3,8 @@ Copyright 2012-2015 The Prometheus Authors
 
 This product includes software developed at
 SoundCloud Ltd. (http://soundcloud.com/).
+
+This product includes software based on Stackoverflow
+Code : toHex() method
+Author : maybeWeCouldStealAVan
+Reference: https://stackoverflow.com/questions/9655181/how-to-convert-a-byte-array-to-a-hex-string-in-java
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 JMX Exporter
 =====
 
-JMX to Prometheus exporter: a collector that can configurably scrape and
+JMX to Prometheus exporter: a collector that can configurable scrape and
 expose mBeans of a JMX target.
 
 This exporter is intended to be run as a Java Agent, exposing a HTTP server
@@ -13,13 +13,10 @@ Agent is thus strongly encouraged.
 
 ## Running the Java Agent
 
-The Java agent is available in two versions with identical functionality:
-* [jmx_prometheus_javaagent-0.18.0.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/0.18.0/jmx_prometheus_javaagent-0.18.0.jar) requires Java >= 7.
-* [jmx_prometheus_javaagent-0.18.0_java6.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent_java6/0.18.0/jmx_prometheus_javaagent_java6-0.18.0.jar) is compatible with Java 6.
-
-Both versions are built from the same code and differ only in the versions of the bundled dependencies.
+- [jmx_prometheus_javaagent-0.18.0.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_javaagent/0.18.0/jmx_prometheus_javaagent-0.18.0.jar)
 
 To run as a Java agent, download one of the JARs and run:
+
 ```
 java -javaagent:./jmx_prometheus_javaagent-0.18.0.jar=12345:config.yaml -jar yourJar.jar
 ```
@@ -38,11 +35,7 @@ Example configurations can be found in the `example_configs/` directory.
 
 ## Running the Standalone HTTP Server
 
-The HTTP server is available in two versions with identical functionality:
-* [jmx_prometheus_httpserver-0.18.0.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver/0.18.0/jmx_prometheus_httpserver-0.18.0.jar) requires Java >= 7.
-* [jmx_prometheus_httpserver-0.18.0_java6.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver_java6/0.18.0/jmx_prometheus_httpserver_java6-0.18.0.jar) is compatible with Java 6.
-
-Both versions are built from the same code and differ only in the versions of the bundled dependencies.
+- [jmx_prometheus_httpserver-0.18.0.jar](https://repo1.maven.org/maven2/io/prometheus/jmx/jmx_prometheus_httpserver/0.18.0/jmx_prometheus_httpserver-0.18.0.jar)
 
 To run the standalone HTTP server, download one of the JARs and run:
 
@@ -151,21 +144,94 @@ domain_beanPropertyValue1_key1_key2_...keyN_attrName{beanpropertyName2="beanProp
 ```
 If a given part isn't set, it'll be excluded.
 
-## Integration Testing
+## HTTP Authentication (optional)
+
+HTTP BASIC authentication supports using the following configuration algorithms:
+
+- plaintext - plaintext password
+- SHA-1 - SHA-1(`<salt>:<password>`)
+- SHA-256 - SHA-256(`<salt>:<password>`) 
+- SHA-512 - SHA-512(`<salt>:<password>`)
+- PBKDF2WithHmacSHA1
+- PBKDF2WithHmacSHA256
+- PBKDF2WithHmacSHA512
+
+---
+
+Plaintext example:
+
+```yaml
+httpServer:
+  authentication:
+    basic:
+      username: Prometheus
+      password: secret
+```
+
+---
+
+SHA-256 example using a salted password SHA-256(`<salt>:<password>`) with a password of `secret`
+
+```yaml
+httpServer:
+  authentication:
+    basic:
+      username: Prometheus
+      passwordHash: 2bf7ed4906ac065bde39f7508d6102a6cdd7153a929ea883ff6cd04442772c99
+      algorithm: SHA-256
+      salt: U9i%=N+m]#i9yvUV:bA/3n4X9JdPXf=n
+```
+
+---
+
+PBKDF2WithHmacSHA256 example with a password of `secret`
+
+```yaml
+httpServer:
+  authentication:
+    basic:
+      username: Prometheus
+      passwordHash: A1:0E:4E:62:F7:1E:0B:59:0A:32:EA:CC:7C:65:37:1F:6D:A6:F1:F1:ED:3F:73:ED:C9:65:19:37:21:5B:6D:4E:9D:C6:61:DF:B5:BF:BB:16:B8:9A:50:14:57:CE:3D:14:67:73:A3:71:1B:87:3B:C4:B1:0E:DC:2D:0B:10:65:D6:F5:B6:DA:07:DD:EE:DA:AC:9C:60:CD:B4:59:0C:C9:CB:A7:3D:7E:30:3E:43:83:E9:E4:13:34:A1:F1:87:5C:24:46:8E:13:90:A6:66:E1:A6:F3:0B:5A:E7:14:8A:98:6A:81:2B:B6:F8:EF:95:D4:82:7E:FB:5E:2D:D3:24:FE:96
+      algorithm: `PBKDF2WithHmacSHA256`
+      salt: U9i%=N+m]#i9yvUV:bA/3n4X9JdPXf=n
+```
+
+- iterations = `600000` (default value for PBKDF2WithHmacSHA256 )
+- keyLength = `128` bits (default value)
+
+**Notes**
+
+- PBKDF2WithHmacSHA1 default iterations = `1300000`
+- PBKDF2WithHmacSHA256 default iterations = `600000`
+- PBKDF2WithHmacSHA256 default iterations = `210000`
+- default keyLength = `128` (bits)
+
+## Generation of `passwordHash`
+
+- `sha1sum`, `sha256sum`, and `sha512sum` can be used to generate the `passwordHash`
+- `openssl` can be used to generate a PBKDF2WithHmac based algorithm `passwordHash`
+
+---
+
+## Integration Test Suite
 
 The JMX exporter uses the [AntuBLUE Test Engine](https://github.com/antublue/test-engine) and [Testcontainers](https://www.testcontainers.org/) to run integration tests with different Java versions.
 
-You need to have Docker installed to run these tests.
+You need to have Docker installed to run the integration test suite.
 
-Build and run the integration tests:
+Build and run the integration test suite:
 
 ```
 ./mvnw clean verify
 ```
 
 **Notes**
 
-- To run the integration tests in IntelliJ, you must build the project from the parent (root).
+- To run the integration tests in IntelliJ, you must build first the project from the parent (root) using Maven
+  - The Maven build copies the core artifacts as resources to the `integration_tests` project 
+
+
+- Additional information can be found in the [Integration Test Suite](https://github.com/prometheus/jmx_exporter/blob/main/integration_test_suite/README.md) readme.
 
 ## Debugging
 
@@ -192,7 +258,6 @@ Add the following flag to your Java invocation:
 
 `-Djava.util.logging.config.file=/path/to/logging.properties`
 
-
 ## Installing
 
 A Debian binary package is created as part of the build process and it can

diff --git a/collector/pom.xml b/collector/pom.xml
@@ -42,7 +42,7 @@
         <dependency>
             <groupId>org.yaml</groupId>
             <artifactId>snakeyaml</artifactId>
-            <version>2.0</version> <!-- The Java 6 build overrides this with 1.23. -->
+            <version>2.0</version>
         </dependency>
     </dependencies>
 

diff --git a/collector/src/test/java/io/prometheus/jmx/BoolMBean.java b/collector/src/test/java/io/prometheus/jmx/BoolMBean.java
@@ -1,6 +1,5 @@
 package io.prometheus.jmx;
 
-import javax.management.*;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
 

diff --git a/collector/src/test/java/io/prometheus/jmx/CassandraMBean.java b/collector/src/test/java/io/prometheus/jmx/CassandraMBean.java
@@ -1,6 +1,5 @@
 package io.prometheus.jmx;
 
-import javax.management.*;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
 

diff --git a/collector/src/test/java/io/prometheus/jmx/CassandraMetricsMBean.java b/collector/src/test/java/io/prometheus/jmx/CassandraMetricsMBean.java
@@ -1,6 +1,5 @@
 package io.prometheus.jmx;
 
-import javax.management.*;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
 

diff --git a/collector/src/test/java/io/prometheus/jmx/HadoopDataNodeMXBean.java b/collector/src/test/java/io/prometheus/jmx/HadoopDataNodeMXBean.java
@@ -1,9 +1,9 @@
 package io.prometheus.jmx;
 
-import java.util.HashMap;
-import java.util.Map;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
+import java.util.HashMap;
+import java.util.Map;
 
 public interface HadoopDataNodeMXBean {
     public Map<String, Map<String, Long>> getDatanodeNetworkCounts();

diff --git a/collector/src/test/java/io/prometheus/jmx/HadoopMBean.java b/collector/src/test/java/io/prometheus/jmx/HadoopMBean.java
@@ -1,6 +1,5 @@
 package io.prometheus.jmx;
 
-import javax.management.*;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
 

diff --git a/collector/src/test/java/io/prometheus/jmx/JmxCollectorTest.java b/collector/src/test/java/io/prometheus/jmx/JmxCollectorTest.java
@@ -1,20 +1,18 @@
 package io.prometheus.jmx;
 
 import io.prometheus.client.Collector;
-import io.prometheus.client.CollectorRegistry;
 import io.prometheus.client.Collector.MetricFamilySamples;
-
+import io.prometheus.client.CollectorRegistry;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;
 
+import javax.management.MBeanServer;
 import java.lang.management.ManagementFactory;
 import java.util.List;
 import java.util.logging.LogManager;
 
-import javax.management.MBeanServer;
-
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;

diff --git a/collector/src/test/java/io/prometheus/jmx/JmxMBeanPropertyCacheTest.java b/collector/src/test/java/io/prometheus/jmx/JmxMBeanPropertyCacheTest.java
@@ -3,7 +3,14 @@
 import org.junit.Test;
 
 import javax.management.ObjectName;
-import java.util.*;
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;

diff --git a/collector/src/test/java/io/prometheus/jmx/TomcatPatternCheckTest.java b/collector/src/test/java/io/prometheus/jmx/TomcatPatternCheckTest.java
@@ -1,11 +1,11 @@
 package io.prometheus.jmx;
 
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
+import org.junit.Test;
 
 import java.util.regex.Pattern;
 
-import org.junit.Test;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 
 /**
 

diff --git a/collector/src/test/java/io/prometheus/jmx/TomcatServletMBean.java b/collector/src/test/java/io/prometheus/jmx/TomcatServletMBean.java
@@ -1,6 +1,5 @@
 package io.prometheus.jmx;
 
-import javax.management.*;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;