Add IoT SDK Metrics V2 (#994)

Author: rakshil14-2

.github/workflows/ci-android.yml

@@ -12,7 +12,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  BUILDER_VERSION: v0.9.92
+  BUILDER_VERSION: v0.9.96
   BUILDER_SOURCE: releases
   BUILDER_HOST: https://d19elf31gohf1l.cloudfront.net
   PACKAGE_NAME: aws-crt-java
@@ -140,4 +140,4 @@ jobs:
         --run_attempt ${{ github.run_attempt }} \
         --project_arn $(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/DeviceFarm/ProjectArn" --query "SecretString" | cut -f5 -d\" | cut -f1 -d'\') \
         --device_pool_arn $(aws secretsmanager get-secret-value --region us-east-1 --secret-id "ci/DeviceFarm/DevicePoolArnAndroid8" --query "SecretString" | cut -f5 -d\" | cut -f1 -d'\') \
-        --device_pool android_8
+        --device_pool android_8

.github/workflows/ci-slow.yml

@@ -12,7 +12,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  BUILDER_VERSION: v0.9.92
+  BUILDER_VERSION: v0.9.96
   BUILDER_SOURCE: releases
   BUILDER_HOST: https://d19elf31gohf1l.cloudfront.net
   PACKAGE_NAME: aws-crt-java
@@ -63,4 +63,4 @@ jobs:
     - name: Build ${{ env.PACKAGE_NAME }}
       run: |
         aws s3 cp s3://aws-crt-test-stuff/ci/${{ env.BUILDER_VERSION }}/linux-container-ci.sh ./linux-container-ci.sh && chmod a+x ./linux-container-ci.sh
-        ./linux-container-ci.sh ${{ env.BUILDER_VERSION }} aws-crt-${{ matrix.image }} build -p ${{ env.PACKAGE_NAME }}
+        ./linux-container-ci.sh ${{ env.BUILDER_VERSION }} aws-crt-${{ matrix.image }} build -p ${{ env.PACKAGE_NAME }}

src/main/java/software/amazon/awssdk/crt/internal/IoTDeviceSDKMetrics.java

@@ -13,6 +13,10 @@
  */
 public class TlsContext extends CrtResource {
 
+    private TlsCipherPreference cipherPreference;
+    private TlsContextOptions.TlsVersions minimumTlsVersion;
+    private TlsContextOptions.CertificateSource certificateSource;
+
     /**
      * Creates a new Client TlsContext. There are significant native resources consumed to create a TlsContext, so most
      * applications will only need to create one and re-use it for all connections.
@@ -22,6 +26,9 @@ public class TlsContext extends CrtResource {
      */
     public TlsContext(TlsContextOptions options) throws CrtRuntimeException {
         acquireNativeHandle(tlsContextNew(options.getNativeHandle()));
+        this.cipherPreference = options.tlsCipherPreference;
+        this.minimumTlsVersion = options.minTlsVersion;
+        this.certificateSource = options.getCertificateSource();
     }
 
     /**
@@ -31,6 +38,9 @@ public TlsContext(TlsContextOptions options) throws CrtRuntimeException {
     public TlsContext() throws CrtRuntimeException  {
         try (TlsContextOptions options = TlsContextOptions.createDefaultClient()) {
             acquireNativeHandle(tlsContextNew(options.getNativeHandle()));
+            this.cipherPreference = options.tlsCipherPreference;
+            this.minimumTlsVersion = options.minTlsVersion;
+            this.certificateSource = options.getCertificateSource();
         }
     }
 
@@ -54,4 +64,26 @@ protected void releaseNativeHandle() {
     protected static native long tlsContextNew(long options) throws CrtRuntimeException;
 
     private static native void tlsContextDestroy(long elg);
+
+    /**
+     * Returns the {@link TlsCipherPreference} configured on this context.
+     *
+     * @return the cipher preference
+     */
+    public TlsCipherPreference getCipherPreference() { return cipherPreference; }
+
+    /**
+     * Returns the minimum {@link TlsContextOptions.TlsVersions TLS version} configured on this context.
+     *
+     * @return the minimum TLS version
+     */
+    public TlsContextOptions.TlsVersions getMinimumTlsVersion() { return minimumTlsVersion; }
+
+    /**
+     * Returns the {@link TlsContextOptions.CertificateSource} of the configured mTLS, or
+     * {@code null} if no mTLS source has been set on the options used to create this context.
+     *
+     * @return the certificate source
+     */
+    public TlsContextOptions.CertificateSource getCertificateSource() { return certificateSource; }
 };

src/main/java/software/amazon/awssdk/crt/io/TlsContext.java

@@ -20,6 +20,26 @@
  */
 public final class TlsContextOptions extends CrtResource {
 
+    /**
+     * Identifies the source of the mTLS certificate/private key configured on a
+     * {@link TlsContextOptions}. Used internally by the IoT Device SDK metrics
+     * layer to encode feature "I" of the SDK metrics string. Values are set
+     * automatically by the {@code createWithMtls*} factory methods (and their
+     * {@code withMtls*} equivalents).
+     */
+    public enum CertificateSource {
+        /** PEM cert + key files (in-memory or on-disk). */
+        CERTIFICATE_FILES,
+        /** Hardware security module via PKCS#11. */
+        PKCS11,
+        /** Windows certificate store. */
+        WINDOWS_CERT_STORE,
+        /** Java keystore. */
+        JAVA_KEYSTORE,
+        /** PKCS#12 (.p12 / .pfx) file. */
+        PKCS12_FILE,
+    }
+
     public enum TlsVersions {
         /**
          * SSL v3. This should almost never be used.
@@ -90,7 +110,7 @@ public enum TlsVersions {
      * On Linux (s2n), this disables validation of OCSP stapled responses provided by the server.
      *
      * On Apple platforms, this is a no-op as revocation checking is not enabled by default.
-     * 
+     *
      * Default is false (revocation checking enabled where available).
      */
     public boolean noCertificateRevocation = false;
@@ -107,6 +127,7 @@ public enum TlsVersions {
     private TlsContextPkcs11Options pkcs11Options;
     private TlsContextCustomKeyOperationOptions customKeyOperations;
     private String windowsCertStorePath;
+    private CertificateSource certificateSource;
 
     /**
      * Creates a new set of options that can be used to create a {@link TlsContext}
@@ -187,6 +208,7 @@ public void setCipherPreference(TlsCipherPreference cipherPref) {
     public void initMtlsFromPath(String certificatePath, String privateKeyPath) {
         this.certificatePath = certificatePath;
         this.privateKeyPath = privateKeyPath;
+        this.certificateSource = CertificateSource.CERTIFICATE_FILES;
     }
 
     /**
@@ -203,6 +225,7 @@ public void initMtls(String certificate, String privateKey) throws IllegalArgume
 
         this.privateKey = PemUtils.cleanUpPem(privateKey);
         PemUtils.sanityCheck(privateKey, 1, "PRIVATE KEY");
+        this.certificateSource = CertificateSource.CERTIFICATE_FILES;
     }
 
     /**
@@ -218,6 +241,7 @@ public void initMtlsPkcs12(String pkcs12Path, String pkcs12Password) {
         }
         this.pkcs12Path = pkcs12Path;
         this.pkcs12Password = pkcs12Password;
+        this.certificateSource = CertificateSource.PKCS12_FILE;
     }
 
     /**
@@ -414,6 +438,7 @@ public static TlsContextOptions createWithMtlsJavaKeystore(
         }
         options.initMtls(certificate, privateKey);
         options.verifyPeer = true;
+        options.certificateSource = CertificateSource.JAVA_KEYSTORE;
         return options;
     }
 
@@ -517,6 +542,7 @@ public TlsContextOptions withMtlsPkcs12(String pkcs12Path, String pkcs12Password
     public TlsContextOptions withMtlsPkcs11(TlsContextPkcs11Options pkcs11Options) {
         swapReferenceTo(this.pkcs11Options, pkcs11Options);
         this.pkcs11Options = pkcs11Options;
+        this.certificateSource = CertificateSource.PKCS11;
         return this;
     }
 
@@ -544,6 +570,7 @@ public TlsContextOptions withMtlsCustomKeyOperations(TlsContextCustomKeyOperatio
      */
     public TlsContextOptions withMtlsWindowsCertStorePath(String certificatePath) {
         this.windowsCertStorePath = certificatePath;
+        this.certificateSource = CertificateSource.WINDOWS_CERT_STORE;
         return this;
     }
 
@@ -577,6 +604,14 @@ public TlsContextOptions withNoCertificateRevocation() {
         return this;
     }
 
+    /**
+     * @return the {@link CertificateSource} of the configured mTLS, or {@code null}
+     *         if no mTLS source has been set (or the source has no defined metrics mapping).
+     */
+    CertificateSource getCertificateSource() {
+        return certificateSource;
+    }
+
     /*******************************************************************************
      * native methods
      ******************************************************************************/