Jn/azure (#585)

Experimental Azure support (PROD-9258)

README.md

@@ -16,6 +16,7 @@
     + [AWS](#aws)
       - [Per region discovery](#per-region-discovery)
     + [GCP](#gcp)
+    + [Azure](#azure)
   * [Saving data to PostgreSQL](#saving-data-to-postgresql)
 
 ## What is Magpie?
@@ -307,12 +308,28 @@ Magpie also supports GCP as a core plugin out of the box. Checked boxes are comp
 - [x]  Web Security Scanner
 - [x]  reCAPTCHA Enterprise
 
-##### Authentcation
+##### Authentication
 To use this plugin save .json file with authentication key to file then set environment variable:
 ```
 export GOOGLE_APPLICATION_CREDENTIALS=PATH_TO_CREDENTIALS_JSON_FILE
 ```
 
+#### Azure
+Magpie now contains experimental Azure support. The services supported are limited to:
+
+- [x] SQL Servers
+- [x] SQL Databases
+- [x] Subscriptions
+- [x] Storage Accounts
+- [x] Storage Containers
+
+While PG persistence works for Azure, there are no configuration rules written at this time and there is no estimate on when
+such CSPM rules will exist for Azure.
+
+##### Authentication
+As with AWS and GCP, Magpie utilizes the Azure SDK to find and use credentials on the local system. Utilizing `az login` will
+save credentials so that Magpie can use them.
+
 
 ### Saving data to PostgreSQL
 By default, Magpie prints all discovered resources to standard out in JSON format. It's possible to modify this behaviour by changing

magpie-api/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <artifactId>magpie-parent</artifactId>
     <groupId>io.openraven.magpie</groupId>
-    <version>0.9.3-SNAPSHOT</version>
+    <version>0.10.0-SNAPSHOT</version>
   </parent>
   <modelVersion>4.0.0</modelVersion>
 
@@ -18,7 +18,7 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
-      <version>1.7.30</version>
+      <version>2.0.12</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>

magpie-api/src/main/java/io/openraven/magpie/api/MagpieAzureResource.java

@@ -0,0 +1,335 @@
+/*-
+ * #%L
+ * Magpie API
+ * %%
+ * Copyright (C) 2021 Open Raven Inc
+ * %%
+ * 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.
+ * #L%
+ */
+package io.openraven.magpie.api;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+
+import java.time.Instant;
+
+import static io.openraven.magpie.api.utils.EncodedNamedUUIDGenerator.getEncodedNamedUUID;
+
+public class MagpieAzureResource {
+  private final ObjectMapper mapper;
+  private final String containingEntity;
+  private final String containingEntityId;
+
+  public String resourceId;
+  public String resourceName;
+  public String resourceType;
+  public String region;
+  public String subscriptionId;
+  public Instant createdIso;
+  public Instant updatedIso = Instant.now();
+  public String discoverySessionId;
+  public Long maxSizeInBytes = null;
+  public Long sizeInBytes = null;
+
+  public JsonNode configuration;
+  public JsonNode supplementaryConfiguration;
+  public JsonNode tags;
+  public JsonNode discoveryMeta;
+
+  private MagpieAzureResource(MagpieAzureResourceBuilder builder) {
+    this.resourceId = builder.resourceId;
+    this.resourceName = builder.resourceName;
+    this.resourceId = builder.resourceId;
+    this.resourceType = builder.resourceType;
+    this.region = builder.region;
+    this.subscriptionId = builder.subscriptionId;
+    this.createdIso = builder.createdIso;
+    this.updatedIso = builder.updatedIso;
+    this.discoverySessionId = builder.discoverySessionId;
+    this.maxSizeInBytes = builder.maxSizeInBytes;
+    this.sizeInBytes = builder.sizeInBytes;
+    this.configuration = builder.configuration;
+    this.supplementaryConfiguration = builder.supplementaryConfiguration;
+    this.tags = builder.tags;
+    this.discoveryMeta = builder.discoveryMeta;
+    this.mapper = builder.mapper;
+    this.containingEntity = builder.containingEntity;
+    this.containingEntityId = builder.containingEntityId;
+  }
+
+  public ObjectNode toJsonNode() {
+    var data = mapper.createObjectNode();
+
+    data.put("documentId", getEncodedNamedUUID(resourceId));
+    data.put("resourceId", resourceId);
+    data.put("resourceName", resourceName);
+    data.put("resourceId", resourceId);
+    data.put("resourceType", resourceType);
+    data.put("region", region);
+    data.put("subscriptionId", subscriptionId);
+    data.put("createdIso", createdIso == null ? null : createdIso.toString());
+    data.put("updatedIso", updatedIso == null ? null : updatedIso.toString());
+    data.put("discoverySessionId", discoverySessionId);
+    data.put("maxSizeInBytes", maxSizeInBytes);
+    data.put("sizeInBytes", sizeInBytes);
+    data.put("containingEntity", containingEntity);
+    data.put("containingEntityId", containingEntityId);
+
+    data.set("configuration", configuration);
+    data.set("supplementaryConfiguration", supplementaryConfiguration);
+    data.set("tags", tags);
+    data.set("discoveryMeta", discoveryMeta);
+
+    return data;
+  }
+
+  public String getResourceName() {
+    return resourceName;
+  }
+
+  public void setResourceName(String resourceName) {
+    this.resourceName = resourceName;
+  }
+
+  public String getResourceId() {
+    return resourceId;
+  }
+
+  public void setResourceId(String resourceId) {
+    this.resourceId = resourceId;
+  }
+
+  public String getResourceType() {
+    return resourceType;
+  }
+
+  public void setResourceType(String resourceType) {
+    this.resourceType = resourceType;
+  }
+
+  public String getRegion() {
+    return region;
+  }
+
+  public void setRegion(String region) {
+    this.region = region;
+  }
+
+  public String getSubscriptionId() {
+    return subscriptionId;
+  }
+
+  public void setSubscriptionId(String subscriptionId) {
+    this.subscriptionId = subscriptionId;
+  }
+
+  public Instant getCreatedIso() {
+    return createdIso;
+  }
+
+  public void setCreatedIso(Instant createdIso) {
+    this.createdIso = createdIso;
+  }
+
+  public Instant getUpdatedIso() {
+    return updatedIso;
+  }
+
+  public void setUpdatedIso(Instant updatedIso) {
+    this.updatedIso = updatedIso;
+  }
+
+  public String getDiscoverySessionId() {
+    return discoverySessionId;
+  }
+
+  public void setDiscoverySessionId(String discoverySessionId) {
+    this.discoverySessionId = discoverySessionId;
+  }
+
+  public Long getMaxSizeInBytes() {
+    return maxSizeInBytes;
+  }
+
+  public void setMaxSizeInBytes(Long maxSizeInBytes) {
+    this.maxSizeInBytes = maxSizeInBytes;
+  }
+
+  public Long getSizeInBytes() {
+    return sizeInBytes;
+  }
+
+  public void setSizeInBytes(Long sizeInBytes) {
+    this.sizeInBytes = sizeInBytes;
+  }
+
+  public JsonNode getConfiguration() {
+    return configuration;
+  }
+
+  public void setConfiguration(JsonNode configuration) {
+    this.configuration = configuration;
+  }
+
+  public JsonNode getSupplementaryConfiguration() {
+    return supplementaryConfiguration;
+  }
+
+  public void setSupplementaryConfiguration(JsonNode supplementaryConfiguration) {
+    this.supplementaryConfiguration = supplementaryConfiguration;
+  }
+
+  public JsonNode getTags() {
+    return tags;
+  }
+
+  public void setTags(JsonNode tags) {
+    this.tags = tags;
+  }
+
+  public JsonNode getDiscoveryMeta() {
+    return discoveryMeta;
+  }
+
+  public void setDiscoveryMeta(JsonNode discoveryMeta) {
+    this.discoveryMeta = discoveryMeta;
+  }
+
+  public String getContainingEntity() {
+    return containingEntity;
+  }
+
+  public String getContainingEntityId() {
+    return containingEntityId;
+  }
+
+  public static class MagpieAzureResourceBuilder {
+    private final ObjectMapper mapper;
+    private String resourceName;
+    private String resourceId;
+    private String resourceType;
+    private String region;
+
+    private String subscriptionId;
+
+    private Instant createdIso;
+    private Instant updatedIso = Instant.now();
+    private String discoverySessionId;
+
+    private Long maxSizeInBytes = null;
+    private Long sizeInBytes = null;
+
+    private JsonNode configuration;
+    private JsonNode supplementaryConfiguration;
+    private JsonNode tags;
+    private JsonNode discoveryMeta;
+    private String containingEntityId;
+    private String containingEntity;
+
+      public MagpieAzureResourceBuilder(ObjectMapper mapper, String resourceId) {
+      this.resourceId = resourceId;
+      this.mapper = mapper;
+
+      this.configuration = mapper.createObjectNode();
+      this.supplementaryConfiguration = mapper.createObjectNode();
+      this.tags = mapper.createObjectNode();
+      this.discoveryMeta = mapper.createObjectNode();
+    }
+
+    public MagpieAzureResourceBuilder withResourceName(String resourceName) {
+      this.resourceName = resourceName;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withResourceId(String resourceId) {
+      this.resourceId = resourceId;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withResourceType(String resourceType) {
+      this.resourceType = resourceType;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withRegion(String region) {
+      this.region = region;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withsubscriptionId(String subscriptionId) {
+      this.subscriptionId = subscriptionId;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withCreatedIso(Instant createdIso) {
+      this.createdIso = createdIso;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withUpdatedIso(Instant updatedIso) {
+      this.updatedIso = updatedIso;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withDiscoverySessionId(String discoverySessionId) {
+      this.discoverySessionId = discoverySessionId;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withMaxSizeInBytes(Long maxSizeInBytes) {
+      this.maxSizeInBytes = maxSizeInBytes;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withSizeInBytes(Long sizeInBytes) {
+      this.sizeInBytes = sizeInBytes;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withConfiguration(JsonNode configuration) {
+      this.configuration = configuration;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withSupplementaryConfiguration(JsonNode supplementaryConfiguration) {
+      this.supplementaryConfiguration = supplementaryConfiguration;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withTags(JsonNode tags) {
+      this.tags = tags;
+      return this;
+    }
+
+    public MagpieAzureResourceBuilder withDiscoveryMeta(JsonNode discoveryMeta) {
+      this.discoveryMeta = discoveryMeta;
+      return this;
+    }
+
+    public MagpieAzureResource build() {
+      return new MagpieAzureResource(this);
+    }
+
+      public MagpieAzureResourceBuilder withContainingEntity(String s) {
+        this.containingEntity = s;
+        return this;
+      }
+
+      public MagpieAzureResourceBuilder withContainingEntityId(String s) {
+          this.containingEntityId = s;
+          return this;
+      }
+  }
+}