Add required fields #692

deepfence · Dec 12, 2022 · 1d3bbdc · 1d3bbdc
1 parent 42bdd38
commit 1d3bbdc
Show file tree

Hide file tree

Showing 18 changed files with 943 additions and 84 deletions.
diff --git a/deepfence_agent/plugins/YaraHunter b/deepfence_agent/plugins/YaraHunter
diff --git a/deepfence_agent/tools/apache/scope/probe/appclient/openapi_client.go b/deepfence_agent/tools/apache/scope/probe/appclient/openapi_client.go
@@ -109,12 +109,10 @@ func (oc OpenapiClient) Publish(r report.Report) error {
 		return err
 	}
 
-	payload := string(buf)
-
 	req := oc.client.TopologyApi.IngestAgentReport(context.Background())
 
 	req = req.ApiDocsRawReport(openapi.ApiDocsRawReport{
-		Payload: &payload,
+		Payload: string(buf),
 	})
 
 	ctl, _, err := oc.client.TopologyApi.IngestAgentReportExecute(req)

diff --git a/deepfence_server/apiDocs/operation.go b/deepfence_server/apiDocs/operation.go
@@ -11,11 +11,11 @@ import (
 )
 
 type RawReport struct {
-	Payload string `json:"payload"`
+	Payload string `json:"payload" required:"true"`
 }
 
 type ScanTrigger struct {
-	NodeId string `json:"node_id"`
+	NodeId string `json:"node_id" required:"true"`
 }
 
 func (d *OpenApiDocs) AddUserAuthOperations() {

diff --git a/deepfence_server_client/.openapi-generator/FILES b/deepfence_server_client/.openapi-generator/FILES
@@ -6,6 +6,7 @@ api_authentication.go
 api_cloud_compliance.go
 api_cloud_resources.go
 api_compliance.go
+api_malware_scan.go
 api_secret_scan.go
 api_threat.go
 api_topology.go
@@ -27,6 +28,7 @@ docs/IngestersCloudResource.md
 docs/IngestersComplianceDoc.md
 docs/IngestersDfCveStruct.md
 docs/IngestersSecret.md
+docs/MalwareScanApi.md
 docs/ModelApiAuthRequest.md
 docs/ModelLoginRequest.md
 docs/ModelResponse.md

diff --git a/deepfence_server_client/README.md b/deepfence_server_client/README.md
@@ -79,15 +79,20 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*AuthenticationApi* | [**AuthToken**](docs/AuthenticationApi.md#authtoken) | **Post** /deepfence/auth/token | API Auth Token
+*AuthenticationApi* | [**AuthToken**](docs/AuthenticationApi.md#authtoken) | **Post** /deepfence/auth/token | Get Access Token for API Token
+*AuthenticationApi* | [**AuthTokenRefresh**](docs/AuthenticationApi.md#authtokenrefresh) | **Post** /deepfence/auth/token/refresh | Refresh access token
 *AuthenticationApi* | [**Login**](docs/AuthenticationApi.md#login) | **Post** /deepfence/user/login | Login API
 *AuthenticationApi* | [**Logout**](docs/AuthenticationApi.md#logout) | **Post** /deepfence/user/logout | Logout API
 *CloudComplianceApi* | [**IngestCloudCompliances**](docs/CloudComplianceApi.md#ingestcloudcompliances) | **Post** /deepfence/ingest/cloud-compliance | Ingest Cloud Compliances
 *CloudResourcesApi* | [**IngestCloudResources**](docs/CloudResourcesApi.md#ingestcloudresources) | **Post** /deepfence/ingest/cloud-resources | Ingest Cloud resources
 *ComplianceApi* | [**IngestCompliances**](docs/ComplianceApi.md#ingestcompliances) | **Post** /deepfence/ingest/compliance | Ingest Compliances
-*ComplianceApi* | [**StartComplianceScan**](docs/ComplianceApi.md#startcompliancescan) | **Get** /deepfence/scan/start/compliances | Start Compliance Scan
+*ComplianceApi* | [**StartComplianceScan**](docs/ComplianceApi.md#startcompliancescan) | **Get** /deepfence/scan/start/compliance | Start Compliance Scan
+*ComplianceApi* | [**StopComplianceScan**](docs/ComplianceApi.md#stopcompliancescan) | **Get** /deepfence/scan/stop/compliance | Stop Compliance Scan
+*MalwareScanApi* | [**StartMalwareScan**](docs/MalwareScanApi.md#startmalwarescan) | **Get** /deepfence/scan/start/malware | Start Malware Scan
+*MalwareScanApi* | [**StopMalwareScan**](docs/MalwareScanApi.md#stopmalwarescan) | **Get** /deepfence/scan/stop/malware | Stop Malware Scan
 *SecretScanApi* | [**IngestSecrets**](docs/SecretScanApi.md#ingestsecrets) | **Post** /deepfence/ingest/secrets | Ingest Secrets
-*SecretScanApi* | [**StartSecretScan**](docs/SecretScanApi.md#startsecretscan) | **Get** /deepfence/scan/start/secrets | Start Secret Scan
+*SecretScanApi* | [**StartSecretScan**](docs/SecretScanApi.md#startsecretscan) | **Get** /deepfence/scan/start/secret | Start Secret Scan
+*SecretScanApi* | [**StopSecretScan**](docs/SecretScanApi.md#stopsecretscan) | **Get** /deepfence/scan/stop/secret | Stop Secret Scan
 *ThreatApi* | [**GetThreatGraph**](docs/ThreatApi.md#getthreatgraph) | **Get** /deepfence/graph/threat | Get Threat Graph
 *TopologyApi* | [**GetTopologyGraph**](docs/TopologyApi.md#gettopologygraph) | **Get** /deepfence/graph/topology | Get Topology Graph
 *TopologyApi* | [**IngestAgentReport**](docs/TopologyApi.md#ingestagentreport) | **Post** /deepfence/ingest/report | Ingest Topology Data
@@ -97,7 +102,8 @@ Class | Method | HTTP request | Description
 *UserApi* | [**RegisterUser**](docs/UserApi.md#registeruser) | **Post** /deepfence/user/register | Register User
 *UserApi* | [**UpdateCurrentUser**](docs/UserApi.md#updatecurrentuser) | **Put** /deepfence/user | Update Current User
 *VulnerabilityApi* | [**IngestCVEs**](docs/VulnerabilityApi.md#ingestcves) | **Post** /deepfence/ingest/cves | Ingest CVEs
-*VulnerabilityApi* | [**StartCVEScan**](docs/VulnerabilityApi.md#startcvescan) | **Get** /deepfence/scan/start/cves | Start CVE Scan
+*VulnerabilityApi* | [**StartVulnerabilityScan**](docs/VulnerabilityApi.md#startvulnerabilityscan) | **Get** /deepfence/scan/start/vulnerability | Start CVE Scan
+*VulnerabilityApi* | [**StopVulnerabilityScan**](docs/VulnerabilityApi.md#stopvulnerabilityscan) | **Get** /deepfence/scan/stop/vulnerability | Stop CVE Scan
 
 
 ## Documentation For Models

diff --git a/deepfence_server_client/api/openapi.yaml b/deepfence_server_client/api/openapi.yaml
@@ -64,7 +64,8 @@ paths:
       - User
   /deepfence/auth/token:
     post:
-      description: Get auth token for API access
+      description: "Get access token for programmatic API access, by providing API\
+        \ Token"
       operationId: authToken
       requestBody:
         content:
@@ -94,7 +95,39 @@ paths:
               schema:
                 $ref: '#/components/schemas/ApiDocsFailureResponse'
           description: Internal Server Error
-      summary: API Auth Token
+      summary: Get Access Token for API Token
+      tags:
+      - Authentication
+  /deepfence/auth/token/refresh:
+    post:
+      description: Reissue access token using refresh token
+      operationId: authTokenRefresh
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ModelResponse'
+          description: OK
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsBadRequestResponse'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsFailureResponse'
+          description: Internal Server Error
+      security:
+      - bearer_token: []
+      summary: Refresh access token
       tags:
       - Authentication
   /deepfence/graph/threat:
@@ -378,13 +411,13 @@ paths:
       summary: Ingest Secrets
       tags:
       - Secret Scan
-  /deepfence/scan/start/compliances:
+  /deepfence/scan/start/compliance:
     get:
-      description: Start Compliance Scan on agent
+      description: Start Compliance Scan on agent or registry
       operationId: startComplianceScan
       responses:
-        "200":
-          description: OK
+        "202":
+          description: Accepted
         "400":
           content:
             application/json:
@@ -406,13 +439,13 @@ paths:
       summary: Start Compliance Scan
       tags:
       - Compliance
-  /deepfence/scan/start/cves:
+  /deepfence/scan/start/malware:
     get:
-      description: Start CVE Scan on agent
-      operationId: startCVEScan
+      description: Start Malware Scan on agent or registry
+      operationId: startMalwareScan
       responses:
-        "200":
-          description: OK
+        "202":
+          description: Accepted
         "400":
           content:
             application/json:
@@ -431,16 +464,16 @@ paths:
           description: Internal Server Error
       security:
       - bearer_token: []
-      summary: Start CVE Scan
+      summary: Start Malware Scan
       tags:
-      - Vulnerability
-  /deepfence/scan/start/secrets:
+      - Malware Scan
+  /deepfence/scan/start/secret:
     get:
-      description: Start Secret Scan on agent
+      description: Start Secret Scan on agent or registry
       operationId: startSecretScan
       responses:
-        "200":
-          description: OK
+        "202":
+          description: Accepted
         "400":
           content:
             application/json:
@@ -462,6 +495,146 @@ paths:
       summary: Start Secret Scan
       tags:
       - Secret Scan
+  /deepfence/scan/start/vulnerability:
+    get:
+      description: Start CVE Scan on agent or registry
+      operationId: startVulnerabilityScan
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsBadRequestResponse'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsFailureResponse'
+          description: Internal Server Error
+      security:
+      - bearer_token: []
+      summary: Start CVE Scan
+      tags:
+      - Vulnerability
+  /deepfence/scan/stop/compliance:
+    get:
+      description: Stop Compliance Scan on agent or registry
+      operationId: stopComplianceScan
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsBadRequestResponse'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsFailureResponse'
+          description: Internal Server Error
+      security:
+      - bearer_token: []
+      summary: Stop Compliance Scan
+      tags:
+      - Compliance
+  /deepfence/scan/stop/malware:
+    get:
+      description: Stop Malware Scan on agent or registry
+      operationId: stopMalwareScan
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsBadRequestResponse'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsFailureResponse'
+          description: Internal Server Error
+      security:
+      - bearer_token: []
+      summary: Stop Malware Scan
+      tags:
+      - Malware Scan
+  /deepfence/scan/stop/secret:
+    get:
+      description: Stop Secret Scan on agent or registry
+      operationId: stopSecretScan
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsBadRequestResponse'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsFailureResponse'
+          description: Internal Server Error
+      security:
+      - bearer_token: []
+      summary: Stop Secret Scan
+      tags:
+      - Secret Scan
+  /deepfence/scan/stop/vulnerability:
+    get:
+      description: Stop CVE Scan on agent or registry
+      operationId: stopVulnerabilityScan
+      responses:
+        "202":
+          description: Accepted
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsBadRequestResponse'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "403":
+          description: Forbidden
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ApiDocsFailureResponse'
+          description: Internal Server Error
+      security:
+      - bearer_token: []
+      summary: Stop CVE Scan
+      tags:
+      - Vulnerability
   /deepfence/user:
     delete:
       description: Delete logged in user
@@ -682,6 +855,8 @@ components:
       properties:
         payload:
           type: string
+      required:
+      - payload
       type: object
     ControlsAction:
       example: